Unigy 4.

3
Enterprise Guide

Part Number: B02200736, Release: 02

IPC Confidential
December 3, 2019
© Copyright 2011–2019 IPC Systems, Inc. All RightsReserved.
 3

Table of Contents
Revision List for Unigy V4.3....................................................................................................... 13
Preface ..........................................................................................................................................17

Chapter 1: Unigy upgrade workflows........................................................................................21

1.1 Overview............................................................................................................................................................25
1.1.1 Patches, service packs, and hotfixes................................................................................................... 25
1.1.2 Unigy software version naming convention ...................................................................................... 29
1.2 Upgrades that require new COP software..........................................................................................................31
1.2.1 Deploy a software update that requires a new COP with Single Click Deployment......................... 31
1.2.2 Deploy a software update with a new COP in a single zone enterprise – standalone or HA............. 41
1.2.3 Deploy a software update with a new COP in a multizone enterprise – subset of zones...................46
1.2.4 Deploy a software update with a new COP in a multizone enterprise – all zones............................. 53
1.3 Upgrades that do not require new COP software...............................................................................................60
1.3.1 Deploy a software update that does not require a new COP with Single Click Deployment ............60
1.3.2 Deploy a software update in a standalone zone enterprise................................................................. 69
1.3.3 Deploy a software update in a single HA zone enterprise..................................................................73
1.3.4 Deploy a software update in a multizone enterprise with Enterprise Install ..................................... 78
1.3.5 Deploy a Unigy software update in parallel in a multizone enterprise ..............................................86
1.3.6 Deploy a software update in a multizone enterprise one zone at a time.............................................93
1.4 Downgrade the software to a previous version ...............................................................................................100

Chapter 2: Blue Wave deployment and upgrade workflows................................................. 101

2.1 Blue Wave initial deployment workflows........................................................................................................102
2.1.1 Deploy the Blue Wave Director software in a single appliance zone...............................................102
2.1.2 Deploy the Blue Wave Director software on both appliances in an HA zone simultaneously.........106
2.1.3 Deploy the Blue Wave Director software in an HA zone one appliance at a time...........................109
2.2 Blue Wave upgrade workflows........................................................................................................................ 114
2.2.1 Deploy a Blue Wave software update in a single appliance zone.....................................................114
2.2.2 Deploy a Blue Wave software update in an HA zone on both appliances simultaneously.............. 116
2.2.3 Deploy a Blue Wave software update in an HA zone one appliance at a time.................................120

Chapter 3: OS patch upgrade workflows................................................................................ 125

3.1 OS patches....................................................................................................................................................... 125
3.2 OS patch naming convention........................................................................................................................... 130
3.3 Procedures........................................................................................................................................................131
3.3.1 Install an OS patch in a single zone from the UMS – automatic install...........................................131
3.3.2 Install an OS patch in a single zone from the UMS - manual install................................................134
3.3.3 Install an OS patch in multiple zones from the UMS with OS Enterprise Install............................ 137

IPC Confidential Unigy 4.3

Enterprise Guide
4

3.3.4 Install an OS patch from the UMS during trading hours .................................................................139
3.3.5 Install an OS patch from the command line within a single maintenance window..........................142
3.3.6 Install an OS patch from the command line within separate maintenance windows....................... 144
3.3.7 Upload or download an OS patch ISO file....................................................................................... 146
3.3.8 Delete an OS patch ISO file from the UMS..................................................................................... 146
3.3.9 Deploy the Spectre and Meltdown BIOS update .............................................................................147

Chapter 4: Single Click Deployment (SCD)............................................................................ 149

4.1 Single Click Deployment appliances............................................................................................................... 150
4.2 Single Click Deployment (SCD) in a virtual environment..............................................................................151
4.2.1 Single Click Deployment (SCD) appliance VM hardware resource requirements.......................... 151
4.2.2 Create a Single Click Deployment (SCD) appliance VM on a host server...................................... 152
4.2.3 Create a Single Click Deployment (SCD) appliance VM on a laptop ............................................ 154
4.3 Single Click Deployment tasks........................................................................................................................159
4.3.1 Register a Unigy appliance with a Single Click Deployment appliance.......................................... 160
4.3.2 Confirm that an appliance is registered with a Single Click Deployment appliance....................... 162
4.3.3 Unregister a Unigy appliance from a Single Click Deployment appliance......................................162
4.3.4 Confirm that an appliance is not registered with a Single Click Deployment appliance................. 163
4.3.5 Configure SMTP for Single Click Deployment notifications.......................................................... 163
4.3.6 Import an artifact.............................................................................................................................. 164
4.3.7 Display available artifacts.................................................................................................................165
4.3.8 Create an image backup (restore point) with Single Click Deployment.......................................... 165
4.3.9 Import an Enterprise backup file to a Single Click Deployment appliance..................................... 166
4.3.10 Roll back the zones in an enterprise with Single Click Deployment............................................... 167
4.3.11 View and update a Unigy appliance profile in Single Click Deployment........................................ 168
4.3.12 Remove a Unigy appliance from a Single Click Deployment appliance......................................... 168
4.3.13 Confirm that an appliance was removed from a Single Click Deployment appliance.....................169
4.3.14 Change a Single Click Deployment user account password............................................................ 169
4.3.15 Assign an appliance to a different Single Click Deployment user account......................................170
4.3.16 Upgrade a Single Click Deployment appliance................................................................................170
4.4 Single Click Deployment panels......................................................................................................................171
4.4.1 Login Form....................................................................................................................................... 172
4.4.2 Main Menu........................................................................................................................................173
4.4.3 Enterprise Servers Plan: Select Servers............................................................................................176
4.4.4 Enterprise Servers Plan: Selected Servers........................................................................................ 181
4.4.5 Enterprise Server Plan: Map Details.................................................................................................188
4.4.6 Enterprise Servers Plan: Monitor......................................................................................................190
4.4.7 Server Profile: Select a Server..........................................................................................................195
4.4.8 Server Profile.................................................................................................................................... 196
4.4.9 Remove Server: Delete a Server.......................................................................................................199
4.4.10 Servers History: Transactions...........................................................................................................201
4.4.11 Show All Servers: Servers................................................................................................................ 206
4.4.12 OCD Build Report............................................................................................................................ 208

December 3, 2019 IPC Confidential

 5

4.4.13 Import Artifact: Import an Artifact................................................................................................... 211

4.4.14 Available Artifact..............................................................................................................................212
4.4.15 Import Enterprise DB: Enterprise DB upload form..........................................................................213
4.4.16 Enterprise Watch...............................................................................................................................215
4.4.17 New Servers......................................................................................................................................221
4.4.18 Upgrade SCD....................................................................................................................................222
4.4.19 SMTP Configuration: Configure SMTP Server............................................................................... 224
4.4.20 User Profile.......................................................................................................................................226

Chapter 5: Multi-tier Replication.............................................................................................229

5.1 Multi-tier Replication activation example....................................................................................................... 238
5.2 Add, edit, or delete an address......................................................................................................................... 242
5.3 Assign the default data center for Multi-tier Replication................................................................................ 243
5.4 Enable Multi-tier Replication.......................................................................................................................... 243
5.4.1 Multi-tier Replication pre-implementation checklist........................................................................244
5.5 Disable Multi-tier Replication......................................................................................................................... 246
5.6 Suspend or resume Multi-tier Replication....................................................................................................... 247
5.7 Change the default data center for Multi-tier Replication............................................................................... 249
5.8 Change the portal zone for a data center..........................................................................................................249
5.9 Check a zone’s Multi-tier Replication status................................................................................................... 250
5.9.1 Check Multi-tier Replication status output details........................................................................... 251
5.10 Check an enterprise’s Multi-tier Replication status......................................................................................... 258
5.10.1 Check enterprise Multi-tier Replication status output details...........................................................259
5.11 Diagnose latency for Multi-tier Replication.................................................................................................... 260
5.11.1 Test Multi-tier Replication status......................................................................................................261

Chapter 6: Secure communications......................................................................................... 263

6.1 Certificates supported for device communication........................................................................................... 268
6.1.1 Upload a self-signed third-party certificate for secure communications..........................................269
6.1.2 Install a customer certificate for Soft Client secure communications.............................................. 270
6.2 Secure Communications configuration............................................................................................................271
6.2.1 Configure secure communications for an instance...........................................................................272
6.2.2 Enable secure communications for Media Gateways.......................................................................273
6.2.3 Disable secure communications for Media Gateways......................................................................274
6.2.4 Enable secure communications for SIP trunks for PBXs and Session Border Controllers.............. 275
6.2.5 Override secure communications settings for specific CDIs, MGs, or MMs...................................276

Chapter 7: Replica system workflow....................................................................................... 279

7.1 Build a replica system......................................................................................................................................279

IPC Confidential Unigy 4.3

Enterprise Guide
6

Chapter 8: BCP workflows....................................................................................................... 283

8.1 BCP ................................................................................................................................................................. 283
8.1.1 During a BCP event ......................................................................................................................... 289
8.1.2 Constraints ....................................................................................................................................... 290
8.2 Configure a BCP plan ..................................................................................................................................... 290
8.3 Configure Campus BCP login priorities for users........................................................................................... 292
8.4 Enable automatic BCP plan activation (failover) ........................................................................................... 293
8.5 Disable automatic BCP plan activation .......................................................................................................... 293
8.6 Manually activate a BCP plan (fail over)........................................................................................................ 294
8.7 Reactivate a BCP plan .................................................................................................................................... 296
8.8 Deactivate a BCP plan (fail back) ...................................................................................................................296
8.9 Retry Deactivation for a BCP plan.................................................................................................................. 298
8.10 Redirect a Soft Client after a BCP event ........................................................................................................ 298
8.11 BCP line redirection example ......................................................................................................................... 299

Chapter 9: Enterprise and instance management workflows................................................301

9.1 Change the enterprise name ............................................................................................................................ 301
9.2 Change the enterprise domain name................................................................................................................ 301
9.3 Change a stateless HA enterprise to stateful HA............................................................................................. 303
9.4 Add an instance................................................................................................................................................303
9.5 Change an instance name.................................................................................................................................304
9.6 Change an instance domain name....................................................................................................................304
9.7 Merge two Unigy enterprises ..........................................................................................................................305

Chapter 10: Zone management workflows..............................................................................307

10.1 Change a zone name........................................................................................................................................ 307
10.2 Add a zone to a Unigy enterprise.....................................................................................................................307
10.3 Remove a zone from the enterprise ................................................................................................................ 309
10.4 Move zones to a different instance.................................................................................................................. 312
10.5 Move a zone to a different data center within the same instance.................................................................... 315
10.6 Partial replication............................................................................................................................................. 316
10.6.1 Enable partial replication .................................................................................................................316
10.6.2 Disable partial replication.................................................................................................................317
10.7 Refresh (restart) a zone in a single zone enterprise......................................................................................... 318
10.8 Refresh (restart) zones in a multizone enterprise.............................................................................................319
10.9 Refresh (restart) a portal zone .........................................................................................................................320
10.10 Reboot the appliances in a single or multizone enterprise...............................................................................321
10.11 Change a zone ID.............................................................................................................................................323
10.12 Configure a zone's OOPS line......................................................................................................................... 324
10.13 Change a zone's country base.......................................................................................................................... 324

December 3, 2019 IPC Confidential

 7

10.14 Upload a country.dat file to a Media Gateway................................................................................................ 325

10.15 Synchronize zones that have been disconnected for more than 15 minutes.................................................... 326
10.15.1 Disconnected zones ......................................................................................................................... 327
10.16 Redeploy (reCOP) one appliance in an HA zone ........................................................................................... 328
10.17 Redeploy (reCOP) a zone in a multizone enterprise........................................................................................331
10.18 Redeploy (reCOP) a zone that must load the database from a lower version zone......................................... 333
10.19 Reestablish the connection with an authentication server............................................................................... 335
10.20 UMS configuration changes that require a zone reboot...................................................................................335
10.21 Convert a local survivability zone to an active or standby zone......................................................................336
10.22 Change the SIP Port for a zone........................................................................................................................ 336
10.23 Enable or disable WebLogic, SWMS, and Enterprise Watch Web link access............................................... 337
10.23.1 Web links access............................................................................................................................... 337

Chapter 11: Hardware management workflows..................................................................... 339

11.1 Shut down and power up appliances................................................................................................................339
11.1.1 Shutdown backroom hardware gracefully........................................................................................ 339
11.1.2 Power down the appliances in an HA zone ..................................................................................... 339
11.1.3 Power up the appliances in an HA zone .......................................................................................... 340
11.1.4 Power down a Media Manager ........................................................................................................ 340
11.1.5 Power up a Media Manager .............................................................................................................340
11.1.6 Power down a Media Gateway ........................................................................................................ 341
11.1.7 Power up a Media Gateway .............................................................................................................341
11.2 Replace R610, R620, or R630 appliances with R640 appliances ...................................................................341
11.3 Replace an appliance in an HA zone .............................................................................................................. 344
11.4 Replace both appliances in a zone................................................................................................................... 347
11.5 Restore an enterprise where one zone survived a multizone hardware failure................................................349
11.6 Restore a multizone enterprise after the failure of all appliances ...................................................................350
11.7 Replace a failed Media Manager..................................................................................................................... 352
11.8 Configure Media Gateway warm standby....................................................................................................... 353
11.8.1 Put the warm standby Media Gateway into service..........................................................................355
11.9 Move CDIs to a different zone.........................................................................................................................355
11.9.1 Move an IQ/MAX or IQ/MAX Edge turret to a different zone .......................................................355
11.9.2 Move a Pulse to a different zone ..................................................................................................... 356
11.9.3 Move a Unigy Soft Client to a different zone...................................................................................358
11.9.4 Move an IQ/MAX TOUCH turret to a different zone...................................................................... 359
11.10 Remove hardware from the database...............................................................................................................359
11.11 Remove an appliance from the database .........................................................................................................361
11.12 Remove a CDI from the database.................................................................................................................... 361
11.13 Confirm that a device registered with a zone...................................................................................................362

Chapter 12: Database backup and restore workflows........................................................... 363

12.1 Create or schedule a new backup ....................................................................................................................363

IPC Confidential Unigy 4.3

Enterprise Guide
8

12.1.1 Edit a scheduled backup or restore job............................................................................................. 366

12.1.2 Backup types.....................................................................................................................................369
12.1.3 Recommended backup types............................................................................................................ 371
12.2 Restore data from a user or archive backup file ............................................................................................. 372
12.3 Restore an Enterprise backup in a single zone.................................................................................................374
12.4 Restore an Enterprise backup file in a multizone enterprise............................................................................377
12.5 Recover from a corrupt enterprise database in a multizone enterprise............................................................380

Chapter 13: Image backup and restore workflows.................................................................383

13.1 Image backup and restore (rollback) overview................................................................................................383
13.2 Create an image backup (restore point) from the UMS...................................................................................385
13.3 Roll back a personality or zone deployment ...................................................................................................386
13.4 Roll back the software on the appliance in a Unigy or Blue Wave standalone zone.......................................387
13.5 Roll back the software on the appliances in a Unigy or Blue Wave HA zone from the UMS ....................... 389
13.6 Create a disk image backup from the command line.......................................................................................391
13.7 Restore a CCM, ACCM, or MM disk image from the command line.............................................................393

Chapter 14: Network change workflows................................................................................. 399

14.1 Change a zone VIP ..........................................................................................................................................399
14.2 Move the appliances in an HA zone to a different network............................................................................ 402
14.3 Change the IP address or other network settings for both appliances in an HA zone..................................... 407
14.4 Change the IP address or other network settings for one CCM or ACCM appliance in an HA zone............. 409
14.5 Change the IP address for a CCM or ACCM in a single appliance zone ....................................................... 412
14.6 Change a CCM or ACCM hostname .............................................................................................................. 415
14.7 Change a Media Manager IP address ..............................................................................................................416
14.8 Change a Media Manager hostname ...............................................................................................................417
14.9 Change the NIC configuration for a Media Manager...................................................................................... 418
14.10 Change a Media Gateway IP address...............................................................................................................419
14.11 Change a Media Gateway host name ..............................................................................................................420
14.12 Tune JGroups parameters to prevent network timeouts...................................................................................420
14.13 Configure Unigy access to Domain Name System (DNS) servers..................................................................421

Chapter 15: Time-related workflows....................................................................................... 423

15.1 Assign NTP servers to the devices in a zone................................................................................................... 423
15.2 Change a location time zone in a standalone zone.......................................................................................... 424
15.3 Change the location time zone for an HA zone in a single or multizone enterprise........................................424
15.4 Change the system time zone...........................................................................................................................426
15.5 Configure the server time source .................................................................................................................... 427
15.6 Configure the server time source – NIM......................................................................................................... 430

December 3, 2019 IPC Confidential

 9

Chapter 16: Enterprise to enterprise line sharing.................................................................. 435

16.1 Enterprise line sharing considerations ............................................................................................................ 435
16.2 Understanding PUIBs ..................................................................................................................................... 437
16.3 Configure enterprise to enterprise line sharing................................................................................................439
16.4 Copy Certificates Between Enterprises .......................................................................................................... 442

Chapter 17: Procedures referenced by the workflows........................................................... 447

17.1 Deployment and upgrade procedures...............................................................................................................447
17.1.1 Common Operating Platform image ................................................................................................447
17.1.2 Deploy the COP (Common Operating Platform) software...............................................................448
17.1.3 Determine the current COP version..................................................................................................450
17.1.4 Configure the appliance network settings with Network Configurator ...........................................450
17.1.5 Deploy the appliance personality software with Personality Deployer............................................465
17.1.6 Transfer a personality ISO file .........................................................................................................478
17.1.7 License procedures........................................................................................................................... 479
17.1.8 Add an IPC Certified Technician user ............................................................................................. 488
17.1.9 Zones.................................................................................................................................................489
17.1.10 HA.....................................................................................................................................................544
17.1.11 Upload or download an ISO file ......................................................................................................547
17.1.12 Download an ISO file when an upload or download fails................................................................548
17.1.13 Deploy an ISO file ........................................................................................................................... 550
17.1.14 Confirm that an update was deployed ............................................................................................. 552
17.1.15 Upgrade the software on system devices .........................................................................................558
17.1.16 Downgrade (roll back) the CDI software......................................................................................... 562
17.1.17 Configure an SMTP server............................................................................................................... 563
17.1.18 Send SNMP recovery alerts prior to an upgrade ............................................................................. 564
17.1.19 Clear Unigy v2.0 and v2.0.1 alerts................................................................................................... 565
17.1.20 Convert the MySQL password hashing algorithm (fix_my_pass)................................................... 565
17.1.21 Update prototype devices after an upgrade...................................................................................... 566
17.1.22 Run the updateToneCadenceFreqForExistingInstances.sh script.....................................................567
17.1.23 Generate address text files with generateAddresses.........................................................................567
17.2 Media Gateway procedures..............................................................................................................................568
17.2.1 Add a Media Gateway ..................................................................................................................... 568
17.2.2 Add Media Gateways for BCP ........................................................................................................ 569
17.2.3 Update Media Gateway software .....................................................................................................570
17.2.4 Downgrade the Media Gateway software.........................................................................................572
17.2.5 Retrieve the Media Gateway configuration......................................................................................577
17.2.6 Media Gateway module population standard .................................................................................. 577
17.2.7 Configure a Media Gateway.............................................................................................................578
17.2.8 Synchronize CAS files......................................................................................................................579
17.2.9 Configure a Media Gateway module................................................................................................580
17.2.10 Associate trunks with a private line .................................................................................................581

IPC Confidential Unigy 4.3

Enterprise Guide
10

17.2.11 Associate trunks with an extension...................................................................................................582

17.2.12 Resynchronize CAS files .................................................................................................................582
17.2.13 Upload default portion of Media Gateway INI file.......................................................................... 583
17.2.14 Download a Media Gateway INI file................................................................................................585
17.2.15 Upload incremental changes to default portion of MG INI file....................................................... 585
17.2.16 Apply changes to a Media Gateway configuration...........................................................................586
17.2.17 Enable or disable Media Gateway SSH remote access ................................................................... 587
17.2.18 Configure the NTP Server for a Media Gateway ............................................................................ 587
17.3 Reboot procedures........................................................................................................................................... 587
17.3.1 Reboot CCM.....................................................................................................................................587
17.3.2 Run Reboot Media Manager.............................................................................................................588
17.3.3 Reapply the license for an MM in a VM after a reboot....................................................................590
17.3.4 Reboot an appliance if the reboot command gets stuck................................................................... 590
17.3.5 Reboot a Media Gateway .................................................................................................................591
17.3.6 Reboot communication devices........................................................................................................591
17.3.7 Restart an IQ/MAX or IQ/MAX Edge turret ...................................................................................595
17.3.8 Restart an IQ/MAX TOUCH turret.................................................................................................. 595
17.3.9 Restart a Pulse...................................................................................................................................596
17.4 Maintenance mode procedures........................................................................................................................ 596
17.4.1 Disable SNMP forwarding for a zone.............................................................................................. 596
17.4.2 Reenable SNMP forwarding for a zone............................................................................................596
17.4.3 Disable SNMP forwarding to a trap destination...............................................................................597
17.4.4 Place a zone into maintenance mode to disable BCP plan activation.............................................. 597
17.4.5 Take a zone out of maintenance mode to reenable BCP plan activation..........................................598
17.4.6 Place a cluster into maintenance mode to enable control of HA failovers.......................................598
17.4.7 Take a cluster out of maintenance mode to resume normal HA operation.......................................599
17.4.8 Place an appliance or Media Gateway into maintenance mode to indicate it is unavailable........... 599
17.4.9 Take an appliance or Media Gateway out of maintenance mode .................................................... 600
17.4.10 Indicate that maintenance on the Standby appliance is complete ....................................................601
17.5 Database backup and restore procedures......................................................................................................... 601
17.5.1 Back up and restore considerations.................................................................................................. 601
17.5.2 Remote storage of backup files.........................................................................................................604
17.5.3 Download a backup file ................................................................................................................... 607
17.5.4 Upload a backup file ........................................................................................................................ 611
17.5.5 Configure a recurring archive backup job and retention policy....................................................... 612
17.5.6 Add or edit backup retention policies...............................................................................................613
17.5.7 Run the post_restore.sh script...........................................................................................................614
17.5.8 Database source zone selection algorithms for database dumps...................................................... 615
17.6 Soft Client install, upgrade, and uninstall procedures..................................................................................... 621
17.6.1 Install the Unigy Soft Client software ............................................................................................. 621
17.6.2 Remote Soft Client installation ........................................................................................................625
17.6.3 Upgrade the Unigy Soft Client software – Microsoft Windows 64-bit............................................ 628
17.6.4 Upgrade the Unigy Soft Client software – Microsoft Windows 32-bit............................................ 630
17.6.5 Roll back the Unigy Soft Client software – Microsoft Windows 64-bit ......................................... 631
17.6.6 Roll back the Unigy Soft Client software – Microsoft Windows 32-bit.......................................... 633

December 3, 2019 IPC Confidential

 11

17.6.7 Uninstall the Unigy Soft Client software..........................................................................................634

17.7 Validation procedures.......................................................................................................................................635
17.7.1 Validation workflow......................................................................................................................... 635
17.7.2 Validate a zone before an upgrade, rollback, or other operations.....................................................636
17.7.3 Validate a zone after a deployment, rollback, or other operations ...................................................638
17.7.4 Verify zone replication and line status port information.................................................................. 639
17.7.5 Run automated health check from the command line...................................................................... 639
17.7.6 Run TAC Health Check from the UMS ...........................................................................................640
17.7.7 Analyze an enterprise with Enterprise Watch...................................................................................643
17.7.8 View system devices by zone .......................................................................................................... 643
17.7.9 Run Walk the Floor diagnostics........................................................................................................644
17.7.10 Run interzone diagnostic tool........................................................................................................... 646
17.7.11 Run CCM Software Version............................................................................................................. 648
17.7.12 Run MM software version................................................................................................................ 649
17.7.13 Run Media Gateway software version..............................................................................................650
17.7.14 View registered IQ/MAX and IQ/MAX Edge turrets.......................................................................651
17.7.15 View registered Pulse devices.......................................................................................................... 651
17.7.16 View registered Soft Clients............................................................................................................. 652
17.7.17 View registered IQ/MAX TOUCH turrets........................................................................................652
17.7.18 Monitor devices ............................................................................................................................... 652
17.7.19 Generate system configuration report ..............................................................................................653
17.7.20 Run call control diagnostic tests....................................................................................................... 654
17.7.21 Test calls........................................................................................................................................... 662
17.7.22 Verify IP Recording Status .............................................................................................................. 668
17.7.23 Run CCM AFM Alerts test...............................................................................................................670
17.7.24 Test HA............................................................................................................................................. 671
17.7.25 Test BCP........................................................................................................................................... 671
17.7.26
Validate JGroups protocol values for the Unigy and Blue Wave channels on an appliance - manual procedure
..........................................................................................................................................................................671
17.8 Miscellaneous procedures................................................................................................................................673
17.8.1 Remove button association properties ............................................................................................. 673
17.8.2 Configure turret network settings .................................................................................................... 674
17.8.3 Configure Pulse network settings .................................................................................................... 676
17.8.4 Create, edit, or delete lines and extensions with Mass Edit Client...................................................676
17.8.5 Edit button sheets with Mass Edit Client .........................................................................................686
17.8.6 Generate assigned license report ..................................................................................................... 689
17.8.7 Edit and upload report...................................................................................................................... 695
17.8.8 Generate a custom report.................................................................................................................. 695
17.8.9 Delete a custom report...................................................................................................................... 696
17.8.10 Sync BCP manually - Unigy V1.......................................................................................................696
17.8.11 Run Sync MM NTP Config..............................................................................................................698
17.8.12 Replication........................................................................................................................................698
17.8.13 Partial replication (Regional Area Data Replication).......................................................................701
17.8.14 Login Mass Edit Client.....................................................................................................................706

IPC Confidential Unigy 4.3

Enterprise Guide
12

17.8.15 Diagnostics....................................................................................................................................... 709

17.8.16
Update the JGroups protocols on individual appliances for the Unigy and Blue Wave Adapter channels - Unigy and Blue Wave z
..........................................................................................................................................................................716
17.8.17
Update the JGroups protocols on individual appliances for the Blue Wave Director channels - Blue Wave zones
..........................................................................................................................................................................718

Appendix A: Dynamic passwords............................................................................................ 719

A.1 Password Manager Web application................................................................................................................ 720
A.2 Establish an SSH session using the shelldiag account.....................................................................................720
A.3 Elevate shelldiag to superuser..........................................................................................................................723
A.4 Dynamic Password and CCM console versus SSH client............................................................................... 728
A.5 Regenerate superuser account password..........................................................................................................728
A.6 Password Manager Help topics........................................................................................................................728
A.6.1 Password Manager - Generate Output panel.................................................................................... 728

Appendix B: iDRAC hardening ...............................................................................................731

B.1 Install the latest iDRAC firmware................................................................................................................... 731
B.2 Harden iDRAC 6 .............................................................................................................................................732
B.3 Harden iDRAC 7 .............................................................................................................................................736
B.4 Harden iDRAC 8..............................................................................................................................................740
B.5 Harden iDRAC 9 .............................................................................................................................................746

Appendix C: BIOS configuration............................................................................................. 755

C.1 Configure the BIOS settings for R620 appliances...........................................................................................755
C.2 Configure the BIOS settings for R630 appliances...........................................................................................762
C.3 Configure the BIOS settings for R640 appliances ..........................................................................................769

Index............................................................................................................................................783

December 3, 2019 IPC Confidential

 13

Revision List for Unigy V4.3

Miscellaneous updates
• You have access to the document Post-Maintenance V...
• You have access to the document Post-Maintenance V...
• You have access to the document Post-Maintenance V...
• You have access to the document Post-Maintenance V...
• You have access to the document Post-Maintenance V...
• You have access to the document Post-Maintenance V...
• You have access to the document Post-Maintenance V...
• You have access to the document Post-Maintenance V...
• You have access to the document Post-Maintenance V...
• You have access to the document Post-Maintenance V...
• After a BCP plan is activated automatically, do on...
• If Multi-tier Replication is not enabled for the d...
• Run TAC Health Check from the UMS Use this procedu...
• Make a phone call to the number on the button you ...

Enterprise to enterprise line sharing

• TrunkAOR: enter the PUIB + the Line Appearance fro...

E911
• Emergency Number The number that allows the caller...

Security
• If the Spectre and Meltdown BIOS update was not de...
• If the Spectre and Meltdown BIOS update was not de...
• If the Spectre and Meltdown BIOS update was not de...
• If the Spectre and Meltdown BIOS update was not de...
• If the Spectre and Meltdown BIOS update was not de...
• If the Spectre and Meltdown BIOS update was not de...
• Deploy the Spectre and Meltdown BIOS update This u...

Deployment
• If you are importing a COP .iso file, copy the fil...
• If you copied a COP .iso file to the SCD appliance...

IPC Confidential Unigy 4.3

Enterprise Guide
14

Issue (Defect)
PKE
• Redeploy (reCOP) one appliance in an HA zone If on...

187065
• If you are upgrading from Unigy v2.x to Unigy v3.0...
• If you are upgrading from Unigy v2.x to Unigy v3.0...
• If you are upgrading from Unigy v2.x to Unigy v3.0...
• If you are upgrading from Unigy v2.x to Unigy v3.0...
• If you are upgrading from Unigy v2.x to Unigy v3.0...
• If you are upgrading from Unigy v2.x to Unigy v3.0...
• If you are upgrading from Unigy v2.x to Unigy v3.0...
• If you are upgrading from Unigy v2.x to Unigy v3.0...
• If you are upgrading from Unigy v2.x to Unigy v3.0...
• Send SNMP recovery alerts prior to an upgrade Send...
• If you did not send the v2.x SNMP recovery alerts ...

191000
• For Media Gateway upgrades from Unigy v2.0.1.x to ...
• For Media Gateway upgrades from Unigy v2.0.1.x to ...

194498
• When the checkHAStatus Server State for both appli...
• Monitor the state of the appliances in the zone by...
• Confirm that both appliances are in Active Mode by...
• When the checkHAStatus Server State for both appli...
• Monitor the state of the appliances in the zone by...
• When the checkHAStatus Server State for both appli...
• Monitor the state of the appliances in the zone by...
• When the checkHAStatus Server State for both appli...
• Monitor the state of the appliances in the zone by...

195002
• If the MM(s) you rebooted are in a Virtual Machine...
• Reapply the license for an MM in a VM after a rebo...
• If the MMs that were synchronized and rebooted are...

December 3, 2019 IPC Confidential

 15

196391
• Active zone: Lines are assigned a resource zone fo...
• Activate: BCP plan activation is the process of re...
• Deactivate: Plan deactivation directs CDIs back to...
• When you activate a BCP plan, turrets and Pulse de...
• After the issues or maintenance operations that tr...
• When you deactivate a BCP plan, the system makes e...
• Click Deactivate then in the BCP Plan Deactivate C...
• BCP line redirection example This is an example of...

196489
• You can deploy the Blue Wave software in any zones...

Other
• If you are upgrading from Unigy v2.x to Unigy v3.0...

IPC Confidential Unigy 4.3

Enterprise Guide
16

December 3, 2019 IPC Confidential

 17

Preface
About this guide
The audience for this guide is IPC Service Delivery and Support personnel who are responsible for
managing and supporting a Unigy enterprise after initial deployment.
The guide provides workflows that you can use to upgrade, maintain, modify, and repair a Unigy
enterprise after initial deployment is complete and the enterprise is fully operational. For information on
deploying a new Unigy enterprise, refer to the System Installation and Deployment Guide.
Before you perform the workflows in this guide, you should be familiar with the various components of
an enterprise. For overview information, refer to Chapter 1 The Unigy enterprise in the System
Installation and Deployment Guide.

Note
The Enterprise Guide is composed of chapters and appendices. The chapters contain overview
information and the workflows that describe how to perform specific tasks. The Procedures referenced
by the workflows chapter contains supporting procedures that are referenced by the workflows. These
procedures are organized to make it easier to locate them; however, they are not intended to be
performed in the sequence in which they are listed. You should usually access these procedures only
when you are following a workflow. Organizing the information in this manner was done in response to
requests to reduce the size of the document.
The appendices provide additional information of interest.

For descriptions of the fields in the various UMS panels associated with the procedures in this guide,
refer to the UMS online help or the UMS UI Guide.

Copyright notices
• IPC, the IPC logo, Alliance MX, IQ/MAX, IQ/MAX TOUCH, MAXaccess, Nexus Suite, Unigy,
Blue Wave, and the Unigy and Blue Wave logos are trademarks of IPC Systems, Inc.
• Microsoft, Windows, Excel, Outlook, Lync, Microsoft OCS, Microsoft Office Communications
Server, Active Directory, and Internet Explorer are trademarks of Microsoft Corporation.
• Oracle, Java, and MySQL are trademarks of Oracle.
• Red Hat, Enterprise Linux, Ansible, and Ansible Tower are registered trademarks of Red Hat, Inc.
• Dell and PowerEdge are trademarks of Dell, Inc.
• Intel and Xeon are trademarks of Intel Corporation in the U.S.
• NICE and the NICE logo are trademarks of NICE Systems Ltd. and/or its subsidiaries.
• Verint is a registered trademark of Verint Systems Inc.
• Radisys is a trademark of Radisys Corporation.
• NetGuardian 832A is a trademark of DPS Telecom.
• ConferenceManager is a trademark of Sonexis Technology Inc.
• Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates.

IPC Confidential Unigy 4.3

Enterprise Guide
18 Preface

• Splunk is a registered trademark of Splunk, Inc.

• All other brand and product names used in this document are trademarks or registered trademarks of
their respective owners.

Document Conventions
This topic describes the typographic conventions used in this manual:
• To indicate a user interface item to select or click:
Click Help. The Help dialog box opens.
Style Note: This is a san-serif bold font.
• To indicate a sequence of UI clicks:
Click File ➤ New ➤ Command.
Style Note: This is a san-serif bold font.
• To indicate window, screen, or panel names:
The Help dialog box opens.
Style Note: This is an italicized font.
• To indicate text to be typed or entered for user input or command names:
Type install at the prompt and press Enter.
Style Note: This is a Fixed-Width Bold font.
Type ls -al at the prompt and press Enter.
Style Note: This is a Fixed-Width Bold font.
• To indicate variables to be typed or entered:
Type yourPassword and press Enter.
Style Note: This is a Fixed-Width Bold Italic font.
• To indicate screen text such as prompts:
At the Enter your password prompt, type your password.
Style Note: This is a Fixed-Width font.
• To indicate file and directory names:
The error.log file is stored in /var/log.
Style Note: This is a Fixed-Width font.
• For references to other documents:
Refer to the Security Administrator Guide.
Style Note: This is an italicized font.
Space Designator
When the user needs to type a space in a command, a single space is used in the command text.
Key Combinations

December 3, 2019 IPC Confidential

 Preface 19

Many instructions include key combinations where it is necessary to press two keys simultaneously. For
example, when CTRL+C is specified, it means press and hold down the Control key and press C at the
same time.

Note styles

Note
This is a Note and is used to alert you to important information.

Tip
This is a Tip and is used to provide helpful suggestions or hints.

Caution
This is a Caution and is used to alert you to any procedures in which extreme caution must be used.

Warning
This is a Warning and is used to alert you to dangerous situations or procedures that must be completed
in a specific manner to prevent a dangerous or damaging situation.

IPC Confidential Unigy 4.3

Enterprise Guide
20 Preface

December 3, 2019 IPC Confidential

 21

1 Unigy upgrade workflows

Periodically, IPC releases updates, including patches, service packs, and hot fixes, to apply software
changes that fix defects, add security updates, or add or enhance functionality. The topics in this chapter
describe updates and the procedures for deploying them to upgrade the software. The procedures apply
to upgrading from appliances that have a Unigy bridge patch to the current software version and to
patch, hotfix, and service pack deployments for the current version.

Note
Beginning with Unigy v4.0, R610 appliances are no longer supported; you must replace all R610s with
R620, R630, or R640 appliances. R640 appliances are supported only for Unigy v4.2 or higher. When
you run Network Configurator for the new appliances, use the IP addressing that is configured for the
R610 appliances they are replacing. If it is necessary to change the IP addressing, upgrade to the new
Unigy version then change the values.

Within this topic, the terms current version and current software version refer to the Unigy software
version specified on the cover of this document. References to previous Unigy versions apply to the
versions, patches, service packs, and hotfixes for these versions that the current version supports.

Important
Because of various COP changes, you cannot upgrade Unigy v1.0 zones directly to the current Unigy
software version. For these upgrades, you have the following options:
• Upgrade the software and migrate the data to a pre-Unigy v3.0 bridge version that is in the upgrade
path for the current version then upgrade from that version to the current software version. For
information on migrating Unigy v1.0 zones, refer to the Unigy v1.0 upgrade and migration
workflows topic in the Enterprise Guide for the Unigy version to which you are migrating the v1.0
zones. For example, if you are migrating from v1.0 to v2.0.1.8, refer to the latest Unigy v2.0.1.x
Enterprise Guide on the Tech Portal. For a list of the Unigy versions that are included in the upgrade
path, refer to the Unigy Product Compatibility Matrix.

After the migration is complete, refer to the upgrade topics in this document to upgrade from
the bridge version to the current version.
• By-pass the bridge upgrade and migration by deploying the current software version then rebuilding
the v1.0 database through a manual process that includes Mass Edit Client.
With both options, you must also upgrade the hardware to R620, R630, or R640 appliances. R640
appliances are supported only for Unigy v4.2 or higher.

IPC Confidential Unigy 4.3

Enterprise Guide
22

Note
Unigy offers the following upgrade options:
• Beginning with Unigy v3.0, Single Click Deployment is the preferred upgrade option for updates in a
multizone enterprise, both for updates that require new COP software and those that do not. Single
Click Deployment automates many of the upgrade steps and offers other features, such as restoring
the Enterprise database and image backup and restore. Single Click Deployment upgrades require a
Single Click Deployment appliance that can be on a VM on a host server or laptop.
• In a multizone enterprise, if a Single Click Deployment appliance is not available, after all zones have
been upgraded to Unigy v2.0.1 or higher, Enterprise Install is the recommended upgrade option for all
updates that do not require upgrading the COP software. You cannot use Enterprise Install to upgrade
pre-v3.0 zones to v3.0 or higher because Enterprise Install cannot deploy the new COP software that
is required for these upgrades. Enterprise Install also automates some of the upgrade steps, but is not
as robust or flexible as Single Click Deployment.
• In single zone enterprises and when Single Click Deployment and Enterprise Install are not available,
various manual upgrade procedures are available, some of which include COP upgrade and some that
do not.
• Beginning with Unigy v4.1, you can install operating system (OS) patches separately from the
appliance personality updates.

Review the following considerations before you upgrade:

• When you upgrade the enterprise to a new software version, any zone in the enterprise can serve as
the peer zone for the other zones being upgraded.
• If partial replication is enabled, upgrade the collector zones before you upgrade the generator zones.
The software and schema version for the collector zones must be the same or higher than the version
on the generator zones.
• If the enterprise includes any zones that have a pre-Unigy v4.1 version deployed, Blue Wave zones,
must be upgraded before Unigy zones. If all zones are at Unigy v4.1 or higher, it is not necessary to
upgrade Blue Wave zones before the Unigy zones.
• If you are upgrading from Unigy v2.0x or v2.0.1x, you must upgrade all zones at the same time or
upgrade to one of the bridge patches or hotfixes; Unigy does not support a mixed zone enterprise that
includes non-bridge version zones.
• All zones within an instance should be at the same Unigy software version, however, during
upgrades, two versions are supported within an instance. For additional details on zone
interoperability, refer to Patches, service packs, and hotfixes on page 25 and the Zone
interoperability section in the System Installation and Deployment Guide.
• If you are upgrading from a pre-Unigy v3.0 version, you must redeploy the Common Operating
Platform (COP) software with version 03.00.00.00.1272 of the COP. This is required due to operating
system and third-party software updates. It might also be necessary to reCOP for later Unigy
versions. Refer to the Unigy Product Compatibility Matrix.
• Different Unigy software and hardware versions support different COP versions; for example:
• Unigy v2.x with R610 or R620 appliances requires COP version 02.00.00.00.1888.
• Unigy v3.x, v4.0.x, and v4.1.x with R620 or R630 appliances requires COP version
03.00.00.00.1272.
• Unigy v4.2 with R620 or R630 appliances supports COP version 03.00.00.00.1272.
• Unigy v4.2 with R640 appliances requires COP version 03.00.01.00.0018.

December 3, 2019 IPC Confidential

 23

If you are upgrading to Unigy v4.2 or higher on new R640 appliances, you must deploy the version
03.00.01.00.0018 COP software to support this new hardware.
• Prior to performing an upgrade that requires deploying the COP software, perform an Enterprise
database backup then perform image backups for all zones that are being upgraded. After you create
the backups, no configuration changes should be made until after the upgrade is complete.
• When you upgrade Blue Wave zones, if a Unigy upgrade is also required, deploy the Unigy update
then deploy the Blue Wave update. For information on Blue Wave upgrades, refer to Blue Wave
upgrade workflows on page 114.
• During an upgrade that involves a database schema change, a script is called to convert the existing
data to the new schema.
• Post upgrade steps are required after an upgrade. Refer to the prerequisites in each upgrade procedure
to be sure you have all of the information and files required for these steps.
• If you are deploying a Unigy patch and applying a hotfix, deploy the patch then deploy the hotfix.
• Consider the following for Multi-tier Replication:
• To enable Multi-tier Replication, you must upgrade all zones in the enterprise to Unigy v3.0.0.2 or
higher.
• Each data center has one portal zone that serves as the preferred zone for the local zones within the
data center. Within a data center, the portal zone must be upgraded before the local zones to ensure
that the data is synchronized properly within the data center and with the other data centers in the
enterprise.
• When you are upgrading the zones in multiple data centers, the first portal zone upgraded should
be the preferred zone for at least one other portal zone to ensure that the database that the portal
zones load has the highest schema version. For example, if Zone 1 is the first portal zone to be
upgraded and Zone 10 is the next portal zone to be upgraded, Zone 1 should be the preferred zone
for Zone 10. Other portal zones can get the database from Zone 1 or Zone 10 or any other portal
zone that has the latest database schema. Plan your upgrades carefully to ensure that all upgraded
zones will have the latest database schema.
• The software version deployed on the appliances in the portal zone for the default data center and
each independent data center must be equal to or higher than the highest version deployed for the
local zones in the associated data center. The version deployed for the default data center must be
equal to the highest version deployed in the enterprise to accommodate any data center that rejoins
the default data center when Multi-tier Replication is disabled for the data center. All zones within
a data center should be upgraded to the same version as soon as possible.
• If Multi-tier Replication is enabled, it must be enabled for all data centers in the enterprise, or the
data centers must be members of the default data center, before you upgrade any of the zones.
• When you upgrade a portal zone, you must suspend the associated data center. It is not necessary
to suspend the data center if you are upgrading only the local zones.
• When you upgrade a portal zone, you can upgrade both appliances in the zone at the same time,
however, to prevent the loss of local data changes during the upgrade, consider upgrading portal
zones one appliance at a time. For local zones you can upgrade both appliances simultaneously
with Single Click Deployment, Enterprise Install, or the parallel manual upgrade procedure.
• During an upgrade, if you are restoring the Enterprise database, restore it on the primary appliance
in a portal zone to ensure that no data is lost.
For information on the specific Unigy upgrade paths supported, refer to the UpgradePaths tab in the
Unigy Product Compatibility Matrix.

IPC Confidential Unigy 4.3

Enterprise Guide
24

Caution
All upgrade procedures are service impacting; therefore upgrade zones only during non-business hours.
If the customer is a global enterprise with zones in different time zones, you can upgrade the zones in
one instance while the zones in other instances continue normal operation.

The topics in this chapter describe:

• Different types of updates.
• Unigy software build naming conventions.
• Version support.
• All the available upgrade procedures.
The upgrade procedure that you should use depends on the software version from which you are
upgrading, whether a Single Click Deployment appliance is available, whether a COP upgrade is
required, whether the enterprise has a single zone or multiple zones, and whether a workaround is
required for an upgrade procedure that is not successful. Consider the following guidelines:
• If you have access to a Single Click Deployment appliance, use Deploy a software update that does
not require a new COP with Single Click Deployment on page 60 or Deploy a software update that
requires a new COP with Single Click Deployment on page 31.
• If you are upgrading from a pre-Unigy v3.0 version to the current software version, you are deploying
a patch, service pack, or hotfix that requires new COP software, or you are upgrading from an R610,
R620, or R630 appliance to an R640 appliance and do not have access to a Single Click Deployment
appliance, use one of the following procedures:
• Deploy a software update with a new COP in a single zone enterprise – standalone or HA on page
41
• Deploy a software update with a new COP in a multizone enterprise – subset of zones on page 46
• Deploy a software update with a new COP in a multizone enterprise – all zones on page 53
• If you are upgrading multiple Unigy zones that do not require a reCOP and do not have access to a
Single Click Deployment appliance, use Deploy a software update in a multizone enterprise with
Enterprise Install on page 78.
• If you are upgrading the zone in a single zone enterprise or the upgrade you performed with Single
Click Deployment or Enterprise Install fails, use one of the manual upgrade procedures:
• Deploy a software update in a standalone zone enterprise on page 69
• Deploy a software update in a single HA zone enterprise on page 73
• Deploy a software update in a multizone enterprise with Enterprise Install on page 78
• Deploy a Unigy software update in parallel in a multizone enterprise on page 86
• Deploy a software update in a multizone enterprise one zone at a time on page 93
• If Multi-tier Replication is enabled and you are upgrading a portal zone and do not want to lose any
local zone data changes that occur while the portal zone is being upgraded, use the procedure Deploy
a software update in a multizone enterprise one zone at a time on page 93 with the option to
upgrade one appliance at a time.
• If you are installing an OS patch, use one of the following procedures:
• Install an OS patch in a single zone from the UMS – automatic install on page 131
• Install an OS patch in a single zone from the UMS - manual install on page 134

December 3, 2019 IPC Confidential

 1.1: Overview 25

• Install an OS patch in multiple zones from the UMS with OS Enterprise Install on page 137
• Install an OS patch from the UMS during trading hours on page 139
• Install an OS patch from the command line within a single maintenance window on page 142
• Install an OS patch from the command line within separate maintenance windows on page 144
After an upgrade, validate the integrity of the system. Refer to the Validation workflow on page 635.

1.1 Overview
1.1.1 Patches, service packs, and hotfixes
Unigy and Blue Wave updates are patches, service packs, or hotfixes, which correct defects, add security
updates, and enhance or add functionality.
Within this topic, the terms current version and current software version refer to the Unigy software
version specified on the cover of this document. References to previous Unigy versions apply to the
versions, patches, service packs, and hotfixes for these versions that the current version supports.
An update can include software changes for one or more of the following:
• Common Operating Platform (COP)
• Converged Communications Manager
• Media Manager
• Media Gateway
• Turret
• IQ/MAX TOUCH
• Pulse
• Unigy Soft Client
• Blue Wave Adapter
• Blue Wave Director

Package composition
Updates consist of packages, which are sets of RPMs (Red Hat Package Manager) grouped under a
common label. The list of RPMs in each package is derived from the build's manifest file. A manifest is
an XML file that defines the packages and RPMs in a build. If one RPM in a package changes, all of the
RPMs in the package are updated. Unigy includes the following packages:
• COP – Common Operating Platform RPMs, repackaged third party RPMs, and Unigy tools and
infrastructure RPMs
• AS – Converged Communications Manager software RPMs
• MS – Media Manager software RPMs
• MGW – Media Gateway software RPMs
• Turret – Turret software RPMs
• IQ/MAX Touch – IQ/MAX TOUCH software RPMs
• Pulse – Pulse software RPMs
• UDAC – Unigy Soft Client software RPMs
• BW – Blue Wave software RPMs

IPC Confidential Unigy 4.3

Enterprise Guide
26 1.1: Overview

Update ISO files

Unigy v2.0.1 and higher patches and service packs are cumulative, so you can use the appliance
personality update ISO files for new deployments and upgrades for all appliance types. Hotfix ISO files
cannot be used for new deployments.
Beginning with Unigy v4.1, you can install operating system (OS) patches separately from the appliance
personality patches or service packs. When an appliance ISO file is created, the latest OS patch is
included in the file. However, OS patches are released more frequently than the appliance personality
updates to address security and OS issues, so after you deploy an appliance update, it might be necessary
to install new OS patches periodically. The OS patches are cumulative, so it is necessary to install only
the latest version to get all of the operating system and security changes. You cannot use the OS patches
to deploy a new zone.
Patches and service packs include the code changes delivered in previous hotfixes. When you deploy a
patch or service pack, the system deletes all hotfix RPMs and replaces them with the patch or service
pack RPMs. After the hotfix RPMs are replaced, the system changes the status of the hotfix ISO file to
not_installed in the Available Software Releases panel within the Install tab at Tools ➤
Deployment ➤ Software Deployment.

In a multizone enterprise, if you delete an ISO file in the local zone (zone you are currently logged in
to), the name of the file remains in the Available Software Releases panel until it is removed from all
zones where it was uploaded. Refer to the Zone Id, Zone Name, and Status columns to determine
whether the file is uploaded or deployed in the local zone. If the zone displayed is the local zone and the
status is not_installed, the file is uploaded to the zone, but not deployed. If the status is
installed, the ISO is uploaded and deployed in the local zone. If the zone displayed for the ISO is
not the local zone, the file is not uploaded to this zone, but is uploaded and possibly deployed in at least
the zone that is displayed. It could also be uploaded or deployed in other zones, but the system displays
only one zone for each ISO file. To determine whether the ISO is uploaded or deployed in a specific
zone, log in to the zone and view the Install tab.

Software version support and zone interoperability

Within an enterprise, you cannot mix zones that have Unigy v1.0, v2.0, or any other version that is prior
to one of the supported bridge versions (currently v2.0.1.5 hotfix 8 or 9, v2.0.1.7 hotfix 1, 2, or 3, or
v2.0.1.8) with the current software version. Therefore, you must upgrade all pre-bridge version zones to
a bridge version or to the current software version for zone interoperability. This is required because the
bridge versions provide compatible database software and JGroups protocol versions that are required
by the current software version. Although Unigy supports zone interoperability with zones that have one
of the required bridge patches or hotfixes deployed, you should upgrade all zones as soon as possible to
take full advantage of the new features and to avoid potential interoperability limitations.
The OS patching feature is available only for Unigy v4.1 or higher zones. Zones within an enterprise can
interoperate with different OS patch versions, so it is not necessary to upgrade all zones at the same
time, but to ensure that the latest security updates are applied, all zones should be upgraded as soon as
possible.
To enable Multi-tier Replication, all zones in the enterprise must have Unigy v3.0.0.1 or higher
deployed. If Multi-tier Replication is enabled, the portal zones should be upgraded before any local
zones because the portal zones serve as the preferred zones for the local zones within a data center. They
also serve as the database source for the portal zones in other data centers.
For information on deploying patches, service packs, or hotfixes for versions prior to the current
software version, refer to the documentation for that version. For example, to deploy a Unigy v2.0.1.6
hotfix in the zones associated with an instance that a customer is not ready to upgrade to the current

December 3, 2019 IPC Confidential

 1.1: Overview 27

software version, refer to the Unigy v2.0.1.6 documentation, or if applicable, the hotfix release notes for
upgrade instructions.
For information on the Unigy software version naming conventions, refer to the following topics:
• Unigy software version naming convention on page 29
• OS patch naming convention on page 130

Global enterprise

Unigy supports seamless upgrades in global enterprises. A global enterprise has zones in multiple
regions, often in different time zones in different parts of the world. The regions are usually associated
with different instances, and if Multi-tier Replication is activated, different data centers within the Wide
Area Data Replication tier. The zones can have different Unigy software versions deployed. The
following operations performed for the zones within one instance have no impact on the zones in other
instances, which continue normal operation during these events:
• Deployment of new zones
• Upgrades using Enterprise Install
• Maintenance operations
• Add, modify, or remove turrets, Pulse devices, and Unigy Soft Clients
• Add, modify, or remove users
• Add, modify, or remove lines
• Add, modify, or remove trunks and Media Gateways
• Add, modify, or remove CCMs or ACCMs
• Add, modify, or remove Media Managers
• Configuration
• Activation of a BCP plan
Unigy supports different software versions as follows:
• The zones in an enterprise can include two major versions (Unigy v2.0.1 and v2.0.1.5 are considered
major versions). The versions do not have to be consecutive, but must be selected from three
consecutive versions. For example, with Version x, Version x+1, and Version x+2, zones within the
enterprise can include Version x and Version x+1, Version x and Version x+2, or Version x+1 and
Version x+2.
• Zones and devices within an instance can have two different major software versions deployed, the
new version and a bridge version, however, to ensure successful operation all zones should be
upgraded to the same version as soon as possible.
• All patch and hotfix versions within a major version are supported.
• When multiple versions are deployed, new functionality and capacities supported by the higher
version zones are not available in lower version zones. For example, if the number of active
connections or lines supported is increased in a newer version, the lower version zones cannot take
advantage of these enhancements, so the number of users or lines should not exceed those supported
by the lower version zones.
A major version is generally defined as a version that has a different database schema and for which the
entire software base is reconfigured. A patch includes updates to a subset of software components, does

IPC Confidential Unigy 4.3

Enterprise Guide
28 1.1: Overview

not include a schema change, and only the updated software components are deployed during the
upgrade.

Upgrade types
Updates can be deployed in the following ways:
• One zone at a time: This option supports upgrades for standalone and HA zones. For HA zones, it
can include deploying one appliance at a time or both appliances simultaneously. Support for
simultaneous upgrade of both appliances in a Blue Wave zone is supported for Blue Wave 2.0.1 or
higher. Blue Wave zones must be upgraded one zone at a time.
• Parallel upgrades: This option reduces the time required to upgrade the zones in a multizone
enterprise by supporting near simultaneous upgrade of all zones. It involves the upgrade of a peer
zone to ensure that there is a stable zone with the new update and database before upgrading the
remaining zones. The system upgrades both appliances in each zone simultaneously. The upgrade is a
manual procedure, but it is not necessary to wait for the upgrade of one zone to complete before
upgrading the next zone. Parallel upgrade is not available for Blue Wave zones.
• Enterprise Install: This option enables the system to automatically upgrade all zones, or a subset of
zones, in a Unigy v2.0.1 or higher enterprise after upgrading a peer zone. Enterprise Install performs
basic zone validation, places the zones, clusters, and appliances into maintenance mode, disables data
replication, deploys the update, takes the appliances, clusters, and zones out of maintenance mode,
performs post upgrade validation, and enables data replication. This option is not available for Blue
Wave zones or for upgrades that require upgrade of the COP software. After you upgrade all Unigy
zones to Unigy v2.0.1 or higher, you can use this option to deploy all subsequent updates that do not
require new COP software.
• Single Click Deployment: This option provides automated upgrades, including COP upgrades, for
one or more zones. It also provides additional features such as automated image backups and
restoring Enterprise backups. It requires a separate dedicated Single Click Deployment appliance. It is
available for upgrades to Unigy v3.0 or higher.
• OS patch: This option installs security and operating system updates on CCM, ACCM, and MM
appliances. Different upgrade options are available based on the type of enterprise and the IPC
product being upgraded.

Note
Because of the requirement to deploy new COP software for upgrades from versions prior to v3.0 to the
current software version, if you do not use Single Click Deployment, you will use one of the manual COP
upgrade procedures.

The upgrade deployment log is available from the Deployment Logs tab within the UMS at Tools ➤
Deployment ➤ Software Deployment or in Single Click Deployment.

Database upgrades
A database upgrade occurs after the new binaries are installed. There is no database backup made, but
rather, a disc rollback image is created. If the upgrade fails, restore the rollback image to return the
system to its pre-upgrade state, which includes the data that was in the database at the time of the
backup.
All data in the database prior to the upgrade persists through the upgrade. Schema changes might add
tables or columns to the database, but they do not invalidate existing data. The values for new columns
and tables that are added with an update are either blank or populated with default seed data.
Updates can upgrade the following database entities:

December 3, 2019 IPC Confidential

 1.1: Overview 29

• Data Services Client code: Used to access the database.

• Schema: Database structure.
• Seed data: Fundamental data required by all systems.

Note
Database upgrades are part of the AS (CCM) package; however, this package does not always include
database upgrades. Not every database upgrade includes updates to all three database entities.

Additional notes
• The COP ISO file includes the operating system, application server, and database. The Unigy
appliance personality software ISO can include updates for the CCM, MM, Media Gateway, turret,
Pulse, and Soft Client software. OS patches include only operating system and Red Hat security
updates.
• The system validates an update ISO file after it is uploaded to an appliance.
• Uploaded appliance personality ISO files are stored on the CCM or ACCM appliances
in /opt/ipc/deployment/iso/. The OS patch ISO files are stored in /opt/ipc/cop/
patch_iso. You should not manually copy ISO files to these directories or delete files from the
directories; instead, use the UMS for these operations.
• Media Gateway firmware updates and new or updated CAS files can also be included in a Unigy
software update. Both require a software deployment to the Media Gateway and the latter also
requires a CAS file resync.
• If a customer-specific hotfix was deployed then the customer decides to deploy a generic hotfix, it
might be necessary to roll back the customer-specific hotfix before deploying the generic hotfix.

1.1.2 Unigy software version naming convention

The Unigy product version string identifies the software version for GA releases, patches, service packs,
and hotfixes.
For information on the OS patch naming convention, refer to OS patch naming convention on page 130.
The format of the version string for GA releases, patches, and service packs is:
MM.mn.RR.PP.nnnn. Each component of the string is described below.

Table 1: Software product version string for GA releases, patches, and service packs

Abbreviation Description Size

MM Major version number 2 digits
mn Minor version number 2 digits
RR Service pack number 2 digits
PP Patch number 2 digits
nnnn Build sequence number 4 digits

For example: 02.00.00.01.0004 is version 2, patch 1, build 4. 02.00.01.00.0024 is version 2,

service pack 1, build 24.

IPC Confidential Unigy 4.3

Enterprise Guide
30 1.1: Overview

The build number for a hotfix is slightly different. The format is MM.mn.RR.PP.9.CN.HF.BN.

Table 2: Software product version string for hotfixes

Abbreviation Description Size

MM Major version number 2 digits
mn Minor version number 2 digits
RR Service pack number 2 digits
PP Patch number 2 digits
9 Hotfix marker: always 9 1 digit
CN Customer identification number: 01 indicates that the hotfix 2 digits
applies to more than one customer
HF Hotfix number 2 digits
BN Hotfix build sequence number 2 digits

For example: 02.00.00.01.9040305 is a hotfix for version 2, patch 1, customer 4, hotfix number
3, hotfix build number 5.
To view the current version for a system device, do any of the following:
• Access the UMS login page and locate Unigy Version and COP Version in the lower left corner.
• Click the About option in the UMS menu bar and locate Version and COP Version at the top of the
panel.
• Click Tools ➤ Reporting ➤ Reporting Configuration ➤ System Report ➤ SoftwareBuild ➤
SoftwareBuild_default, enter the filter and output criteria, then click Run Report. Review the
Version column.
• Click Tools ➤ Deployment ➤ Software Deployment and look for the version of the last installed
ISO file in the Version column. You can also click the Deploy tab to view the version deployed on
each system device.
• On turrets, access the Admin menu then press System Info ➤ Station ➤ Software View.
• On Pulse devices, access the Admin menu. The Software Version is within the View tab.
• For Unigy Soft Clients:
• Within the Soft Client Main window, click the help icon (?) in the toolbar then click About. Refer
to the Version property.
• Locate the unigyClient version entry in the udac.log file within c:\Program
Files\IPC Systems Inc\logs\ on the client computer.
• From the Microsoft Windows Start menu, click Control Panel ➤ Programs ➤ Uninstall a
Program (Windows 7) or Control Panel ➤ Add or Remove Programs(Windows XP). Within the
list of programs, click Unigy(TM)Client. In Windows 7, the version is displayed at the bottom of
the window. In Windows XP, click Click here for support information then within the Support
Info dialog box, locate the Version property.

December 3, 2019 IPC Confidential

 1.2: Upgrades that require new COP software 31

1.2 Upgrades that require new COP software

1.2.1 Deploy a software update that requires a new COP with Single Click Deployment
Single Click Deployment (SCD) automates many of the steps required to upgrade the Unigy software on
Converged Communications Manager (CCM), Aggregated Converged Communications Manager
(ACCM), and Media Manager (MM) appliances. This topic describes how to upgrade appliances that
require new COP software.
For information on upgrading appliances that do not need new COP software, refer to Deploy a software
update that does not require a new COP with Single Click Deployment on page 60.
For overview information on Single Click Deployment, refer to Single Click Deployment (SCD) on page
149.

Note
To avoid possible version compatibility issues, always use the latest available SCD version (v4.x or
higher) for the upgrade.

Note
If the enterprise includes Blue Wave zones and any zones in the enterprise have a pre-Unigy v4.1
version deployed, upgrade the Blue Wave zones before you upgrade any Unigy zones. If all zones are at
Unigy v4.1 or higher, it is not necessary to upgrade the Blue Wave zones before the Unigy zones.
For information on upgrading Blue Wave zones, refer to Blue Wave upgrade workflows on page 114.

This upgrade procedure requires access to a Single Click Deployment appliance. If you do not have a
virtual SCD appliance deployed on your laptop or do not have access to an SCD appliance on a host
server or an appliance at the customer site, refer to one of the following manual upgrade procedures:
• Deploy a software update with a new COP in a single zone enterprise – standalone or HA on page
41
• Deploy a software update with a new COP in a multizone enterprise – subset of zones on page 46
• Deploy a software update with a new COP in a multizone enterprise – all zones on page 53
For information on the specific Unigy upgrade paths supported, refer to the UpgradePaths tab in the
Unigy Product Compatibility Matrix.
For additional information related to updates, refer to Unigy upgrade workflows on page 21, Patches,
service packs, and hotfixes on page 25, and Unigy software version naming convention on page 29.
Prerequisites:
Upgrades to Unigy v3.0 or higher from pre-v3.0 versions include operating system and third-party
software updates that require redeployment of the COP software on each appliance that is being
upgraded. First time deployment of software on R640 appliances requires a new COP.

Important
When new COP software is deployed, all existing software and data are removed from the appliances
you upgrade, therefore, you should perform an Enterprise backup and create an image backup for every
appliance you are upgrading before performing the upgrade.

If Multi-tier Replication is enabled, it must be enabled for all data centers in the enterprise, or the data
centers must be members of the default data center, before you upgrade any of the zones. When you
upgrade the zones, upgrade the portal zones before the local zones because the portal zone serves as the

IPC Confidential Unigy 4.3

Enterprise Guide
32 1.2: Upgrades that require new COP software

preferred zone for the local zones within a data center. To upgrade a portal zone, you must suspend
Multi-tier Replication for the associated data center. To avoid data loss when you upgrade a portal zone,
consider upgrading one appliance in the zone at a time so the zone remains active and available to
collect local zone data changes throughout the upgrade. For information on this upgrade procedure, refer
to Deploy a software update in a multizone enterprise one zone at a time on page 93. If you are
restoring an Enterprise database backup during the upgrade, restore the database to a portal zone. After
you upgrade the portal zone, resume Multi-tier Replication before you upgrade the Local zones. For
additional information on Multi-tier Replication, refer to Multi-tier Replication on page 229.
To help ensure the success of an upgrade in a multizone enterprise, it is important that you design an
upgrade plan that includes at least the following information:

Item Notes
Type of zones. If partial replication is enabled, collector zones must be upgraded
before generator zones.
If Multi-tier Replication is enabled, portal zones must be upgraded
before local zones.
If the enterprise includes any zones that have a pre-Unigy v4.1
version deployed, Blue Wave zones must be upgraded before Unigy
zones. If all zones are at Unigy v4.1 or higher, it is not necessary to
upgrade the Blue Wave zones before the Unigy zones.
Zones that will be upgraded and The pre and post upgrade steps can be different when upgrading
their current software version. from different software versions.
When each zone will be Will all zones be upgraded at the same time or staggered over time?
upgraded. If a subset of pre-v3.0 zones will be upgraded, all zones must be
upgraded to one of the supported bridge patches or hotfixes before
any of the zones are upgraded to Unigy v3.0 or higher to ensure that
they have the correct JGroups protocol version (MERGE3,
NAKACK2, FD_ALL, and UNICAST3).
If all zones in the enterprise are This is the zone that will be the first zone to be upgraded. The
being upgraded within the same Enterprise database backup will be restored to the primary appliance
maintenance window, determine in the zone. It will then serve as the preferred zone for one or more of
the zone that will serve as the the other zones being upgraded.
Source Zone for restoring the
Enterprise database backup.

December 3, 2019 IPC Confidential

 1.2: Upgrades that require new COP software 33

Item Notes
The preferred zone for each In a multizone enterprise, each zone should have a preferred zone
zone. from which it loads the database during an upgrade. A zone that is
being upgraded should always get its database from a zone that has
the latest software version deployed. A zone can provide the
database for up to two other zones simultaneously. To provide the
greatest efficiency and to avoid potential issues, do not assign the
same zone as the preferred zone for more than three zones. As soon
as a zone has loaded the database, it can serve as a source zone for
other zones. If you do not specify a preferred zone, the system uses
the zone selection algorithm (Database source zone selection
algorithms for database dumps on page 615).
If zones in different data centers are being upgraded within the same
maintenance window, the preferred zone for the first zone to be
upgraded in each data center (other than the first) should be a zone
in a data center that has been upgraded. After the first zone in each
data center is upgraded, the other zones in the data center should
get the database from a zone within the same data center to reduce
the data transmitted between data centers over the WAN. For
example, assume that you are upgrading the zones in two data
centers, each of which has five zones. Zones 1 through 5 are in data
center 1 and Zones 6 through 10 are in data center 2. Assign Zone 1
as the preferred zone for Zones 2 and 3 and assign Zone 2 as the
preferred zone for Zones 4 and 5. Assign Zone 3 as the preferred
zone for Zone 6, assign Zone 6 as the preferred zone for Zone 7 and
Zone 8, and assign Zone 7 or Zone 8 as the preferred zone for Zone
9 and Zone 10.
For post v3.0.0.1 upgrades, if Multi-tier Replication is enabled, the
preferred zone for the portal zones should be another portal zone,
preferably the one in the closest data center, and it should have the
latest version of the software deployed.
Number of Single Click You can use a single Single Click Deployment appliance to upgrade
Deployment appliances that will all of the zones in the enterprise, even if they are in different data
be used. centers distributed across the globe; however, for greater efficiency
and reduced bandwidth contention in large distributed enterprises, it
might be better to have multiple Single Click Deployment appliances
or to stagger the upgrades so the appliance can be moved to each
data center.
If you are upgrading zones in multiple data centers and a Single Click
Deployment appliance is available for each data center, consider
starting the upgrades in one data center then waiting for the upgrade
of at least some of the zones in the first data center to complete
before starting the upgrades in the next data center. This enables you
to use a zone in the first data center as the database source for
zones in the next data center while reducing the time required to
complete the upgrades by not placing a heavy load on a single Single
Click Deployment appliance.

IPC Confidential Unigy 4.3

Enterprise Guide
34 1.2: Upgrades that require new COP software

Item Notes
Whether a Dependency VIP is A Dependency VIP provides a way to ensure that the database is
required. loaded from a specific zone when the zone VIP is available and the
source zone is fully operational. This is useful if you are upgrading
zones in different data centers and want to be sure the preferred
zone for a zone is available before it requests a database dump. In
the preferred zone example above, you might want to set Zone 3 as
the Dependency VIP for Zone 6.
Whether it is necessary to If you are upgrading all zones in multiple data centers within the
disable data replication for some same maintenance window and the JGroups protocols in the zones
of the zones. were not updated with a previous bridge patch or hotfix, it might be
advisable to disable data replication in some of the zones to prevent
JGroups protocol mismatch issues if a zone that has not been
upgraded attempts to load the database from a zone that has been
upgraded.
For example, using the preferred zones example above, it would
make sense to disable replication in Zones 6 through 10 if you are
upgrading the zones in data center 2 using a different Single Click
Deployment appliance and are delaying the upgrade of the zones in
data center 2 to ensure that Zone 3 is available.
Disabling data replication prevents a zone from loading the database
from another zone. Single Click Deployment will reenable data
replication during the upgrade so the zones can load the database
after they are upgraded.

Before you perform this procedure, confirm the following:

• You reviewed the Unigy upgrade workflows and Patches, service packs, and hotfixes topics and
the Unigy Product Compatibility Matrix (if you are viewing this topic from the Single Click
Deployment or UMS online help, refer to the Enterprise Guide for this information).
• Unigy upgrade workflows on page 21
• Patches, service packs, and hotfixes on page 25
• Unigy Product Compatibility Matrix
• The Single Click Deployment appliance is installed, deployed, configured, enabled, and available on
the network. If the customer allows use of their SMTP system for sending Single Click Deployment
notifications, this should include configuration of the connection to the SMTP server. Refer to
Configure SMTP for Single Click Deployment notifications on page 163.
• Confirm that the following software .iso files are available on the Single Click Deployment
appliance by performing the procedure Display available artifacts on page 165. If they are not
available, contact IPC Manufacturing.
• COP software:
• Unigy v4.2 COP (build 03.00.01.00.0018). This COP is required for R640 appliances for Unigy
v4.2 or higher.
• Unigy v3.0 COP (build 03.00.00.00.1272). This COP is required only if it is necessary to roll
back the upgrade on an R620 or R630 appliance to a pre-v4.2 version if an issue is encountered
with the upgrade.
• Unigy v2.0 COP (build 02.00.00.00.1888). This COP is required only if it is necessary to roll
back the upgrade to a pre-v3.0 version if an issue is encountered with the upgrade.

December 3, 2019 IPC Confidential

 1.2: Upgrades that require new COP software 35

• New appliance personality software file.

• For Unigy v4.1 or higher, if an OS (operating system) patch that is more recent than the OS version
included in the appliance personality ISO file you are deploying is available and you want to deploy
this patch after the appliance upgrade is complete, you have access to the patch ISO file. You can get
the file from the IPC FTP site, FilesAnywhere. It can be burned to a DVD or copied to your laptop or
an external data storage device.
• You have the following network configuration values for each zone you are upgrading. For
information on these values and a table for recording them, refer to Information to collect prior to
running Network Configurator or performing an upgrade on page 462 and Network configuration
properties worksheet on page 464.
• Values that were entered in Network Configurator for each CCM, ACCM, and MM appliance
during initial deployment, or if these values were changed after deployment, the current values.
• VIP Address, ACCM/CCM1 Server IP Address, ACCM/CCM2 Server IP Address, and
Backroom Location field values. The Backroom Location field is not available for pre-v3.0
zones, so if you are upgrading from a pre-v3.0 version, you will configure this field after the
upgrade.
• Zone ID assigned when each zone was deployed with Zone Deployer, or if the ID was changed
after initial deployment, the current value. You will reuse the zone IDs during the upgrade, and if
you are upgrading from a Unigy version prior to v2.0.1.6, you will also need this information to
populate the prototype devices in each zone with the updateMyPrototype.sh script
following the upgrade.
• If the update requires a new enterprise license, you have the new license file for the customer.
• You have the SMTP configuration values for the enterprise. These are available at Configuration ➤
Enterprise ➤ SMTP. This data is not saved in the database, so it will be replaced with default values
during the upgrade. You will reconfigure SMTP after the upgrade. Record the values in the table in
SMTP configuration properties on page 564.
• If you are upgrading from a Unigy version prior to v2.0.1.7 and the
updateToneCadensceFreqForExistingInstances.sh script was not run for that
version, obtain the instance ID for the instance associated with each zone you are upgrading. To
obtain this information, identify the instance assigned to each zone at Configuration ➤
Enterprise ➤ System ➤ Zones, then run the command mysql -udatabase_username -
pdatabase_password dunkin -e "select id, name from Instance";
where:
• database_username is the user name for accessing the Unigy database.
• database_password is the password for the database user account.
• You have access to the document Post-Maintenance Validation Test Suite, which is available on the
Tech Portal. This document provides a set of procedures you should perform to determine whether a
zone is in a healthy state before and after you upgrade the zone.
• The appliances on which you are deploying the current version software have at least 48 GB of
memory.
If you are deploying the new software on new appliances that are replacing older version appliances,
you will shut down the old appliances and disconnect them from the network so they do not attempt to
register with the zones when they are deployed. Retain the old appliances in case it is necessary to roll
back the update. If a rollback is necessary, disconnect the new appliances and reconnect the old
appliances.

IPC Confidential Unigy 4.3

Enterprise Guide
36 1.2: Upgrades that require new COP software

Tip
It is a best practice to make a note of the customer's dial patterns, route plans, recording profiles, and
scheduled backups before performing this procedure and to verify that they are the same in the upgraded
enterprise when the procedure is complete. If an enterprise backup is restored during the upgrade,
scheduled backups will need to be reconfigured if the date of the next scheduled event is before the date
the backup was restored. This is because the currently scheduled job will not run because the date is in
the past. For recurring jobs, this prevents the next occurrence from being scheduled.

Single Click Deployment provides a great deal of flexibility based on the options you select for the plan;
for example, you can deploy just the COP software or fully deploy one or more zones, including
restoring an Enterprise backup.

Note
Upgrades are service impacting, so perform them only during a maintenance window when the zones
being deployed are not required to process calls or configuration requests.

1. Log in to the UMS in each zone you are upgrading.

2. Determine the state of the zone by performing the procedures in the Post-Maintenance Validation Test
Suite. If you do not have access to this document, perform the procedure Validate a zone before an
upgrade, rollback, or other operations on page 636.
If a zone is not in a healthy state or there is not sufficient disk space available, resolve the issues
before you perform the upgrade, unless the upgrade is required to resolve the issues.
3. If the zone you are upgrading is a Multi-tier Replication portal zone, place the associated data center
into the suspended state by performing the procedure Suspend or resume Multi-tier Replication on
page 247.
4. If you are upgrading from Unigy v2.x to Unigy v3.0 or higher, perform the procedure Send SNMP
recovery alerts prior to an upgrade on page 564.
5. Disable SNMP Forwarding for each zone you are upgrading by performing the procedure Disable
SNMP forwarding for a zone on page 596.
6. If the enterprise includes Media Gateways, backup the .ini file from each one by performing the
procedure Download a Media Gateway INI file on page 585.
7. If the appliances you are upgrading are not registered with the Single Click Deployment appliance,
perform the procedure Register a Unigy appliance with a Single Click Deployment appliance on page
160.
If you are performing a partial upgrade, be sure that the zone that will provide the database for the
zones being upgraded is also registered with the Single Click Deployment appliance.
8. Log in to Single Click Deployment with the user account assigned to the appliances you are
upgrading: https://scd_ip/svc/oneclick/, where scd_ip is the IP address of the Single
Click Deployment appliance.
9. Within Single Click Deployment, confirm that the configuration for each appliance you are upgrading
is correct:
a) In the Main Menu, click Enterprise Servers Plan.
b) Confirm that all of the appliances you registered with the SCD appliance are in the Select Servers
list.
If any appliances are missing, rerun step 7 for those appliances.

December 3, 2019 IPC Confidential

 1.2: Upgrades that require new COP software 37

c) For each appliance you are upgrading, select the check box in the Select column.
d) Click Next.
e) For each appliance, click the Advance button and confirm that all of the values with the yellow
background are correct.
These values are pulled from each appliance when they register with the Single Click Deployment
appliance.

Important
In general, you should not change any of these values unless instructed to do so by IPC Support or
Development. However, if the upgrade plan you designed includes a requirement to wait for a
specific zone to be up before attempting to take a database dump from the zone, you might have to
set the Dependency VIP. If there is no specific requirement for the Dependency VIP, leave it blank.

The Instance ID does not represent the instance ID in the Unigy database, so if it is not correct,
you can leave it at 1 and the system will handle it properly.
10. Within the UMS, create an Enterprise database backup from a zone with the highest database schema
and download the backup file to an external data storage device that is accessible from the Single
Click Deployment appliance by performing the procedures Create or schedule a new backup on page
363 and Download a backup file on page 607.
This step is required only if you are upgrading the appliances in a single zone enterprise or you are
upgrading all zones in a multizone enterprise at the same time, however, it is recommended for all
upgrades to ensure that a backup is available if it is needed.
If partial replication is enabled, the source zone for the backup should be a collector zone. For post
v3.0.0.1 upgrades, if Multi-tier Replication is enabled, the source zone should be a portal zone,
preferably one that is also a collector zone.
11. If you are upgrading a standalone zone or all of the zones in the enterprise at the same time, upload
the Enterprise backup file you created in the previous step by performing the procedure Import an
Enterprise backup file to a Single Click Deployment appliance on page 166.
12. Within Single Click Deployment, create an image backup of each appliance you are upgrading by
performing the procedure Create an image backup (restore point) with Single Click Deployment on
page 165.
Use the External Backup option. The backup file will be stored on the appliance and on the Single
Click Deployment appliance.
To reduce the size of the image backup files and the time required to transfer the files to the Single
Click Deployment appliance, you can run Archive all Zone backups prior to using the External
Backup option to purge most of the history data.
13. If you are upgrading all zones in the enterprise at the same time, the zones were not previously
upgraded to a bridge patch or hotfix to update the JGroups protocols, and your upgrade plan calls for
disabling data replication for some of the zones to prevent potential JGroups protocol mismatches,
perform the procedure Disable data replication on page 498 for each applicable zone.
14. Within Single Click Deployment, configure and validate the Single Click Deployment upgrade plan
for all appliances that are being upgraded:
a) In the Main Menu, click Enterprise Servers Plan.
b) In the Select column, select the check box for all of the appliances you are upgrading then click
Next.
c) In the Task column, select Recop.

IPC Confidential Unigy 4.3

Enterprise Guide
38 1.2: Upgrades that require new COP software

d) In the COP ISO column, select the COP software version.

e) In the Personality column, select the appliance personality type, CCM, ACCM, or MM.
f) In the Server Type column select HA for appliances in an HA zone or Standalone for the
appliance in a standalone zone or for an MM.
g) In the Install App ISO column, select the check box and the appropriate software version for each
appliance.
If all zones in the plan are being upgraded, select the check box at the top of the column then select
the version. This selects the check box and populates the version for all of the appliances.
h) In the Zone Deploy & Data Source column, select the check box for the CCM or ACCM
appliances and type the VIP of the peer zone that provides the customer digital certificates,
certificate keys, and database dump.
For MMs, do not select the check box, but the Data Source text box should contain the same peer
zone value as the associated zone's CCM or ACCM appliances.
i) If you are upgrading the appliances in a single zone enterprise or you are upgrading all zones in a
multizone enterprise at the same time, in the Enterprise DB Restore column, select the check box
then select the Enterprise backup file Single Click Deployment will restore.
Assign this file to the primary appliance in the zone you selected as the Data Source in the
previous step.
For post v3.0.0.1 upgrades, if Multi-tier Replication is enabled for the enterprise, the appliance you
restore the database to must be the primary appliance in an active portal zone.
If you are upgrading a subset of zones, it is not necessary to restore the Enterprise backup because
the zones being upgraded can load the database from another zone.
j) To assign a preferred zone for a zone, in the Preferred Zone column, select the check box for each
appliance in the zone and type the preferred zone's VIP. Single Click Deployment populates the
Preferred Zone field in the UMS zone configuration. If you do not specify a value, no preferred
zone is assigned and the system uses the zone selection algorithm to select a zone. The preferred
zone is the zone that provides the database dump if the zone is available.
k) Click Save to save the plan.

Important
Do not select the check boxes in the Active column before saving at this point. If you select these
check boxes then click Save, Single Click Deployment starts the upgrade before you have an
opportunity to validate the upgrade plan.

l) Click View Map to confirm that the plan configuration is valid.

If Single Click Deployment displays any error messages, resolve the issues then click View Map
again.
15. Initiate and monitor the upgrade:
a) In the Active column, select the check box for all of the appliances you are upgrading.
This informs Single Click Deployment to run the upgrade for the selected appliances when you
click Save. If you do not want to initiate the upgrade for some of the appliances at this time, clear
this check box for those appliances.
b) Click Save to save the plan, and for all appliances for which you selected the Active check box, to
execute the deployment plan.

December 3, 2019 IPC Confidential

 1.2: Upgrades that require new COP software 39

The upgrade begins. Single Click Deployment displays the progress, and if the SMTP server
connection is configured, begins to send progress e-mail messages every thirty minutes to the e-
mail addresses specified in the Single Click Deployment SMTP configuration.
c) Click Monitor to monitor the progress of the deployment for each appliance.
The progress is displayed in the Deployment Status column; it is updated every two minutes. To
display details for the current process, click the process hyperlink, the last 40 lines of the agent log
are displayed. To display the time remaining to complete the upgrade, mouse over the running
process in the Deployment Status column.
The deployment is complete when the progress for all appliances is 100% and the status is
agent-hold.
16. Check the status of all the zones you upgraded by performing the procedure Check the state of a zone
from a browser on page 499.
17. If you suspended Multi-tier Replication in step 3, resume it by performing the procedure Suspend or
resume Multi-tier Replication on page 247.
18. Perform the post upgrade procedures.

1.2.1.1 Post upgrade procedures

Perform the steps in this topic after you upgrade Unigy appliances with Single Click Deployment.
1. Reboot all Media Managers that were upgraded by performing the procedure Run Reboot Media
Manager on page 588.
2. If the current software version requires a new enterprise license, install the license you obtained as
part of the prerequisites by performing the procedure Install an enterprise license file on page 481.
3. Perform the following substeps for each zone you are upgrading:
a) Deploy the updated software on the remaining devices in the zone, including Media Managers,
Media Gateways, turrets, Pulse devices, and Soft Clients by performing the procedure Upgrade the
software on system devices on page 558.
b) Upgrade the Unigy Soft Client software on the client computers by performing one of the
following procedures:
• Upgrade the Unigy Soft Client software – Microsoft Windows 32-bit on page 630
• Upgrade the Unigy Soft Client software – Microsoft Windows 64-bit on page 628
This step applies only to enterprises that use the Unigy Soft Client. If necessary, it can be
performed at a later time.
c) If necessary, change the zone's Preferred Zone to point to a different zone at Configuration ➤
Enterprise ➤ System ➤ Zones.
If you specified the preferred zone in Single Click Deployment, it should not be necessary perform
this step unless you want to point to a zone that is more appropriate for zone restarts.
d) If the upgrade was from a pre-Unigy v3.0 zone or a new zone was added, confirm or configure the
following:
1. If the Name for each address is blank or not appropriate, or an address does not exist, configure
the address at Configuration ➤ Enterprise ➤ System ➤ Addresses.
2. Confirm that the appropriate address is assigned to each location. If it is not, assign the address
at Configuration ➤ Enterprise ➤ System ➤ Locations.
3. Confirm that the correct Backroom Location is assigned to each zone. If it is not, assign the
location at Configuration ➤ Enterprise ➤ System ➤ Zones.

IPC Confidential Unigy 4.3

Enterprise Guide
40 1.2: Upgrades that require new COP software

e) If the upgrade was from a pre-Unigy v2.0.1.6 version, perform the procedure Update prototype
devices after an upgrade on page 566.
f) Reconfigure the SMTP properties with the values you recorded in the prerequisites by performing
the procedure Configure an SMTP server on page 563.
g) If secure communications is enabled for third-party devices, such as PBXs, voice recorders, or
Session Border Controllers, and a self-signed certificate is used to secure the connections, perform
the procedure Upload a self-signed third-party certificate for secure communications on page 269.
h) Confirm that the dial patterns, route plans, recording profiles, and scheduled backups that were
configured in the previous version are present and correct.
If the next run date for a scheduled backup job is in the past, delete the scheduled backup then
recreate it because subsequent scheduled jobs will not run.
4. If the data source that provided the database dump during the upgrade was a pre-Unigy v3.0 zone in
which the updateToneCadenceFreqForExistingInstances.sh script was not run during
a previous upgrade, run the updateToneCadenceFreqForExistingInstances.sh script
to copy the Tone Cadence Frequency settings from a zone in the default instance to the zones in all
other instances by performing the procedure Run the
updateToneCadenceFreqForExistingInstances.sh script on page 567.
5. Enable SNMP Forwarding for the zones you upgraded by performing the procedure Reenable SNMP
forwarding for a zone on page 596.
6. Validate each zone you upgraded by performing the procedures in the Post-Maintenance Validation
Test Suite. If you do not have access to this document, perform the procedure Validate a zone after a
deployment, rollback, or other operations on page 638.
7. Unregister the Unigy appliances from the Single Click Deployment appliance by performing the
procedure Unregister a Unigy appliance from a Single Click Deployment appliance on page 162.
8. Within the UMS, create an Enterprise database backup from a zone with the highest database schema
and download the backup file to an external data storage device by performing the procedures Create
or schedule a new backup on page 363 and Download a backup file on page 607.
9. If a recurring Archive all Zone backup job and backup file retention policy are not configured for at
least one zone in each realm in the enterprise, perform the procedure Configure a recurring archive
backup job and retention policy on page 612.
This helps to prevent out of memory issues due to high volumes of call history data. If partial
replication is enabled, the zone must be a collector zone.
10. If applicable, do one or more of the following:
• If an OS patch that is more recent than the OS patch included in the appliance personality ISO file
you deployed is available and you want to install the newer OS patch, perform the procedure
Install an OS patch in multiple zones from the UMS with OS Enterprise Install on page 137
• Enable partial replication by performing the procedure Enable partial replication on page 316.
This applies only to customers who use partial replication to reduce the volume of data that is
replicated throughout the enterprise. If the customer is not using partial replication or it is already
enabled, it is not necessary to perform this task.
• If you upgraded to Unigy v3.0.0.1 or higher, enable Multi-tier Replication to further reduce the
volume of data replicated, improve WAN resiliency, and increase scalability by performing the
procedure Enable Multi-tier Replication on page 243. If the customer is not using Multi-tier
Replication or it is already enabled, it is not necessary to perform this task.
• If you are implementing the System Logging and Information Collector (SLIC) feature to forward
customer log data to a data analytics engine such as Splunk, refer to the System Logging and

December 3, 2019 IPC Confidential

 1.2: Upgrades that require new COP software 41

Information Collector Service Installation and Administration Guide. If the customer is not using
this feature or it is already implemented, it is not necessary to perform this task.
• Install and configure the Compliance Policy Engine to control access to lines and users. For
information on these procedures, refer to the Compliance Policy Engine Installation Guide and
Compliance Policy Engine Administration Guide. If the customer has not purchased the
Compliance Policy Engine or it is already installed, it is not necessary to perform this task.

1.2.2 Deploy a software update with a new COP in a single zone enterprise – standalone or
HA
This topic describes how to deploy a software update, that requires upgrading the Common Operating
Platform (COP) software, in a single zone enterprise. It applies to any update (except v1.0 upgrades) that
requires new COP software.

Note
Use this procedure only if a Single Click Deployment appliance is not available. For information on Single
Click Deployment, refer to Single Click Deployment (SCD) on page 149 and Deploy a software update
that requires a new COP with Single Click Deployment on page 31.

Important
Perform this procedure only if a COP upgrade is required.
When the COP software is deployed, all existing software and data is removed, therefore, you should
perform enterprise and image backups before performing the upgrade.

This topic applies to upgrading the ACCM in a standalone enterprise and the CCMs and MMs or
ACCMs in a single HA zone enterprise.
For single zone upgrades that do not require a new COP, refer to the following procedures:
• Deploy a software update in a standalone zone enterprise on page 69
• Deploy a software update in a single HA zone enterprise on page 73
For information on upgrading zones that require a COP upgrade in a multizone enterprise, refer to the
following procedures:
• Deploy a software update with a new COP in a multizone enterprise – subset of zones on page 46
For information on the specific Unigy upgrade paths supported, refer to the UpgradePaths tab in the
Unigy Product Compatibility Matrix.
For additional information related to updates, refer to Unigy upgrade workflows on page 21, Patches,
service packs, and hotfixes on page 25, and Unigy software version naming convention on page 29.
Within this topic, the terms current version and current software version refer to the Unigy software
version specified on the cover of this document. References to previous Unigy versions apply to the
versions, patches, service packs, and hotfixes for these versions that the current version supports.
Prerequisites:
Before you perform this procedure, confirm the following:
• You reviewed the following information:
• Unigy upgrade workflows on page 21
• Patches, service packs, and hotfixes on page 25

IPC Confidential Unigy 4.3

Enterprise Guide
42 1.2: Upgrades that require new COP software

• Unigy Product Compatibility Matrix

• You have the following COP software DVDs:
• Unigy v4.2 COP (build 03.00.01.00.0018). This COP is required for R640 appliances for Unigy
v4.2 or higher.
• Unigy v3.0 COP (build 03.00.00.00.1272). This COP is required only if it is necessary to roll back
the upgrade on an R620 or R630 appliance to a pre-v4.2 version if an issue is encountered with the
upgrade.
• Unigy v2.0 COP (build 02.00.00.00.1888). This COP is required only if it is necessary to roll back
the upgrade to a pre-v3.0 version if an issue is encountered with the upgrade.
• You have the new appliance personality software update ISO file. Updates are generally delivered on
a DVD, but might also be available on a network drive or other external data storage device.

Note
The ISO files for new versions, patches, and service packs are over 2.0 GBs in size, so if low band
width or slow file transfer rates caused by other factors is an issue, do one or both of the following to
ensure that a copy of the ISO file is available for upload or download prior to performing the upgrade:
• If you will be at the customer site, be sure the DVD is available or copy the ISO file to your laptop or
a flash drive.
• Copy the ISO file to a customer or IPC server from which you can download it to one of the Unigy
appliances. Perform the copy before you start the upgrade because it might take an hour or more to
complete.

• For Unigy v4.1 or higher, if an OS (operating system) patch that is more recent than the OS version
included in the appliance personality ISO file you are deploying is available and you want to deploy
this patch after the appliance upgrade is complete, you have access to the patch ISO file. You can get
the file from the IPC FTP site, FilesAnywhere. It can be burned to a DVD or copied to your laptop or
an external data storage device.
• You have the following network configuration values for the zone you are upgrading. For information
on these values and a table for recording them, refer to Information to collect prior to running
Network Configurator or performing an upgrade on page 462 and Network configuration properties
worksheet on page 464.
• Values that were entered in Network Configurator for each CCM, MM, or ACCM appliance during
initial deployment, or if these values were changed after deployment, the current values.
• VIP Address, ACCM/CCM1 Server IP Address, ACCM/CCM2 Server IP Address, and
Backroom Location field values. The Backroom Location field is not available for pre-v3.0
zones, so if you are upgrading from a pre-v3.0 version, you will configure this field after the
upgrade.
• Zone ID assigned when the zone was deployed with Zone Deployer, or if the ID was changed after
initial deployment, the current value. You will reuse the zone IDs during the upgrade.
• If the update requires a new enterprise license, you have the new license file for the customer.
• You have the SMTP configuration values for the enterprise. These are available at Configuration ➤
Enterprise ➤ SMTP. This data is not saved in the database, so it will be replaced with default values
during the upgrade. You will reconfigure SMTP after the upgrade. Record the values in the table in
SMTP configuration properties on page 564.

December 3, 2019 IPC Confidential

 1.2: Upgrades that require new COP software 43

• You have access to the document Post-Maintenance Validation Test Suite, which is available on the
Tech Portal. This document provides a set of procedures you should perform to determine whether a
zone is in a healthy state before and after you upgrade the zone.
• The appliances on which you are deploying the update have at least 48 GB of memory.
If you are deploying the new software on new appliances that are replacing older version appliances,
you will shut down the old appliances and disconnect them from the network so they do not attempt to
register with the zones when they are deployed. Retain the old appliances in case it is necessary to roll
back the update. If a rollback is necessary, disconnect the new appliances and reconnect the old
appliances.

Tip
It is a best practice to make a note of the customer's dial patterns, route plans, recording profiles, and
scheduled backups before performing this procedure and to verify that they are the same in the upgraded
enterprise when the procedure is complete. If an enterprise backup is restored during the upgrade,
scheduled backups will need to be reconfigured if the date of the next scheduled event is before the date
the backup was restored. This is because the currently scheduled job will not run because the date is in
the past. For recurring jobs, this prevents the next occurrence from being scheduled.

Caution
An update is service-impacting when the COP software is upgraded, the system creates a rollback point
or reboots an appliance, or the update contains changes to the Media Gateways, turrets, Pulse devices,
or Soft Clients that require a reboot after the software is deployed. Review the Impacted RPMs tab within
the Software Deployment Install tab to determine the impacts of the update.
All upgrades should be performed only during a maintenance window when the zones being deployed
are not required to process calls or configuration requests.

This procedure requires a user account with the IPC Certified Tech role assigned.
1. Log in to the UMS.
2. Determine the state of the zone by performing the procedures in the Post-Maintenance Validation Test
Suite. If you do not have access to this document, perform the procedure Validate a zone before an
upgrade, rollback, or other operations on page 636.
If a zone is not in a healthy state or there is not sufficient disk space available, resolve the issues
before you perform the upgrade, unless the upgrade is required to resolve the issues.
3. Remove from the database any devices that are no longer required, including older version appliances
that are no longer supported, by performing the procedure Remove hardware from the database on
page 359.
4. If the enterprise includes Media Gateway, backup the .ini file from each Media Gateway by
performing the procedure Download a Media Gateway INI file on page 585.
5. If you are upgrading from Unigy v2.x to Unigy v3.0 or higher, perform the procedure Send SNMP
recovery alerts prior to an upgrade on page 564.
6. To prevent the forwarding of alerts during the upgrade process, perform the procedure Disable SNMP
forwarding for a zone on page 596.
7. To prevent new hardware from registering with the zone during the upgrade, disable device
registration by performing the procedure Disable device registration on page 497.
8. Schedule an Enterprise backup by performing the procedure Create or schedule a new backup on
page 363.

IPC Confidential Unigy 4.3

Enterprise Guide
44 1.2: Upgrades that require new COP software

9. Download the enterprise backup file to an external data storage device by performing the procedure
Download a backup file on page 607.
Record the name and location of the backup file so it is available when you restore the data after you
redeploy the appliance(s).
10. Back up the appliance disk image to create a restore point and copy the compressed image file to a
remote data storage device by performing the procedure Create an image backup (restore point) from
the UMS on page 385.
In an HA zone, create a restore point for both appliances.

Note
The backup directory can be quite large if it contains multiple image backup files. This can require
large amounts of disk space and long transfer times. To reduce the amount of data transferred, you
can move, archive, or delete older image backup directories, identified by the date and time in the
backup directory name, and retain only the most recent directory. Confirm that the directory does not
exceed the available disk space of the storage device to which you are copying it by running the
command du -hc /var/spool/backup, which displays the disk space used.
If you remove the older directories, the system continues to display the deleted image file names
within the UMS on the Rollback tab at Tools ➤ Deployment ➤ Software Deployment, but the files will
not be available for recovery.

11. If you are deploying the new software on new appliances that are replacing older version appliances,
shut down the old appliances and disconnect them from the network so they do not attempt to register
with the zone when it is deployed. Retain the old appliances in case it is necessary to roll back the
update.
12. Deploy the new COP software by performing the procedure Deploy the COP (Common Operating
Platform) software on page 448.
The COP software must be version v3.0. In an HA zone, deploy the software on both CCM or ACCM
appliances, and if applicable, all MMs.
If you are deploying the update software on new hardware, perform this procedure only if the
appropriate COP is not already deployed. To determine whether a COP is deployed, power on the
appliance. If after booting up, the appliance displays the prompt Do you want to generate
finger print?, the COP is deployed and the appliance is ready for network configuration. If the
COP is deployed, be sure that it is the correct version by performing the procedure Determine the
current COP version on page 450. If the COP is not the correct version, deploy the new COP
software.
13. Configure the appliance network settings by performing the procedure Configure the appliance
network settings with Network Configurator on page 450.
Enter the values you collected in the prerequisites. In an HA zone, perform this procedure on both
CCM or ACCM appliances, and if applicable, all MMs.
14. Deploy the appliance personality software by performing the procedure Deploy the appliance
personality software with Personality Deployer on page 465.
In an HA zone, deploy the software on both CCM or ACCM appliances, and if applicable, all MMs.
15. Deploy the zone by performing the procedure Deploy the first or only zone with Zone Deployer on
page 489.
In an HA zone, perform this step on both appliances.
16. Restore the Enterprise backup file by performing the procedure Restore an Enterprise backup in a
single zone on page 374.

December 3, 2019 IPC Confidential

 1.2: Upgrades that require new COP software 45

17. If the current software version requires a new enterprise license, install the license you obtained as
part of the prerequisites by performing the procedure Install an enterprise license file on page 481.
18. Enable device registration by performing the procedure Enable device registration on page 496.
19. Deploy the updated software on the remaining devices in the zone, including Media Managers, Media
Gateways, turrets, Pulse devices, and Unigy Soft Clients, by performing the procedure Upgrade the
software on system devices on page 558.
20. If the upgrade was from a pre-Unigy v3.0 version, confirm or configure the following:
1. If the Name for zone address is blank or not appropriate, or the address does not exist, configure
the address at Configuration ➤ Enterprise ➤ System ➤ Addresses.
2. Confirm that the appropriate address is assigned to each location. If it is not, assign the address at
Configuration ➤ Enterprise ➤ System ➤ Locations.
3. Confirm that the correct Backroom Location is assigned to the zone. If it is not, assign the
location at Configuration ➤ Enterprise ➤ System ➤ Zones.
21. If necessary, change the zone's BCP status to Active by performing the procedure Change a zone's
BCP status to Active on page 498.
22. Reconfigure the SMTP properties with the values you recorded in the prerequisites by performing the
procedure Configure an SMTP server on page 563.
23. If secure communications is enabled for third-party devices, such as PBXs, voice recorders, or
Session Border Controllers, and a self-signed certificate is used to secure the connections, perform
the procedure Upload a self-signed third-party certificate for secure communications on page 269.
24. Confirm that the dial patterns, route plans, recording profiles, and scheduled backups that were
configured in the previous version are present and correct.
If the next run date for a scheduled backup job is in the past, delete the scheduled backup then
recreate it.
25. Validate the zone you upgraded by performing the procedures in the Post-Maintenance Validation
Test Suite. If you do not have access to this document, perform the procedure Validate a zone after a
deployment, rollback, or other operations on page 638.
26. Confirm that a recurring Archive all Zone backup job and backup file retention policy are configured
for the zone. If this backup is not scheduled, perform the procedure Configure a recurring archive
backup job and retention policy on page 612.
This helps to prevent out of memory issues due to high volumes of call history data.
27. If applicable, do one or more of the following:
• If an OS patch that is more recent than the OS patch included in the appliance personality ISO file
you deployed is available and you want to install the newer OS patch, perform the procedure
Install an OS patch in a single zone from the UMS – automatic install on page 131.
• Upgrade the Unigy Soft Client software on the client computers by performing one of the
following procedures. If the customer does not use the Soft Client, it is not necessary to perform
this task.
• Upgrade the Unigy Soft Client software – Microsoft Windows 32-bit on page 630
• Upgrade the Unigy Soft Client software – Microsoft Windows 64-bit on page 628
• If you are implementing the System Logging and Information Collector (SLIC) feature to forward
customer log data to a data analytics engine such as Splunk, refer to the System Logging and

IPC Confidential Unigy 4.3

Enterprise Guide
46 1.2: Upgrades that require new COP software

Information Collector Service Installation and Administration Guide. If the customer is not using
this feature or it is already implemented, it is not necessary to perform this task.
• Install and configure the Compliance Policy Engine to control access to lines and users. For
information on these procedures, refer to the Compliance Policy Engine Installation Guide and
Compliance Policy Engine Administration Guide. If the customer has not purchased the
Compliance Policy Engine or it is already installed, it is not necessary to perform this task.

1.2.3 Deploy a software update with a new COP in a multizone enterprise – subset of zones
This topic describes how to deploy a software update, that requires upgrading the Common Operating
Platform (COP) software, in a multizone zone enterprise in which some, but not all of the zones are
being upgraded. It applies to any update (except v1.0 upgrades) that requires new COP software.

Note
If the enterprise includes Blue Wave zones and any zones in the enterprise have a pre-Unigy v4.1
version deployed, upgrade the Blue Wave zones before you upgrade any Unigy zones. If all zones are at
Unigy v4.1 or higher, it is not necessary to upgrade the Blue Wave zones before the Unigy zones.
For information on upgrading Blue Wave zones, refer to Blue Wave upgrade workflows on page 114.

Note
Use this procedure only if a Single Click Deployment appliance is not available. For information on Single
Click Deployment, refer to Single Click Deployment (SCD) on page 149.

Note
Perform this procedure only if new COP software is required.
When the COP software is deployed, all existing software and data is removed from the zones you
upgrade, therefore, you should perform enterprise and image backups before performing the upgrade.

For multizone upgrades that do not require a new COP, for example, v3.0 or higher patches, service
packs, or hotfixes, refer to the following procedures:
• Deploy a software update in a multizone enterprise with Enterprise Install on page 78
• Deploy a Unigy software update in parallel in a multizone enterprise on page 86
• Deploy a software update in a multizone enterprise one zone at a time on page 93
For information on upgrading zones that require a new COP in a single zone enterprise, refer to Deploy
a software update with a new COP in a single zone enterprise – standalone or HA on page 41.
For information on the specific Unigy upgrade paths supported, refer to the UpgradePaths tab in the
Unigy Product Compatibility Matrix.
For additional information related to updates, refer to Unigy upgrade workflows on page 21, Patches,
service packs, and hotfixes on page 25, and Unigy software version naming convention on page 29.

December 3, 2019 IPC Confidential

 1.2: Upgrades that require new COP software 47

Note
After all zones in a multizone enterprise have been upgraded to Unigy v2.0.1 or higher, Enterprise Install
is generally the recommended upgrade method for all subsequent upgrades. However, you cannot use
Enterprise Install for upgrades that require a reCOP because Enterprise Install cannot deploy the new
COP software that is required for these upgrades. If a Single Click Deployment appliance is available,
use it for upgrades that require a reCOP. If a Single Click Deployment appliance is not available, use the
manual procedures for upgrades that require a new COP.

Important
If the enterprise consists of multiple instances, upgrade one instance at a time.

Prerequisites:
Before you perform this procedure, confirm the following:
• You reviewed the following information:
• Unigy upgrade workflows on page 21
• Patches, service packs, and hotfixes on page 25
• Unigy Product Compatibility Matrix
• You have the following COP software DVDs:
• Unigy v4.2 COP (build 03.00.01.00.0018). This COP is required for R640 appliances for Unigy
v4.2 or higher.
• Unigy v3.0 COP (build 03.00.00.00.1272). This COP is required only if it is necessary to roll back
the upgrade on an R620 or R630 appliance to a pre-v4.2 version if an issue is encountered with the
upgrade.
• Unigy v2.0 COP (build 02.00.00.00.1888). This COP is required only if it is necessary to roll back
the upgrade to a pre-v3.0 version if an issue is encountered with the upgrade.
• You have the new appliance personality software update ISO file. Updates are generally delivered on
a DVD, but might also be available on a network drive or other external data storage device.

Note
The ISO files for new versions, patches, and service packs are over 2.0 GBs in size, so if low band
width or slow file transfer rates caused by other factors is an issue, do one or both of the following to
ensure that a copy of the ISO file is available for upload or download prior to performing the upgrade:
• If you will be at the customer site, be sure the DVD is available or copy the ISO file to your laptop or
a flash drive.
• Copy the ISO file to a customer or IPC server from which you can download it to one of the Unigy
appliances. Perform the copy before you start the upgrade because it might take an hour or more to
complete.

• For Unigy v4.1 or higher, if an OS (operating system) patch that is more recent than the OS version
included in the appliance personality ISO file you are deploying is available and you want to deploy
this patch after the appliance upgrade is complete, you have access to the patch ISO file. You can get
the file from the IPC FTP site, FilesAnywhere. It can be burned to a DVD or copied to your laptop or
an external data storage device.
• You have the following network configuration values for each zone you are upgrading. For
information on these values and a table for recording them, refer to Information to collect prior to

IPC Confidential Unigy 4.3

Enterprise Guide
48 1.2: Upgrades that require new COP software

running Network Configurator or performing an upgrade on page 462 and Network configuration
properties worksheet on page 464.
• Values that were entered in Network Configurator for each CCM, ACCM, and MM appliance
during initial deployment, or if these values were changed after deployment, the current values.
• VIP Address, ACCM/CCM1 Server IP Address, ACCM/CCM2 Server IP Address, and
Backroom Location field values. The Backroom Location field is not available for pre-v3.0
zones, so if you are upgrading from a pre-v3.0 version, you will configure this field after the
upgrade.
• Zone ID assigned when each zone was deployed with Zone Deployer, or if the ID was changed
after initial deployment, the current value. You will reuse the zone IDs during the upgrade, and if
you are upgrading from a Unigy version prior to v2.0.1.6, you will also need this information to
populate the prototype devices in each zone with the updateMyPrototype.sh script
following the upgrade.
• If the update requires a new enterprise license, you have the new license file for the customer.
• You have the SMTP configuration values for the enterprise. These are available at Configuration ➤
Enterprise ➤ SMTP. This data is not saved in the database, so it will be replaced with default values
during the upgrade. You will reconfigure SMTP after the upgrade. Record the values in the table in
SMTP configuration properties on page 564.
• If you are upgrading from a Unigy version prior to v2.0.1.7 and the
updateToneCadensceFreqForExistingInstances.sh script was not run for that
version, obtain the instance ID for the instance associated with each zone you are upgrading. To
obtain this information, identify the instance assigned to each zone at Configuration ➤
Enterprise ➤ System ➤ Zones, then run the command mysql -udatabase_username -
pdatabase_password dunkin -e "select id, name from Instance";
where:
• database_username is the user name for accessing the Unigy database.
• database_password is the password for the database user account.
• You have access to the document Post-Maintenance Validation Test Suite, which is available on the
Tech Portal. This document provides a set of procedures you should perform to determine whether a
zone is in a healthy state before and after you upgrade the zone.
• The appliances on which you are deploying the update have at least 48 GB of memory.
If Multi-tier Replication is enabled, it must be enabled for all data centers in the enterprise, or the data
centers must be members of the default data center, before you upgrade any of the zones. When you
upgrade the zones, upgrade the portal zones before the local zones because the portal zone serves as the
preferred zone for the local zones within a data center. To upgrade a portal zone, you must suspend
Multi-tier Replication for the associated data center. To avoid data loss when you upgrade a portal zone,
consider upgrading one appliance in the zone at a time so the zone remains active and available to
collect local zone data changes throughout the upgrade. For information on this upgrade procedure, refer
to Deploy a software update in a multizone enterprise one zone at a time on page 93. If you are
restoring an Enterprise database backup during the upgrade, restore the database to a portal zone. After
you upgrade the portal zone, resume Multi-tier Replication before you upgrade the Local zones. For
additional information on Multi-tier Replication, refer to Multi-tier Replication on page 229.
If you are deploying the new software on new appliances that are replacing older version appliances,
you will shut down the old appliances and disconnect them from the network so they do not attempt to
register with the zones when they are deployed. Retain the old appliances in case it is necessary to roll

December 3, 2019 IPC Confidential

 1.2: Upgrades that require new COP software 49

back the update. If a rollback is necessary, disconnect the new appliances and reconnect the old
appliances.

Tip
It is a best practice to make a note of the customer's dial patterns, route plans, recording profiles, and
scheduled backups before performing this procedure and to verify that they are the same in the upgraded
enterprise when the procedure is complete. If an enterprise backup is restored during the upgrade,
scheduled backups will need to be reconfigured if the date of the next scheduled event is before the date
the backup was restored. This is because the currently scheduled job will not run because the date is in
the past. For recurring jobs, this prevents the next occurrence from being scheduled.

If manual or automated configuration or other changes are made within a zone before data replication is
reenabled, those changes might be lost when the zone obtains a copy of the Unigy database after
replication is enabled. Job history records for the upgrade are also lost, so you should review the history
and log details before enabling replication.

Caution
An update is service-impacting when the COP software is upgraded, the system creates a rollback point
or reboots an appliance, the procedure includes an HA failover (manual HA failovers are always
stateless), data replication is re-enabled, or the update contains changes to the Media Gateways, turrets,
Pulse devices, or Soft Clients that require a reboot after the software is deployed. Review the Impacted
RPMs tab within the Software Deployment Install tab to determine the impacts of the update.
All upgrades should be performed only during a maintenance window when the zones being deployed
are not required to process calls or configuration requests.

Note
This procedure assumes that at least one zone will remain operational to provide a database dump for
the zones you upgrade.

To perform this procedure, your user account must have the IPC Certified Tech role assigned.
1. Log in to the UMS in each zone you are upgrading.
2. Determine the state of each zone by performing the procedures in the Post-Maintenance Validation
Test Suite. If you do not have access to this document, perform the procedure Validate a zone before
an upgrade, rollback, or other operations on page 636.
If a zone is not in a healthy state or there is not sufficient disk space available, resolve the issues
before you perform the upgrade, unless the upgrade is required to resolve the issues.
3. If the zone you are upgrading is a Multi-tier Replication portal zone, place the associated data center
into the suspended state by performing the procedure Suspend or resume Multi-tier Replication on
page 247.
4. Remove from the database any devices that do not apply to the upgraded enterprise, including older
version appliances that are no longer supported, by performing the procedure Remove hardware from
the database on page 359.
5. If the enterprise includes Media Gateways, backup the .ini file from each Media Gateway by
performing the procedure Download a Media Gateway INI file on page 585.
6. If you are upgrading from Unigy v2.x to Unigy v3.0 or higher, perform the procedure Send SNMP
recovery alerts prior to an upgrade on page 564.

IPC Confidential Unigy 4.3

Enterprise Guide
50 1.2: Upgrades that require new COP software

7. To prevent the forwarding of alerts during the upgrade process and automatic activation of BCP
plans, perform the following procedures in each of the zones you are upgrading:
a) Disable SNMP forwarding for a zone on page 596.
b) Place a zone into maintenance mode to disable BCP plan activation on page 597.
8. To prevent new hardware from registering with the zones during the upgrade, disable device
registration in each of the zones you are upgrading by performing the procedure Disable device
registration on page 497.
9. Disable data replication in all of the zones by performing the procedure Disable data replication on
page 498.
10. Schedule an Enterprise backup in a zone that has the latest database schema by performing the
procedure Create or schedule a new backup on page 363.
To reduce the volume of data included in the backup, you can run an Archive all Zone backup prior to
creating the enterprise backup.
11. Download the database backup file, and if applicable, the Archive all Zone backup file, to an external
data storage device by performing the procedure Download a backup file on page 607.
Record the name of the backup files so they are available when you restore the data after you upgrade
the appliances.
12. Back up the appliance disk image on each appliance you are upgrading to create a restore point by
performing the procedure Create an image backup (restore point) from the UMS on page 385.
Perform this procedure for both CCM or ACCM appliances in all zones.

Note
The backup directory can be quite large if it contains multiple image backup files. This can require
large amounts of disk space and long transfer times. To reduce the amount of data transferred, you
can move, archive, or delete older image backup directories, identified by the date and time in the
backup directory name, and retain only the most recent directory. Confirm that the directory does not
exceed the available disk space of the storage device to which you are copying it by running the
command du -hc /var/spool/backup, which displays the disk space used.
If you remove the older directories, the system continues to display the deleted image file names
within the UMS on the Rollback tab at Tools ➤ Deployment ➤ Software Deployment, but the files will
not be available for recovery.

13. If you are deploying the new software on new appliances that are replacing older version appliances,
shut down the old appliances and disconnect them from the network so they do not attempt to register
with the zone when it is deployed. Retain the old appliances in case it is necessary to roll back the
update.
14. Perform the following substeps for each zone you are upgrading. You can perform these steps for
each zone simultaneously.
a) Deploy the new COP software by performing the procedure Deploy the COP (Common Operating
Platform) software on page 448.
The COP software must be version 03.00.00.00.1272. Deploy the software on both CCM or
ACCM appliances, and if applicable, all MMs.
If you are deploying the update software on new hardware, perform this procedure only if the
appropriate COP is not already deployed. To determine whether a COP is deployed, power on the
appliance. If after booting up, the appliance displays the prompt Do you want to generate
finger print?, the COP is deployed and the appliance is ready for network configuration. If
the COP is deployed, be sure that it is the correct version by performing the procedure Determine

December 3, 2019 IPC Confidential

 1.2: Upgrades that require new COP software 51

the current COP version on page 450. If the COP is not the correct version, deploy the new COP
software.
b) Configure the appliance network settings by performing the procedure Configure the appliance
network settings with Network Configurator on page 450.
Enter the values you collected in the prerequisites. Perform this procedure on both CCM or ACCM
appliances, and if applicable, all MMs.
c) Deploy the appliance personality software by performing the procedure Deploy the appliance
personality software with Personality Deployer on page 465.
Deploy the software on both CCM or ACCM appliances, and if applicable, all MMs.
15. Perform the following substeps, one zone at a time, in each zone you are upgrading:
a) Deploy the zone on the primary and secondary CCM or ACCM appliances in each zone by
performing the procedure Deploy subsequent zones on page 495.
The zone should already be configured in the database, however, you should configure the
Backroom Location, which was not available in pre-v3.0 versions, and if you are upgrading from
a pre-v2.0.1.5 version, the ACCM/CCM1 Server IP Address, ACCM/CCM2 Server IP Address,
and Preferred Zone.
When you specify the zone ID in Zone Deployer, use the ID that was assigned when the zone was
initially deployed. Refer to the zone IDs you collected in the prerequisites.
b) Confirm that the update was deployed by performing the procedure Confirm that an update was
deployed on page 552.
c) Enable data replication by performing the procedure Enable data replication on page 497.
d) Enable device registration by performing the procedure Enable device registration on page 496.
16. If a new enterprise license is required, install the license you obtained as part of the prerequisites by
performing the procedure Install an enterprise license file on page 481.
17. If you suspended Multi-tier Replication in step 3, resume it by performing the procedure Suspend or
resume Multi-tier Replication on page 247.
18. Perform the following substeps for each zone you are upgrading:
a) Deploy the updated software on the remaining devices in the zone, including Media Managers,
Media Gateways, turrets, Pulse devices, and Unigy Soft Clients by performing the procedure
Upgrade the software on system devices on page 558.
b) If the upgrade was from a pre-Unigy v3.0 version, confirm or configure the following:
1. If the Name for each address is blank or not appropriate, or an address does not exist, configure
the address at Configuration ➤ Enterprise ➤ System ➤ Addresses.
2. Confirm that the appropriate address is assigned to each location. If it is not, assign the address
at Configuration ➤ Enterprise ➤ System ➤ Locations.
c) Confirm that the ACCM/CCM1 Server IP Address, ACCM/CCM2 IP Address, Preferred Zone,
and Backroom Location fields in the zone configuration are correct at Configuration ➤
Enterprise ➤ System ➤ Zones.
d) If you are upgrading from a pre-Unigy v2.0.1.6 version, perform the procedure Update prototype
devices after an upgrade on page 566.
e) Reconfigure the SMTP properties with the values you recorded in the prerequisites by performing
the procedure Configure an SMTP server on page 563.

IPC Confidential Unigy 4.3

Enterprise Guide
52 1.2: Upgrades that require new COP software

f) If secure communications is enabled for third-party devices, such as PBXs, voice recorders, or
Session Border Controllers, and a self-signed certificate is used to secure the connections, perform
the procedure Upload a self-signed third-party certificate for secure communications on page 269.
g) Confirm that the dial patterns, route plans, recording profiles, and scheduled backups that were
configured in the previous version are present and correct.
If the next run date for a scheduled backup job is in the past, delete the scheduled backup then
recreate it.
h) Take the zone out of maintenance mode by performing the following procedures:
• Take a zone out of maintenance mode to reenable BCP plan activation on page 598.
• Reenable SNMP forwarding for a zone on page 596.
i) Validate the zones you upgraded by performing the procedures in the Post-Maintenance Validation
Test Suite. If you do not have access to this document, perform the procedure Validate a zone after
a deployment, rollback, or other operations on page 638.
19. If the data source that provided the database dump during the upgrade was a pre-Unigy v3.0 zone in
which the updateToneCadenceFreqForExistingInstances.sh script was not already
run in a previous upgrade, run the updateToneCadenceFreqForExistingInstances.sh
script to copy the Tone Cadence Frequency settings from a zone in the default instance to the zones in
all other instances by performing the procedure Run the
updateToneCadenceFreqForExistingInstances.sh script on page 567.
20. If a recurring Archive all Zone backup job and backup file retention policy are not configured for at
least one zone in each realm in the enterprise, perform the procedure Configure a recurring archive
backup job and retention policy on page 612.
This helps to prevent out of memory issues due to high volumes of call history data. If partial
replication is enabled, the zone must be a collector zone.
21. If applicable, do one or more of the following:
• If an OS patch that is more recent than the OS patch included in the appliance personality ISO file
you deployed is available and you want to install the newer OS patch, perform the procedure
Install an OS patch in multiple zones from the UMS with OS Enterprise Install on page 137
• Enable partial replication by performing the procedure Enable partial replication on page 316.
This applies only to customers who use partial replication to reduce the volume of data that is
replicated throughout the enterprise. If the customer is not using partial replication or it is already
enabled, it is not necessary to perform this task.
• If you upgraded to Unigy v3.0.0.1 or higher, enable Multi-tier Replication to further reduce the
volume of data replicated, improve WAN resiliency, and increase scalability by performing the
procedure Enable Multi-tier Replication on page 243. If the customer is not using Multi-tier
Replication or it is already enabled, it is not necessary to perform this task.
• Upgrade the Unigy Soft Client software on the client computers by performing one of the
following procedures. If the customer does not use the Soft Client, it is not necessary to perform
this task.
• Upgrade the Unigy Soft Client software – Microsoft Windows 32-bit on page 630
• Upgrade the Unigy Soft Client software – Microsoft Windows 64-bit on page 628
• If you are implementing the System Logging and Information Collector (SLIC) feature to forward
customer log data to a data analytics engine such as Splunk, refer to the System Logging and

December 3, 2019 IPC Confidential

 1.2: Upgrades that require new COP software 53

Information Collector Service Installation and Administration Guide. If the customer is not using
this feature or it is already implemented, it is not necessary to perform this task.
• Install and configure the Compliance Policy Engine to control access to lines and users. For
information on these procedures, refer to the Compliance Policy Engine Installation Guide and
Compliance Policy Engine Administration Guide. If the customer has not purchased the
Compliance Policy Engine or it is already installed, it is not necessary to perform this task.

1.2.4 Deploy a software update with a new COP in a multizone enterprise – all zones
This topic describes how to deploy a software update, that requires upgrading the Common Operating
Platform (COP) software, in a multizone zone enterprise in which all zones are being upgraded at the
same time. It applies to any update (except v1.0 upgrades) that requires new COP software.

Note
If the enterprise includes Blue Wave zones and any zones in the enterprise have a pre-Unigy v4.1
version deployed, upgrade the Blue Wave zones before you upgrade any Unigy zones. If all zones are at
Unigy v4.1 or higher, it is not necessary to upgrade the Blue Wave zones before the Unigy zones.
For information on upgrading Blue Wave zones, refer to Blue Wave upgrade workflows on page 114.

Note
Use this procedure only if a Single Click Deployment appliance is not available. For information on Single
Click Deployment, refer to Single Click Deployment (SCD) on page 149 and Deploy a software update
that requires a new COP with Single Click Deployment on page 31.

Important
Perform this procedure only if new COP software is required.
When the COP software is deployed, all existing software and data is removed, therefore you should
perform Enterprise and image backups before performing the upgrade.

Note
Use this procedure only if a Single Click Deployment appliance is not available. For information on Single
Click Deployment, refer to Single Click Deployment (SCD) on page 149.

This procedure assumes that all zones are being upgraded at the same time, therefore, no zones will
remain operational to provide a database dump for the zones that are being upgraded.
For multizone upgrades that will be performed on a subset of the enterprise zones, for example, to
upgrade one instance at a time, refer to Deploy a software update with a new COP in a multizone
enterprise – subset of zones on page 46.
For multizone upgrades that do not require a new COP, for example, v3.0 or higher patches, service
packs, or hotfixes, refer to the following procedures:
• Deploy a software update in a multizone enterprise with Enterprise Install on page 78
• Deploy a Unigy software update in parallel in a multizone enterprise on page 86
• Deploy a software update in a multizone enterprise one zone at a time on page 93
For information on the specific Unigy upgrade paths supported, refer to the UpgradePaths tab in the
Unigy Product Compatibility Matrix.

IPC Confidential Unigy 4.3

Enterprise Guide
54 1.2: Upgrades that require new COP software

For additional information related to updates, refer to Unigy upgrade workflows on page 21, Patches,
service packs, and hotfixes on page 25, and Unigy software version naming convention on page 29.

Note
After all zones in a multizone enterprise have been upgraded to Unigy v2.0.1 or higher, Enterprise Install
is generally the recommended upgrade method for all subsequent upgrades. However, you cannot use
Enterprise Install for upgrades that require a reCOP because Enterprise Install cannot deploy the new
COP software that is required for these upgrades. If a Single Click Deployment appliance is available,
use it for upgrades that require a reCOP. If a Single Click Deployment appliance is not available, use the
manual procedures for upgrades that require a new COP.

Prerequisites:
Before you perform this procedure, confirm the following:
• You reviewed the following information:
• Unigy upgrade workflows on page 21
• Patches, service packs, and hotfixes on page 25
• Unigy Product Compatibility Matrix
• You have the following COP software DVDs:
• Unigy v4.2 COP (build 03.00.01.00.0018). This COP is required for R640 appliances for Unigy
v4.2 or higher.
• Unigy v3.0 COP (build 03.00.00.00.1272). This COP is required only if it is necessary to roll back
the upgrade on an R620 or R630 appliance to a pre-v4.2 version if an issue is encountered with the
upgrade.
• Unigy v2.0 COP (build 02.00.00.00.1888). This COP is required only if it is necessary to roll back
the upgrade to a pre-v3.0 version if an issue is encountered with the upgrade.
• You have the new appliance personality software update ISO file. Updates are generally delivered on
a DVD, but might also be available on a network drive or other external data storage device.

Note
The ISO files for new versions, patches, and service packs are over 2.0 GBs in size, so if low band
width or slow file transfer rates caused by other factors is an issue, do one or both of the following to
ensure that a copy of the ISO file is available for upload or download prior to performing the upgrade:
• If you will be at the customer site, be sure the DVD is available or copy the ISO file to your laptop or
a flash drive.
• Copy the ISO file to a customer or IPC server from which you can download it to one of the Unigy
appliances. Perform the copy before you start the upgrade because it might take an hour or more to
complete.

• For Unigy v4.1 or higher, if an OS (operating system) patch that is more recent than the OS version
included in the appliance personality ISO file you are deploying is available and you want to deploy
this patch after the appliance upgrade is complete, you have access to the patch ISO file. You can get
the file from the IPC FTP site, FilesAnywhere. It can be burned to a DVD or copied to your laptop or
an external data storage device.
• You have the following network configuration values for each zone you are upgrading. For
information on these values and a table for recording them, refer to Information to collect prior to

December 3, 2019 IPC Confidential

 1.2: Upgrades that require new COP software 55

running Network Configurator or performing an upgrade on page 462 and Network configuration
properties worksheet on page 464.
• Values that were entered in Network Configurator for each CCM, ACCM, and MM appliance
during initial deployment, or if these values were changed after deployment, the current values.
• VIP Address, ACCM/CCM1 Server IP Address, ACCM/CCM2 Server IP Address, and
Backroom Location field values. The Backroom Location field is not available for pre-v3.0
zones, so if you are upgrading from a pre-v3.0 version, you will configure this field after the
upgrade.
• Zone ID assigned when each zone was deployed with Zone Deployer, or if the ID was changed
after initial deployment, the current value. You will reuse the zone IDs during the upgrade, and if
you are upgrading from a Unigy version prior to v2.0.1.6, you will also need this information to
populate the prototype devices in each zone with the updateMyPrototype.sh script
following the upgrade.
• If the update requires a new enterprise license, you have the new license file for the customer.
• You have the SMTP configuration values for the enterprise. These are available at Configuration ➤
Enterprise ➤ SMTP. This data is not saved in the database, so it will be replaced with default values
during the upgrade. You will reconfigure SMTP after the upgrade. Record the values in the table in
SMTP configuration properties on page 564.
• If you are upgrading from a Unigy version prior to v2.0.1.7 and the
updateToneCadensceFreqForExistingInstances.sh script was not run for that
version, obtain the instance ID for the instance associated with each zone you are upgrading. To
obtain this information, identify the instance assigned to each zone at Configuration ➤
Enterprise ➤ System ➤ Zones, then run the command mysql -udatabase_username -
pdatabase_password dunkin -e "select id, name from Instance";
where:
• database_username is the user name for accessing the Unigy database.
• database_password is the password for the database user account.
• You have access to the document Post-Maintenance Validation Test Suite, which is available on the
Tech Portal. This document provides a set of procedures you should perform to determine whether a
zone is in a healthy state before and after you upgrade the zone.
• The appliances on which you are deploying the update have at least 48 GB of memory.
If Multi-tier Replication is enabled, it must be enabled for all data centers in the enterprise, or the data
centers must be members of the default data center, before you upgrade any of the zones. When you
upgrade the zones, upgrade the portal zones before the local zones because the portal zone serves as the
preferred zone for the local zones within a data center. To upgrade a portal zone, you must suspend
Multi-tier Replication for the associated data center. To avoid data loss when you upgrade a portal zone,
consider upgrading one appliance in the zone at a time so the zone remains active and available to
collect local zone data changes throughout the upgrade. For information on this upgrade procedure, refer
to Deploy a software update in a multizone enterprise one zone at a time on page 93. If you are
restoring an Enterprise database backup during the upgrade, restore the database to a portal zone. After
you upgrade the portal zone, resume Multi-tier Replication before you upgrade the Local zones. For
additional information on Multi-tier Replication, refer to Multi-tier Replication on page 229.
If you are deploying the new software on new appliances that are replacing older version appliances,
you will shut down the old appliances and disconnect them from the network so they do not attempt to
register with the zones when they are deployed. Retain the old appliances in case it is necessary to roll

IPC Confidential Unigy 4.3

Enterprise Guide
56 1.2: Upgrades that require new COP software

back the update. If a rollback is necessary, disconnect the new appliances and reconnect the old
appliances.

Tip
It is a best practice to make a note of the customer's dial patterns, route plans, recording profiles, and
scheduled backups before performing this procedure and to verify that they are the same in the upgraded
enterprise when the procedure is complete. If an enterprise backup is restored during the upgrade,
scheduled backups will need to be reconfigured if the date of the next scheduled event is before the date
the backup was restored. This is because the currently scheduled job will not run because the date is in
the past. For recurring jobs, this prevents the next occurrence from being scheduled.

If manual or automated configuration or other changes are made within a zone before data replication is
reenabled, those changes might be lost when the zone obtains a copy of the Unigy database after
replication is enabled. Job history records for the upgrade are also lost, so you should review the history
and log details before enabling replication.

Caution
An update is service-impacting when the COP software is upgraded, the system creates a rollback point
or reboots an appliance, the procedure includes an HA failover (manual HA failovers are always
stateless), data replication is re-enabled, or the update contains changes to the Media Gateways, turrets,
Pulse devices, or Soft Clients that require a reboot after the software is deployed. Review the Impacted
RPMs tab within the Software Deployment Install tab to determine the impacts of the update.
All upgrades should be performed only during a maintenance window when the zones being deployed
are not required to process calls or configuration requests.

To perform this procedure, your user account must have the IPC Certified Tech role assigned.
1. Log in to the UMS in each zone in the enterprise.
2. Determine the state of each zone by performing the procedures in the Post-Maintenance Validation
Test Suite. If you do not have access to this document, perform the procedure Validate a zone before
an upgrade, rollback, or other operations on page 636.
If a zone is not in a healthy state or there is not sufficient disk space available, resolve the issues
before you perform the upgrade, unless the upgrade is required to resolve the issues.
3. If the zone you are upgrading is a Multi-tier Replication portal zone, place the associated data center
into the suspended state by performing the procedure Suspend or resume Multi-tier Replication on
page 247.
4. Remove from the database any devices that do not apply to the upgraded enterprise, including older
version appliances that are no longer supported, by performing the procedure Remove hardware from
the database on page 359.
Rerun this step multiple times from the first zone, selecting a different zone in the Deployment Zones
panel, until you have removed the unneeded devices from all zones.
5. If the enterprise includes Media Gateways, backup the .ini file from each Media Gateway by
performing the procedure Download a Media Gateway INI file on page 585.
6. If you are upgrading from Unigy v2.x to Unigy v3.0 or higher, perform the procedure Send SNMP
recovery alerts prior to an upgrade on page 564.
7. To prevent the forwarding of alerts during the upgrade process and automatic activation of BCP
plans, perform the following procedures in each of the zones you are upgrading:

December 3, 2019 IPC Confidential

 1.2: Upgrades that require new COP software 57

a) Disable SNMP forwarding for a zone on page 596.

b) Place a zone into maintenance mode to disable BCP plan activation on page 597.
8. To prevent new hardware from registering with the zones during the upgrade, disable device
registration in each zone by performing the procedure Disable device registration on page 497.
9. Disable data replication in each of the zones by performing the procedure Disable data replication on
page 498.
10. Schedule an Enterprise backup in a zone that has the latest database schema by performing the
procedure Create or schedule a new backup on page 363.
To reduce the volume of data included in the backup, you can run an Archive all Zone backup prior to
creating the enterprise backup.
11. Download the database backup file, and if applicable, the Archive all Zone backup file, to an external
data storage device by performing the procedure Download a backup file on page 607.
Record the name of the backup files so they are available when you restore the data after you upgrade
the appliances.
12. Back up the appliance disk image on each appliance in the enterprise to create a restore point by
performing the procedure Create an image backup (restore point) from the UMS on page 385.
Perform this procedure for both CCM or ACCM appliances in all zones.

Note
The backup directory can be quite large if it contains multiple image backup files. This can require
large amounts of disk space and long transfer times. To reduce the amount of data transferred, you
can move, archive, or delete older image backup directories, identified by the date and time in the
backup directory name, and retain only the most recent directory. Confirm that the directory does not
exceed the available disk space of the storage device to which you are copying it by running the
command du -hc /var/spool/backup, which displays the disk space used.
If you remove the older directories, the system continues to display the deleted image file names
within the UMS on the Rollback tab at Tools ➤ Deployment ➤ Software Deployment, but the files will
not be available for recovery.

13. If you are deploying the new software on new appliances that are replacing older version appliances,
shut down the old appliances and disconnect them from the network so they do not attempt to register
with the zone when it is deployed. Retain the old appliances in case it is necessary to roll back the
update.
14. Deploy the new COP software by performing the procedure Deploy the COP (Common Operating
Platform) software on page 448.
The COP software must be version 03.00.00.00.1272. In an HA zone, deploy the software on both
CCM or ACCM appliances, and if applicable, all MMs.
If you are deploying the update software on new hardware, perform this procedure only if the
appropriate COP is not already deployed. To determine whether a COP is deployed, power on the
appliance. If after booting up, the appliance displays the prompt Do you want to generate
finger print?, the COP is deployed and the appliance is ready for network configuration. If the
COP is deployed, be sure that it is the correct version by performing the procedure Determine the
current COP version on page 450. If the COP is not the correct version, deploy the new COP
software.
15. Configure the appliance network settings on all CCM, ACCM and MM appliances by performing the
procedure Configure the appliance network settings with Network Configurator on page 450.
Enter the values you collected in the prerequisites.

IPC Confidential Unigy 4.3

Enterprise Guide
58 1.2: Upgrades that require new COP software

16. Deploy the appliance personality software on all CCM, ACCM and MM appliances by performing
the procedure Deploy the appliance personality software with Personality Deployer on page 465.
17. Deploy the zone on the primary and secondary CCM or ACCM appliances in the zone with the
lowest zone ID by performing the procedure Deploy the first or only zone with Zone Deployer on
page 489.
Assign the zone ID that was assigned to the zone prior to the upgrade. Refer to the values you
recorded in the prerequisites.
18. Restore the Enterprise database backup file you downloaded in step 11 by performing steps 1
through 12 in the procedure Restore an Enterprise backup in a single zone on page 374.
19. Perform the following substeps in the first zone:
a) Log in to the UMS.
b) Confirm that the update was deployed by performing the procedure Confirm that an update was
deployed on page 552.
c) Configure the Backroom Location, which was not available in pre-v3.0 versions, and if you are
upgrading from a pre-v2.0.1.5 version, the ACCM/CCM1 Server IP Address, ACCM/CCM2
Server IP Address, and Preferred Zone:
1. Click Configuration ➤ Enterprise ➤ System ➤ Zones.
2. In the Zones list on the left, click the zone you are configuring.
3. Enter the values then click Save.
d) Enable device registration by performing the procedure Enable device registration on page 496.
e) If a new enterprise license is required, install the license you obtained as part of the prerequisites
by performing the procedure Install an enterprise license file on page 481.
f) Confirm that the enterprise name is the same in each zone. If it is not, change it by performing the
procedure Change the enterprise name on page 301.
Do not perform the last step that reboots all of the zones in the enterprise, they will be rebooted
when data replication is enabled.
g) If you suspended Multi-tier Replication in step 3, resume it by performing the procedure Suspend
or resume Multi-tier Replication on page 247.
h) Deploy the updated software on the remaining devices in the zone, including Media Managers,
Media Gateways, turrets, Pulse devices, and Unigy Soft Clients by performing the procedure
Upgrade the software on system devices on page 558.
i) Validate the zone by performing the procedure Validate a zone after a deployment, rollback, or
other operations on page 638.
j) Enable data replication for the zone by performing the procedure Enable data replication on page
497.
20. Deploy the remaining zones, one zone at a time, by performing the following substeps:
a) Perform the procedure Deploy subsequent zones on page 495.
The zone should already be configured in the database, however, you should configure the
Backroom Location, and if you are upgrading from a pre-v2.0.1.5 version, the ACCM/CCM1
Server IP Address, ACCM/CCM2 Server IP Address, and Preferred Zone.

Assign the zone ID that was assigned to the zone prior to the upgrade. Refer to the values you
recorded in the prerequisites.
b) Log in to the UMS.

December 3, 2019 IPC Confidential

 1.2: Upgrades that require new COP software 59

c) Confirm that the update was deployed by performing the procedure Confirm that an update was
deployed on page 552.
d) Enable data replication by performing the procedure Enable data replication on page 497.
e) Enable device registration by performing the procedure Enable device registration on page 496.
f) Deploy the updated software on the remaining devices in the zone, including Media Managers,
Media Gateways, turrets, Pulse devices, and Unigy Soft Clients by performing the procedure
Upgrade the software on system devices on page 558.
21. Perform the following steps for each of the zones you upgraded:
a) If the upgrade was from a pre-Unigy v3.0 version, confirm or configure the following:
1. If the Name for each address is blank or not appropriate, or an address does not exist, configure
the address at Configuration ➤ Enterprise ➤ System ➤ Addresses.
2. Confirm that the appropriate address is assigned to each location. If it is not, assign the address
at Configuration ➤ Enterprise ➤ System ➤ Locations.
b) Confirm that the ACCM/CCM1 Server IP Address, ACCM/CCM2 IP Address, Preferred Zone,
and Backroom Location fields in the zone configuration are correct at Configuration ➤
Enterprise ➤ System ➤ Zones.
c) If you are upgrading from a pre-Unigy v2.0.1.6 version, perform the procedure Update prototype
devices after an upgrade on page 566.
d) Reconfigure the SMTP properties with the values you recorded in the prerequisites by performing
the procedure Configure an SMTP server on page 563.
e) If secure communications is enabled for third-party devices, such as PBXs, voice recorders, or
Session Border Controllers, and a self-signed certificate is used to secure the connections, perform
the procedure Upload a self-signed third-party certificate for secure communications on page 269.
f) Confirm that the dial patterns, route plans, recording profiles, and scheduled backups that were
configured in the previous version are present and correct.
If the next run date for a scheduled backup job is in the past, delete the scheduled backup then
recreate it.
g) Take the zone out of maintenance mode by performing the following procedures:
• Take a zone out of maintenance mode to reenable BCP plan activation on page 598.
• Reenable SNMP forwarding for a zone on page 596.
h) Validate the zones you upgraded by performing the procedures in the Post-Maintenance Validation
Test Suite. If you do not have access to this document, perform the procedure Validate a zone after
a deployment, rollback, or other operations on page 638.
22. If the data source that provided the database dump during the upgrade was a pre-Unigy v3.0 zone in
which the updateToneCadenceFreqForExistingInstances.sh script was not already
run in a previous upgrade, run the updateToneCadenceFreqForExistingInstances.sh
script to copy the Tone Cadence Frequency settings from a zone in the default instance to the zones in
all other instances by performing the procedure Run the
updateToneCadenceFreqForExistingInstances.sh script on page 567.
23. If a recurring Archive all Zone backup job and backup file retention policy are not configured for at
least one zone within each realm, perform the procedure Configure a recurring archive backup job
and retention policy on page 612 in one zone per realm.

IPC Confidential Unigy 4.3

Enterprise Guide
60 1.3: Upgrades that do not require new COP software

This helps to prevent out of memory issues due to high volumes of call history data. If partial
replication is enabled, the zone must be a collector zone.
24. If applicable, do one or more of the following:
• If an OS patch that is more recent than the OS patch included in the appliance personality ISO file
you deployed is available and you want to install the newer OS patch, perform the procedure
Install an OS patch in multiple zones from the UMS with OS Enterprise Install on page 137.
• Enable partial replication by performing the procedure Enable partial replication on page 316.
This applies only to customers who use partial replication to reduce the volume of data that is
replicated throughout the enterprise. If the customer is not using partial replication or it is already
enabled, it is not necessary to perform this task.
• If you upgraded to Unigy v3.0.0.1 or higher, enable Multi-tier Replication to further reduce the
volume of data replicated, improve WAN resiliency, and increase scalability by performing the
procedure Enable Multi-tier Replication on page 243. If the customer is not using Multi-tier
Replication or it is already enabled, it is not necessary to perform this task.
• Upgrade the Unigy Soft Client software on the client computers by performing one of the
following procedures. If the customer does not use the Soft Client, it is not necessary to perform
this task.
• Upgrade the Unigy Soft Client software – Microsoft Windows 32-bit on page 630
• Upgrade the Unigy Soft Client software – Microsoft Windows 64-bit on page 628
• If you are implementing the System Logging and Information Collector (SLIC) feature to forward
customer log data to a data analytics engine such as Splunk, refer to the System Logging and
Information Collector Service Installation and Administration Guide. If the customer is not using
this feature or it is already implemented, it is not necessary to perform this task.
• Install and configure the Compliance Policy Engine to control access to lines and users. For
information on these procedures, refer to the Compliance Policy Engine Installation Guide and
Compliance Policy Engine Administration Guide. If the customer has not purchased the
Compliance Policy Engine or it is already installed, it is not necessary to perform this task.

1.3 Upgrades that do not require new COP software

1.3.1 Deploy a software update that does not require a new COP with Single Click
Deployment
Single Click Deployment (SCD) automates many of the steps required to upgrade the Unigy software on
Converged Communications Manager (CCM), Aggregated Converged Communications Manager
(ACCM), and Media Manager (MM) appliances. This topic describes how to upgrade appliances that do
not require new COP software.
For information on upgrading appliances that require new COP software, refer to Deploy a software
update that requires a new COP with Single Click Deployment on page 31.
For overview information on Single Click Deployment, refer to Single Click Deployment (SCD) on page
149.

Note
To avoid possible version compatibility issues, always use the latest available SCD version (v4.x or
higher) for the upgrade.

December 3, 2019 IPC Confidential

 1.3: Upgrades that do not require new COP software 61

Note
If the enterprise includes Blue Wave zones and any zones in the enterprise have a pre-Unigy v4.1
version deployed, upgrade the Blue Wave zones before you upgrade any Unigy zones. If all zones are at
Unigy v4.1 or higher, it is not necessary to upgrade the Blue Wave zones before the Unigy zones.
For information on upgrading Blue Wave zones, refer to Blue Wave upgrade workflows on page 114.

This upgrade procedure requires access to a Single Click Deployment appliance. If you do not have a
virtual SCD appliance deployed on your laptop or an SCD appliance is not available at the customer site,
refer to one of the following manual upgrade procedures:
• Deploy a software update in a standalone zone enterprise on page 69
• Deploy a software update in a single HA zone enterprise on page 73
• Deploy a software update in a multizone enterprise with Enterprise Install on page 78
• Deploy a Unigy software update in parallel in a multizone enterprise on page 86
• Deploy a software update in a multizone enterprise one zone at a time on page 93
For information on the specific Unigy upgrade paths supported, refer to the UpgradePaths tab in the
Unigy Product Compatibility Matrix.
For additional information related to updates, refer to Unigy upgrade workflows on page 21, Patches,
service packs, and hotfixes on page 25, and Unigy software version naming convention on page 29.
Prerequisites:
Upgrades to Unigy v3.0 or higher from pre-v3.0 versions include operating system and third-party
software updates that require redeployment of the COP software on each appliance that is being
upgraded. First time deployment of software on R640 appliances requires a new COP.
To help ensure the success of an upgrade in a multizone enterprise, it is important that you design an
upgrade plan that includes at least the following information:

Item Notes
Type of zones. If partial replication is enabled, collector zones must be upgraded
before generator zones.
Zones that will be upgraded and The pre and post upgrade steps can be different when upgrading
their current software version. from different software versions.

IPC Confidential Unigy 4.3

Enterprise Guide
62 1.3: Upgrades that do not require new COP software

Item Notes
The preferred zone for each In a multizone enterprise, each zone should have a preferred zone
zone. from which it loads the database during an upgrade. A zone that is
being upgraded should always get its database from a zone that has
the latest software version deployed. A zone can provide the
database for up to two other zones simultaneously. To provide the
greatest efficiency and to avoid potential issues, do not assign the
same zone as the preferred zone for more than three zones. As soon
as a zone has loaded the database, it can serve as a source zone for
other zones. If you do not specify a preferred zone, the system uses
the zone selection algorithm (Database source zone selection
algorithms for database dumps on page 615).
If zones in different data centers are being upgraded within the same
maintenance window, the preferred zone for the first zone to be
upgraded in each data center (other than the first) should be a zone
in a data center that has been upgraded. After the first zone in each
data center is upgraded, the other zones in the data center should
get the database from a zone within the same data center to reduce
the data transmitted between data centers over the WAN. For
example, assume that you are upgrading the zones in two data
centers, each of which has five zones. Zones 1 through 5 are in data
center 1 and Zones 6 through 10 are in data center 2. Assign Zone 1
as the preferred zone for Zones 2 and 3 and assign Zone 2 as the
preferred zone for Zones 4 and 5. Assign Zone 3 as the preferred
zone for Zone 6, assign Zone 6 as the preferred zone for Zone 7 and
Zone 8, and assign Zone 7 or Zone 8 as the preferred zone for Zone
9 and Zone 10.
For post v3.0.0.1 upgrades, if Multi-tier Replication is enabled, the
preferred zone for the portal zones should be another portal zone,
preferably the one in the closest data center, and it should have the
latest version of the software deployed.
Number of Single Click You can use a single Single Click Deployment appliance to upgrade
Deployment appliances that will all of the zones in the enterprise, even if they are in different data
be used. centers distributed across the globe; however, for greater efficiency
and reduced bandwidth contention in large distributed enterprises, it
might be better to have multiple Single Click Deployment appliances
or to stagger the upgrades so the appliance can be moved to each
data center.
If you are upgrading zones in multiple data centers and a Single Click
Deployment appliance is available for each data center, consider
starting the upgrades in one data center then waiting for the upgrade
of at least some of the zones in the first data center to complete
before starting the upgrades in the next data center. This enables you
to use a zone in the first data center as the database source for
zones in the next data center while reducing the time required to
complete the upgrades by not placing a heavy load on a single Single
Click Deployment appliance.
Whether a Dependency VIP is A Dependency VIP provides a way to ensure that the database is
required. loaded from a specific zone when the zone VIP is available and the
source zone is fully operational. This is useful if you are upgrading
zones in different data centers and want to be sure the preferred
zone for a zone is available before it requests a database dump. In
the preferred zone example above, you might want to set Zone 3 as
the Dependency VIP for Zone 6.

December 3, 2019 IPC Confidential

 1.3: Upgrades that do not require new COP software 63

Before you perform this procedure, confirm the following:

• You reviewed the Unigy upgrade workflows and Patches, service packs, and hotfixes topics and
the Unigy Product Compatibility Matrix (if you are viewing this topic from the Single Click
Deployment or UMS online help, refer to the Enterprise Guide for this information).
• Unigy upgrade workflows on page 21
• Patches, service packs, and hotfixes on page 25
• Unigy Product Compatibility Matrix
• The Single Click Deployment appliance is installed, deployed, configured, enabled, and available on
the network. If the customer allows use of their SMTP system for sending Single Click Deployment
notifications, this should include configuration of the connection to the SMTP server. Refer to
Configure SMTP for Single Click Deployment notifications on page 163.
• Confirm that the following software .iso files are available on the Single Click Deployment
appliance by performing the procedure Display available artifacts on page 165. If they are not
available, contact IPC Manufacturing.
• COP software:
• Unigy v4.2 COP (build 03.00.01.00.0018). This COP is required for R640 appliances for Unigy
v4.2 or higher.
• Unigy v3.0 COP (build 03.00.00.00.1272). This COP is required only if it is necessary to roll
back the upgrade on an R620 or R630 appliance to a pre-v4.2 version if an issue is encountered
with the upgrade.
• Unigy v2.0 COP (build 02.00.00.00.1888). This COP is required only if it is necessary to roll
back the upgrade to a pre-v3.0 version if an issue is encountered with the upgrade.
• New appliance personality software file.
• For Unigy v4.1 or higher, if an OS (operating system) patch that is more recent than the OS version
included in the appliance personality ISO file you are deploying is available and you want to deploy
this patch after the appliance upgrade is complete, you have access to the patch ISO file. You can get
the file from the IPC FTP site, FilesAnywhere. It can be burned to a DVD or copied to your laptop or
an external data storage device.
• You have the following network configuration values for each zone you are upgrading. For
information on these values and a table for recording them, refer to Information to collect prior to
running Network Configurator or performing an upgrade on page 462 and Network configuration
properties worksheet on page 464.
• Values that were entered in Network Configurator for each CCM, ACCM, and MM appliance
during initial deployment, or if these values were changed after deployment, the current values.
• VIP Address, ACCM/CCM1 Server IP Address, ACCM/CCM2 Server IP Address, and
Backroom Location field values. The Backroom Location field is not available for pre-v3.0
zones, so if you are upgrading from a pre-v3.0 version, you will configure this field after the
upgrade.
• Zone ID assigned when each zone was deployed with Zone Deployer, or if the ID was changed
after initial deployment, the current value. You will reuse the zone IDs during the upgrade, and if
you are upgrading from a Unigy version prior to v2.0.1.6, you will also need this information to
populate the prototype devices in each zone with the updateMyPrototype.sh script
following the upgrade.
• If the update requires a new enterprise license, you have the new license file for the customer.

IPC Confidential Unigy 4.3

Enterprise Guide
64 1.3: Upgrades that do not require new COP software

• You have the SMTP configuration values for the enterprise. These are available at Configuration ➤
Enterprise ➤ SMTP. This data is not saved in the database, so it will be replaced with default values
during the upgrade. You will reconfigure SMTP after the upgrade. Record the values in the table in
SMTP configuration properties on page 564.
• If you are upgrading from a Unigy version prior to v2.0.1.7 and the
updateToneCadensceFreqForExistingInstances.sh script was not run for that
version, obtain the instance ID for the instance associated with each zone you are upgrading. To
obtain this information, identify the instance assigned to each zone at Configuration ➤
Enterprise ➤ System ➤ Zones, then run the command mysql -udatabase_username -
pdatabase_password dunkin -e "select id, name from Instance";
where:
• database_username is the user name for accessing the Unigy database.
• database_password is the password for the database user account.
• You have access to the document Post-Maintenance Validation Test Suite, which is available on the
Tech Portal. This document provides a set of procedures you should perform to determine whether a
zone is in a healthy state before and after you upgrade the zone.
• The appliances on which you are deploying the current version software have at least 48 GB of
memory.
If Multi-tier Replication is enabled, it must be enabled for all data centers in the enterprise, or the data
centers must be members of the default data center, before you upgrade any of the zones. When you
upgrade the zones, upgrade the portal zones before the local zones because the portal zone serves as the
preferred zone for the local zones within a data center. To upgrade a portal zone, you must suspend
Multi-tier Replication for the associated data center. To avoid data loss when you upgrade a portal zone,
consider upgrading one appliance in the zone at a time so the zone remains active and available to
collect local zone data changes throughout the upgrade. For information on this upgrade procedure, refer
to Deploy a software update in a multizone enterprise one zone at a time on page 93. If you are
restoring an Enterprise database backup during the upgrade, restore the database to a portal zone. After
you upgrade the portal zone, resume Multi-tier Replication before you upgrade the Local zones. For
additional information on Multi-tier Replication, refer to Multi-tier Replication on page 229.
If you are deploying the new software on new appliances that are replacing older version appliances,
you will shut down the old appliances and disconnect them from the network so they do not attempt to
register with the zones when they are deployed. Retain the old appliances in case it is necessary to roll
back the update. If a rollback is necessary, disconnect the new appliances and reconnect the old
appliances.

Tip
It is a best practice to make a note of the customer's dial patterns, route plans, recording profiles, and
scheduled backups before performing this procedure and to verify that they are the same in the upgraded
enterprise when the procedure is complete. If an enterprise backup is restored during the upgrade,
scheduled backups will need to be reconfigured if the date of the next scheduled event is before the date
the backup was restored. This is because the currently scheduled job will not run because the date is in
the past. For recurring jobs, this prevents the next occurrence from being scheduled.

Note
Upgrades are service impacting, so perform them only during a maintenance window when the zones
being deployed are not required to process calls or configuration requests.

December 3, 2019 IPC Confidential

 1.3: Upgrades that do not require new COP software 65

1. Log in to the UMS in each zone you are upgrading.

2. Determine the state of each zone by performing the procedures in the Post-Maintenance Validation
Test Suite. If you do not have access to this document, perform the procedure Validate a zone before
an upgrade, rollback, or other operations on page 636.
If a zone is not in a healthy state or there is not sufficient disk space available, resolve the issues
before you perform the upgrade, unless the upgrade is required to resolve the issues.
3. If the zone you are upgrading is a Multi-tier Replication portal zone, place the associated data center
into the suspended state by performing the procedure Suspend or resume Multi-tier Replication on
page 247.
4. If you are upgrading from Unigy v2.x to Unigy v3.0 or higher, perform the procedure Send SNMP
recovery alerts prior to an upgrade on page 564.
5. Disable SNMP Forwarding for each zone you are upgrading by performing the procedure Disable
SNMP forwarding for a zone on page 596.
6. If the enterprise includes Media Gateways, backup the .ini file from each one by performing the
procedure Download a Media Gateway INI file on page 585.
7. If the appliances you are upgrading are not registered with the Single Click Deployment appliance,
perform the procedure Register a Unigy appliance with a Single Click Deployment appliance on page
160.
If you are performing a partial upgrade, be sure that the zone that will provide the database for the
zones being upgraded is also registered with the Single Click Deployment appliance.
8. Log in to Single Click Deployment with the user account assigned to the appliances you are
upgrading: https://scd_ip/svc/oneclick/, where scd_ip is the IP address of the Single
Click Deployment appliance.
9. Within Single Click Deployment, confirm that the configuration for each appliance you are upgrading
is correct:
a) In the Main Menu, click Enterprise Servers Plan.
b) Confirm that all of the appliances you registered with the SCD appliance are in the Select Servers
list.
If any appliances are missing, rerun step 7 for those appliances.
c) For each appliance you are upgrading, select the check box in the Select column.
d) Click Next.
e) For each appliance, click the Advance button and confirm that all of the values with the yellow
background are correct.
These values are pulled from each appliance when they register with the Single Click Deployment
appliance.

Important
In general, you should not change any of these values unless instructed to do so by IPC Support or
Development. However, if the upgrade plan you designed includes a requirement to wait for a
specific zone to be up before attempting to take a database dump from the zone, you might have to
set the Dependency VIP. If there is no specific requirement for the Dependency VIP, leave it blank.

The Instance ID does not represent the instance ID in the Unigy database, so if it is not correct,
you can leave it at 1 and the system will handle it properly.

IPC Confidential Unigy 4.3

Enterprise Guide
66 1.3: Upgrades that do not require new COP software

10. Within the UMS, create an Enterprise database backup from a zone with the highest database schema
and download the backup file to an external data storage device that is accessible from the Single
Click Deployment appliance by performing the procedures Create or schedule a new backup on page
363 and Download a backup file on page 607.
This step is recommended for all upgrades to ensure that a backup is available if it is needed.
If partial replication is enabled, the source zone for the backup should be a collector zone. For post
v3.0.0.1 upgrades, if Multi-tier Replication is enabled, the source zone should be a portal zone,
preferably one that is also a collector zone.
11. If you are upgrading a standalone zone or all of the zones in the enterprise at the same time, upload
the Enterprise backup file you created in the previous step by performing the procedure Import an
Enterprise backup file to a Single Click Deployment appliance on page 166.
12. Within Single Click Deployment, create an image backup of each appliance you are upgrading by
performing the procedure Create an image backup (restore point) with Single Click Deployment on
page 165.
Use the External Backup option. The backup file will be stored on the appliance and on the Single
Click Deployment appliance.
To reduce the size of the image backup files and the time required to transfer the files to the Single
Click Deployment appliance, you can run Archive all Zone backups prior to using the External
Backup option to purge most of the history data.
13. If you are upgrading all zones in the enterprise at the same time, the zones were not previously
upgraded to a bridge patch or hotfix to update the JGroups protocols, and your upgrade plan calls for
disabling data replication for some of the zones to prevent potential JGroups protocol mismatches,
perform the procedure Disable data replication on page 498 for each applicable zone.
14. Within Single Click Deployment, configure and validate the Single Click Deployment upgrade plan
for all appliances that are being upgraded:
a) In the Main Menu, click Enterprise Servers Plan.
b) In the Select column, select the check box for all of the appliances you are upgrading then click
Next.
c) In the Task column, select None.
d) In the COP ISO column, confirm that the COP software version is correct.
e) In the Personality column, select the appliance personality type, CCM, ACCM, or MM.
f) In the Server Type column select HA for appliances in an HA zone or Standalone for the
appliance in a standalone zone or for an MM.
g) In the Install App ISO column, select the check box and the appropriate software version for each
appliance.
If all zones in the plan are being upgraded, select the check box at the top of the column then select
the version. This selects the check box and populates the version for all of the appliances.
h) In the Zone Deploy & Data Source column, clear the check box and text box for all of the
appliances.
i) In the Enterprise DB Restore column, clear the check box and text box for all of the appliances.
j) To assign a preferred zone for a zone, in the Preferred Zone column, select the check box for each
appliance in the zone and type the preferred zone's VIP. Single Click Deployment populates the
Preferred Zone field in the UMS zone configuration. If you do not specify a value, no preferred
zone is assigned and the system uses the zone selection algorithm to select a zone. The preferred
zone is the zone that provides the database dump if the zone is available.

December 3, 2019 IPC Confidential

 1.3: Upgrades that do not require new COP software 67

k) Click Save to save the plan.

Important
Do not select the check boxes in the Active column before saving at this point. If you select these
check boxes then click Save, Single Click Deployment starts the upgrade before you have an
opportunity to validate the upgrade plan.

l) Click View Map to confirm that the plan configuration is valid.

If Single Click Deployment displays any error messages, resolve the issues then click View Map
again.
15. Initiate and monitor the upgrade:
a) In the Active column, select the check box for all of the appliances you are upgrading.
This informs Single Click Deployment to run the upgrade for the selected appliances when you
click Save. If you do not want to initiate the upgrade for some of the appliances at this time, clear
this check box for those appliances.
b) Click Save to save the plan, and for all appliances for which you selected the Active check box, to
execute the deployment plan.
The upgrade begins. Single Click Deployment displays the progress, and if the SMTP server
connection is configured, begins to send progress e-mail messages every thirty minutes to the e-
mail addresses specified in the Single Click Deployment SMTP configuration.
c) Click Monitor to monitor the progress of the deployment for each appliance.
The progress is displayed in the Deployment Status column; it is updated every two minutes. To
display details for the current process, click the process hyperlink, the last 40 lines of the agent log
are displayed. To display the time remaining to complete the upgrade, mouse over the running
process in the Deployment Status column.
The deployment is complete when the progress for all appliances is 100% and the status is
agent-hold.
16. If you suspended Multi-tier Replication in step 3, resume it by performing the procedure Suspend or
resume Multi-tier Replication on page 247.
17. Check the status of all the zones you upgraded by performing the procedure Check the state of a zone
from a browser on page 499.
18. Perform the post upgrade procedures.

1.3.1.1 Post upgrade procedures

Perform the steps in this topic after you upgrade Unigy appliances with Single Click Deployment.
1. Reboot all Media Managers that were upgraded by performing the procedure Run Reboot Media
Manager on page 588.
2. If the current software version requires a new enterprise license, install the license you obtained as
part of the prerequisites by performing the procedure Install an enterprise license file on page 481.
3. Perform the following substeps for each zone you are upgrading:
a) Deploy the updated software on the remaining devices in the zone, including Media Managers,
Media Gateways, turrets, Pulse devices, and Soft Clients by performing the procedure Upgrade the
software on system devices on page 558.
b) Upgrade the Unigy Soft Client software on the client computers by performing one of the
following procedures:

IPC Confidential Unigy 4.3

Enterprise Guide
68 1.3: Upgrades that do not require new COP software

• Upgrade the Unigy Soft Client software – Microsoft Windows 32-bit on page 630
• Upgrade the Unigy Soft Client software – Microsoft Windows 64-bit on page 628
This step applies only to enterprises that use the Unigy Soft Client. If necessary, it can be
performed at a later time.
c) If necessary, change the zone's Preferred Zone to point to a different zone at Configuration ➤
Enterprise ➤ System ➤ Zones.
If you specified the preferred zone in Single Click Deployment, it should not be necessary perform
this step unless you want to point to a zone that is more appropriate for zone restarts.
d) If the upgrade was from a pre-Unigy v3.0 zone or a new zone was added, confirm or configure the
following:
1. If the Name for each address is blank or not appropriate, or an address does not exist, configure
the address at Configuration ➤ Enterprise ➤ System ➤ Addresses.
2. Confirm that the appropriate address is assigned to each location. If it is not, assign the address
at Configuration ➤ Enterprise ➤ System ➤ Locations.
3. Confirm that the correct Backroom Location is assigned to each zone. If it is not, assign the
location at Configuration ➤ Enterprise ➤ System ➤ Zones.
e) If the upgrade was from a pre-Unigy v2.0.1.6 version, perform the procedure Update prototype
devices after an upgrade on page 566.
f) Reconfigure the SMTP properties with the values you recorded in the prerequisites by performing
the procedure Configure an SMTP server on page 563.
g) If secure communications is enabled for third-party devices, such as PBXs, voice recorders, or
Session Border Controllers, and a self-signed certificate is used to secure the connections, perform
the procedure Upload a self-signed third-party certificate for secure communications on page 269.
h) Confirm that the dial patterns, route plans, recording profiles, and scheduled backups that were
configured in the previous version are present and correct.
If the next run date for a scheduled backup job is in the past, delete the scheduled backup then
recreate it because subsequent scheduled jobs will not run.
4. If the data source that provided the database dump during the upgrade was a pre-Unigy v3.0 zone in
which the updateToneCadenceFreqForExistingInstances.sh script was not run during
a previous upgrade, run the updateToneCadenceFreqForExistingInstances.sh script
to copy the Tone Cadence Frequency settings from a zone in the default instance to the zones in all
other instances by performing the procedure Run the
updateToneCadenceFreqForExistingInstances.sh script on page 567.
5. Enable SNMP Forwarding for the zones you upgraded by performing the procedure Reenable SNMP
forwarding for a zone on page 596.
6. Validate the zones you upgraded by performing the procedures in the Post-Maintenance Validation
Test Suite. If you do not have access to this document, perform the procedure Validate a zone after a
deployment, rollback, or other operations on page 638.
7. Unregister the Unigy appliances from the Single Click Deployment appliance by performing the
procedure Unregister a Unigy appliance from a Single Click Deployment appliance on page 162.
8. Within the UMS, create an Enterprise database backup from a zone with the highest database schema
and download the backup file to an external data storage device by performing the procedures Create
or schedule a new backup on page 363 and Download a backup file on page 607.

December 3, 2019 IPC Confidential

 1.3: Upgrades that do not require new COP software 69

9. If a recurring Archive all Zone backup job and backup file retention policy are not configured for at
least one zone in each realm in the enterprise, perform the procedure Configure a recurring archive
backup job and retention policy on page 612.
This helps to prevent out of memory issues due to high volumes of call history data. If partial
replication is enabled, the zone must be a collector zone.
10. If applicable, do one or more of the following:
• If an OS patch that is more recent than the OS patch included in the appliance personality ISO file
you deployed is available and you want to install the newer OS patch, perform the procedure
Install an OS patch in multiple zones from the UMS with OS Enterprise Install on page 137
• Enable partial replication by performing the procedure Enable partial replication on page 316.
This applies only to customers who use partial replication to reduce the volume of data that is
replicated throughout the enterprise. If the customer is not using partial replication or it is already
enabled, it is not necessary to perform this step.
• If you upgraded to Unigy v3.0.0.1 or higher, enable Multi-tier Replication to further reduce the
volume of data replicated, improve WAN resiliency, and increase scalability by performing the
procedure Enable Multi-tier Replication on page 243. If the customer is not using Multi-tier
Replication or it is already enabled, it is not necessary to perform this step.
• If you are implementing the System Logging and Information Collector (SLIC) feature to forward
customer log data to a data analytics engine such as Splunk, refer to the System Logging and
Information Collector Service Installation and Administration Guide. If the customer is not using
this feature or it is already implemented, it is not necessary to perform this task.
• Install and configure the Compliance Policy Engine to control access to lines and users. For
information on these procedures, refer to the Compliance Policy Engine Installation Guide and
Compliance Policy Engine Administration Guide. If the customer has not purchased the
Compliance Policy Engine or it is already installed, it is not necessary to perform this step.

1.3.2 Deploy a software update in a standalone zone enterprise

This procedure describes how to deploy a Unigy software update, that does not require upgrading the
Common Operating Platform (COP) software, in a standalone zone enterprise that consists of a single
zone with a single ACCM appliance. An update can be a patch, service pack, or hotfix.

Note
Use this procedure only if a Single Click Deployment appliance is not available. For information on Single
Click Deployment, refer to Single Click Deployment (SCD) on page 149 and Deploy a software update
that requires a new COP with Single Click Deployment on page 31.

Within this topic, the terms current version and current software version refer to the Unigy software
version specified on the cover of this document. References to previous Unigy versions apply to the
versions, patches, service packs, and hotfixes for these versions that the current version supports.

Important
If the update you are deploying requires the deployment of new COP software, use the procedure Deploy
a software update with a new COP in a single zone enterprise – standalone or HA on page 41. Refer to
that procedure for upgrades from Unigy pre-v3.0 versions to the current software version.

This procedure applies to the following types of upgrades:

• Upgrades from previous software versions that do not require deployment of new COP software.

IPC Confidential Unigy 4.3

Enterprise Guide
70 1.3: Upgrades that do not require new COP software

• Patches, service packs, or hotfixes for the current software version.

For information on the specific Unigy upgrade paths supported, refer to the UpgradePaths tab in the
Unigy Product Compatibility Matrix.
For information on upgrading Blue Wave zones, refer to Blue Wave upgrade workflows on page 114.
For additional information related to updates, refer to Unigy upgrade workflows on page 21, Patches,
service packs, and hotfixes on page 25, and Unigy software version naming convention on page 29.

Prerequisites:
Before you perform this procedure, confirm the following:
• You reviewed the following information:
• Unigy upgrade workflows on page 21
• Patches, service packs, and hotfixes on page 25
• Unigy Product Compatibility Matrix
• You have the new appliance personality software update ISO file. Updates are generally delivered on
a DVD, but might also be available on a network drive or other external data storage device.

Note
The ISO files for new versions, patches, and service packs are over 2.0 GBs in size, so if low band
width or slow file transfer rates caused by other factors is an issue, do one or both of the following to
ensure that a copy of the ISO file is available for upload or download prior to performing the upgrade:
• If you will be at the customer site, be sure the DVD is available or copy the ISO file to your laptop or
a flash drive.
• Copy the ISO file to a customer or IPC server from which you can download it to one of the Unigy
appliances. Perform the copy before you start the upgrade because it might take an hour or more to
complete. Refer to Download an ISO file when an upload or download fails on page 548.

• For Unigy v4.1 or higher, if an OS (operating system) patch that is more recent than the OS version
included in the appliance personality ISO file you are deploying is available and you want to deploy
this patch, you have access to the patch ISO file. You can get the file from the IPC FTP site,
FilesAnywhere. It can be burned to a DVD or copied to your laptop or an external data storage device.
• If the update requires a new enterprise license, you have the new license file for the customer.
• You have the SMTP configuration values for the enterprise. These are available at Configuration ➤
Enterprise ➤ SMTP. This data is not saved in the database, so it will be replaced with default values
during the upgrade. You will reconfigure SMTP after the upgrade. Record the values in the table in
SMTP configuration properties on page 564.
• You have access to the document Post-Maintenance Validation Test Suite, which is available on the
Tech Portal. This document provides a set of procedures you should perform to determine whether a
zone is in a healthy state before and after you upgrade the zone.
• The appliances on which you are deploying the update have at least 48 GB of memory.

December 3, 2019 IPC Confidential

 1.3: Upgrades that do not require new COP software 71

Tip
It is a best practice to make a note of the customer's dial patterns, route plans, recording profiles, and
scheduled backups before performing this procedure and to verify that they are the same in the upgraded
enterprise when the procedure is complete. If an enterprise backup is restored during the upgrade,
scheduled backups will need to be reconfigured if the date of the next scheduled event is before the date
the backup was restored. This is because the currently scheduled job will not run because the date is in
the past. For recurring jobs, this prevents the next occurrence from being scheduled.

Caution
An update is service-impacting when the COP software is upgraded, the system creates a rollback point
or reboots an appliance, or the update contains changes to the Media Gateways, turrets, Pulse devices,
or Soft Clients that require a reboot after the software is deployed. Review the Impacted RPMs tab within
the Software Deployment Install tab to determine the impacts of the update.
All upgrades should be performed only during a maintenance window when the zones being deployed
are not required to process calls or configuration requests.

This procedure requires a user account with the IPC Certified Tech role assigned.
1. Log in to the UMS with the appliance IP address: https://appliance_ip.
2. Determine the state of the zone by performing the procedures in the Post-Maintenance Validation Test
Suite. If you do not have access to this document, perform the procedure Validate a zone before an
upgrade, rollback, or other operations on page 636.
If the zone is not in a healthy state or there is not sufficient disk space available, resolve the issues
before you perform the upgrade, unless the upgrade is required to resolve the issues.
3. To prevent new hardware from registering with the zone during the upgrade, disable device
registration before you begin the upgrade by performing the procedure Disable device registration on
page 497.
4. If you are upgrading from Unigy v2.x to Unigy v3.0 or higher, perform the procedure Send SNMP
recovery alerts prior to an upgrade on page 564.
5. Click Tools ➤ Deployment ➤ Software Deployment.
6. In the Available Software Releases panel, confirm that the Status of all ISOs is installed. If an
ISO file is not installed, determine whether it should be installed before you deploy the new update.
The status not_installed indicates one of the following:
• If the zone in the Zone Name column is the local zone and the zone is a non-HA zone, the ISO is
uploaded to the appliance, but is not deployed.
• If the zone in the Zone Name column is the local zone and the zone is an HA zone, either the ISO
is not deployed on either appliance in the zone or it is deployed on one appliance, but not the other
appliance.
• If the zone in the Zone Name column is not the local zone, the ISO is not uploaded to the
appliances in the local zone, but is available in at least one other zone.
• If you deploy a patch or service pack after deploying a hotfix, the system changes the status of the
hotfix to not _installed, indicating that the hotfix RPMs were replaced by the corresponding
patch or service pack RPMs.
7. Upload the appliance personality update ISO file by performing the procedure Upload or download
an ISO file on page 547.

IPC Confidential Unigy 4.3

Enterprise Guide
72 1.3: Upgrades that do not require new COP software

8. Confirm that the ISO file is visible in the Available Software Releases panel and when you click the
file name, the Install Zone button is enabled and the Enterprise Install button is disabled.
9. If an OS patch that is more recent than the OS patch included in the appliance personality ISO file
you uploaded is available and you want the upgrade process to deploy the newer OS patch, perform
the procedure Upload or download an OS patch ISO file on page 146.
10. Within the Install tab, click the ISO file then review the following update information by clicking the
View Details icon ( ) and expanding each section:
• Within the Package Explorer tab, review the value in the Version column to determine the
software version for each package.
• Within the Release Contents tab, review the manifest information for the update.
• Within the Impacted RPMs tab, review the list of RPMs that will be upgraded to determine
whether any appliances or associated devices require a reboot after the software is deployed.
11. Place the appliance into maintenance mode by performing the procedure Place an appliance or
Media Gateway into maintenance mode to indicate it is unavailable on page 599.
12. Deploy the update by performing the procedure Deploy an ISO file on page 550.
13. After the deployment completes, monitor the state of the appliance until all processes are running by
performing the procedure Check the state of a zone from a browser on page 499.
14. Perform the procedure Confirm that an update was deployed on page 552.
15. Take the appliance out of maintenance mode by performing the procedure Take an appliance or
Media Gateway out of maintenance mode on page 600.
16. If the current software version requires a new enterprise license, install the license you obtained as
part of the prerequisites by performing the procedure Install an enterprise license file on page 481.
17. If you disabled device registration in step 3, enable it by performing the procedure Enable device
registration on page 496.
18. Deploy the updated software on the remaining devices in the zone, including Media Gateways,
turrets, Pulse devices, and Unigy Soft Clients, by performing the procedure Upgrade the software on
system devices on page 558.
19. Reconfigure the SMTP properties with the values you recorded in the prerequisites by performing the
procedure Configure an SMTP server on page 563.
20. If secure communications is enabled for third-party devices, such as PBXs, voice recorders, or
Session Border Controllers, and a self-signed certificate is used to secure the connections, perform
the procedure Upload a self-signed third-party certificate for secure communications on page 269.
21. Confirm that the dial patterns, route plans, recording profiles, and scheduled backups that were
configured in the previous version are present and correct.
22. Validate the zone you upgraded by performing the procedures in the Post-Maintenance Validation
Test Suite. If you do not have access to this document, perform the procedure Validate a zone after a
deployment, rollback, or other operations on page 638.
23. Confirm that a recurring Archive all Zone backup job and backup file retention policy are configured
for the zone. If this backup is not scheduled, perform the procedure Configure a recurring archive
backup job and retention policy on page 612.
This helps to prevent out of memory issues due to high volumes of call history data.
24. If applicable, do one or more of the following:

December 3, 2019 IPC Confidential

 1.3: Upgrades that do not require new COP software 73

• Upgrade the Unigy Soft Client software on the client computers by performing one of the
following procedures. If the customer does not use the Soft Client, it is not necessary to perform
this step.
• Upgrade the Unigy Soft Client software – Microsoft Windows 32-bit on page 630
• Upgrade the Unigy Soft Client software – Microsoft Windows 64-bit on page 628
• If you are implementing the System Logging and Information Collector (SLIC) feature to forward
customer log data to a data analytics engine such as Splunk, refer to the System Logging and
Information Collector Service Installation and Administration Guide. If the customer is not using
this feature or it is already implemented, it is not necessary to perform this task.
• Install and configure the Compliance Policy Engine to control access to lines and users. For
information on these procedures, refer to the Compliance Policy Engine Installation Guide and
Compliance Policy Engine Administration Guide. If the customer has not purchased the
Compliance Policy Engine or it is already installed, it is not necessary to perform this step.

Note
If you discover an issue with the upgrade that requires rolling back to the restore point created prior to the
upgrade, refer to Roll back the software on the appliance in a Unigy or Blue Wave standalone zone on
page 387.

1.3.3 Deploy a software update in a single HA zone enterprise

This procedure describes how to deploy a Unigy software update, that does not require upgrading the
Common Operating Platform (COP) software, in a single HA zone enterprise. An update can be a patch,
service pack, or hotfix.

Note
If the enterprise includes Blue Wave zones and any zones in the enterprise have a pre-Unigy v4.1
version deployed, upgrade the Blue Wave zones before you upgrade any Unigy zones. If all zones are at
Unigy v4.1 or higher, it is not necessary to upgrade the Blue Wave zones before the Unigy zones.
For information on upgrading Blue Wave zones, refer to Blue Wave upgrade workflows on page 114.

Note
Use this procedure only if a Single Click Deployment appliance is not available. For information on Single
Click Deployment, refer to Single Click Deployment (SCD) on page 149 and Deploy a software update
that requires a new COP with Single Click Deployment on page 31.

Within this topic, the terms current version and current software version refer to the Unigy software
version specified on the cover of this document. References to previous Unigy versions apply to the
versions, patches, service packs, and hotfixes for these versions that the current version supports.

Important
If the update you are deploying requires the deployment of new COP software, use the procedure Deploy
a software update with a new COP in a single zone enterprise – standalone or HA on page 41, which
applies to upgrades from Unigy pre-v3.0 versions to the current software version.

This procedure applies to the following types of upgrades:

• Upgrades from previous software versions that do not require deployment of new COP software.

IPC Confidential Unigy 4.3

Enterprise Guide
74 1.3: Upgrades that do not require new COP software

• Patches, service packs, or hotfixes for the current software version.

For information on the specific Unigy upgrade paths supported, refer to the UpgradePaths tab in the
Unigy Product Compatibility Matrix.
For information on upgrading Blue Wave zones, refer to Blue Wave upgrade workflows on page 114.
For additional information related to updates, refer to Unigy upgrade workflows on page 21, Patches,
service packs, and hotfixes on page 25, and Unigy software version naming convention on page 29.
Prerequisites:
Before you perform this procedure, confirm the following:
• You reviewed the following information:
• Unigy upgrade workflows on page 21
• Patches, service packs, and hotfixes on page 25
• Unigy Product Compatibility Matrix
• You have the new appliance personality software update ISO file. Updates are generally delivered on
a DVD, but might also be available on a network drive or other external data storage device.

Note
The ISO files for new versions, patches, and service packs are over 2.0 GBs in size, so if low band
width or slow file transfer rates caused by other factors is an issue, do one or both of the following to
ensure that a copy of the ISO file is available for upload or download prior to performing the upgrade:
• If you will be at the customer site, be sure the DVD is available or copy the ISO file to your laptop or
a flash drive.
• Copy the ISO file to a customer or IPC server from which you can download it to one of the Unigy
appliances. Perform the copy before you start the upgrade because it might take an hour or more to
complete. Refer to Download an ISO file when an upload or download fails on page 548.

• For Unigy v4.1 or higher, if an OS (operating system) patch that is more recent than the OS version
included in the appliance personality ISO file you are deploying is available and you want to deploy
this patch, you have access to the patch ISO file. You can get the file from the IPC FTP site,
FilesAnywhere. It can be burned to a DVD or copied to your laptop or an external data storage device.
• If the update requires a new enterprise license, you have the new license file for the customer.
• You have the SMTP configuration values for the enterprise. These are available at Configuration ➤
Enterprise ➤ SMTP. This data is not saved in the database, so it will be replaced with default values
during the upgrade. You will reconfigure SMTP after the upgrade. Record the values in the table in
SMTP configuration properties on page 564.
• If you are upgrading from a Unigy version prior to v2.0.1.6, you have the zone ID for each zone you
are upgrading. You will need this information to populate the prototype devices in each zone with the
updateMyPrototype.sh script following the upgrade. You can determine the zone IDs from
within the Install tab at Tools ➤ Deployment ➤ Software Deployment.
• You have access to the document Post-Maintenance Validation Test Suite, which is available on the
Tech Portal. This document provides a set of procedures you should perform to determine whether a
zone is in a healthy state before and after you upgrade the zone.
• The appliances on which you are deploying the update have at least 48 GB of memory.

December 3, 2019 IPC Confidential

 1.3: Upgrades that do not require new COP software 75

Tip
It is a best practice to make a note of the customer's dial patterns, route plans, recording profiles, and
scheduled backups before performing this procedure and to verify that they are the same in the upgraded
enterprise when the procedure is complete. If an enterprise backup is restored during the upgrade,
scheduled backups will need to be reconfigured if the date of the next scheduled event is before the date
the backup was restored. This is because the currently scheduled job will not run because the date is in
the past. For recurring jobs, this prevents the next occurrence from being scheduled.

You can deploy the update on one appliance at a time, or to minimize deployment time, on both
appliances simultaneously. If you deploy the appliances one at a time, deploy the update on the Standby
appliance first, then force an HA failover and deploy the update on the second appliance.

Caution
An update is service-impacting when the COP software is upgraded, the system creates a rollback point
or reboots an appliance, the procedure includes an HA failover (manual HA failovers are always
stateless), data replication is re-enabled, or the update contains changes to the Media Gateways, turrets,
Pulse devices, or Soft Clients that require a reboot after the software is deployed. Review the Impacted
RPMs tab within the Software Deployment Install tab to determine the impacts of the update.
All upgrades should be performed only during a maintenance window when the zones being deployed
are not required to process calls or configuration requests.

This procedure requires a user account with the IPC Certified Tech role assigned.
1. Log in to the UMS.
2. Determine the state of the zone by performing the procedures in the Post-Maintenance Validation Test
Suite. If you do not have access to this document, perform the procedure Validate a zone before an
upgrade, rollback, or other operations on page 636.
If the zone is not in a healthy state or there is not sufficient disk space available, resolve the issues
before you perform the upgrade, unless the upgrade is required to resolve the issues.
3. To prevent new hardware from registering with the zone during the upgrade, disable device
registration before you begin the upgrade by performing the procedure Disable device registration on
page 497.
4. If you are upgrading from Unigy v2.x to Unigy v3.0 or higher, perform the procedure Send SNMP
recovery alerts prior to an upgrade on page 564.
5. Click Tools ➤ Deployment ➤ Software Deployment.
6. In the Available Software Releases panel, confirm that the Status of all ISOs is installed. If an
ISO file is not installed, determine whether it should be installed before you deploy the new update.
The status not_installed indicates one of the following:
• If the zone in the Zone Name column is the local zone and the zone is a non-HA zone, the ISO is
uploaded to the appliance, but is not deployed.
• If the zone in the Zone Name column is the local zone and the zone is an HA zone, either the ISO
is not deployed on either appliance in the zone or it is deployed on one appliance, but not the other
appliance.

IPC Confidential Unigy 4.3

Enterprise Guide
76 1.3: Upgrades that do not require new COP software

• If the zone in the Zone Name column is not the local zone, the ISO is not uploaded to the
appliances in the local zone, but is available in at least one other zone.
• If you deploy a patch or service pack after deploying a hotfix, the system changes the status of the
hotfix to not _installed, indicating that the hotfix RPMs were replaced by the corresponding
patch or service pack RPMs.
7. Upload the appliance personality update ISO file by performing the procedure Upload or download
an ISO file on page 547.
8. Confirm that the ISO file is visible in the Available Software Releases panel and when you click the
file name, the Install Zone button is enabled and the Enterprise Install button is disabled.
9. If an OS patch that is more recent than the OS patch included in the appliance personality ISO file
you uploaded is available and you want the upgrade process to deploy the newer OS patch, perform
the procedure Upload or download an OS patch ISO file on page 146.
10. Within the Install tab, click the ISO file then review the following update information by clicking the
View Details icon ( ) and expanding each section:
• Within the Package Explorer tab, review the value in the Version column to determine the
software version for each package.
• Within the Release Contents tab, review the manifest information for the update.
• Within the Impacted RPMs tab, review the list of RPMs that will be upgraded to determine
whether any appliances or associated devices require a reboot after the software is deployed. When
you click the tab, the system downloads the update ISO file to the Standby appliance then displays
the impacted RPMs for both appliances. Confirm that the impact statements for both appliances
are displayed and the same RPMs are displayed for both. This might take several minutes. If the
RPM lists are not the same, wait one minute then refresh the list by re-clicking the ISO file name
then clicking the Impacted RPMs tab.
11. Place the cluster into maintenance mode by performing the procedure Place a cluster into
maintenance mode to enable control of HA failovers on page 598.
12. Place the Standby appliance into maintenance mode by performing the procedure Place an appliance
or Media Gateway into maintenance mode to indicate it is unavailable on page 599.
13. Deploy the update by performing the procedure Deploy an ISO file on page 550.

Note
When you click Install Zone to deploy the ISO, the Install dialog box is displayed with the Install the
update simultaneously on both servers in the zone check box selected. To automatically deploy the
update on the Active and Standby appliances, leave the check box at the default setting. To deploy the
update only on the Standby appliance, clear the Install the update simultaneously on both servers in the
zone check box.
If upgrading both appliances simultaneously fails before the software is deployed, clear the Install the
update simultaneously on both servers in the zone check box and attempt to upgrade one appliance at
a time.

14. After the deployment completes, monitor the state of the appliances in the zone until all processes are
running successfully by performing the procedure Check the state of a zone from a browser on page
499.
15. Confirm that the update was installed by performing the procedure Confirm that an update was
deployed on page 552.
16. Take the Standby appliance out of maintenance mode by performing the procedure Take an appliance
or Media Gateway out of maintenance mode on page 600.

December 3, 2019 IPC Confidential

 1.3: Upgrades that do not require new COP software 77

17. Indicate that the maintenance for the Standby appliance is complete by performing the procedure
Indicate that maintenance on the Standby appliance is complete on page 601.

Important
After you complete this step, if you selected the Install the update simultaneously on both servers in the
zone option in the Install dialog box in step 13, the software is deployed on both appliances, so you
should proceed directly to step 19. If you did not select this option, perform step 18 before performing
step 19.

18. If you are upgrading the appliances one at a time, do the following:
a) Force an HA failover to make the Active appliance the Standby appliance by performing the
procedure Force an HA failover on page 546.

Note
This is a stateless failover, so active calls are dropped.

b) Repeat steps 12 through 17 for the second appliance.

19. Take the cluster out of maintenance mode by performing the procedure Take a cluster out of
maintenance mode to resume normal HA operation on page 599.
20. If the current software version requires a new enterprise license, install the license you obtained as
part of the prerequisites by performing the procedure Install an enterprise license file on page 481.
21. If you disabled device registration in step 3, enable it by performing the procedure Enable device
registration on page 496.
22. Deploy the updated software on the remaining system devices, including Media Managers, Media
Gateways, turrets, Pulse devices, and Unigy Soft Clients by performing the procedure Upgrade the
software on system devices on page 558.
23. Reconfigure the SMTP properties with the values you recorded in the prerequisites by performing the
procedure Configure an SMTP server on page 563.
24. If secure communications is enabled for third-party devices, such as PBXs, voice recorders, or
Session Border Controllers, and a self-signed certificate is used to secure the connections, perform
the procedure Upload a self-signed third-party certificate for secure communications on page 269.
25. Confirm that the dial patterns, route plans, recording profiles, and scheduled backups that were
configured in the previous version are present and correct.
26. Validate the zone you upgraded by performing the procedures in the Post-Maintenance Validation
Test Suite. If you do not have access to this document, perform the procedure Validate a zone after a
deployment, rollback, or other operations on page 638.
27. If a recurring Archive all Zone backup job and backup file retention policy are not configured,
perform the procedure Configure a recurring archive backup job and retention policy on page 612.
This helps to prevent out of memory issues due to high volumes of call history data.
28. If applicable, do one or more of the following:
• Upgrade the Unigy Soft Client software on the client computers by performing one of the
following procedures. If the customer does not use the Soft Client, it is not necessary to perform
this step.
• Upgrade the Unigy Soft Client software – Microsoft Windows 32-bit on page 630
• Upgrade the Unigy Soft Client software – Microsoft Windows 64-bit on page 628

IPC Confidential Unigy 4.3

Enterprise Guide
78 1.3: Upgrades that do not require new COP software

• If you are implementing the System Logging and Information Collector (SLIC) feature to forward
customer log data to a data analytics engine such as Splunk, refer to the System Logging and
Information Collector Service Installation and Administration Guide. If the customer is not using
this feature or it is already implemented, it is not necessary to perform this task.
• Install and configure the Compliance Policy Engine to control access to lines and users. For
information on these procedures, refer to the Compliance Policy Engine Installation Guide and
Compliance Policy Engine Administration Guide. If the customer has not purchased the
Compliance Policy Engine or it is already installed, it is not necessary to perform this step.
If you discover an issue with the upgrade that requires rolling back to the restore point created prior to
the upgrade, refer to the procedure Roll back the software on the appliances in a Unigy or Blue Wave HA
zone from the UMS on page 389.

1.3.4 Deploy a software update in a multizone enterprise with Enterprise Install

In a multizone enterprise, you can deploy software updates one zone at a time to upgrade a peer zone or
when only a single zone needs to be upgraded, in parallel to manually upgrade multiple Unigy zones, or
through Enterprise Install or Single Click Deployment to automatically upgrade all, or a subset of zones.
This procedure describes how to deploy an update, that does not require upgrading the Common
Operating Platform (COP) software, with Enterprise Install. An update can be a patch, service pack, or
hotfix.

Note
If the enterprise includes Blue Wave zones and any zones in the enterprise have a pre-Unigy v4.1
version deployed, upgrade the Blue Wave zones before you upgrade any Unigy zones. If all zones are at
Unigy v4.1 or higher, it is not necessary to upgrade the Blue Wave zones before the Unigy zones.
For information on upgrading Blue Wave zones, refer to Blue Wave upgrade workflows on page 114.

Note
Use this procedure only if a Single Click Deployment appliance is not available. For information on Single
Click Deployment, refer to Single Click Deployment (SCD) on page 149.

Within this topic, the terms current version and current software version refer to the Unigy software
version specified on the cover of this document. References to previous Unigy versions apply to the
versions, patches, service packs, and hotfixes for these versions that the current version supports.
This procedure applies to the following types of upgrades:
• Upgrades from previous software versions that do not require deployment of new COP software.
• Patches, service packs, or hotfixes for the current software version.

December 3, 2019 IPC Confidential

 1.3: Upgrades that do not require new COP software 79

Important
If the update you are deploying requires the deployment of new COP software, refer to the following
procedures, which apply to upgrades from pre-Unigy v3.0 versions to the current software version.
• Deploy a software update that requires a new COP with Single Click Deployment on page 31
• Deploy a software update with a new COP in a multizone enterprise – subset of zones on page 46
• Deploy a software update with a new COP in a multizone enterprise – all zones on page 53
Upgrades to Unigy v3.0 or higher from pre-v3.0 versions include operating system and third-party
software updates that require redeployment of the COP software on each appliance that is being
upgraded. First time deployment of software on R640 appliances requires a new COP.

Note
After all zones in a multizone enterprise have been upgraded to Unigy v2.0.1 or higher, Enterprise Install
is generally the recommended upgrade method for all subsequent upgrades. However, you cannot use
Enterprise Install for upgrades that require a reCOP because Enterprise Install cannot deploy the new
COP software that is required for these upgrades. If a Single Click Deployment appliance is available,
use it for upgrades that require a reCOP. If a Single Click Deployment appliance is not available, use the
manual procedures for upgrades that require a new COP.

You cannot use Enterprise Install to upgrade Unigy v1.0, Unigy v2.0, or Blue Wave zones.
For an explanation of the Enterprise Install process, refer to Enterprise Install on page 85. The
procedure involves deploying the update software in a peer zone, then from the peer zone, deploying the
update in all remaining zones or a subset of the zones. The peer zone is the zone you upgrade first to
ensure that there is a stable zone with the latest software and database schema before you deploy the
remaining zones. You will run Enterprise Install from the peer zone after the zone is upgraded. Any zone
can serve as the peer zone; but the peer zone should have the highest software version and database
schema to ensure that no data is lost. If Multi-tier Replication is enabled, the peer zone should be an
active portal zone.
For information on the specific Unigy upgrade paths supported, refer to the UpgradePaths tab in the
Unigy Product Compatibility Matrix.
For information on upgrading Blue Wave zones, refer to Blue Wave upgrade workflows on page 114.
For additional information related to updates, refer to Unigy upgrade workflows on page 21, Patches,
service packs, and hotfixes on page 25, and Unigy software version naming convention on page 29.

Important
If you are upgrading the zones in a data center that has more than five zones, upgrade no more than five
zones at a time. After the upgrade of those zones completes, run the upgrade for the next set of zones.

If Enterprise Install fails for one or more zones, rerun it for each zone that failed.
Prerequisites:
Before you perform this procedure, confirm the following:
• You reviewed the following information:
• Unigy upgrade workflows on page 21
• Patches, service packs, and hotfixes on page 25

IPC Confidential Unigy 4.3

Enterprise Guide
80 1.3: Upgrades that do not require new COP software

• Unigy Product Compatibility Matrix

• You have the new appliance personality software update ISO file. Updates are generally delivered on
a DVD, but might also be available on a network drive or other external data storage device.

Note
The ISO files for new versions, patches, and service packs are over 2.0 GBs in size, so if low band
width or slow file transfer rates caused by other factors is an issue, do one or both of the following to
ensure that a copy of the ISO file is available for upload or download prior to performing the upgrade:
• If you will be at the customer site, be sure the DVD is available or copy the ISO file to your laptop or
a flash drive.
• Copy the ISO file to a customer or IPC server from which you can download it to one of the Unigy
appliances. Perform the copy before you start the upgrade because it might take an hour or more to
complete. Refer to Download an ISO file when an upload or download fails on page 548.

• For Unigy v4.1 or higher, if an OS (operating system) patch that is more recent than the OS version
included in the appliance personality ISO file you are deploying is available and you want to deploy
this patch, you have access to the patch ISO file. You can get the file from the IPC FTP site,
FilesAnywhere. It can be burned to a DVD or copied to your laptop or an external data storage device.
• If the update requires a new enterprise license, you have the new license file for the customer.
• You have the SMTP configuration values for the enterprise. These are available at Configuration ➤
Enterprise ➤ SMTP. This data is not saved in the database, so it will be replaced with default values
during the upgrade. You will reconfigure SMTP after the upgrade. Record the values in the table in
SMTP configuration properties on page 564.
• If you are upgrading from a Unigy version prior to v2.0.1.6, you have the zone ID for each zone you
are upgrading. You will need this information to populate the prototype devices in each zone with the
updateMyPrototype.sh script following the upgrade. You can determine the zone IDs from
within the Install tab at Tools ➤ Deployment ➤ Software Deployment.
• You have access to the document Post-Maintenance Validation Test Suite, which is available on the
Tech Portal. This document provides a set of procedures you should perform to determine whether a
zone is in a healthy state before and after you upgrade the zone.
• The appliances on which you are deploying the update have at least 48 GB of memory.
If Multi-tier Replication is enabled, it must be enabled for all data centers in the enterprise, or the data
centers must be members of the default data center, before you upgrade any of the zones. When you
upgrade the zones, upgrade the portal zones before the local zones because the portal zone serves as the
preferred zone for the local zones within a data center. To upgrade a portal zone, you must suspend
Multi-tier Replication for the associated data center. To avoid data loss when you upgrade a portal zone,
consider upgrading one appliance in the zone at a time so the zone remains active and available to
collect local zone data changes throughout the upgrade. For information on this upgrade procedure, refer
to Deploy a software update in a multizone enterprise one zone at a time on page 93. If you are
restoring an Enterprise database backup during the upgrade, restore the database to a portal zone. After
you upgrade the portal zone, resume Multi-tier Replication before you upgrade the Local zones. For
additional information on Multi-tier Replication, refer to Multi-tier Replication on page 229.

Important
If partial replication is enabled, collector zones must be upgraded before generator zones.

December 3, 2019 IPC Confidential

 1.3: Upgrades that do not require new COP software 81

Tip
It is a best practice to make a note of the customer's dial patterns, route plans, recording profiles, and
scheduled backups before performing this procedure and to verify that they are the same in the upgraded
enterprise when the procedure is complete. If an enterprise backup is restored during the upgrade,
scheduled backups will need to be reconfigured if the date of the next scheduled event is before the date
the backup was restored. This is because the currently scheduled job will not run because the date is in
the past. For recurring jobs, this prevents the next occurrence from being scheduled.

Caution
An update is service-impacting when the COP software is upgraded, the system creates a rollback point
or reboots an appliance, the procedure includes an HA failover (manual HA failovers are always
stateless), data replication is re-enabled, or the update contains changes to the Media Gateways, turrets,
Pulse devices, or Soft Clients that require a reboot after the software is deployed. Review the Impacted
RPMs tab within the Software Deployment Install tab to determine the impacts of the update.
All upgrades should be performed only during a maintenance window when the zones being deployed
are not required to process calls or configuration requests.

Note
After you click Continue to initiate the install, you cannot cancel the deployment.

This procedure requires a user account with the IPC Certified Tech role assigned.
1. Log in to the UMS in the peer zone with the zone VIP: https://vip.
2. Determine the state of the zones you are upgrading by performing the procedures in the Post-
Maintenance Validation Test Suite. If you do not have access to this document, perform the procedure
Validate a zone before an upgrade, rollback, or other operations on page 636.
If a zone is not in a healthy state or there is not sufficient disk space available, resolve the issues
before you perform the upgrade, unless the upgrade is required to resolve the issues.
3. If the zone you are upgrading is a Multi-tier Replication portal zone, place the associated data center
into the suspended state by performing the procedure Suspend or resume Multi-tier Replication on
page 247.
4. To prevent new hardware from registering with the zones during the upgrade, disable device
registration in each of the zones you are upgrading before you begin the upgrade by performing the
procedure Disable device registration on page 497.
5. If you are upgrading from Unigy v2.x to Unigy v3.0 or higher, perform the procedure Send SNMP
recovery alerts prior to an upgrade on page 564.
6. Confirm that data replication is enabled in all zones by performing the procedure Check the data
replication status for all zones in the enterprise on page 513. If replication is not enabled, enable it
by performing the procedure Enable data replication on page 497.
7. Click Tools ➤ Deployment ➤ Software Deployment.
8. In the Available Software Releases panel, confirm that the Status of all ISOs is installed. If an
ISO file is not installed, determine whether it should be installed before you deploy the new update.
The status not_installed indicates one of the following:

IPC Confidential Unigy 4.3

Enterprise Guide
82 1.3: Upgrades that do not require new COP software

• If the zone in the Zone Name column is the local zone and the zone is a non-HA zone, the ISO is
uploaded to the appliance, but is not deployed.
• If the zone in the Zone Name column is the local zone and the zone is an HA zone, either the ISO
is not deployed on either appliance in the zone or it is deployed on one appliance, but not the other
appliance.
• If the zone in the Zone Name column is not the local zone, the ISO is not uploaded to the
appliances in the local zone, but is available in at least one other zone.
• If you deploy a patch or service pack after deploying a hotfix, the system changes the status of the
hotfix to not _installed, indicating that the hotfix RPMs were replaced by the corresponding
patch or service pack RPMs.
9. Upload the appliance personality update ISO file by performing the procedure Upload or download
an ISO file on page 547.
10. Confirm that the update ISO file is visible in the Available Software Releases panel and when you
click the file, the Install Zone and Enterprise Install buttons are enabled.
11. If an OS patch that is more recent than the OS patch included in the appliance personality ISO file
you uploaded is available and you want the upgrade process to deploy the newer OS patch, perform
the procedure Upload or download an OS patch ISO file on page 146.
12. Within the Install tab, click the ISO file then review the following update information by clicking the
View Details icon ( ) and expanding each section:
• Within the Package Explorer tab, review the value in the Version column to determine the
upgrade version for each package.
• Within the Release Contents tab, review the manifest information for the update.
• Within the Impacted RPMs tab, review the list of RPMs that will be upgraded to determine
whether any appliances or associated devices require a reboot after the software is deployed. When
you click the tab, the system downloads the update ISO file to the Standby appliance then displays
the impacted RPMs for both appliances. Confirm that the impact statements for both appliances
are displayed and the same RPMs are displayed for both. This might take several minutes. If the
RPM lists are not the same, wait one minute then refresh the list by re-clicking the ISO file name
then clicking the Impacted RPMs tab.
13. In the Zone field in the top right corner of the panel, select each zone you are upgrading and confirm
that the update ISO file is in the Available Software Releases panel and the Impacted RPMs list is the
same for each appliance in each zone. If the ISO file is not uploaded on the appliances in the zone
you select, the system downloads the file when you click Impacted RPMs. This takes several
minutes.
14. Deploy the update in the peer zone by performing the procedure Deploy an ISO file on page 550.
Select the Automatic Deployment and Install the update simultaneously on both servers in the
zone check boxes.
15. After the deployment completes, monitor the state of the appliances in the zone until all processes are
running by performing the procedure Check the state of a zone from a browser on page 499.
16. Confirm that the update was deployed by performing the procedure Confirm that an update was
deployed on page 552.
17. If a new enterprise license is required, install the license you obtained as part of the prerequisites in
one of the zones by performing the procedure Install an enterprise license file on page 481.
18. Deploy the updated software on the other system devices, including Media Managers, Media
Gateways, turrets, Pulse devices, and Unigy Soft Clients, by performing the procedure Upgrade the
software on system devices on page 558.

December 3, 2019 IPC Confidential

 1.3: Upgrades that do not require new COP software 83

19. Validate the peer zone by performing the procedures in the Post-Maintenance Validation Test Suite. If
you do not have access to this document, perform the procedure Validate a zone after a deployment,
rollback, or other operations on page 638.
20. From the peer zone, deploy the update on the remaining zones by clicking the update ISO file within
the Install tab then clicking Enterprise Install.
After approximately one minute, the Enterprise wide Install panel is displayed showing all zones in
the enterprise, except the peer zone.
21. Select the check box for each zone you are upgrading.

Important
Upgrade only zones where the Health Check status is success and the current software version is
lower than the version you are deploying. Refer to the Software Version column for the current version.
Select a maximum of five zones at a time.

22. Select the following check boxes as applicable:

• Create a server backup image: This option creates an image backup (restore point, rollback
point) prior to deploying the update.

Note
You should always create the image backup so you have a restore point to roll back to if there is a
problem with the update.

• Remove the archive logs prior to backup: This option deletes archived log files before running
the update deployment to reduce the deployment time when the system creates the image backup
file. To retain the data without impacting the backup time, download the backup files prior to
deploying the update.
• Install OS Patch(patch version): This option instructs the deployment process to install the latest
OS patch during the application software upgrade. To install the patch, you must have uploaded the
OS patch ISO file in step 9. The version displayed is the OS patch version deployed on the zone
you are currently logged in to.
23. Click Continue.
The system starts the upgrade job and displays the message Install ISO Job Created
Successfully.
24. Click OK.
The deployment begins. No other actions are required until the deployment completes.
25. Monitor the state of the zones during the deployment:
• Approximately 15 minutes after the appliances reboot prior to the image backup you can monitor
the deployment by running the command tail -f /opt/ipc/deployment/log/
dunkin_deployment.log for patches and service packs or tail -f /opt/ipc/
deployment/log/hotfix_deployment.log for hotfixes. Output similar to the following
is displayed near the end of the file to indicate that the deployment is complete and the final
appliance reboot is in progress:
[Mon Feb 25 03:36:36 EST 2013] : === DONE ===== switch on orchestrator
chkconfig
[Mon Feb 25 03:36:36 EST 2013] : === DONE ===== switch
on orchestrator chkconfig
[Mon Feb 25 03:36:36 EST 2013] : START :
update_about_xml
[Mon Feb 25 03:36:36 EST 2013] : END :

IPC Confidential Unigy 4.3

Enterprise Guide
84 1.3: Upgrades that do not require new COP software

update_about_xml
[Mon Feb 25 03:36:36 EST 2013] : Sending Deployment
status update to CCM curl -X POST -uipccdi:
2fc608f4887cf73a54d0729a4b92777b671b1df2 -H "Content-Type:application/
xml" --data @/tmp/job_status_req.xml http://10.20.30.40/svc/deployment/
deploymentmgr/updatejob/33554604:33554605 adding index.html to apache
for DMS Client switch on orchestrator chkconfig
[Mon Feb 25 03:36:36 EST 2013] : Deployment Process
exiting with exit status 0
[Mon Feb 25 03:36:36 EST 2013] : !!! SYSTEM IS GOING
TO REBOOT AFTER INSTALL .... PLEASE WAIT... !!!!

• When the appliances reboot following the deployment, monitor the appliance services in each zone
until they are all running successfully by performing the procedure Check the state of a zone from
a browser on page 499.
26. Confirm that the upgrade completed successfully in each zone by performing the procedure Confirm
that an update was deployed on page 552.
27. If you disabled device registration in step 4, enable device registration in each zone you upgraded by
performing the procedure Enable device registration on page 496.
28. If you suspended Multi-tier Replication in step 3, resume it by performing the procedure Suspend or
resume Multi-tier Replication on page 247.
29. Deploy the update software on the remaining system devices in each zone you upgraded (except the
peer zone), including Media Managers, Media Gateways, turrets, Pulse devices, and Unigy Soft
Clients, by performing the procedure Upgrade the software on system devices on page 558. Perform
this procedure in all zones that you upgraded.
30. Reconfigure the SMTP properties with the values you recorded in the prerequisites by performing the
procedure Configure an SMTP server on page 563.
31. If secure communications is enabled for third-party devices, such as PBXs, voice recorders, or
Session Border Controllers, and a self-signed certificate is used to secure the connections, perform
the procedure Upload a self-signed third-party certificate for secure communications on page 269 for
each zone that communicates with the third-party devices.
32. Validate the zones you upgraded by performing the procedures in the Post-Maintenance Validation
Test Suite. If you do not have access to this document, perform the procedure Validate a zone after a
deployment, rollback, or other operations on page 638.
33. If a recurring Archive all Zone backup job and backup file retention policy are not configured for at
least one zone in each realm, perform the procedure Configure a recurring archive backup job and
retention policy on page 612 for a zone in each realm.
This helps to prevent out of memory issues due to high volumes of call history data. If partial
replication is enabled, the zone must be a collector zone.
34. If applicable, do one or more of the following:
• Enable partial replication by performing the procedure Enable partial replication on page 316.
This applies only to customers who use partial replication to reduce the volume of data that is
replicated throughout the enterprise. If the customer is not using partial replication or it is already
enabled, it is not necessary to perform this step.
• If you upgraded to Unigy v3.0.0.1 or higher, enable Multi-tier Replication to further reduce the
volume of data replicated, improve WAN resiliency, and increase scalability by performing the
procedure Enable Multi-tier Replication on page 243. If the customer is not using Multi-tier
Replication or it is already enabled, it is not necessary to perform this step.

December 3, 2019 IPC Confidential

 1.3: Upgrades that do not require new COP software 85

• Upgrade the Unigy Soft Client software on the client computers by performing one of the
following procedures. If the customer does not use the Soft Client, it is not necessary to perform
this step.
• Upgrade the Unigy Soft Client software – Microsoft Windows 32-bit on page 630
• Upgrade the Unigy Soft Client software – Microsoft Windows 64-bit on page 628
• If you are implementing the System Logging and Information Collector (SLIC) feature to forward
customer log data to a data analytics engine such as Splunk, refer to the System Logging and
Information Collector Service Installation and Administration Guide. If the customer is not using
this feature or it is already implemented, it is not necessary to perform this task.
• Install and configure the Compliance Policy Engine to control access to lines and users. For
information on these procedures, refer to the Compliance Policy Engine Installation Guide and
Compliance Policy Engine Administration Guide. If the customer has not purchased the
Compliance Policy Engine or it is already installed, it is not necessary to perform this step.

Note
If you discover an issue with the upgrade that requires rolling back to the restore point created prior to the
upgrade, refer to the procedure Roll back the software on the appliances in a Unigy or Blue Wave HA
zone from the UMS on page 389.

1.3.4.1 Enterprise Install

Enterprise Install enables you to deploy software updates in all zones, or a subset of zones, in an
enterprise through a simplified upgrade process that automatically performs basic validation, zone pre-
deployment, deployment, and post deployment functions that are manual steps in other upgrade
procedures.
For information on the Enterprise Install deployment procedure, refer to Deploy a software update in a
multizone enterprise with Enterprise Install on page 78

Note
If partial replication is enabled, collector zones must be at a software version that is equal to or greater
than the version deployed on the generator zones.

Peer zone
Before you deploy the update in all selected zones, deploy it in one zone, the peer zone, to ensure that
the enterprise database with the latest seed data and schema is available in a stable zone. From the peer
zone, you will start Enterprise Install, which deploys the update in all other zones that you select. Any
zone can serve as the peer zone; however, a zone with the highest database schema version is
recommended to ensure that all data is preserved.
Unigy V2.0 zones
Enterprise Install does not support Unigy v2.0 upgrades. To upgrade v2.0 zones to the current software
version, use one of the following procedures:
• Deploy a software update in a multizone enterprise one zone at a time on page 93
• Deploy a Unigy software update in parallel in a multizone enterprise on page 86
Health check tests
The system performs the following zone Health Check validation tests prior to displaying the list of
zones in the enterprise:

IPC Confidential Unigy 4.3

Enterprise Guide
86 1.3: Upgrades that do not require new COP software

• Determines whether each zone is available.

• Determines the role and state of each appliance in each zone. The role of Active appliances must be
ACTIVE and the state must be AVAILABLE. The role of Standby appliances must be STANDBY and
the state must be AVAILABLE. The appliances cannot be in maintenance mode.
If both tests pass, the Health Check status will be Success, otherwise it will be Failure. If the
Health Check status is Failure, the system displays the reason for the failure when you mouse over
the row for the failed zone. Failed zones should not be upgraded until the source of the problem is
identified and corrected.
Upgrade process
Enterprise Deployment does the following:
1. Performs the Health Check tests to determine the state of all zones prior to displaying the list of zones
in the enterprise.
2. Displays a list of all zones in the enterprise with a selection check box and their Health Check status
and software version.
3. After you select the zones to be upgraded and initiate the deployment, the Deployment Service
creates a job in the peer zone's local database for each selected zone. These jobs are replicated to the
other zones in the enterprise.
4. Creates a local Enterprise Watch job in the peer zone to track the status of the deployment. The
process polls the deployment status in each zone every two minutes. If the replication service fails to
replicate a job in any of the selected zones, the status of the respective job is set to FAIL and the
deployment for that zone is cancelled. Failure of one zone does not affect deployment of the other
zones.
5. Places the zone(s) into maintenance mode to prevent automatic BCP plan activation.
6. Places the zone(s) into maintenance mode to disable forwarding of alerts to the GSOC or other AFM
systems.
7. Places the cluster(s) into maintenance mode.
8. Places the Standby appliance(s) into maintenance mode.
9. Disables data replication.
10. Deploys the update.
11. Takes the zone(s) out of maintenance mode to enable automatic BCP plan activation.
12. Takes the zone(s) out of maintenance mode to enable forwarding of alerts to an AFM system.
13. Takes the Standby appliance(s) out of maintenance mode.
14. Indicates that maintenance is complete for the Standby appliance(s).
15. Takes the cluster(s) out of maintenance mode.
16. Enables data replication.

1.3.5 Deploy a Unigy software update in parallel in a multizone enterprise

In a multizone enterprise, you can deploy software updates one zone at a time to upgrade a peer zone or
when only a single zone needs to be upgraded, in parallel to manually upgrade multiple Unigy zones, or
through Enterprise Install or Single Click Deployment to automatically upgrade all, or a subset of zones.
This procedure describes how to deploy a Unigy software update, that does not require upgrading the

December 3, 2019 IPC Confidential

 1.3: Upgrades that do not require new COP software 87

Common Operating Platform (COP) software, in a multizone enterprise with the parallel upgrade option.
An update can be a patch, service pack, or hotfix.

Note
If the enterprise includes Blue Wave zones and any zones in the enterprise have a pre-Unigy v4.1
version deployed, upgrade the Blue Wave zones before you upgrade any Unigy zones. If all zones are at
Unigy v4.1 or higher, it is not necessary to upgrade the Blue Wave zones before the Unigy zones.
For information on upgrading Blue Wave zones, refer to Blue Wave upgrade workflows on page 114.

Note
Use this procedure only if a Single Click Deployment appliance is not available. For information on Single
Click Deployment, refer to Single Click Deployment (SCD) on page 149.

Within this topic, the terms current version and current software version refer to the Unigy software
version specified on the cover of this document. References to previous Unigy versions apply to the
versions, patches, service packs, and hotfixes for these versions that the current version supports.
This procedure applies to the following types of upgrades:
• Upgrades from previous software versions that do not require deployment of new COP software.
• Patches, service packs, or hotfixes for the current software version.

Important
If the update you are deploying requires the deployment of new COP software, refer to the following
procedures, which apply to upgrades from Unigy pre-v3.0 versions to the current software version.
• Deploy a software update that requires a new COP with Single Click Deployment on page 31
• Deploy a software update with a new COP in a multizone enterprise – subset of zones on page 46
• Deploy a software update with a new COP in a multizone enterprise – all zones on page 53
Upgrades to Unigy v3.0 or higher from pre-v3.0 versions include operating system and third-party
software updates that require redeployment of the COP software on each appliance that is being
upgraded. First time deployment of software on R640 appliances requires a new COP.

Note
After all zones in a multizone enterprise have been upgraded to Unigy v2.0.1 or higher, Enterprise Install
is generally the recommended upgrade method for all subsequent upgrades. However, you cannot use
Enterprise Install for upgrades that require a reCOP because Enterprise Install cannot deploy the new
COP software that is required for these upgrades. If a Single Click Deployment appliance is available,
use it for upgrades that require a reCOP. If a Single Click Deployment appliance is not available, use the
manual procedures for upgrades that require a new COP.

The procedure involves deploying the update software in a peer zone, then from the peer zone,
deploying the update in all remaining zones or a subset of the zones. The peer zone is the zone you
upgrade first to ensure that there is a stable zone with the latest software and database schema before
you deploy the remaining zones. Any zone can serve as the peer zone; but the peer zone should have the
highest software version and database schema to ensure that no data is lost. If Multi-tier Replication is
enabled, the peer zone should be an active portal zone.

IPC Confidential Unigy 4.3

Enterprise Guide
88 1.3: Upgrades that do not require new COP software

For information on the specific Unigy upgrade paths supported, refer to the UpgradePaths tab in the
Unigy Product Compatibility Matrix.
For information on upgrading Blue Wave zones, refer to Blue Wave upgrade workflows on page 114.
For additional information related to updates, refer to Unigy upgrade workflows on page 21, Patches,
service packs, and hotfixes on page 25, and Unigy software version naming convention on page 29.
With this type of upgrade, you deploy the update in one zone to establish a stable zone and database then
deploy it in all other zones that need to be upgraded. It is not necessary to wait for the deployment of
one zone (except the first zone) to complete before you upgrade the next zone. You can initiate the
upgrade for all of the remaining zones at any time; for example, you can initiate the upgrade of one
zone, then when the deployment starts, initiate the deployment of the next zone, or if more than one
deployment specialist is available, each can initiate the upgrade for different zones at the same time.
Prerequisites:
Before you perform this procedure, confirm the following:
• You reviewed the following information:
• Unigy upgrade workflows on page 21
• Patches, service packs, and hotfixes on page 25
• Unigy Product Compatibility Matrix
• You have the new appliance personality software update ISO file. Updates are generally delivered on
a DVD, but might also be available on a network drive or other external data storage device.

Note
The ISO files for new versions, patches, and service packs are over 2.0 GBs in size, so if low band
width or slow file transfer rates caused by other factors is an issue, do one or both of the following to
ensure that a copy of the ISO file is available for upload or download prior to performing the upgrade:
• If you will be at the customer site, be sure the DVD is available or copy the ISO file to your laptop or
a flash drive.
• Copy the ISO file to a customer or IPC server from which you can download it to one of the Unigy
appliances. Perform the copy before you start the upgrade because it might take an hour or more to
complete. Refer to Download an ISO file when an upload or download fails on page 548.

• For Unigy v4.1 or higher, if an OS (operating system) patch that is more recent than the OS version
included in the appliance personality ISO file you are deploying is available and you want to deploy
this patch, you have access to the patch ISO file. You can get the file from the IPC FTP site,
FilesAnywhere. It can be burned to a DVD or copied to your laptop or an external data storage device.
• If the update requires a new enterprise license, you have the new license file for the customer.
• You have the SMTP configuration values for the enterprise. These are available at Configuration ➤
Enterprise ➤ SMTP. This data is not saved in the database, so it will be replaced with default values
during the upgrade. You will reconfigure SMTP after the upgrade. Record the values in the table in
SMTP configuration properties on page 564.
• If you are upgrading from a Unigy version prior to v2.0.1.6, you have the zone ID for each zone you
are upgrading. You will need this information to populate the prototype devices in each zone with the
updateMyPrototype.sh script following the upgrade. You can determine the zone IDs from
within the Install tab at Tools ➤ Deployment ➤ Software Deployment.

December 3, 2019 IPC Confidential

 1.3: Upgrades that do not require new COP software 89

• You have access to the document Post-Maintenance Validation Test Suite, which is available on the
Tech Portal. This document provides a set of procedures you should perform to determine whether a
zone is in a healthy state before and after you upgrade the zone.
• The appliances on which you are deploying the update have at least 48 GB of memory.

Important
If partial replication is enabled, collector zones must be upgraded before generator zones, and Blue
Wave zones, which are always collector zones, must be upgraded before the Unigy collector zones.

If Multi-tier Replication is enabled, it must be enabled for all data centers in the enterprise, or the data
centers must be members of the default data center, before you upgrade any of the zones. When you
upgrade the zones, upgrade the portal zones before the local zones because the portal zone serves as the
preferred zone for the local zones within a data center. To upgrade a portal zone, you must suspend
Multi-tier Replication for the associated data center. To avoid data loss when you upgrade a portal zone,
consider upgrading one appliance in the zone at a time so the zone remains active and available to
collect local zone data changes throughout the upgrade. For information on this upgrade procedure, refer
to Deploy a software update in a multizone enterprise one zone at a time on page 93. If you are
restoring an Enterprise database backup during the upgrade, restore the database to a portal zone. After
you upgrade the portal zone, resume Multi-tier Replication before you upgrade the Local zones. For
additional information on Multi-tier Replication, refer to Multi-tier Replication on page 229.

Tip
It is a best practice to make a note of the customer's dial patterns, route plans, recording profiles, and
scheduled backups before performing this procedure and to verify that they are the same in the upgraded
enterprise when the procedure is complete. If an enterprise backup is restored during the upgrade,
scheduled backups will need to be reconfigured if the date of the next scheduled event is before the date
the backup was restored. This is because the currently scheduled job will not run because the date is in
the past. For recurring jobs, this prevents the next occurrence from being scheduled.

Caution
An update is service-impacting when the COP software is upgraded, the system creates a rollback point
or reboots an appliance, the procedure includes an HA failover (manual HA failovers are always
stateless), data replication is re-enabled, or the update contains changes to the Media Gateways, turrets,
Pulse devices, or Soft Clients that require a reboot after the software is deployed. Review the Impacted
RPMs tab within the Software Deployment Install tab to determine the impacts of the update.
All upgrades should be performed only during a maintenance window when the zones being deployed
are not required to process calls or configuration requests.

During this procedure, you disable data replication. If there is only one Unigy instance configured,
disable replication in all zones in the enterprise. If there are multiple instances configured, disable
replication only in the zones associated with the instance for which you are performing the upgrade.
If manual or automated configuration or other changes are made within a zone before data replication is
reenabled, those changes will be lost when the zone obtains a copy of the Unigy database after
replication is enabled. Job history records for the upgrade are also lost, so you should review the history
and log details before enabling replication.
This process deploys the update on both appliances in a zone simultaneously. Deploy the update in one
zone before you deploy it in parallel in all other zones. This ensures that there is a stable zone with the
new update and database schema before the other zones are upgraded.

IPC Confidential Unigy 4.3

Enterprise Guide
90 1.3: Upgrades that do not require new COP software

This procedure requires a user account with the IPC Certified Tech role assigned.
1. Log in to the UMS in each zone you are upgrading.
2. Determine the state of the zones you are upgrading by performing the procedures in the Post-
Maintenance Validation Test Suite. If you do not have access to this document, perform the procedure
Validate a zone before an upgrade, rollback, or other operations on page 636.
If a zone is not in a healthy state or there is not sufficient disk space available, resolve the issues
before you perform the upgrade, unless the upgrade is required to resolve the issues.
3. If the zone you are upgrading is a Multi-tier Replication portal zone, place the associated data center
into the suspended state by performing the procedure Suspend or resume Multi-tier Replication on
page 247.
4. To prevent new hardware from registering with the zones during the upgrade, disable device
registration in each of the zones you are upgrading before you begin the upgrade by performing the
procedure Disable device registration on page 497.
5. If you are upgrading from Unigy v2.x to Unigy v3.0 or higher, perform the procedure Send SNMP
recovery alerts prior to an upgrade on page 564.
6. In the first zone you are upgrading, click Tools ➤ Deployment ➤ Software Deployment.
7. In the Available Software Releases panel, confirm that the Status of all ISOs is installed. If an
ISO file is not installed, determine whether it should be installed before you deploy the new update.
The status not_installed indicates one of the following:
• If the zone in the Zone Name column is the local zone and the zone is a non-HA zone, the ISO is
uploaded to the appliance, but is not deployed.
• If the zone in the Zone Name column is the local zone and the zone is an HA zone, either the ISO
is not deployed on either appliance in the zone or it is deployed on one appliance, but not the other
appliance.
• If the zone in the Zone Name column is not the local zone, the ISO is not uploaded to the
appliances in the local zone, but is available in at least one other zone.
• If you deploy a patch or service pack after deploying a hotfix, the system changes the status of the
hotfix to not _installed, indicating that the hotfix RPMs were replaced by the corresponding
patch or service pack RPMs.
8. Upload the appliance personality update ISO file by performing the procedure Upload or download
an ISO file on page 547.
9. Confirm that the ISO file is visible in the Available Software Releases panel and when you click the
file name, the Install Zone and Enterprise Install buttons are enabled.
10. If an OS patch that is more recent than the OS patch included in the appliance personality ISO file
you uploaded is available and you want the upgrade process to deploy the newer OS patch, perform
the procedure Upload or download an OS patch ISO file on page 146.
11. Within the Install tab, click the ISO file then review the following update information by clicking the
View Details icon ( ) and expanding each section:
• Within the Package Explorer tab, review the value in the Version column to determine the
software version for each package.
• Within the Release Contents tab, review the manifest information for the update.
• Within the Impacted RPMs tab, review the list of RPMs that will be upgraded to determine
whether any appliances or associated devices require a reboot after the software is deployed. When
you click the tab, the system downloads the update ISO file to the Standby appliance then displays
the impacted RPMs for both appliances. Confirm that the impact statements for both appliances

December 3, 2019 IPC Confidential

 1.3: Upgrades that do not require new COP software 91

are displayed and the same RPMs are displayed for both. This might take several minutes. If the
RPM lists are not the same, wait one minute then refresh the list by re-clicking the ISO file name
then clicking the Impacted RPMs tab.
12. In the Zone field in the top right corner of the panel, select each zone you are upgrading and confirm
that the update ISO file is in the Available Software Releases panel and the Impacted RPMs list is the
same for each appliance in each zone. If the ISO file is not uploaded on the appliances in the zone
you select, the system downloads the file when you click Impacted RPMs. This takes several
minutes.
13. Disable data replication by performing the procedure Disable data replication on page 498:
• If the enterprise consists of a single Unigy instance, disable replication in all zones in the
enterprise.
• If the enterprise consists of multiple Unigy instances, disable replication only in the zones
associated with the instance for which you are performing the upgrade.
You can start with any zone.
14. Place each zone you are upgrading into maintenance mode by performing the following procedures:
• Disable SNMP forwarding for a zone on page 596.
• Place a zone into maintenance mode to disable BCP plan activation on page 597.
Start with the first zone in which you disabled data replication in step 13.
15. If you are not logged in to the zone that you will upgrade first, log in to the UMS in that zone.
16. Place the cluster into maintenance mode by performing the procedure Place a cluster into
maintenance mode to enable control of HA failovers on page 598.
17. Place the Standby appliance into maintenance mode by performing the procedure Place an appliance
or Media Gateway into maintenance mode to indicate it is unavailable on page 599.
18. Deploy the update by performing the procedure Deploy an ISO file on page 550.
Be sure that the Install the Update simultaneously on both servers in the zone check box is
selected.
19. After the deployment completes, monitor the state of the appliances in the zone until all services are
running successfully by performing the procedure Check the state of a zone from a browser on page
499.
20. Confirm that the update was installed by performing the procedure Confirm that an update was
deployed on page 552.
21. Take the Standby appliance out of maintenance mode by performing the procedure Take an appliance
or Media Gateway out of maintenance mode on page 600.
22. Indicate that the maintenance for the Standby appliance is complete by performing the procedure
Indicate that maintenance on the Standby appliance is complete on page 601.
23. Take the cluster out of maintenance mode by performing the procedure Take a cluster out of
maintenance mode to resume normal HA operation on page 599.
24. For each subsequent zone, log in to the UMS then repeat steps 16 through 23. It is not necessary to
wait for the deployment of one zone to complete before deploying the next zone; deploy the update in
all subsequent zones at the same time.
25. After all zones are upgraded, take the zones out of maintenance mode by performing the following
procedures:
• Take a zone out of maintenance mode to reenable BCP plan activation on page 598.

IPC Confidential Unigy 4.3

Enterprise Guide
92 1.3: Upgrades that do not require new COP software

• Reenable SNMP forwarding for a zone on page 596.

26. Enable data replication in one of the zones by performing the procedure Enable data replication on
page 497. If preferred zones are configured, the first zone should be a preferred zone. If Multi-tier
Replication is enabled, the first zone you enable should be a portal zone.
27. If you suspended Multi-tier Replication in step 3, resume it by performing the procedure Suspend or
resume Multi-tier Replication on page 247.
28. If you disabled device registration in step 4, enable device registration by performing the procedure
Enable device registration on page 496.
29. Repeat steps 26 through 28 for each remaining zone.

Note
Enable preferred zones before non-preferred zones, and if Multi-tier Replication is enabled, enable
portal zones before local zones.
Enable replication for one zone at a time. Wait for the replication to complete in one zone before you
enable replication for the next zone.

30. If a new enterprise license is required, install the license you obtained as part of the prerequisites in
the first zone you upgraded by performing the procedure Install an enterprise license file on page
481.
31. Deploy the updated software on the remaining system devices, including Media Managers, Media
Gateways, turrets, Pulse devices, and Unigy Soft Clients by performing the procedure Upgrade the
software on system devices on page 558 for each zone you upgraded.
32. Reconfigure the SMTP properties with the values you recorded in the prerequisites by performing the
procedure Configure an SMTP server on page 563.
33. If secure communications is enabled for third-party devices, such as PBXs, voice recorders, or
Session Border Controllers, and a self-signed certificate is used to secure the connections, perform
the procedure Upload a self-signed third-party certificate for secure communications on page 269 for
each zone that communicates with the third-party devices.
34. Validate the zones you upgraded by performing the procedures in the Post-Maintenance Validation
Test Suite. If you do not have access to this document, perform the procedure Validate a zone after a
deployment, rollback, or other operations on page 638.
35. If a recurring Archive all Zone backup job and backup file retention policy are not configured for at
least one zone in each realm, perform the procedure Configure a recurring archive backup job and
retention policy on page 612.
This helps to prevent out of memory issues due to high volumes of call history data. If partial
replication is enabled, the zone must be a collector zone.
36. If applicable, do one or more of the following:
• Enable partial replication by performing the procedure Enable partial replication on page 316.
This applies only to customers who use partial replication to reduce the volume of data that is
replicated throughout the enterprise. If the customer is not using partial replication or it is already
enabled, it is not necessary to perform this step.
• If you upgraded to Unigy v3.0.0.1 or higher, enable Multi-tier Replication to further reduce the
volume of data replicated, improve WAN resiliency, and increase scalability by performing the
procedure Enable Multi-tier Replication on page 243. If the customer is not using Multi-tier
Replication or it is already enabled, it is not necessary to perform this step.

December 3, 2019 IPC Confidential

 1.3: Upgrades that do not require new COP software 93

• Upgrade the Unigy Soft Client software on the client computers by performing one of the
following procedures. If the customer does not use the Soft Client, it is not necessary to perform
this step.
• Upgrade the Unigy Soft Client software – Microsoft Windows 32-bit on page 630
• Upgrade the Unigy Soft Client software – Microsoft Windows 64-bit on page 628
• If you are implementing the System Logging and Information Collector (SLIC) feature to forward
customer log data to a data analytics engine such as Splunk, refer to the System Logging and
Information Collector Service Installation and Administration Guide. If the customer is not using
this feature or it is already implemented, it is not necessary to perform this task.
• Install and configure the Compliance Policy Engine to control access to lines and users. For
information on these procedures, refer to the Compliance Policy Engine Installation Guide and
Compliance Policy Engine Administration Guide. If the customer has not purchased the
Compliance Policy Engine or it is already installed, it is not necessary to perform this step.

Note
If you discover an issue with the upgrade that requires rolling back to the restore point created prior to the
upgrade, refer to the procedure Roll back the software on the appliances in a Unigy or Blue Wave HA
zone from the UMS on page 389.

1.3.6 Deploy a software update in a multizone enterprise one zone at a time

In a multizone enterprise, you can deploy software updates one zone at a time to upgrade a peer zone or
when only a single zone needs to be upgraded, in parallel to manually upgrade multiple Unigy zones, or
through Enterprise Install or Single Click Deployment to automatically upgrade all, or a subset of zones.
This procedure describes how to deploy a Unigy software update, that does not require upgrading the
Common Operating Platform (COP) software, in a multizone enterprise one zone at a time. An update
can be a patch, service pack, or hotfix.

Note
If the enterprise includes Blue Wave zones and any zones in the enterprise have a pre-Unigy v4.1
version deployed, upgrade the Blue Wave zones before you upgrade any Unigy zones. If all zones are at
Unigy v4.1 or higher, it is not necessary to upgrade the Blue Wave zones before the Unigy zones.
For information on upgrading Blue Wave zones, refer to Blue Wave upgrade workflows on page 114.

Note
Use this procedure only if a Single Click Deployment appliance is not available. For information on Single
Click Deployment, refer to Single Click Deployment (SCD) on page 149.

Within this topic, the terms current version and current software version refer to the Unigy software
version specified on the cover of this document. References to previous Unigy versions apply to the
versions, patches, service packs, and hotfixes for these versions that the current version supports.
This procedure applies to the following types of upgrades:
• Upgrades from previous software versions that do not require deployment of new COP software.
• Patches, service packs, or hotfixes for the current software version.

IPC Confidential Unigy 4.3

Enterprise Guide
94 1.3: Upgrades that do not require new COP software

Important
If the update you are deploying requires the deployment of new COP software, refer to the following
procedures, which apply to upgrades from Unigy pre-v3.0 versions to the current software version.
• Deploy a software update that requires a new COP with Single Click Deployment on page 31
• Deploy a software update with a new COP in a multizone enterprise – subset of zones on page 46
• Deploy a software update with a new COP in a multizone enterprise – all zones on page 53
Upgrades to Unigy v3.0 or higher from pre-v3.0 versions include operating system and third-party
software updates that require redeployment of the COP software on each appliance that is being
upgraded. First time deployment of software on R640 appliances requires a new COP.

Note
After all zones in a multizone enterprise have been upgraded to Unigy v2.0.1 or higher, Enterprise Install
is generally the recommended upgrade method for all subsequent upgrades. However, you cannot use
Enterprise Install for upgrades that require a reCOP because Enterprise Install cannot deploy the new
COP software that is required for these upgrades. If a Single Click Deployment appliance is available,
use it for upgrades that require a reCOP. If a Single Click Deployment appliance is not available, use the
manual procedures for upgrades that require a new COP.

For information on the specific Unigy upgrade paths supported, refer to the UpgradePaths tab in the
Unigy Product Compatibility Matrix.
For information on upgrading Blue Wave zones, refer to Blue Wave upgrade workflows on page 114.
For additional information related to updates, refer to Unigy upgrade workflows on page 21, Patches,
service packs, and hotfixes on page 25, and Unigy software version naming convention on page 29.

Important
If the enterprise consists of multiple instances, upgrade one instance at a time.

Prerequisites:
Before you perform this procedure, confirm the following:
• You reviewed the following information:
• Unigy upgrade workflows on page 21
• Patches, service packs, and hotfixes on page 25
• Unigy Product Compatibility Matrix
• You have the new appliance personality software update ISO file. Updates are generally delivered on
a DVD, but might also be available on a network drive or other external data storage device.

December 3, 2019 IPC Confidential

 1.3: Upgrades that do not require new COP software 95

Note
The ISO files for new versions, patches, and service packs are over 2.0 GBs in size, so if low band
width or slow file transfer rates caused by other factors is an issue, do one or both of the following to
ensure that a copy of the ISO file is available for upload or download prior to performing the upgrade:
• If you will be at the customer site, be sure the DVD is available or copy the ISO file to your laptop or
a flash drive.
• Copy the ISO file to a customer or IPC server from which you can download it to one of the Unigy
appliances. Perform the copy before you start the upgrade because it might take an hour or more to
complete. Refer to Download an ISO file when an upload or download fails on page 548.

• For Unigy v4.1 or higher, if an OS (operating system) patch that is more recent than the OS version
included in the appliance personality ISO file you are deploying is available and you want to deploy
this patch, you have access to the patch ISO file. You can get the file from the IPC FTP site,
FilesAnywhere. It can be burned to a DVD or copied to your laptop or an external data storage device.
• If the update requires a new enterprise license, you have the new license file for the customer.
• You have the SMTP configuration values for the enterprise. These are available at Configuration ➤
Enterprise ➤ SMTP. This data is not saved in the database, so it will be replaced with default values
during the upgrade. You will reconfigure SMTP after the upgrade. Record the values in the table in
SMTP configuration properties on page 564.
• If you are upgrading from a Unigy version prior to v2.0.1.6, you have the zone ID for each zone you
are upgrading. You will need this information to populate the prototype devices in each zone with the
updateMyPrototype.sh script following the upgrade. You can determine the zone IDs from
within the Install tab at Tools ➤ Deployment ➤ Software Deployment.
• You have access to the document Post-Maintenance Validation Test Suite, which is available on the
Tech Portal. This document provides a set of procedures you should perform to determine whether a
zone is in a healthy state before and after you upgrade the zone.
• The appliances on which you are deploying the update have at least 48 GB of memory.
If you are deploying a post Unigy v3.0.0.1 update and Multi-tier Replication is enabled, it must be
enabled for all data centers in the enterprise before you upgrade any zones. Zones can be upgraded when
the associated data center is in either the enabled or suspended state. When you upgrade the zones, the
portal zones should be upgraded before the local zones because the portal zones serve as the preferred
zone for the local zones within a data center. If you are restoring the Enterprise database during the
upgrade, restore the database to a portal zone.

Important
If partial replication is enabled, collector zones must be upgraded before generator zones.

If Multi-tier Replication is enabled, it must be enabled for all data centers in the enterprise, or the data
centers must be members of the default data center, before you upgrade any of the zones. When you
upgrade the zones, upgrade the portal zones before the local zones because the portal zone serves as the
preferred zone for the local zones within a data center. To upgrade a portal zone, you must suspend
Multi-tier Replication for the associated data center. To avoid data loss when you upgrade a portal zone,
consider upgrading one appliance in the zone at a time so the zone remains active and available to
collect local zone data changes throughout the upgrade. For information on this upgrade procedure, refer
to Deploy a software update in a multizone enterprise one zone at a time on page 93. If you are restoring
an Enterprise database backup during the upgrade, restore the database to a portal zone. After you

IPC Confidential Unigy 4.3

Enterprise Guide
96 1.3: Upgrades that do not require new COP software

upgrade the portal zone, resume Multi-tier Replication before you upgrade the Local zones. For
additional information on Multi-tier Replication, refer to Multi-tier Replication on page 229.

Tip
It is a best practice to make a note of the customer's dial patterns, route plans, recording profiles, and
scheduled backups before performing this procedure and to verify that they are the same in the upgraded
enterprise when the procedure is complete. If an enterprise backup is restored during the upgrade,
scheduled backups will need to be reconfigured if the date of the next scheduled event is before the date
the backup was restored. This is because the currently scheduled job will not run because the date is in
the past. For recurring jobs, this prevents the next occurrence from being scheduled.

Caution
An update is service-impacting when the COP software is upgraded, the system creates a rollback point
or reboots an appliance, the procedure includes an HA failover (manual HA failovers are always
stateless), data replication is re-enabled, or the update contains changes to the Media Gateways, turrets,
Pulse devices, or Soft Clients that require a reboot after the software is deployed. Review the Impacted
RPMs tab within the Software Deployment Install tab to determine the impacts of the update.
All upgrades should be performed only during a maintenance window when the zones being deployed
are not required to process calls or configuration requests.

You can deploy the update on one appliance at a time, or to minimize deployment time, on both
appliances simultaneously. If you deploy the appliances one at a time, deploy the update on the Standby
appliance first, then force an HA failover and deploy the update on the second appliance. Perform this
procedure on the appliances in each zone you are upgrading.
If manual or automated configuration or other changes are made within a zone before data replication is
reenabled, those changes might be lost when the zone obtains a copy of the Unigy database after
replication is enabled. Job history records for the upgrade are also lost, so you should review the history
and log details before enabling replication.
This procedure requires a user account with the IPC Certified Tech role assigned.
1. Log in to the UMS in the first zone you are upgrading.
2. Determine the state of each of the zones you are upgrading by performing the procedures in the Post-
Maintenance Validation Test Suite. If you do not have access to this document, perform the procedure
Validate a zone before an upgrade, rollback, or other operations on page 636.
If a zone is not in a healthy state or there is not sufficient disk space available, resolve the issues
before you perform the upgrade, unless the upgrade is required to resolve the issues.
3. If the zone you are upgrading is a Multi-tier Replication portal zone, place the associated data center
into the suspended state by performing the procedure Suspend or resume Multi-tier Replication on
page 247.
4. To prevent new hardware from registering with the zones during the upgrade, disable device
registration in each of the zones you are upgrading before you begin the upgrade by performing the
procedure Disable device registration on page 497.
5. If you are upgrading from Unigy v2.x to Unigy v3.0 or higher, perform the procedure Send SNMP
recovery alerts prior to an upgrade on page 564.
6. Within the first zone you are upgrading, click Tools ➤ Deployment ➤ Software Deployment.
7. In the Available Software Releases panel, confirm that the Status of all ISOs is installed. If an
ISO file is not installed, determine whether it should be installed before you deploy the new update.
The status not_installed indicates one of the following:

December 3, 2019 IPC Confidential

 1.3: Upgrades that do not require new COP software 97

• If the zone in the Zone Name column is the local zone and the zone is a non-HA zone, the ISO is
uploaded to the appliance, but is not deployed.
• If the zone in the Zone Name column is the local zone and the zone is an HA zone, either the ISO
is not deployed on either appliance in the zone or it is deployed on one appliance, but not the other
appliance.
• If the zone in the Zone Name column is not the local zone, the ISO is not uploaded to the
appliances in the local zone, but is available in at least one other zone.
• If you deploy a patch or service pack after deploying a hotfix, the system changes the status of the
hotfix to not _installed, indicating that the hotfix RPMs were replaced by the corresponding
patch or service pack RPMs.
8. Upload the appliance personality update ISO file by performing the procedure Upload or download
an ISO file on page 547.
9. Confirm that the ISO file is visible in the Available Software Releases panel and when you click the
file name, the Install Zone button is enabled and the Enterprise Install button is disabled.
10. If an OS patch that is more recent than the OS patch included in the appliance personality ISO file
you uploaded is available and you want the upgrade process to deploy the newer OS patch, perform
the procedure Upload or download an OS patch ISO file on page 146.
11. Within the Install tab, click the ISO file then review the following update information by clicking the
View Details icon ( ) and expanding each section:
• Within the Package Explorer tab, review the value in the Version column to determine the
software version for each package.
• Within the Release Contents tab, review the manifest information for the update.
• Within the Impacted RPMs tab, review the list of RPMs that will be upgraded to determine
whether any appliances or associated devices require a reboot after the software is deployed. When
you click the tab, the system downloads the update ISO file to the Standby appliance then displays
the impacted RPMs for both appliances. Confirm that the impact statements for both appliances
are displayed and the same RPMs are displayed for both. This might take several minutes. If the
RPM lists are not the same, wait one minute then refresh the list by re-clicking the ISO file name
then clicking the Impacted RPMs tab.
12. In the Zone field in the top right corner of the panel, select each zone you are upgrading and confirm
that the update ISO file is in the Available Software Releases panel and the Impacted RPMs list is the
same for each appliance in each zone. If the ISO file is not uploaded on the appliances in the zone
you select, the system downloads the file to both appliances when you click Impacted RPMs. This
takes several minutes.
13. Disable data replication by performing the procedure Disable data replication on page 498:
• If the enterprise consists of a single Unigy instance, disable replication in all zones in the
enterprise.
• If the enterprise consists of multiple Unigy instances, disable replication only in the zones
associated with the instance for which you are performing the upgrade.
You can start with any zone.
14. Place each zone you are upgrading into maintenance mode and disable SNMP forwarding by
performing the following procedures:
• Disable SNMP forwarding for a zone on page 596.
• Place a zone into maintenance mode to disable BCP plan activation on page 597.
Start with the first zone in which you disabled data replication in step 13.

IPC Confidential Unigy 4.3

Enterprise Guide
98 1.3: Upgrades that do not require new COP software

15. Log in to the UMS in a zone you are upgrading.

16. Place the cluster into maintenance mode by performing the procedure Place a cluster into
maintenance mode to enable control of HA failovers on page 598.
17. Place the Standby appliance into maintenance mode by performing the procedure Place an appliance
or Media Gateway into maintenance mode to indicate it is unavailable on page 599.
18. Deploy the update by performing the procedure Deploy an ISO file on page 550.

Note
When you click Install Zone to deploy the ISO, the Install dialog box is displayed with the Install the
update simultaneously on both servers in the zone check box selected. To automatically deploy the
update on the Active and Standby appliances, leave the check box at the default setting. To deploy the
update only on the Standby appliance, clear the Install the update simultaneously on both servers in the
zone check box.
If upgrading both appliances simultaneously fails and the software is not deployed, clear the Install the
update simultaneously on both servers in the zone check box and attempt to upgrade one appliance at
a time.

19. After the deployment completes, monitor the state of the appliances in the zone until all services are
running successfully by performing the procedure Check the state of a zone from a browser on page
499.
20. Confirm that the update was installed by performing the procedure Confirm that an update was
deployed on page 552.
21. Take the Standby appliance out of maintenance mode by performing the procedure Take an appliance
or Media Gateway out of maintenance mode on page 600.
22. Indicate that the maintenance for the Standby appliance is complete by performing the procedure
Indicate that maintenance on the Standby appliance is complete on page 601.

Important
After you complete this step, if you selected the Install the update simultaneously on both servers in the
zone option in the Install dialog box in step 18, the software is deployed on both appliances, so you
should proceed directly to step 24. If you did not select this option, perform step 23 before performing
step 24.

23. If you are upgrading the appliances one at a time, do the following:
a) Force an HA failover to make the Active appliance the Standby appliance by performing the
procedure Force an HA failover on page 546.

Note
This is a stateless failover, so active calls are dropped.

b) Repeat steps 17 through 22 for the second appliance.

24. Take the cluster out of maintenance mode by performing the procedure Take a cluster out of
maintenance mode to resume normal HA operation on page 599.
25. Repeat steps 15 through 24 for each subsequent zone.
26. After all zones are upgraded, take the zones out of maintenance mode by performing the following
procedures:
• Take a zone out of maintenance mode to reenable BCP plan activation on page 598.

December 3, 2019 IPC Confidential

 1.3: Upgrades that do not require new COP software 99

• Reenable SNMP forwarding for a zone on page 596.

27. Enable data replication in one of the zones by performing the procedure Enable data replication on
page 497. If preferred zones are configured, the first zone should be a preferred zone. If Multi-tier
Replication is enabled, the first zone you enable should be a portal zone for the associated data center.
28. If you disabled device registration in step 4, enable device registration by performing the procedure
Enable device registration on page 496.
29. Repeat steps 27 and 28 for each remaining zone.

Note
Enable preferred zones before non-preferred zones, and if Multi-tier Replication is enabled, enable
portal zones before local zones.
Enable replication for one zone at a time. Wait for the replication to complete in one zone before you
enable replication for the next zone.

30. If a new enterprise license is required, install the license you obtained as part of the prerequisites in
one of the zones by performing the procedure Install an enterprise license file on page 481.
31. If you suspended Multi-tier Replication in step 3, resume it by performing the procedure Suspend or
resume Multi-tier Replication on page 247.
32. Deploy the updated software on the remaining devices in the zone, including Media Managers, Media
Gateways, turrets, Pulse devices, and Unigy Soft Clients by performing the procedure Upgrade the
software on system devices on page 558 for each zone you upgraded.
33. Reconfigure the SMTP properties with the values you recorded in the prerequisites by performing the
procedure Configure an SMTP server on page 563.
34. If secure communications is enabled for third-party devices, such as PBXs, voice recorders, or
Session Border Controllers, and a self-signed certificate is used to secure the connections, perform
the procedure Upload a self-signed third-party certificate for secure communications on page 269.
35. Validate the zones you upgraded by performing the procedures in the Post-Maintenance Validation
Test Suite. If you do not have access to this document, perform the procedure Validate a zone after a
deployment, rollback, or other operations on page 638.
36. If a recurring Archive all Zone backup job and backup file retention policy are not configured for at
least one zone in each realm, perform the procedure Configure a recurring archive backup job and
retention policy on page 612 for a zone in each realm.
This helps to prevent out of memory issues due to high volumes of call history data. If partial
replication is enabled, the zone must be a collector zone.
37. If applicable, do one or more of the following:
• Enable partial replication by performing the procedure Enable partial replication on page 316.
This applies only to customers who use partial replication to reduce the volume of data that is
replicated throughout the enterprise. If the customer is not using partial replication or it is already
enabled, it is not necessary to perform this step.
• If you upgraded to Unigy v3.0.0.1 or higher, enable Multi-tier Replication to further reduce the
volume of data replicated, improve WAN resiliency, and increase scalability by performing the
procedure Enable Multi-tier Replication on page 243. If the customer is not using Multi-tier
Replication or it is already enabled, it is not necessary to perform this step.
• Upgrade the Unigy Soft Client software on the client computers by performing one of the
following procedures. If the customer does not use the Soft Client, it is not necessary to perform
this step.

IPC Confidential Unigy 4.3

Enterprise Guide
100 1.4: Downgrade the software to a previous version

• Upgrade the Unigy Soft Client software – Microsoft Windows 32-bit on page 630
• Upgrade the Unigy Soft Client software – Microsoft Windows 64-bit on page 628
• If you are implementing the System Logging and Information Collector (SLIC) feature to forward
customer log data to a data analytics engine such as Splunk, refer to the System Logging and
Information Collector Service Installation and Administration Guide. If the customer is not using
this feature or it is already implemented, it is not necessary to perform this task.
• Install and configure the Compliance Policy Engine to control access to lines and users. For
information on these procedures, refer to the Compliance Policy Engine Installation Guide and
Compliance Policy Engine Administration Guide. If the customer has not purchased the
Compliance Policy Engine or it is already installed, it is not necessary to perform this step.

Note
If you discover an issue with the upgrade that requires rolling back to the restore point created prior to the
upgrade, refer to the procedure Roll back the software on the appliances in a Unigy or Blue Wave HA
zone from the UMS on page 389.

1.4 Downgrade the software to a previous version

If there is an issue with a software upgrade, you can roll back the software to a previous version.
Perform one or more of the following procedures to downgrade (roll back) the software:
• Restore a CCM, ACCM, or MM disk image from the command line on page 393
• Downgrade (roll back) the CDI software on page 562
• Downgrade the Media Gateway software on page 572

December 3, 2019 IPC Confidential

 101

2 Blue Wave deployment and upgrade

workflows
The topics in this chapter describe the procedures for initial Blue Wave zone deployments and Blue
Wave software upgrades.
The software deployed is the Blue Wave Director and Blue Wave Adapter software.
Review the following considerations before deploying the Blue Wave Director software:
• Prior to initial deployment, the appliances in each Blue Wave zone must have the Unigy COP
software deployed, the network configured, and the Unigy CCM or ACCM personality software
deployed.
• You can deploy the Blue Wave software in any zones in the enterprise, including the first zone that
was deployed.
• Prior to a software upgrade, if a Unigy upgrade is also required, deploy the Unigy upgrade before
deploying the Blue Wave upgrade.

Blue Wave zones

Blue Wave zones include the Blue Wave Director and Blue Wave Adapter software that routes call
processing and data retrieval requests between Blue Wave client applications and Unigy.
Unigy provides HA resiliency for these zones, but does not support load sharing or BCP zone
redirection; however, these functions can be provided through client applications. The Unigy enterprise
license dictates the type of HA (stateful or stateless) supported for the HA zones within an enterprise;
however, Blue Wave zones provide the same failover behavior for all zones. For information on this
behavior, refer to the Blue Wave API Developer’s Guide.
Two types of Blue Wave zones are available: co-located and dedicated Blue Wave.
Co-located zones
Co-location involves deployment of the Blue Wave software on an appliance that is also running the
Unigy software for configuration, management, and call processing.
These zones can include lines, CDIs (turrets, Pulse devices, and Unigy Soft Clients), Media Managers
(MMs), Media Gateways (MGs), Channel Banks (CBs), and Session Border Controllers (SBCs).
The Blue Wave and Unigy features are fully functional.
Dedicated Blue Wave zones
The appliances in a dedicated Blue Wave zone also have the Unigy and Blue Wave software deployed,
but they are used only for Blue Wave application support. They do not include lines, CDIs, Media
Managers, Media Gateways, Channel Banks, or Session Border Controllers.
Prior to Unigy v3.1, to avoid performance issues, Unigy and dedicated Blue Wave zones had to be
associated with separate instances. However, beginning with Unigy v3.1, these zones can be associated
with the same instance without a performance impact if the CDI Support and Line Support properties
for each Blue Wave zone are disabled at Configuration ➤ Enterprise ➤ System ➤ Zones.

IPC Confidential Unigy 4.3

Enterprise Guide
102 2.1: Blue Wave initial deployment workflows

You can deploy multiple dedicated Blue Wave zones within a Unigy enterprise that has a Standard or
Enterprise license.
Supported Blue Wave zone configurations
The following Blue Wave configurations are supported:

Personality Enterprise Single appliance HA zone Dedicated Co-located

type zone
ACCM Multizone X Yes Yes
ACCM Single zone X Yes Yes
ACCM Multizone X Yes Yes
ACCM Single zone X Yes Yes
CCM Multizone X Yes Yes
CCM Single zone X Yes Yes
CCM Multizone X No No
CCM Single zone X No No

2.1 Blue Wave initial deployment workflows

The workflows in this section describe the initial deployment of the Blue Wave Director software to
manage data and call processing requests from Blue Wave client applications.
The Blue Wave Director software is deployed on the appliance(s) in a zone to create a dedicated Blue
Wave zone that manages data and call processing requests from Blue Wave client applications or a co-
located zone that combines the functions of a Unigy zone for configuration and call processing and a
Blue Wave zone for managing Blue Wave client application requests.
These procedures assume that you have already deployed the Unigy software that serves as the
foundation on which the Blue Wave features operate. You can deploy the Blue Wave software as part of
the initial Unigy deployment or at any time after you deploy and configure a Unigy zone.
The following procedures are included in this section:
• Deploy the Blue Wave Director software in a single appliance zone on page 102
• Deploy the Blue Wave Director software on both appliances in an HA zone simultaneously on page
106
• Deploy the Blue Wave Director software in an HA zone one appliance at a time on page 109
For information on upgrading the Blue Wave software, refer to the following procedures:
• Deploy a Blue Wave software update in a single appliance zone on page 114
• Deploy a Blue Wave software update in an HA zone on both appliances simultaneously on page 116
• Deploy a Blue Wave software update in an HA zone one appliance at a time on page 120

2.1.1 Deploy the Blue Wave Director software in a single appliance zone
To support custom and third-party applications that use the Blue Wave APIs, deploy the Blue Wave
Director software on an appliance that will be used to route application requests from the applications to

December 3, 2019 IPC Confidential

 2.1: Blue Wave initial deployment workflows 103

Unigy zones for call processing. This topic describes how to deploy a Blue Wave Appliance in a single
appliance, non-HA zone.
For information on the different types of Blue Wave zones, refer to Blue Wave deployment and upgrade
workflows on page 101.
Prerequisites:
Prior to deploying the Blue Wave Director software, the following prerequisite procedures must be
complete for the Blue Wave Appliance:

Procedure Reference
Appliance hardware is installed (racked) and Common Appliance Platform Onsite Installation
connected to the network. Manual
Common Operating Platform (COP) software is Deploy the COP (Common Operating Platform)
deployed. software on page 448
This software is deployed by IPC Manufacturing
prior to appliance shipment, so deploy this
software only if the Unigy COP software is not
deployed.
Appliance network settings are configured. Configure the appliance network settings with
Network Configurator on page 450
Appliance personality software is deployed as a Deploy the appliance personality software with
CCM or ACCM appliance that is not part of an HA Personality Deployer on page 465
pair.
The zone is deployed. Co-located zone: Deploy the first or only zone with
Zone Deployer on page 489
Dedicated Blue Wave zone: Deploy subsequent
zones on page 495
You have the DVD for the latest Blue Wave
Director software or access to the ISO file on an
external data storage device.

This procedure requires a user account with the IPC Certified Tech role assigned.
1. Log in to the UMS in the zone in which you are deploying the Blue Wave software.
2. Confirm that the CDI Support and Line Support fields are configured properly.
a) Click Configuration ➤ Enterprise ➤ System ➤ Zones.
b) In the Zones list on the left, click the Blue Wave zone you are deploying.
c) Within the Trading section, confirm that the CDI Support and Line Support check boxes are
selected to enable this support. If they are not, select the check boxes then click Save.
3. Place the appliance into maintenance mode by performing the procedure Place an appliance or
Media Gateway into maintenance mode to indicate it is unavailable on page 599.
4. Click Tools ➤ Deployment ➤ Software Deployment.
5. In the Available Software Releases panel, confirm that the Status of all ISOs is installed. If an
ISO file is not installed, determine whether it should be installed before you deploy the new update.
The status not_installed indicates one of the following:

IPC Confidential Unigy 4.3

Enterprise Guide
104 2.1: Blue Wave initial deployment workflows

• If the zone in the Zone Name column is the local zone and the zone is a non-HA zone, the ISO is
uploaded to the appliance, but is not deployed.
• If the zone in the Zone Name column is the local zone and the zone is an HA zone, either the ISO
is not deployed on either appliance in the zone or it is deployed on one appliance, but not the other
appliance.
• If the zone in the Zone Name column is not the local zone, the ISO is not uploaded to the
appliances in the local zone, but is available in at least one other zone.
• If you deploy a patch or service pack after deploying a hotfix, the system changes the status of the
hotfix to not _installed, indicating that the hotfix RPMs were replaced by the corresponding
patch or service pack RPMs.
6. Upload the Blue Wave ISO file by performing the procedure Upload or download an ISO file on page
547.
7. Confirm that the update ISO file is visible in the Available Software Releases panel and when you
click the file, the Install Zone button is enabled and the Enterprise Install button is disabled.
8. Click the ISO file then review the following update information:
• Within the Package Explorer tab, review the value in the Version column to determine the
software version for each package.
• Within the Release Contents tab, review the manifest information.
• Within the Impacted RPMs tab, review the list of RPMs that will be upgraded to determine
whether any appliances or associated devices require a reboot after the software is deployed.
9. Deploy the software by performing the procedure Deploy an ISO file on page 550.
10. After the deployment completes, confirm that the application deployed properly by accessing the Web
Application Description Language (WADL) link for the Blue Wave Appliance:
a) If your browser is Microsoft Internet Explorer 8.0, enable the Compatibility Mode before viewing
the WADL page to ensure proper formatting of the website.
b) Within the browser, access http://ip/svc/bw/api/wadl, where ip is the IP address of the
appliance on which you deployed the Blue Wave Director software.
c) Confirm that the WADL page displays Summary, Grammars, and Resources sections for the Blue
Wave APIs. These sections include resource URIs, supported methods, and a brief description of
each API.

December 3, 2019 IPC Confidential

 2.1: Blue Wave initial deployment workflows 105

Figure 1: Blue Wave WADL output Summary section

Figure 2: Blue Wave WADL output Grammars and Resources sections

IPC Confidential Unigy 4.3

Enterprise Guide
106 2.1: Blue Wave initial deployment workflows

11. Take the appliance out of maintenance mode by performing the procedure Take an appliance or
Media Gateway out of maintenance mode on page 600.
12. Confirm that the CDI Support, Line Support, and Blue Wave Director Support check boxes are
selected. These are required for a co-located Blue Wave zone.
a) Log in to the UMS.
b) Click Configuration ➤ Enterprise ➤ System ➤ Zones.
c) In the Zones list on the left, click the zone you deployed.
d) Within the Trading section, confirm that the CDI Support, Line Support, and Blue Wave Director
Support check boxes are selected. If the CDI Support and Line Support check boxes are not
selected, select them then click Save. The system should have selected the Blue Wave Director
Support check box when the software was deployed. If the check box is not selected, contact IPC
Support.

Note
If you discover a problem with the deployment, roll back to the restore point that was created before the
software was deployed by performing the procedure Roll back the software on the appliance in a Unigy or
Blue Wave standalone zone on page 387.

2.1.2 Deploy the Blue Wave Director software on both appliances in an HA zone
simultaneously
To support custom and third-party applications that use the Blue Wave APIs, deploy the Blue Wave
Director software on appliances in zones that will be used to route application requests from the
applications to Unigy zones for data retrieval and call processing. This topic describes how to deploy the
Blue Wave Director software on both appliances in an HA zone simultaneously.

Important
This procedure applies to Blue Wave v2.0.1 or higher deployments.

For information on deploying the software on only one appliance in a zone or for an alternate procedure
if this procedure fails, refer to Deploy the Blue Wave Director software in an HA zone one appliance at a
time on page 109.
For information on the different types of Blue Wave zones, refer to Blue Wave deployment and upgrade
workflows on page 101.
Prerequisites:
Prior to deploying the Blue Wave Director software, the following prerequisite procedures must be
complete for the Blue Wave Appliances:

Procedure Reference
Appliance hardware is installed (racked) and Common Appliance Platform Onsite Installation
connected to the network. Manual
Common Operating Platform (COP) software is Deploy the COP (Common Operating Platform)
deployed. software on page 448
This software is deployed by IPC Manufacturing
prior to appliance shipment, so deploy the Unigy
COP software.

December 3, 2019 IPC Confidential

 2.1: Blue Wave initial deployment workflows 107

Procedure Reference
Appliance network settings are configured on both Configure the appliance network settings with
appliances. Network Configurator on page 450
Appliance personality software is deployed on both Deploy the appliance personality software with
appliances as a CCM or ACCM in an HA pair. Personality Deployer on page 465
The zone is deployed. Co-located zone: Deploy the first or only zone with
Zone Deployer on page 489
Dedicated Blue Wave zone: Deploy subsequent
zones on page 495
If you are deploying a dedicated Blue Wave zone, Add an instance on page 303
determine the instance the zone will be associated
with.
Prior to Unigy v3.1, Unigy and dedicated Blue
Wave zones could not be associated with the
same instance. With Unigy v3.1 or higher, these
zones can be associated with the same instance if
the CDI Support and Line Support fields in the zone
configuration are disabled.
You have the DVD for the latest Blue Wave
Director software or access to the ISO file on an
external data storage device.

This procedure deploys the software on both appliances in a zone simultaneously; however, unlike
Unigy parallel upgrades, you cannot deploy multiple Blue Wave zones at the same time. You must
complete the deployment of one zone before you begin the deployment of the next zone.
This procedure requires a user account with the IPC Certified Tech role assigned.
1. Log in to the UMS in the Blue Wave zone you are deploying https://vip.
2. Confirm that the CDI Support and Line Support fields are configured properly. If they are not,
change the values then click Save.
a) Click Configuration ➤ Enterprise ➤ System ➤ Zones.
b) In the Zones list, click the Blue Wave zone you are deploying.
c) Within the Trading section, confirm the following:
• If the zone is a co-located Blue Wave zone, the CDI Support and Line Support check boxes
should be selected to enable this support.
• If the zone is a dedicated Blue Wave zone, the CDI Support and Line Support check boxes
should be cleared to disable this support.
3. Determine the state of the zone by performing the procedures in the Post-Maintenance Validation Test
Suite. If you do not have access to this document, perform the procedure Validate a zone before an
upgrade, rollback, or other operations on page 636.
If a zone is not in a healthy state or there is not sufficient disk space available, resolve the issues
before you perform the upgrade, unless the upgrade is required to resolve the issues.
4. Click Tools ➤ Deployment ➤ Software Deployment.
5. In the Available Software Releases panel, confirm that the Status of all ISOs is installed,
especially any Unigy update that is required before you deploy the Blue Wave software. If an ISO file
is not installed, determine whether it should be installed before you deploy the software.

IPC Confidential Unigy 4.3

Enterprise Guide
108 2.1: Blue Wave initial deployment workflows

The status not_installed indicates one of the following:

• If the zone in the Zone Name column is the local zone and the zone is a non-HA zone, the ISO is
uploaded to the appliance, but is not deployed.
• If the zone in the Zone Name column is the local zone and the zone is an HA zone, either the ISO
is not deployed on either appliance in the zone or it is deployed on one appliance, but not the other
appliance.
• If the zone in the Zone Name column is not the local zone, the ISO is not uploaded to the
appliances in the local zone, but is available in at least one other zone.
• If you deploy a patch or service pack after deploying a hotfix, the system changes the status of the
hotfix to not _installed, indicating that the hotfix RPMs were replaced by the corresponding
patch or service pack RPMs.

6. Upload the ISO file by performing the procedure Upload or download an ISO file on page 547.
7. Confirm that the ISO is visible in the Available Software Releases panel and when you click the file
name, the Install Zone button is enabled.
Enterprise Install is not available for Blue Wave deployments or upgrades.
8. Within the Install tab, click the ISO file then review the following update information by clicking the
View Details icon ( ) and expanding each section:
• Within the Package Explorer tab, review the value in the Version column to determine the
upgrade version for each package.
• Within the Release Contents tab, review the manifest information for the update.
• Within the Impacted RPMs tab, review the list of RPMs that will be upgraded to determine
whether any appliances or associated devices require a reboot after the software is deployed. When
you click the tab, the system downloads the update ISO file to the Standby appliance then displays
the impacted RPMs for both appliances. Confirm that the impact statements for both appliances
are displayed and the same RPMs are displayed for both. This might take several minutes. If the
RPM lists are not the same, wait one minute then refresh the list by re-clicking the ISO file name
then clicking the Impacted RPMs tab.
9. Disable data replication for the Blue Wave zone you are deploying by performing the procedure
Disable data replication on page 498.
10. Place the zone into maintenance mode by performing the procedures Place a zone into maintenance
mode to disable BCP plan activation on page 597 and Disable SNMP forwarding for a zone on page
596.
11. Place the cluster into maintenance mode by performing the procedure Place a cluster into
maintenance mode to enable control of HA failovers on page 598.
12. Place the standby appliance into maintenance mode by performing the procedure Place an appliance
or Media Gateway into maintenance mode to indicate it is unavailable on page 599.
13. Deploy the software by performing the procedure Deploy an ISO file on page 550.
Be sure that the Install the Update simultaneously on both servers in the zone check box is
selected.
14. After the deployment completes, monitor the state of the appliances in the zone until all processes are
running by performing the procedure Check the state of a zone from a browser on page 499.
15. Take the standby appliance out of maintenance mode by performing the procedure Take an appliance
or Media Gateway out of maintenance mode on page 600.

December 3, 2019 IPC Confidential

 2.1: Blue Wave initial deployment workflows 109

16. Indicate that the maintenance for the Standalone appliance is complete by performing the procedure
Indicate that maintenance on the Standby appliance is complete on page 601.
17. Take the cluster out of maintenance mode by performing the procedure Take a cluster out of
maintenance mode to resume normal HA operation on page 599.
18. Take the zone out of maintenance mode by performing the procedures Take a zone out of
maintenance mode to reenable BCP plan activation on page 598 and Reenable SNMP forwarding for
a zone on page 596.
19. Determine whether the CDI Support, Line Support, and Blue Wave Director Support fields are
configured properly for the zone:
a) Log in to the UMS.
b) Click Configuration ➤ Enterprise ➤ System ➤ Zones.
c) In the Zones list, click the zone you deployed.
d) Within the Trading section, confirm the following. If the values are not correct, correct them then
click Save.
• If the zone is a co-located Blue Wave zone, confirm that the CDI Support and Line Support
check boxes are selected to enable this support.
• If the zone is a dedicated Blue Wave zone, confirm that the CDI Support and Line Support
check boxes are cleared to disable this support.
• The system should have selected the Blue Wave Director Support check box when the
software was deployed. If the check box is not selected, contact IPC Support.
20. Enable data replication in the zone by performing the procedure Enable data replication on page
497.
21. Confirm that the software was deployed by performing the procedure Confirm that an update was
deployed on page 552.
22. Validate the zone you deployed by performing the procedures in the Post-Maintenance Validation
Test Suite. If you do not have access to this document, perform the procedure Validate a zone after a
deployment, rollback, or other operations on page 638.
23. For each additional Blue Wave zone you are deploying, repeat steps 1 through 22.

Note
If you discover a problem with the deployment, roll back to the restore point that was created before the
software was deployed by performing the procedure Restore a CCM, ACCM, or MM disk image from the
command line on page 393.

2.1.3 Deploy the Blue Wave Director software in an HA zone one appliance at a time
To support custom and third-party applications that use the Blue Wave APIs, deploy the Blue Wave
Director software on appliances in zones that will be used to route application requests from the
applications to Unigy zones for call processing. This topic describes how to deploy the Blue Wave
Director software in an HA zone one appliance at a time.

Note
The preferred method for deploying the Blue Wave v2.0.1 or higher software in an HA zone is the
procedure Deploy the Blue Wave Director software on both appliances in an HA zone simultaneously on
page 106. This reduces the time and effort required to deploy a Blue Wave zone.

IPC Confidential Unigy 4.3

Enterprise Guide
110 2.1: Blue Wave initial deployment workflows

Use the procedure described in this topic if you are deploying the software on only one of the appliances
in a zone or if the simultaneous procedure fails. This procedure applies to Blue Wave v2.0.1 or higher.
For information on the different types of Blue Wave zones, refer to Blue Wave deployment and upgrade
workflows on page 101.
Prerequisites:
Prior to deploying the Blue Wave Director software, the following prerequisite procedures must be
complete for the Blue Wave Appliances:

Procedure Reference
Appliance hardware is installed (racked) and Common Appliance Platform Onsite Installation
connected to the network. Manual
Common Operating Platform (COP) software is Deploy the COP (Common Operating Platform)
deployed. software on page 448
This software is deployed by IPC Manufacturing
prior to appliance shipment, so deploy the Unigy
COP software only if it is not already deployed.
Appliance network settings are configured on both Configure the appliance network settings with
appliances. Network Configurator on page 450
Appliance personality software is deployed on both Deploy the appliance personality software with
appliances as a CCM or ACCM in an HA pair. Personality Deployer on page 465
The zone is deployed. Co-located zone: Deploy the first or only zone with
Zone Deployer on page 489
Dedicated Blue Wave zone: Deploy subsequent
zones on page 495
If you are deploying a dedicated Blue Wave zone, Add an instance on page 303
determine the instance the zone will be associated
with.
Prior to Unigy v3.1, Unigy and dedicated Blue
Wave zones could not be associated with the
same instance. With Unigy v3.1 or higher, these
zones can be associated with the same instance if
the CDI Support and Line Support fields in the zone
configuration are disabled.
You have the DVD for the latest Blue Wave
Director software or access to the ISO file on an
external data storage device.

For details on the fields and buttons in the UMS panels referenced in this procedure, refer to the online
help or the UMS UI Guide.
This procedure requires a user account with the IPC Certified Tech role assigned.

Important
The first appliance you deploy must be the Primary CCM or ACCM appliance in the HA pair. The Primary
appliance is the one with the lower IP address. Deploy the software on the Primary appliance then force
an HA failover and deploy the software on the Secondary appliance.

December 3, 2019 IPC Confidential

 2.1: Blue Wave initial deployment workflows 111

1. Log in to the UMS in the Blue Wave zone you are deploying https://vip.
2. Confirm that the CDI Support and Line Support fields are configured properly. If they are not,
change the values then click Save.
a) Click Configuration ➤ Enterprise ➤ System ➤ Zones.
b) In the Zones list, click the Blue Wave zone you are deploying.
c) Within the Trading section, confirm the following:
• If the zone is a co-located Blue Wave zone, the CDI Support and Line Support check boxes
should be selected to enable this support.
• If the zone is a dedicated Blue Wave zone, the CDI Support and Line Support check boxes
should be cleared to disable this support.
3. Determine the state of the zone by performing the procedures in the Post-Maintenance Validation Test
Suite. If you do not have access to this document, perform the procedure Validate a zone before an
upgrade, rollback, or other operations on page 636.
If a zone is not in a healthy state or there is not sufficient disk space available, resolve the issues
before you perform the upgrade, unless the upgrade is required to resolve the issues.
4. Confirm that the Primary appliance is the Standby appliance:
a) Click Configuration ➤ Sites ➤ Servers ➤ Clusters.
b) In the Clusters list, click the zone cluster.
c) Within the Members tab, determine which appliance has the STANDBY Role.
d) If you are not sure which appliance is the Primary appliance, click Check Status, review the IP
address in the Server property for the first appliance then scroll through the Cluster Operation
Output Details to locate the Server property for the second appliance. The appliance with the
lower IP address is the Primary appliance.
e) If the Primary appliance is not the Standby appliance, force an HA failover by performing the
procedure Force an HA failover on page 546.
f) After the failover completes, determine the status of the Standby appliance. If the Role is not
STANDBY and the State AVAILABLE, click the Standby appliance then click Rearm Server. Wait
for the rearm to complete. The Role should be STANDBY and the State should be AVAILABLE.
You can refresh the page by clicking the Properties tab then clicking the Members tab.
g) Click Check Status then confirm that the Primary appliance is the Standby appliance, the State
for both appliances is AVAILABLE, all services are running, and there are no errors.
5. Click Tools ➤ Deployment ➤ Software Deployment.
6. In the Available Software Releases panel, confirm that the Status of all ISOs is installed. If an
ISO file is not installed, determine whether it should be installed before you deploy the new update.
The status not_installed indicates one of the following:
• If the zone in the Zone Name column is the local zone and the zone is a non-HA zone, the ISO is
uploaded to the appliance, but is not deployed.
• If the zone in the Zone Name column is the local zone and the zone is an HA zone, either the ISO
is not deployed on either appliance in the zone or it is deployed on one appliance, but not the other
appliance.

IPC Confidential Unigy 4.3

Enterprise Guide
112 2.1: Blue Wave initial deployment workflows

• If the zone in the Zone Name column is not the local zone, the ISO is not uploaded to the
appliances in the local zone, but is available in at least one other zone.
• If you deploy a patch or service pack after deploying a hotfix, the system changes the status of the
hotfix to not _installed, indicating that the hotfix RPMs were replaced by the corresponding
patch or service pack RPMs.
7. Upload the Blue Wave ISO file by performing the procedure Upload or download an ISO file on page
547.
8. Confirm that the update ISO file is visible in the Available Software Releases panel and when you
click the file, the Install Zone button is enabled.
9. Within the Install tab, click the ISO file then review the following update information by clicking the
View Details icon ( ) and expanding each section:
• Within the Package Explorer tab, review the value in the Version column to determine the
upgrade version for each package.
• Within the Release Contents tab, review the manifest information for the update.
• Within the Impacted RPMs tab, review the list of RPMs that will be upgraded to determine
whether any appliances or associated devices require a reboot after the software is deployed. When
you click the tab, the system downloads the update ISO file to the Standby appliance then displays
the impacted RPMs for both appliances. Confirm that the impact statements for both appliances
are displayed and the same RPMs are displayed for both. This might take several minutes. If the
RPM lists are not the same, wait one minute then refresh the list by re-clicking the ISO file name
then clicking the Impacted RPMs tab.
10. Place the cluster into maintenance mode by performing the procedure Place a cluster into
maintenance mode to enable control of HA failovers on page 598.
11. Place the Standby appliance into maintenance mode by performing the procedure Place an appliance
or Media Gateway into maintenance mode to indicate it is unavailable on page 599.

Note
The Standby appliance must be the Primary appliance.

12. Deploy the software by performing the procedure Deploy an ISO file on page 550.
13. After the deployment completes, monitor the state of the appliances in the zone until all processes are
running by performing the procedure Check the state of a zone from a browser on page 499.
14. Take the Standby appliance out of maintenance mode by performing the procedure Take an appliance
or Media Gateway out of maintenance mode on page 600.
15. Indicate that the maintenance is complete for the appliance by performing the procedure Indicate that
maintenance on the Standby appliance is complete on page 601.
16. Take the cluster out of maintenance mode by performing the procedure Take a cluster out of
maintenance mode to resume normal HA operation on page 599.
17. Force an HA failover to make the Secondary appliance the Standby appliance by performing the
procedure Force an HA failover on page 546.
18. Rearm the Standby appliance by clicking the appliance then clicking Rearm Server.
Wait for the rearm to complete. The Role for the Secondary appliance should be STANDBY and the
State should be AVAILABLE. You can refresh the page by clicking the Properties tab then clicking
the Members tab.
19. Click Check Status then confirm that the Secondary appliance is the Standby appliance, the State for
both appliances is AVAILABLE, all services are running, and there are no errors.

December 3, 2019 IPC Confidential

 2.1: Blue Wave initial deployment workflows 113

20. Place the cluster into maintenance mode by performing the procedure Place a cluster into
maintenance mode to enable control of HA failovers on page 598.
21. Place the Standby appliance into maintenance mode by performing the procedure Place an appliance
or Media Gateway into maintenance mode to indicate it is unavailable on page 599.
22. Deploy the software by performing the procedure Deploy an ISO file on page 550.
23. After the deployment completes, monitor the state of the appliances in the zone until all processes are
running by performing the procedure Check the state of a zone from a browser on page 499.
24. Take the Standby appliance out of maintenance mode by performing the procedure Take an appliance
or Media Gateway out of maintenance mode on page 600.
25. Indicate that the maintenance is complete for the appliance by performing the procedure Indicate that
maintenance on the Standby appliance is complete on page 601.
26. Take the cluster out of maintenance mode by performing the procedure Take a cluster out of
maintenance mode to resume normal HA operation on page 599.
27. Reboot both appliances in the zone.
Reboot the Standby appliance then within no more than 15 seconds reboot the Active appliance.
a) Log in to both appliances through SSH.
b) On both appliances, run the command su -lp and enter the root user account password.
c) On the Standby appliance, run the reboot command.
d) On the Active appliance, run the reboot command.
Wait for both appliances to reboot.
28. Determine whether the CDI Support, Line Support, and Blue Wave Director Support fields are
configured properly for the zone:
a) Log in to the UMS.
b) Click Configuration ➤ Enterprise ➤ System ➤ Zones.
c) In the Zones list, click the zone you deployed.
d) Within the Trading section, confirm the following. If the values are not correct, correct them then
click Save.
• If the zone is a co-located Blue Wave zone, confirm that the CDI Support and Line Support
check boxes are selected to enable this support.
• If the zone is a dedicated Blue Wave zone, confirm that the CDI Support and Line Support
check boxes are cleared to disable this support.
• The system should have selected the Blue Wave Director Support check box when the
software was deployed. If the check box is not selected, contact IPC Support.
29. Confirm that the software was deployed by performing the procedure Confirm that an update was
deployed on page 552.
30. Validate the zone you deployed by performing the procedures in the Post-Maintenance Validation
Test Suite. If you do not have access to this document, perform the procedure Validate a zone after a
deployment, rollback, or other operations on page 638.

IPC Confidential Unigy 4.3

Enterprise Guide
114 2.2: Blue Wave upgrade workflows

Note
If you discover a problem with the deployment, roll back to the restore point that was created before the
software was deployed. If you deployed the software on only one appliance, perform the procedure Roll
back the software on the appliances in a Unigy or Blue Wave HA zone from the UMS on page 389. If you
deployed the software on both appliances, perform the procedure Restore a CCM, ACCM, or MM disk
image from the command line on page 393.

2.2 Blue Wave upgrade workflows

Periodically, IPC releases updates for the Blue Wave Director software, including patches, service packs,
and hot fixes, to apply software changes that fix defects or to add or enhance functionality. The topics in
this section describe the procedures for deploying updates to upgrade the software.
The following procedures are included:
• Deploy a Blue Wave software update in a single appliance zone on page 114.
• Deploy a Blue Wave software update in an HA zone on both appliances simultaneously on page 116.
This is the preferred procedure when you are upgrading both appliances in an HA zone.
• Deploy a Blue Wave software update in an HA zone one appliance at a time on page 120.

2.2.1 Deploy a Blue Wave software update in a single appliance zone

This procedure describes how to deploy a Blue Wave software update in a Blue Wave single appliance,
non-HA zone. An update can be a patch, service pack, or hotfix.
Prerequisites:

Note
If you are upgrading the Blue Wave zone(s) to v3.0 or higher from a pre-v3.0 version, the following are
required:
• The Unigy software for the zone must be version v4.0 or higher.
• The appliance you deploy the software on must be an R620 or higher appliance. R610s are not
supported for Unigy v4.0 or higher.
• When you deploy the Unigy software for the zone, you must deploy the new COP software, even if the
upgrade for a Unigy zone does not require a new COP. For example, if you are upgrading a Unigy
zone from v3.1.0.2 to v4.0, a COP upgrade is not required; however, you must deploy the COP for the
Blue Wave zones.
• If any zones in the enterprise have a pre-Unigy v4.1 version deployed, upgrade the Blue Wave zones
before you upgrade any Unigy zones. If all zones are at Unigy v4.1 or higher, it is not necessary to
upgrade the Blue Wave zones before the Unigy zones.

Before you perform this procedure:

• If a Unigy upgrade is also required, deploy the Unigy update before you deploy the Blue Wave
update. For information on Unigy upgrades, refer to Unigy upgrade workflows on page 21.
• Obtain the latest Blue Wave update ISO file. Updates are generally delivered on a DVD, but might
also be available on a network drive or other remote data storage device.

December 3, 2019 IPC Confidential

 2.2: Blue Wave upgrade workflows 115

Caution
An update is service-impacting when the COP software is upgraded, the system creates a rollback point
or reboots an appliance, or the update contains changes to the Media Gateways, turrets, Pulse devices,
or Soft Clients that require a reboot after the software is deployed. Review the Impacted RPMs tab within
the Software Deployment Install tab to determine the impacts of the update.
All upgrades should be performed only during a maintenance window when the zones being deployed
are not required to process calls or configuration requests.

This procedure requires a user account with the IPC Certified Tech role assigned.
1. Log in to the UMS with the appliance IP address: https://appliance_ip.
2. Confirm that the CDI Support and Line Support fields are configured properly.
a) Click Configuration ➤ Enterprise ➤ System ➤ Zones.
b) In the Zones list, click the Blue Wave zone you are upgrading.
c) Within the Trading section, confirm that the CDI Support and Line Support check boxes are
selected to enable this support. If they are not, select the check boxes then click Save.
3. Determine the state of the zone by performing the procedures in the Post-Maintenance Validation Test
Suite. If you do not have access to this document, perform the procedure Validate a zone before an
upgrade, rollback, or other operations on page 636.
If a zone is not in a healthy state or there is not sufficient disk space available, resolve the issues
before you perform the upgrade, unless the upgrade is required to resolve the issues.
4. Click Tools ➤ Deployment ➤ Software Deployment.
5. In the Available Software Releases panel, confirm that the Status of all ISOs is installed. If an
ISO file is not installed, determine whether it should be installed before you deploy the new update.
The status not_installed indicates one of the following:
• If the zone in the Zone Name column is the local zone and the zone is a non-HA zone, the ISO is
uploaded to the appliance, but is not deployed.
• If the zone in the Zone Name column is the local zone and the zone is an HA zone, either the ISO
is not deployed on either appliance in the zone or it is deployed on one appliance, but not the other
appliance.
• If the zone in the Zone Name column is not the local zone, the ISO is not uploaded to the
appliances in the local zone, but is available in at least one other zone.
• If you deploy a patch or service pack after deploying a hotfix, the system changes the status of the
hotfix to not _installed, indicating that the hotfix RPMs were replaced by the corresponding
patch or service pack RPMs.
6. Upload the update ISO file by performing the procedure Upload or download an ISO file on page
547.
7. Confirm that the update ISO file is visible in the Available Software Releases panel and when you
click the file, the Install Zone button is enabled.
8. Within the Install tab, click the ISO file then review the following update information by clicking the
View Details icon ( ) and expanding each section:
• Within the Package Explorer tab, review the value in the Version column to determine the
upgrade version for each package.
• Within the Release Contents tab, review the manifest information for the update.

IPC Confidential Unigy 4.3

Enterprise Guide
116 2.2: Blue Wave upgrade workflows

• Within the Impacted RPMs tab, review the list of RPMs that will be upgraded to determine
whether any appliances or associated devices require a reboot after the software is deployed. When
you click the tab, the system downloads the update ISO file to the Standby appliance then displays
the impacted RPMs for both appliances. Confirm that the impact statements for both appliances
are displayed and the same RPMs are displayed for both. This might take several minutes. If the
RPM lists are not the same, wait one minute then refresh the list by re-clicking the ISO file name
then clicking the Impacted RPMs tab.
9. Place the appliance into maintenance mode by performing the procedure Place an appliance or
Media Gateway into maintenance mode to indicate it is unavailable on page 599.
10. Deploy the update by performing the procedure Deploy an ISO file on page 550.
11. Monitor the state of the zone after the deployment completes by performing the procedure Check the
state of a zone from a browser on page 499.
12. Take the appliance out of maintenance mode by performing the procedure Take an appliance or
Media Gateway out of maintenance mode on page 600.
13. Confirm that the CDI Support, Line Support, and Blue Wave Director Support check boxes are
selected. These are required for a co-located Blue Wave zone.
a) Log in to the UMS.
b) Click Configuration ➤ Enterprise ➤ System ➤ Zones.
c) In the Zones list, click the zone you deployed.
d) Within the Trading section, confirm that the CDI Support, Line Support, and Blue Wave Director
Support check boxes are selected. If the CDI Support and Line Support check boxes are not
selected, select them then click Save. The system should have selected the Blue Wave Director
Support check box when the software was deployed. If the check box is not selected, contact IPC
Support.
14. After the zone is operational, confirm that the update was installed by performing the procedure
Confirm that an update was deployed on page 552.
15. Validate the zone you upgraded by performing the procedures in the Post-Maintenance Validation
Test Suite. If you do not have access to this document, perform the procedure Validate a zone after a
deployment, rollback, or other operations on page 638.

Note
If you discover a problem with the upgrade, roll back to the restore point that was created before the
update was deployed by performing the procedure Roll back the software on the appliance in a Unigy or
Blue Wave standalone zone on page 387.

2.2.2 Deploy a Blue Wave software update in an HA zone on both appliances simultaneously
When you deploy a Blue Wave update, you can upgrade one appliance at a time, or for Blue Wave
v2.0.1 or higher zones, both appliances simultaneously. This topic describes how to deploy a Blue Wave
Director software update on both appliances simultaneously. This is the preferred method for Blue Wave
v2.0.1 or higher upgrades. An update can be a patch, service pack, or hotfix.

December 3, 2019 IPC Confidential

 2.2: Blue Wave upgrade workflows 117

Note
If you are upgrading the Blue Wave zone(s) to v3.0 or higher from a pre-v3.0 version, the following are
required:
• The Unigy software for the zone must be version v4.0 or higher.
• The appliance you deploy the software on must be an R620 or higher appliance. R610s are not
supported for Unigy v4.0 or higher.
• When you deploy the Unigy software for the zone, you must deploy the new COP software, even if the
upgrade for a Unigy zone does not require a new COP. For example, if you are upgrading a Unigy
zone from v3.1.0.2 to v4.0, a COP upgrade is not required; however, you must deploy the COP for the
Blue Wave zones.
• If any zones in the enterprise have a pre-Unigy v4.1 version deployed, upgrade the Blue Wave zones
before you upgrade any Unigy zones. If all zones are at Unigy v4.1 or higher, it is not necessary to
upgrade the Blue Wave zones before the Unigy zones.

For information on upgrading the software on only one appliance in a zone or for an alternate procedure
if this procedure fails, refer to Deploy a Blue Wave software update in an HA zone one appliance at a
time on page 120.
Prerequisites:
Before you perform this procedure:
• If a Unigy upgrade is also required, deploy the Unigy update before you deploy the Blue Wave
update. For information on Unigy upgrades, refer to Unigy upgrade workflows on page 21.
• Obtain the latest Blue Wave update ISO file. Updates are generally delivered on a DVD, but might
also be available on a network drive or other remote data storage device.
• If Multi-tier Replication is enabled, it must be enabled for all data centers in the enterprise before you
upgrade any of the zones. If the Blue Wave zone being upgraded is a portal zone, the associated data
center must be moved to the suspended state. If the data center is the default data center, you must
make a different data center the default data center before you suspend the data center.
This procedure applies to dedicated Blue Wave and co-located zones.

Caution
An update is service-impacting when the COP software is upgraded, the system creates a rollback point
or reboots an appliance, the procedure includes an HA failover (manual HA failovers are always
stateless), data replication is re-enabled, or the update contains changes to the Media Gateways, turrets,
Pulse devices, or Soft Clients that require a reboot after the software is deployed. Review the Impacted
RPMs tab within the Software Deployment Install tab to determine the impacts of the update.
All upgrades should be performed only during a maintenance window when the zones being deployed
are not required to process calls or configuration requests.

This procedure deploys the update on both appliances in a zone simultaneously; however, unlike Unigy
parallel upgrades, you cannot upgrade multiple Blue Wave zones at the same time. You must complete
the upgrade of one zone before you begin the upgrade of the next zone.
This procedure requires a user account with the IPC Certified Tech role assigned.

IPC Confidential Unigy 4.3

Enterprise Guide
118 2.2: Blue Wave upgrade workflows

1. Log in to the UMS in the Blue Wave zone you are upgrading https://vip.
2. Confirm that the CDI Support and Line Support fields are configured properly. If they are not,
change the values then click Save.
a) Click Configuration ➤ Enterprise ➤ System ➤ Zones.
b) In the Zones list, click the Blue Wave zone you are deploying.
c) Within the Trading section, confirm the following:
• If the zone is a co-located Blue Wave zone, the CDI Support and Line Support check boxes
should be selected to enable this support.
• If the zone is a dedicated Blue Wave zone, the CDI Support and Line Support check boxes
should be cleared to disable this support.
3. Determine the state of the zone by performing the procedures in the Post-Maintenance Validation Test
Suite. If you do not have access to this document, perform the procedure Validate a zone before an
upgrade, rollback, or other operations on page 636.
If a zone is not in a healthy state or there is not sufficient disk space available, resolve the issues
before you perform the upgrade, unless the upgrade is required to resolve the issues.
4. If the zone you are upgrading is the portal zone for a data center, suspend Multi-tier Replication for
the associated data center by performing the procedure Suspend or resume Multi-tier Replication on
page 247.
5. Click Tools ➤ Deployment ➤ Software Deployment.
6. In the Available Software Releases panel, confirm that the Status of all ISOs is installed,
especially any Unigy update that is required for the Blue Wave update you are deploying. If an ISO
file is not installed, determine whether it should be installed before you deploy the new update.
The status not_installed indicates one of the following:
• If the zone in the Zone Name column is the local zone and the zone is a non-HA zone, the ISO is
uploaded to the appliance, but is not deployed.
• If the zone in the Zone Name column is the local zone and the zone is an HA zone, either the ISO
is not deployed on either appliance in the zone or it is deployed on one appliance, but not the other
appliance.
• If the zone in the Zone Name column is not the local zone, the ISO is not uploaded to the
appliances in the local zone, but is available in at least one other zone.
• If you deploy a patch or service pack after deploying a hotfix, the system changes the status of the
hotfix to not _installed, indicating that the hotfix RPMs were replaced by the corresponding
patch or service pack RPMs.

7. Upload the update ISO file by performing the procedure Upload or download an ISO file on page
547.
8. Confirm that the ISO is visible in the Available Software Releases panel and when you click the file
name, the Install Zone button is enabled.
Enterprise Install is not available for Blue Wave upgrades.
9. Within the Install tab, click the ISO file then review the following update information by clicking the
View Details icon ( ) and expanding each section:
• Within the Package Explorer tab, review the value in the Version column to determine the
upgrade version for each package.

December 3, 2019 IPC Confidential

 2.2: Blue Wave upgrade workflows 119

• Within the Release Contents tab, review the manifest information for the update.
• Within the Impacted RPMs tab, review the list of RPMs that will be upgraded to determine
whether any appliances or associated devices require a reboot after the software is deployed. When
you click the tab, the system downloads the update ISO file to the Standby appliance then displays
the impacted RPMs for both appliances. Confirm that the impact statements for both appliances
are displayed and the same RPMs are displayed for both. This might take several minutes. If the
RPM lists are not the same, wait one minute then refresh the list by re-clicking the ISO file name
then clicking the Impacted RPMs tab.
10. Disable data replication for the Blue Wave zone you are upgrading by performing the procedure
Disable data replication on page 498.
11. Place the zone into maintenance mode by performing the procedures Place a zone into maintenance
mode to disable BCP plan activation on page 597 and Disable SNMP forwarding for a zone on page
596.
12. Place the cluster into maintenance mode by performing the procedure Place a cluster into
maintenance mode to enable control of HA failovers on page 598.
13. Place the standby appliance into maintenance mode by performing the procedure Place an appliance
or Media Gateway into maintenance mode to indicate it is unavailable on page 599.
14. Deploy the update by performing the procedure Deploy an ISO file on page 550.
Be sure that the Install the Update simultaneously on both servers in the zone check box is
selected.
15. After the deployment completes, monitor the state of the appliances in the zone until all processes are
running by performing the procedure Check the state of a zone from a browser on page 499.
16. Take the standby appliance out of maintenance mode by performing the procedure Take an appliance
or Media Gateway out of maintenance mode on page 600.
17. Indicate that the maintenance for the Standalone appliance is complete by performing the procedure
Indicate that maintenance on the Standby appliance is complete on page 601.
18. Take the cluster out of maintenance mode by performing the procedure Take a cluster out of
maintenance mode to resume normal HA operation on page 599.
19. Take the zone out of maintenance mode by performing the procedures Take a zone out of
maintenance mode to reenable BCP plan activation on page 598 and Reenable SNMP forwarding for
a zone on page 596.
20. Determine whether the CDI Support, Line Support, and Blue Wave Director Support fields are
configured properly for the zone:
a) Log in to the UMS.
b) Click Configuration ➤ Enterprise ➤ System ➤ Zones.
c) In the Zones list, click the zone you deployed.
d) Within the Trading section, confirm the following. If the values are not correct, correct them then
click Save.
• If the zone is a co-located Blue Wave zone, confirm that the CDI Support and Line Support
check boxes are selected to enable this support.
• If the zone is a dedicated Blue Wave zone, confirm that the CDI Support and Line Support
check boxes are cleared to disable this support.
• The system should have selected the Blue Wave Director Support check box when the
software was deployed. If the check box is not selected, contact IPC Support.

IPC Confidential Unigy 4.3

Enterprise Guide
120 2.2: Blue Wave upgrade workflows

21. Enable data replication in the zone by performing the procedure Enable data replication on page
497.
22. If the zone you are upgrading is the portal zone for a data center, resume Multi-tier Replication for
the associated data center by performing the procedure Suspend or resume Multi-tier Replication on
page 247.
23. Confirm that the update was deployed by performing the procedure Confirm that an update was
deployed on page 552.
24. Validate the zone you upgraded by performing the procedures in the Post-Maintenance Validation
Test Suite. If you do not have access to this document, perform the procedure Validate a zone after a
deployment, rollback, or other operations on page 638.
25. For each additional Blue Wave zone you are upgrading, repeat steps 1 through 24.

Note
If you discover a problem with the upgrade, roll back to the restore point that was created before the
update was deployed by performing the procedure Restore a CCM, ACCM, or MM disk image from the
command line on page 393.

2.2.3 Deploy a Blue Wave software update in an HA zone one appliance at a time
When you deploy a Blue Wave update, you can upgrade one appliance at a time, or for Blue Wave
v2.0.1 or higher zones, both appliances simultaneously. This topic describes how to deploy a Blue Wave
Director software update in a Blue Wave HA zone one appliance at a time. An update can be a patch,
service pack, or hotfix.

Note
If you are upgrading the Blue Wave zone(s) to v3.0 or higher from a pre-v3.0 version, the following are
required:
• The Unigy software for the zone must be version v4.0 or higher.
• The appliance you deploy the software on must be an R620 or higher appliance. R610s are not
supported for Unigy v4.0 or higher.
• When you deploy the Unigy software for the zone, you must deploy the new COP software, even if the
upgrade for a Unigy zone does not require a new COP. For example, if you are upgrading a Unigy
zone from v3.1.0.2 to v4.0, a COP upgrade is not required; however, you must deploy the COP for the
Blue Wave zones.
• If any zones in the enterprise have a pre-Unigy v4.1 version deployed, upgrade the Blue Wave zones
before you upgrade any Unigy zones. If all zones are at Unigy v4.1 or higher, it is not necessary to
upgrade the Blue Wave zones before the Unigy zones.

Note
The preferred method for upgrading the Blue Wave v2.0.1 or higher software in an HA zone is the
procedure Deploy a Blue Wave software update in an HA zone on both appliances simultaneously on
page 116. This reduces the time and effort required to upgrade a Blue Wave zone.

Use the procedure described in this topic if you are deploying the software on only one of the appliances
in a zone or if the simultaneous procedure fails.
Prerequisites:

December 3, 2019 IPC Confidential

 2.2: Blue Wave upgrade workflows 121

Before you perform this procedure:

• If a Unigy upgrade is also required, deploy the Unigy update before you deploy the Blue Wave
update. For information on Unigy upgrades, refer to Unigy upgrade workflows on page 21.
• Obtain the latest Blue Wave update ISO file. Updates are generally delivered on a DVD, but might
also be available on a network drive or other remote data storage device.
• If Multi-tier Replication is enabled, it must be enabled for all data centers in the enterprise, or the data
centers must be members of the default data center, before you upgrade any of the zones. If the Blue
Wave zone being upgraded is a portal zone, the associated data center must be moved to the
suspended state. If the data center is the default data center, you must make a different data center the
default data center before you suspend the data center.
This procedure applies to dedicated Blue Wave and co-located zones.

Caution
An update is service-impacting when the COP software is upgraded, the system creates a rollback point
or reboots an appliance, the procedure includes an HA failover (manual HA failovers are always
stateless), data replication is re-enabled, or the update contains changes to the Media Gateways, turrets,
Pulse devices, or Soft Clients that require a reboot after the software is deployed. Review the Impacted
RPMs tab within the Software Deployment Install tab to determine the impacts of the update.
All upgrades should be performed only during a maintenance window when the zones being deployed
are not required to process calls or configuration requests.

Note
The first appliance you upgrade must be the Primary CCM or ACCM in the HA pair. The Primary
appliance is the one with the lower IP address. Deploy the software on the Primary appliance, force a
failover, then deploy the software on the Secondary appliance.
Data replication should be enabled in all zones during this upgrade.

This procedure requires a user account with the IPC Certified Tech role assigned.
1. Log in to the UMS with the zone VIP: https://vip.
2. Confirm that the CDI Support and Line Support fields are configured properly. If they are not,
change the values then click Save.
a) Click Configuration ➤ Enterprise ➤ System ➤ Zones.
b) In the Zones list, click the Blue Wave zone you are deploying.
c) Within the Trading section, confirm the following:
• If the zone is a co-located Blue Wave zone, the CDI Support and Line Support check boxes
should be selected to enable this support.
• If the zone is a dedicated Blue Wave zone, the CDI Support and Line Support check boxes
should be cleared to disable this support.
3. Determine the state of the zone by performing the procedures in the Post-Maintenance Validation Test
Suite. If you do not have access to this document, perform the procedure Validate a zone before an
upgrade, rollback, or other operations on page 636.
If a zone is not in a healthy state or there is not sufficient disk space available, resolve the issues
before you perform the upgrade, unless the upgrade is required to resolve the issues.

IPC Confidential Unigy 4.3

Enterprise Guide
122 2.2: Blue Wave upgrade workflows

4. If the zone you are upgrading is the portal zone for a data center, suspend Multi-tier Replication for
the associated data center by performing the procedure Suspend or resume Multi-tier Replication on
page 247.
5. Confirm that the Primary appliance is the Standby appliance:
a) Click Configuration ➤ Sites ➤ Servers ➤ Clusters.
b) In the Clusters list, click the zone cluster.
c) Within the Members tab, determine which appliance has the STANDBY Role.
d) If you are not sure which appliance is the Primary appliance, click Check Status, review the IP
address in the Server property for the first appliance then scroll through the Cluster Operation
Output Details to locate the Server property for the second appliance. The appliance with the
lower IP address is the Primary appliance.
e) If the Primary appliance is not the Standby appliance, force an HA failover by performing the
procedure Force an HA failover on page 546.
f) After the failover completes, determine the status of the Standby appliance. If the Role is not
STANDBY and the State AVAILABLE, click the Standby appliance then click Rearm Server. Wait
for the rearm to complete. The Role should be STANDBY and the State should be AVAILABLE.
You can refresh the page by clicking the Properties tab then clicking the Members tab.
g) Click Check Status then confirm that the Primary appliance is the Standby appliance, the State
for both appliances is AVAILABLE, all services are running, and there are no errors.
6. Click Tools ➤ Deployment ➤ Software Deployment.
7. In the Available Software Releases panel, confirm that the Status of all ISOs is installed. If an
ISO file is not installed, determine whether it should be installed before you deploy the new update.
The status not_installed indicates one of the following:
• If the zone in the Zone Name column is the local zone and the zone is a non-HA zone, the ISO is
uploaded to the appliance, but is not deployed.
• If the zone in the Zone Name column is the local zone and the zone is an HA zone, either the ISO
is not deployed on either appliance in the zone or it is deployed on one appliance, but not the other
appliance.
• If the zone in the Zone Name column is not the local zone, the ISO is not uploaded to the
appliances in the local zone, but is available in at least one other zone.
• If you deploy a patch or service pack after deploying a hotfix, the system changes the status of the
hotfix to not _installed, indicating that the hotfix RPMs were replaced by the corresponding
patch or service pack RPMs.
8. Upload the update ISO file by performing the procedure Upload or download an ISO file on page
547.
9. Confirm that the update ISO file is visible in the Available Software Releases panel and when you
click the file, the Install Zone button is enabled.
10. Within the Install tab, click the ISO file then review the following update information by clicking the
View Details icon ( ) and expanding each section:
• Within the Package Explorer tab, review the value in the Version column to determine the
upgrade version for each package.
• Within the Release Contents tab, review the manifest information for the update.
• Within the Impacted RPMs tab, review the list of RPMs that will be upgraded to determine
whether any appliances or associated devices require a reboot after the software is deployed. When

December 3, 2019 IPC Confidential

 2.2: Blue Wave upgrade workflows 123

you click the tab, the system downloads the update ISO file to the Standby appliance then displays
the impacted RPMs for both appliances. Confirm that the impact statements for both appliances
are displayed and the same RPMs are displayed for both. This might take several minutes. If the
RPM lists are not the same, wait one minute then refresh the list by re-clicking the ISO file name
then clicking the Impacted RPMs tab.
11. Place the cluster into maintenance mode by performing the procedure Place a cluster into
maintenance mode to enable control of HA failovers on page 598.
12. Place the Standby appliance into maintenance mode by performing the procedure Place an appliance
or Media Gateway into maintenance mode to indicate it is unavailable on page 599.

Note
The Standby appliance must be the Primary appliance.

13. Deploy the update by performing the procedure Deploy an ISO file on page 550.

Important
Clear the Install the update simultaneously on both servers in the zone check box.

14. After the deployment completes, monitor the state of the appliances in the zone until all processes are
running by performing the procedure Check the state of a zone from a browser on page 499.
15. Take the Standby appliance out of maintenance mode by performing the procedure Take an appliance
or Media Gateway out of maintenance mode on page 600.
16. Indicate that the maintenance for the appliance is complete by performing the procedure Indicate that
maintenance on the Standby appliance is complete on page 601.
17. Take the cluster out of maintenance mode by performing the procedure Take a cluster out of
maintenance mode to resume normal HA operation on page 599.
18. Force an HA failover to make the Secondary appliance the Standby appliance by performing the
procedure Force an HA failover on page 546.
The Standby appliance must be the Secondary appliance.
19. Rearm the Standby appliance by clicking the appliance then clicking Rearm Server.
After the rearm completes, the Role for the Standby appliance should be STANDBY and the State
should be AVAILABLE. You can refresh the page by clicking the Properties tab then clicking the
Members tab.
20. Click Check Status then confirm that the Secondary appliance is the Standby appliance, the State for
both appliances is AVAILABLE, all services are running, and there are no errors.
21. Place the cluster into maintenance mode by performing the procedure Place a cluster into
maintenance mode to enable control of HA failovers on page 598.
22. Place the Standby appliance into maintenance mode by performing the procedure Place an appliance
or Media Gateway into maintenance mode to indicate it is unavailable on page 599.
23. Deploy the software by performing the procedure Deploy an ISO file on page 550.
24. After the deployment completes, monitor the state of the appliances in the zone until all processes are
running by performing the procedure Check the state of a zone from a browser on page 499.
25. Take the Standby appliance out of maintenance mode by performing the procedure Take an appliance
or Media Gateway out of maintenance mode on page 600.
26. Indicate that the maintenance is complete for the appliance by performing the procedure Indicate that
maintenance on the Standby appliance is complete on page 601.

IPC Confidential Unigy 4.3

Enterprise Guide
124 2.2: Blue Wave upgrade workflows

27. Take the cluster out of maintenance mode by performing the procedure Take a cluster out of
maintenance mode to resume normal HA operation on page 599.
28. Reboot both appliances in the zone.
Reboot the Standby appliance then within no more than 15 seconds reboot the Active appliance.
a) Log in to both appliances through SSH.
b) On both appliances, run the command su -lp and enter the root user account password.
c) On the Standby appliance, run the reboot command.
d) On the Active appliance, run the reboot command.
Wait for both appliances to reboot.
29. Determine whether the CDI Support, Line Support, and Blue Wave Director Support fields are
configured properly for the zone:
a) Log in to the UMS.
b) Click Configuration ➤ Enterprise ➤ System ➤ Zones.
c) In the Zones list, click the zone you deployed.
d) Within the Trading section, confirm the following. If the values are not correct, correct them then
click Save.
• If the zone is a co-located Blue Wave zone, confirm that the CDI Support and Line Support
check boxes are selected to enable this support.
• If the zone is a dedicated Blue Wave zone, confirm that the CDI Support and Line Support
check boxes are cleared to disable this support.
• The system should have selected the Blue Wave Director Support check box when the
software was deployed. If the check box is not selected, contact IPC Support.
30. If the zone you are upgrading is the portal zone for a data center, resume Multi-tier Replication for
the associated data center by performing the procedure Suspend or resume Multi-tier Replication on
page 247.
31. Confirm that the update was deployed by performing the procedure Confirm that an update was
deployed on page 552.
32. Validate the zone you upgraded by performing the procedures in the Post-Maintenance Validation
Test Suite. If you do not have access to this document, perform the procedure Validate a zone after a
deployment, rollback, or other operations on page 638.

Note
If you discover a problem with the upgrade, roll back to the restore point that was created before the
update was deployed. If you upgraded the software on only one appliance, perform the procedure Roll
back the software on the appliances in a Unigy or Blue Wave HA zone from the UMS on page 389. If you
upgraded the software on both appliances, perform the procedure Restore a CCM, ACCM, or MM disk
image from the command line on page 393.

December 3, 2019 IPC Confidential

 125

3 OS patch upgrade workflows

3.1 OS patches
Beginning with Unigy v4.1, the appliance operating system (OS) for various IPC products can be
upgraded separately from the appliance personality software.
The Common Operating Platform (COP) is a hardened Red Hat Enterprise Linux (RHEL) operating
system that is used by IPC products including Unigy, Blue Wave, Compliance Policy Engine, and Unigy
360. In previous releases, operating system updates were tightly coupled with the appliance personality
software updates. This introduced delays in delivering operating system and security updates because
they could not be delivered until a new product version or patch was available. OS patching removes
this dependency and provides the opportunity to deliver OS upgrades as needed.
It is not necessary to deploy an OS patch in all zones within the enterprise at the same time, however, for
security reasons, all zones should be upgraded as soon as possible. Zone interoperability is not impacted
by different OS patch versions.
You can install an OS patch in the following ways:
• UMS: For Unigy and Blue Wave CCM, ACCM, and MM appliances, you can deploy OS patches
from the OS Patch tab at Tools ➤ Deployment ➤ Software Deployment. Options are available for
upgrading one appliance or one zone at a time (OS Install Zone) or multiple zones simultaneously
(OS Enterprise Install).
• Appliance upgrade: When you deploy a Unigy appliance personality update, the OS patch that was
available at the time the update was released is included in the appliance personality ISO file and can
be deployed along with the personality update. If subsequent OS patches are released after the Unigy
appliance personality update was released, you can upload the most recent OS patch ISO file then
indicate to the upgrade script that you want it to install the newer OS patch by selecting the Install OS
Patch(patch version) check box within the Software Deployment Install or Enterprise wide Install
panels. For example, if the version of the OS patch included with the appliance personality ISO file
you are deploying is version 06.00.00.02.0012, but you are installing the application update three
months after it was released and the latest OS patch is now 06.00.00.05.0015, upload the
06.00.00.05.0015 ISO file then select the Install OS Patch(patch version) check box to install the
newer OS patch during the appliance upgrade. After installing the OS patch on the CCM or ACCM
appliances, you install the OS patch on the Media Managers from the Software Deployment Deploy
tab.
• Command line: For all applicable IPC products, you can deploy OS patches by running command
line scripts that install or update the installer RPM, copy the OS RPMs to the proper location, and
perform the installation. Use this option only if you cannot use one of the previous options.
An OS patch does not perform a reCOP; that is, it does not reformat and repartition the drives and
redeploy all of the software and database on an appliance, but simply applies operating system and
security updates.
OS patches are cumulative, so it is not necessary to install multiple OS patches to get all applicable
updates. Installing the latest update includes all previous updates.
An OS patch is delivered as part of an appliance personality update ISO file or as a separate ISO 9660
image that can be stored on a laptop or network drive or burned to a DVD. The name of the ISO file is
ipc_os_patch_os-patch-version.iso, where os-patch-version is the version of the

IPC Confidential Unigy 4.3

Enterprise Guide
126 3.1: OS patches

ISO file. For information on the OS patch version naming convention, refer to OS patch naming
convention on page 130.
You can see the OS patch version that is deployed on the appliances in a zone from the following
sources:
• UMS Login panel. Refer to the OS Patch Version line.
• About panel: Access this panel by clicking the About option in the UMS menu bar. Refer to the OS
Patch Version line.
• OS Patch tab: Access this tab by clicking Tools ➤ Deployment ➤ Software Deployment. Refer to
the Version column. The tab displays the version of the latest OS patch ISO file that was installed,
and if applicable, the latest file uploaded, but not installed from within the OS Patch tab. It also
displays the version of OS patch RPMs that are bundled with the latest appliance personality software
ISO that was uploaded and deployed within the Install tab.
• Enterprise Watch: Access this utility with one of the options below. Refer to the HW-SW test.
• Perform the procedure Analyze an enterprise with Enterprise Watch on page 643. For Unigy v4.0
or higher, before you access Enterprise Watch, perform the procedure Enable or disable WebLogic,
SWMS, and Enterprise Watch Web link access on page 337.
• From a Single Click Deployment (SCD appliance, click Enterprise Watch in the Main Menu.
• Automated Health Check: To access this information, perform the procedure Run automated health
check from the command line on page 639. Refer to the CCM VIP: CCM Software Version test. For
details on the Automated Health Check tests, refer to the Automated Health Check Guide.
• Hostinfo command: Run the hostinfo command from the command line on any appliance. Refer
to the OS Patch Version line.
• Vitals: Run the vitals command from the command line on any appliance. Refer to the HW_SW
test.
An OS patch ISO file includes the following components:

Component File Description Location

type
cpms.sh Script COP Patch Management Subsystem (CPMS) Within the
script that Installs or updates the OS patch ISO file
installer RPM and calls the installer script,
which prepares the OS patch RPM for
installation, and removes previous OS patch
RPMs.
ipc-os-patch-installer- RPM OS patch installer package, which includes the /tmp
installer-version.rpm installation script and command line interface
(CLI) API.
ipc-os-patch-os-patch- RPM OS patch package, which Includes the RHEL /opt/ipc/cop/
version-rpm-version- operating system RPMs that will be installed or patch
i386.rpm updated. More than one RPM might be
included.

Scripts
The following scripts are used in the OS patch process:
• cpms.sh

December 3, 2019 IPC Confidential

 3.1: OS patches 127

The cpms.sh script does the following:

• Installs or updates the ipc-os-patch-installer-installer-version.rpm file in
the /tmp/coppatch directory on the platform.
• Calls the os_patch.sh script to copy the appropriate OS patch RPM file for the current RHEL
version to the /opt/ipc/cop/patch directory on the appliance, making it available for
installation.
• If you specify the install option when you run the script, it calls the os_patch.sh script to
install the OS patch RPMs.
The script has the following usage:
cpms.sh option
The following options are available:
• copy: Installs or updates the OS patch installer and copies the OS patch RPM to the /tmp
directory in the appliance file system, but does not install the patch.
• install: Installs or updates the OS patch installer and copies the OS patch RPM to the appliance
file system then installs the patch. This is the default action if you do not specify an option.
• os_patch.sh
The OS patch management script, os_patch.sh, copies, installs, validates, and provides status for
the OS patch materials. It is called by the osPatchManager.sh script when an OS patch is
deployed from the Unigy UMS and can be run from the command line for all applicable IPC
products. Below are the script's base properties.
• Provides all necessary functionality to manage the OS patches.
• Is permanently installed or upgraded on the platform by the OS patch installer RPM.
• Is backward compatible with all prior OS patch updates.
• Has no dependencies on the IPC application software.
• Is compatible with RHEL OS version 6.x and higher.
• Updates the Red Hat RPMs that are installed or are specified as dependencies for RPMs to be
updated.
This file resides in the /opt/ipc/sbin directory.
Below is the script usage.
os_patch.sh [-vf] [copy | install | version | avail | impact |
listcve]
An option is required. The following options are available:
• copy: Copies ipc-os-patch-ipc-version.rpm to the /opt/ipc/cop/patch
directory, making it available for installation.
• install: Installs (applies) the ipc-os-patch-os-patch-version.rpm that was copied
to /opt/ipc/cop/patch by the copy option.
• version: Displays the version of the currently installed OS patch.
• avail: Displays one of the:
• Version of ipc-os-patch-os-patch-version.rpm that is currently available to install.
• Message Nothing to update if the latest patch is already installed.

IPC Confidential Unigy 4.3

Enterprise Guide
128 3.1: OS patches

• Message no compatible COP Patch for RHEL # available when an OS patch

ISO file for the current RHEL version is not available.
• impact: Displays one of the following:
• Package version for the RPMs that are available to install.
• Message Nothing to update if the latest patch is already installed.
• Message no compatible COP Patch for RHEL # available when an OS patch
ISO file for the current RHEL version is not available.
• listcve: Displays the Common Vulnerabilities and Exposures (CVEs) addressed by the current OS
patch and all previous patches for the Red Hat major version associated with the current patch.
• -v: Provide verbose information.
• -f: Force the installation of the Red Hat RPMs even if the OS patch RPM is already installed.
• -h: Display the script help.
• osPatchManager.sh
The osPatchManager.sh script is a wrapper script that is run by the Unigy UMS to manage the
following OS patch processes:
• Call the cpms.sh script to copy the files to the staging area and install the currently selected
patch.
• Call the os_patch.sh script to do the following:
• Delete the selected OS patch ISO file.
• Display the RPMs that will be impacted by the patch.
• Display a list of the OS patch ISO files in the staging area.
• Extract the CVE list from the selected ISO.
• Display the version of the latest installed OS patch.
• Display the OS patch version that is available to install.
Below is the script usage.
osPatchManager.sh [copy | install | delete | impact | listISO |
copyCVE | version | cleanup | maxAvail | avail | zoneVersion]
• copy: Performs the cpms.sh copy process.
• install: Performs the os_patch.sh installation process.
• delete: Deletes the selected ISO and associated .cve files.
• impact: Displays the RPMs that are available to install.
• listISO: Displays a list of the OS patch ISO files in the staging area.
• copyCVE: Extracts the CVE list from the ISO file.
• version: Displays the version of the currently installed OS patch.
• cleanup: Cleans up unwanted OS patch ISOs.
• maxAvail: Displays the latest ISO file available to install on the appliances in the zone or None if
there are no available ISOs.
• avail: Displays one of the following:

December 3, 2019 IPC Confidential

 3.1: OS patches 129

• Version of ipc-os-patch-os-patch-version.rpm that is currently available to install.

• Message Nothing to update if the latest patch is already installed.
• Message no compatible COP Patch for RHEL # available when an OS patch
ISO file for the current RHEL version is not available.
• zoneVersion: Displays the version of all appliances associated with the current zone.

RPMs
• OS patch installer RPM
The OS patch installer RPM, ipc-os-patch-installer-installer-version.rpm,
includes the os_patch.sh script that extracts, copies, and installs or updates the COP Patch
Management System (CPMS). The installer RPM must be installed to manage OS patches on the
platform. The RPM has the following naming convention, where installer-version is the
version number assigned to the installer; this version is different from the version assigned to the OS
patch ISO file and OS patch RPM file:
ipc-os-patch-installer-installer-version.rpm
• OS patch RPM
The OS patch RPM, ipc-os-patch-os-patch-version.rpm, contains the RHEL OS
package RPMs to be installed or updated. These RPMs, provided by Red Hat, address specific
security CVEs identified on the Red Hat website.
The OS patch RPM includes the following files:
• The os_patch_payload.tgz file contains the set of RPMs to be installed or upgraded. This
file is copied to the /opt/ipc/cop/patch directory.
• The os_patch_cvelist.txt file that lists the CVEs the patch addresses. This file is copied
to the /opt/ipc/cop/patch directory.
• The os_patch.sh script that extracts and copies the RPMs.

Logs
The following log files are written to by the OS patch installation scripts:
• install.log: This log applies to all OS patch upgrades. The output is from the os_patch.sh
script. The file is in the /opt/ipc/cop/patch/log/ directory.
• os_patch_deployment.log: This log applies only to upgrades run from the UMS. The output
is from the osPatchManager.sh script. This file is in the /opt/ipc/deployment/log/
directory.

Upgrade procedures
The following OS patch upgrade procedures are available for different deployment scenarios:
• If you are installing an OS patch while deploying an appliance personality update, refer to the
appliance upgrade procedure you are using to perform the upgrade.
• To upgrade all appliances in a single Unigy zone during non-trading hours or to upgrade the zone that
will serve as the peer zone for subsequent upgrades, perform the procedure Install an OS patch in a
single zone from the UMS – automatic install on page 131.

IPC Confidential Unigy 4.3

Enterprise Guide
130 3.2: OS patch naming convention

• To upgrade one or more Unigy appliances, but not all appliances, in a single zone during non-trading
hours, perform the procedure Install an OS patch in a single zone from the UMS - manual install on
page 134. This is most appropriate for upgrading appliances that replace failed CCM, ACCM, or
MM appliances.
• To upgrade the appliances in multiple zones within a Unigy enterprise during non-trading hours,
perform the procedure Install an OS patch in multiple zones from the UMS with OS Enterprise Install
on page 137.
• To upgrade Unigy appliances in a stateful HA zone during trading hours, perform the procedure
Install an OS patch from the UMS during trading hours on page 139.
• To upgrade appliances for other IPC products (not Unigy) during separate maintenance windows,
perform the procedure Install an OS patch from the command line within separate maintenance
windows on page 144.
• To upgrade appliances for other IPC products (not Unigy) within a single maintenance window,
perform the procedure Install an OS patch from the command line within a single maintenance
window on page 142.

3.2 OS patch naming convention

The name of an OS patch ISO file, the associated OS patch RPMs, and the patch installer includes a
version number. This topic describes the version naming conventions for these files.
The version numbering system for OS patches is separate from the versioning schemes for other IPC
products. Two versioning conventions are involved, one for the OS patch ISO files and RPMs and one
for the OS patch installer.

OS patch ISO and RPM version

The naming convention for the OS patch ISO files is ipc_os_patch_os-patch-version.iso,
where os-patch-version is the version number assigned to the patch.
The naming convention for the OS patch RPMs is ipc-os-patch-os-patch-version-rpm-
version.i386.rpm, where os-patch-version is the version number assigned to the patch and
rpm-version is the version of the RPM.
The OS patch version numbering scheme is ww.xx.yy.zz.bbbb-r. Each component is described below.
• ww = RHEL major version; for example, 06 or 07
• xx = 00 (reserved for future use)
• yy = OS patch version – most significant digits: 00-99
• zz = OS patch version – least significant digits: 00-99
• bbbb = build number: 0001 - 9999
• r = RPM release (always 1) - applies only to RPMs
For example:
• ipc_os_patch_06.00.00.02.0011.iso
• ipc-os-patch-06.00.00.02.0011-1.i386.rpm

December 3, 2019 IPC Confidential

 3.3: Procedures 131

OS patch installer version

The naming convention for the OS patch installer RPM is ipc_os_patch_installer-
installer-version-rpm-version.i386.rpm, where installer-version is the version
number assigned to the patch installer and rpm-version is the version of the RPM.
The OS patch installer version numbering scheme is ww.xx.yy.zz.bbbb. Each version component is
described below.
• ww = 01
• xx = 00 (reserved for future use)
• yy = 00 (reserved for future use)
• zz = installer version: 00-99
• bbbb = build number: 0001 - 9999
For example, ipc_os_patch_installer-01.00.00.01.0004-1.i386.rpm

3.3 Procedures
3.3.1 Install an OS patch in a single zone from the UMS – automatic install
Use this procedure to install an OS (operating system) patch on all of the appliances in a single zone
using the Automatic Deployment option. Automatic deployment performs the pre- and post validation
and processing procedures that are required to install an OS patch on all CCM and MM appliances or the
ACCM appliances in a zone.

Note
If the Spectre and Meltdown BIOS update was not deployed for OS Patch 13 or a subsequent patch,
refer to Deploy the Spectre and Meltdown BIOS update on page 147.

Prerequisite
Before you begin this procedure, obtain the latest OS patch ISO file from the IPC FTP site,
FilesAnywhere. You can download the file to your laptop, copy it to a network drive, or burn it to a
DVD.
For overview information, refer to OS patches on page 125.
For information on installing an OS patch in a single zone with the manual option, refer to Install an OS
patch in a single zone from the UMS - manual install on page 134.
For information on multizone OS patch installation, refer to Install an OS patch in multiple zones from
the UMS with OS Enterprise Install on page 137.
For information on installing an OS patch during trading hours, refer to Install an OS patch from the
UMS during trading hours on page 139.
For information on the fields and buttons in the panels mentioned in this procedure, refer to the UMS
online help or UMS UI Guide.
If Multi-tier Replication is enabled, it must be enabled for all data centers in the enterprise, or the data
centers must be members of the default data center, before you upgrade any of the zones. If the zone
being upgraded is a portal zone, the associated data center must be in the suspended state. When you
upgrade the zones, the portal zones should be upgraded before the local zones because the portal zone
serves as the preferred zone for the local zones within a data center.

IPC Confidential Unigy 4.3

Enterprise Guide
132 3.3: Procedures

Caution
This procedure is service impacting, so it should be performed only during non-trading hours.

To perform this procedure, your user account must have the IPC Certified Tech role.
1. Log in to the UMS in the zone you are upgrading.
2. Determine the state of the zone by performing the procedure Validate a zone before an upgrade,
rollback, or other operations on page 636.
Data replication should be enabled and the zone and appliances should not be in maintenance mode.
If the zone is not in a healthy state or there is not sufficient disk space available, resolve the issues
before you perform the upgrade, unless the upgrade is required to resolve the issues.
3. Click Tools ➤ Deployment ➤ Software Deployment.
4. Click the OS Patch tab.
5. In the Available OS Patch Releases section, determine whether the OS patch ISO file you are
deploying is already uploaded, and if it is, its status:
• If the ISO file is in the list, the file is uploaded. If the ISO file is not in the list, upload the file by
performing the procedure Upload or download an OS patch ISO file on page 146.
• If the value in the Status column is installed, the OS patch is already installed on all of the
appliances in the zone, so it is not necessary to continue this procedure. If the value is
not_installed, proceed to the next step.
6. Click the ISO file.
The Upload OS Patch, Delete OS Patch, and OS Install Zone buttons should be enabled and the OS
Enterprise Install button should be disabled.
7. Review the following patch information:
a) Click the View details icon ( ).
b) Expand the following sections:
• CVEs: Review the Common Vulnerabilities and Exposures (CVEs) that are addressed in the OS
patch you selected.
• Impacted RPMs: Review the list of RPMs that will be added or updated. When you expand this
section, the system downloads the patch ISO file to the Standby appliance and all Media
Managers then displays the impacted RPMs for all appliances. Confirm that the impact
statements for all appliances are displayed and that the same RPMs are displayed for all; this
might take several minutes. If the RPM lists are not the same, wait several minutes then refresh
the list by re-clicking the ISO file name then expanding the Impacted RPMs section. If the
RPMs were already installed for an appliance, you will see the appliance host name with no
RPMs.
c) Click < Back to return to the OS Patch tab.
8. Click the OS Install Zone button.
The OS Patch Install panel is displayed with a list of the CCM and MM appliances or the ACCM
appliances associated with the zone.
9. Confirm that the value in the Health Check column for each appliance you are upgrading is
Success.
You cannot upgrade an appliance that has a Health Check status of Failure.
If the status is Failure, mouse over the appliance entry to display basic information about the
appliance including its role and status.

December 3, 2019 IPC Confidential

 3.3: Procedures 133

10. In the Select column, select the check box for all of the appliances in the zone.
11. Select the following check boxes as applicable:
• Create a server backup image: This option creates an image backup (restore point, rollback
point) for each appliance that is being upgraded prior to deploying the patch. The check box is
selected by default.

Important
The only way to roll back an OS patch is to restore an image backup that was created prior to the
upgrade, therefore, this check box should always be selected.

• Remove the archive logs prior to backup: This option deletes archived log files before running
the deployment to reduce the time required to create the image backup files. To preserve the
archived data without impacting the backup time, download the archive files to an external data
storage device before starting the deployment.
• Automatic Deployment: This option instructs the system to install the OS patch on the CCM and
MM appliances or the ACCM appliances in the zone, without the need for manual interaction,
including pre-deployment zone validation, placing the zone into maintenance mode, placing the
cluster and Standby appliance into maintenance mode, disabling data replication, deploying the
patch, taking the Standby appliance out of maintenance mode, indicating that maintenance is
complete, taking the cluster out of maintenance mode, taking the zone out of maintenance mode,
enabling replication, and post deployment validation.

Note
For an automatic OS patch upgrade, this check box should always be selected.

12. Click Continue.

The upgrade starts and the Information message box is displayed.
13. Click OK to close the message box.
14. Monitor the progress of the upgrade in one or more of the following ways:
• Display the associated process in the History tab:
1. Within the History tab, click the process that started at the time you started the upgrade.
2. Within the Deployment Status Details section, click a job to display the details.
• Check the OS patch version:
1. After approximately thirty minutes, log in to the UMS in the zone you are upgrading.
If you wait too long, you will not be able to access the OS Install Zone button in step 3 below
because the system disables the button when all appliances in the zone are upgraded. If you
cannot log in, wait several more minutes to allow the system to complete the image backups.
2. Click Tools ➤ Deployment ➤ Software Deplolyment.
3. Within the OS Patch tab, click OS Install Zone.
4. Check the version displayed in the OS Patch Version column for each appliance.
The upgrade is complete when the version you installed is displayed for all of the appliances.
OS patch upgrades are performed sequentially and take approximately five minutes to complete
on each appliance. To refresh the panel, click Cancel within the OS Patch Install panel then re-
click the OS Install Zone button.
• Tail the os_patch_deployment.log file:

IPC Confidential Unigy 4.3

Enterprise Guide
134 3.3: Procedures

From the command line, run the following command:

tail -f /opt/ipc/deployment/log/os_patch_deployment.log
15. Confirm that the patch was deployed by performing the procedure Confirm that an update was
deployed on page 552.
16. Validate each zone you upgraded by performing the procedure Validate a zone after a deployment,
rollback, or other operations on page 638.

3.3.2 Install an OS patch in a single zone from the UMS - manual install
Use this procedure to manually install an OS patch on one or more appliances in a zone. This is most
appropriate for upgrading appliances that replace failed CCM, ACCM, or MM appliances.

Note
If the Spectre and Meltdown BIOS update was not deployed for OS Patch 13 or a subsequent patch,
refer to Deploy the Spectre and Meltdown BIOS update on page 147.

Prerequisite
Before you begin this procedure, obtain the latest OS patch ISO file from the IPC FTP site,
FilesAnywhere. You can download the file to your laptop, copy it to a network drive, or burn it to a
DVD.
For overview information, refer to OS patches on page 125.
For information on installing an OS patch on the appliances in a single zone with the Automatic
Deployment option, refer to Install an OS patch in a single zone from the UMS – automatic install on
page 131.
For information on multizone OS patch installation, refer to Install an OS patch in multiple zones from
the UMS with OS Enterprise Install on page 137.
For information on installing an OS patch during trading hours, refer to Install an OS patch from the
UMS during trading hours on page 139.
If Multi-tier Replication is enabled, it must be enabled for all data centers in the enterprise, or the data
centers must be members of the default data center, before you upgrade any of the zones. If the zone
being upgraded is a portal zone, the associated data center must be in the suspended state. When you
upgrade the zones, the portal zones should be upgraded before the local zones because the portal zone
serves as the preferred zone for the local zones within a data center.
For information on the fields and buttons in the panels mentioned in this procedure, refer to the UMS
online help or UMS UI Guide.

Caution
This procedure is service impacting, so it should be performed only during non-trading hours.

To perform this procedure your user account must have the IPC Certified Tech role.
1. Log in to the UMS in the zone you are upgrading.
2. Determine the state of the zone by performing the procedure Validate a zone before an upgrade,
rollback, or other operations on page 636.
If the zone is not in a healthy state or there is not sufficient disk space available, resolve the issues
before you perform the upgrade, unless the upgrade is required to resolve the issues.

December 3, 2019 IPC Confidential

 3.3: Procedures 135

3. Click Tools ➤ Deployment ➤ Software Deployment.

4. Click the OS Patch tab.
5. In the Available OS Patch Releases panel, determine whether the OS patch ISO file you are deploying
is already uploaded, and if it is, its status:
• If the ISO file is in the list, the file is uploaded. If the ISO file is not in the list, upload the file by
performing the procedure Upload or download an OS patch ISO file on page 146.
• If the value in the Status column is installed, the OS patch is already installed on all of the
appliances in the zone, so it is not necessary to continue this procedure. If the value is
not_installed, proceed to the next step.
6. Click the ISO file.
The Upload OS Patch, Delete OS Patch, and OS Install Zone buttons should be enabled and the OS
Enterprise Install button should be disabled.
7. Review the following patch information:
a) Click the View details icon ( ).
b) Expand the following sections:
• CVEs: Review the Common Vulnerabilities and Exposures (CVEs) that are addressed in the OS
patch you selected.
• Impacted RPMs: Review the list of RPMs that will be added or updated. When you expand this
section, the system downloads the patch ISO file to the Standby appliance and all Media
Managers then displays the impacted RPMs for all appliances. Confirm that the impact
statements for all appliances are displayed and that the same RPMs are displayed for all; this
might take several minutes. If the RPM lists are not the same, wait several minutes then refresh
the list by re-clicking the ISO file name then expanding the Impacted RPMs section. If the
RPMs were already installed for an appliance, you will see the appliance host name with no
RPMs.
c) Click < Back to return to the OS Patch tab.
8. If the appliance you are upgrading is in an HA zone, do the following:
a) Place the zone into maintenance mode and disable SNMP forwarding by performing the following
procedures:
• Disable SNMP forwarding for a zone on page 596.
• Place a zone into maintenance mode to disable BCP plan activation on page 597.
b) If you are upgrading the Active and Standby CCM or ACCM appliances in the zone at the same
time, disable data replication for the zone by performing the procedure Disable data replication on
page 498.
If you are upgrading one appliance or one appliance at a time, do not disable data replication.
c) Place the cluster into maintenance mode by performing the procedure Place a cluster into
maintenance mode to enable control of HA failovers on page 598.
d) Place the Standby appliance into maintenance mode by performing the procedure Place an
appliance or Media Gateway into maintenance mode to indicate it is unavailable on page 599.
9. Click the OS Install Zone button.
The OS Patch Install panel is displayed with a list of the CCM and MM appliances or the ACCM
appliances associated with the zone.
10. Confirm that the value in the Health Check column for each appliance you are upgrading is
Success.

IPC Confidential Unigy 4.3

Enterprise Guide
136 3.3: Procedures

You cannot upgrade an appliance that has a Health Check status of Failure.
If the status is Failure, mouse over the appliance entry to display basic information about the
appliance including its role and status.
11. In the Select column, select the check box for each appliance you are upgrading.
If you are upgrading only the Active appliance, you must perform an HA failover (Force an HA
failover on page 546) to make the Active appliance the Standby appliance because you cannot
upgrade only the Active appliance.
12. Select the following check boxes as applicable:
• Create a server backup image: This option creates a backup image (restore point, rollback point)
for each appliance that is being upgraded prior to deploying the patch. The check box is selected
by default.

Important
The only way to roll back an OS patch is to restore an image backup that was created prior to the
upgrade, therefore, this check box should always be selected.

• Remove the archive logs prior to backup: This option deletes archived log files before running
the deployment to reduce the time required to create the image backup file. To preserve the
archived data without impacting the backup time, download the archive files to an external data
storage device before starting the deployment.
• Automatic Deployment: For a manual OS patch upgrade, clear this check box to enable you to
upgrade a subset of appliances.
13. Click Continue.
The upgrade starts and the Information message box is displayed.
14. Click OK to close the message box.
15. Monitor the progress of the upgrade in one or more of the following ways:
• Display the associated process in the History tab:
1. Within the History tab, click the process that started at the time you started the upgrade.
2. Within the Deployment Status Details section, click a job to display the details.
• Check the OS patch version:
1. After approximately thirty minutes, log in to the UMS in the zone you are upgrading.
If you wait too long, you will not be able to access the OS Install Zone button in step 3 below
because the system disables the button when all appliances in the zone are upgraded. If you
cannot log in, wait several more minutes to allow the system to complete the image backups.
2. Click Tools ➤ Deployment ➤ Software Deplolyment.
3. Within the OS Patch tab, click OS Install Zone.
4. Check the version displayed in the OS Patch Version column for each appliance.
The upgrade is complete when the version you installed is displayed for all of the appliances
you selected for upgrade. OS patch upgrades are performed sequentially and take approximately
five minutes to complete on each appliance. To refresh the panel, click Cancel within the OS
Patch Install panel then re-click the OS Install Zone button.
• Tail the os_patch_deployment.log file:
From the command line, run the following command:

December 3, 2019 IPC Confidential

 3.3: Procedures 137

tail -f /opt/ipc/deployment/log/os_patch_deployment.log
16. After the upgrade is complete for all applicable appliances, take the Standby appliance out of
maintenance mode by performing the procedure Take an appliance or Media Gateway out of
maintenance mode on page 600.
17. Indicate that the maintenance for the Standby appliance is complete by performing the procedure
Indicate that maintenance on the Standby appliance is complete on page 601.
18. If you are upgrading the CCM or ACCM appliances one at a time, do the following:
a) Force an HA failover to make the Active appliance the Standby appliance by performing the
procedure Force an HA failover on page 546.
b) Repeat steps 8d through 17 for the second appliance.
19. After all appliances are upgraded, take the cluster out of maintenance mode by performing the
procedure Take a cluster out of maintenance mode to resume normal HA operation on page 599.
20. Take the zone out of maintenance mode by performing the following procedures:
• Take a zone out of maintenance mode to reenable BCP plan activation on page 598.
• Reenable SNMP forwarding for a zone on page 596.
21. If you disabled data replication in step 8b, enable it by performing the procedure Enable data
replication on page 497.
22. Confirm that the patch was deployed by performing the procedure Confirm that an update was
deployed on page 552.
23. Validate each zone you upgraded by performing the procedure Validate a zone after a deployment,
rollback, or other operations on page 638.

3.3.3 Install an OS patch in multiple zones from the UMS with OS Enterprise Install
Use this procedure to install an operating system (OS) patch on the appliances in multiple Unigy zones
within an enterprise using the OS Enterprise Install option. OS Enterprise Install performs all steps,
including pre- and post validation and processing procedures, that are required to install an OS patch on
all appliances in the selected zones.

Note
If the Spectre and Meltdown BIOS update was not deployed for OS Patch 13 or a subsequent patch,
refer to Deploy the Spectre and Meltdown BIOS update on page 147.

Prerequisites
Before you perform this procedure, you must install the OS patch in a single zone with the OS Install
Zone option. This ensures that at least one zone in the enterprise has the new OS patch installed and that
the zone is stable with the patch deployed. This zone then serves as the peer zone for the upgrade of
subsequent zones with OS Enterprise Install. For information on upgrading a single zone, refer to
Install an OS patch in a single zone from the UMS – automatic install on page 131.
For overview information, refer to OS patches on page 125.
If Multi-tier Replication is enabled, it must be enabled for all data centers in the enterprise, or the data
centers must be members of the default data center, before you upgrade any of the zones. If the zone
being upgraded is a portal zone, the associated data center must be in the suspended state. When you
upgrade the zones, the portal zones should be upgraded before the local zones because the portal zone
serves as the preferred zone for the local zones within a data center.

IPC Confidential Unigy 4.3

Enterprise Guide
138 3.3: Procedures

For information on the fields and buttons in the panels mentioned in this procedure, refer to the UMS
online help or UMS UI Guide.
To perform this procedure, your user account must have the IPC Certified Tech role.

Caution
This procedure is service impacting, so it should be performed only during non-trading hours.

1. Log in to the peer zone that has the correct OS patch installed.
2. Determine the state of the zone by performing the procedure Validate a zone before an upgrade,
rollback, or other operations on page 636.
Data replication should be enabled and the zones should not be in maintenance mode.
If a zone is not in a healthy state or there is not sufficient disk space available, resolve the issues
before you perform the upgrade, unless the upgrade is required to resolve the issues.
3. Click Tools ➤ Deployment ➤ Software Deployment.
4. Click the OS Patch tab.
5. If bandwidth is an issue for any of the zones you are upgrading, perform the substeps below for each
applicable zone. After you upload the ISO file to all of the zones, return to the peer zone and continue
this procedure at step 6.
a) Log in to the UMS.
b) Perform the procedure Upload or download an OS patch ISO file on page 146.
c) When the upload is complete, click the Impacted RPMs tab to copy the file to all appliances
associated with the zone.
OS Enterprise Install automatically uploads the ISO file to all selected zones, however, if bandwidth
is an issue, you can do this manually. If the file is already uploaded, OS Enterprise Install will not
attempt to upload it again.
6. Review the following patch information:
a) Click the View details icon ( ).
b) Expand the following sections:
• CVEs: Review the Common Vulnerabilities and Exposures (CVEs) that are addressed in the OS
patch you selected.
• Impacted RPMs: Review the list of RPMs that will be added or updated. When you expand this
section, the system downloads the patch ISO file to the Standby appliance and all Media
Managers then displays the impacted RPMs for all appliances. Confirm that the impact
statements for all appliances are displayed and that the same RPMs are displayed for all; this
might take several minutes. If the RPM lists are not the same, wait several minutes then refresh
the list by re-clicking the ISO file name then expanding the Impacted RPMs section. If the
RPMs were already installed for an appliance, you will see the appliance host name with no
RPMs.
c) Click < Back to return to the OS Patch tab.
7. Click the OS Enterprise Install button.
The OS Patch Enterprise Install panel is displayed with a list of all zones in the enterprise, except the
peer zone.
8. In the Select column, select the check box for all zones you want to upgrade or select the check box
in the column heading to select all of the zones.

December 3, 2019 IPC Confidential

 3.3: Procedures 139

Confirm that the value in the Health Check column is Success. You cannot upgrade a zone where
the Health Check status is Failure. If the status is Failure, mouse over the zone entry to display
basic information about the appliances in the zone including their role and status.
9. Click the Retrieve OS Patch Version button to display, in the OS Patch Version column, the current
OS software version installed on all of the selected zones.
If a zone is already at the latest version, clear the check box for the zone.
10. Select the following check boxes as applicable:
• Create a server backup image: This option creates an image backup for the appliances in each
selected zone prior to deploying the update. The check box is selected by default.

Important
The only way to roll back an OS patch is to restore an image backup that was created prior to the
upgrade, therefore, this check box should always be selected.

• Remove the archive logs prior to backup: This option deletes archived log files before running
the deployment to reduce the time required to create the image backup file. To preserve the
archived data without impacting the backup time, download the archive files to an external data
storage device before starting the deployment.
11. Click Continue.
The upgrade starts and the Information message box is displayed.
12. Click OK to close the message box.
13. Monitor the progress of the upgrade in one or more of the following ways:
• Display the associated process in the History tab:
1. Within the History tab, click the process that started at the time you started the upgrade.
2. Within the Deployment Status Details section, click a job to display the details.
• Tail the os_patch_deployment log file by running the following command from the
command line:
tail -f /opt/ipc/deployment/log/os_patch_deployment.log
14. After the upgrade is complete, confirm that the patch was deployed on each appliance by performing
the procedure Confirm that an update was deployed on page 552.
15. Validate each zone you upgraded by performing the procedure Validate a zone after a deployment,
rollback, or other operations on page 638.

3.3.4 Install an OS patch from the UMS during trading hours

Perform this procedure to install an OS (operating system) patch from the UMS during trading hours
without interrupting call processing. The enterprise must support stateful HA through the Unigy
Enterprise license.

Note
If the Spectre and Meltdown BIOS update was not deployed for OS Patch 13 or a subsequent patch,
refer to Deploy the Spectre and Meltdown BIOS update on page 147.

Prerequisites

IPC Confidential Unigy 4.3

Enterprise Guide
140 3.3: Procedures

Before you begin this procedure, obtain the latest OS patch ISO file from the IPC FTP site,
FilesAnywhere. You can download the file to your laptop, copy it to a network drive, or burn it to a
DVD.

Note
You cannot use this procedure in the following situations:
• In an enterprise that has the Standard or Express enterprise license, which do not support stateful HA,
so active calls would be dropped.
• Zones that have ACCMs, because stateful HA is not supported for ACCMs.
• Zones that have only one MM, because at least one backup MM must be available to maintain active
calls.

To maintain a functioning zone during the upgrade without impacting call processing or system
configuration, this procedure involves upgrading the Standby CCM appliance, performing an HA
failover to make the Active appliance the Standby appliance, then upgrading the new Standby appliance.
It also involves upgrading one Media Manager (MM) at a time. The MMs must have sufficient capacity
to handle the additional call load that results from load balancing when an MM is being upgraded.
If Multi-tier Replication is enabled, it must be enabled for all data centers in the enterprise, or the data
centers must be members of the default data center, before you upgrade any of the zones. If the zone
being upgraded is a portal zone, the associated data center must be in the suspended state. When you
upgrade the zones, the portal zones should be upgraded before the local zones because the portal zone
serves as the preferred zone for the local zones within a data center.
For information on the fields and buttons in the panels mentioned in this procedure, refer to the UMS
online help or UMS UI Guide.
To perform this procedure your user account must have the IPC Certified Tech role.

Note
Perform this procedure carefully to ensure that call processing is not impacted.

1. Log in to the UMS in the zone you are upgrading.

2. Determine the state of the zone by performing the procedure Validate a zone before an upgrade,
rollback, or other operations on page 636.
If the zone is not in a healthy state or there is not sufficient disk space available, resolve the issues
before you perform the upgrade, unless the upgrade is required to resolve the issues.
Data replication should be enabled and the zone and appliances should not be in maintenance mode.
3. Click Tools ➤ Deployment ➤ Software Deployment.
4. Click the OS Patch tab.
5. In the Available OS Patch Releases panel, determine whether the OS patch ISO file you are deploying
is already uploaded, and if it is, its status:
• If the ISO file is in the list, the file is uploaded. If the ISO file is not in the list, upload the file by
performing the procedure Upload or download an OS patch ISO file on page 146.
• If the value in the Status column is installed, the OS patch is already installed, so it is not
necessary to continue this procedure. If the value is not_installed, proceed to the next step.
6. Click the ISO file.

December 3, 2019 IPC Confidential

 3.3: Procedures 141

The Upload OS Patch, Delete OS Patch, and OS Install Zone buttons should be enabled and the OS
Enterprise Install button should be disabled.
7. Review the following patch information:
a) Click the View details icon ( ).
b) Expand the following sections:
• CVEs: Review the Common Vulnerabilities and Exposures (CVEs) that are addressed in the OS
patch you selected.
• Impacted RPMs: Review the list of RPMs that will be added or updated. When you expand this
section, the system downloads the patch ISO file to the Standby appliance and all Media
Managers then displays the impacted RPMs for all appliances. Confirm that the impact
statements for all appliances are displayed and that the same RPMs are displayed for all; this
might take several minutes. If the RPM lists are not the same, wait several minutes then refresh
the list by re-clicking the ISO file name then expanding the Impacted RPMs section. If the
RPMs were already installed for an appliance, you will see the appliance host name with no
RPMs.
c) Click < Back to return to the OS Patch tab.
8. Click the OS Install Zone button.
The OS Patch Install panel is displayed with a list of the CCM and MM appliances or the ACCM
appliances associated with the zone.
9. Confirm that the value in the Health Check column for each appliance you are upgrading is
Success.
You cannot upgrade an appliance that has a Health Check status of Failure.
If the status is Failure, mouse over the appliance entry to display basic information about the
appliance including its role and status.
10. In the Select column, select the Standby CCM and one MM.
11. Select or clear the following check boxes as applicable:
• Create a server backup image: This option creates a backup image (restore point, rollback point)
for each appliance that is being upgraded prior to deploying the patch. The check box is selected
by default.

Important
The only way to roll back an OS patch is to restore an image backup that was created prior to the
upgrade, therefore, this check box should always be selected.

• Remove the archive logs prior to backup: This option deletes archived log files before running
the deployment to reduce the time required to create the image backup file. To preserve the
archived data without impacting the backup time, download the archive files to an external data
storage device before starting the deployment.
• Automatic Deployment: For this procedure, clear this check box to prevent the system from
upgrading the Active appliance and all MMs and from initiating processes that will impact call
processing.
12. Click Continue.
The upgrade starts and the Information message box is displayed.
13. Click OK to close the message box.
If a previous OS patch was installed, the Status of the zone in the OS Patch panel changes to
partial for both versions until all of the appliances are upgraded.

IPC Confidential Unigy 4.3

Enterprise Guide
142 3.3: Procedures

14. Monitor the progress of the upgrade in one or more of the following ways:
• Display the associated process in the History tab:
1. Within the History tab, click the process that started at the time you started the upgrade.
2. Within the Deployment Status Details section, click a job to display the details.
• Check the OS patch version:
1. After approximately thirty minutes, log in to the UMS in the zone you are upgrading.
If you wait too long, you will not be able to access the OS Install Zone button in step 3 below
because the system disables the button when all appliances in the zone are upgraded. If you
cannot log in, wait several more minutes to allow the system to complete the image backups.
2. Click Tools ➤ Deployment ➤ Software Deplolyment.
3. Within the OS Patch tab, click OS Install Zone.
4. Check the version displayed in the OS Patch Version column for each appliance.
The upgrade is complete when the version you installed is displayed for all of the appliances.
OS patch upgrades are performed sequentially and take approximately five minutes to complete
on each appliance. To refresh the panel, click Cancel within the OS Patch Install panel then re-
click the OS Install Zone button.
• Tail the os_patch_deployment log file by running the following command from the
command line:
tail -f /opt/ipc/deployment/log/os_patch_deployment.log
15. Confirm that the patch was deployed by performing the procedure Confirm that an update was
deployed on page 552.
16. Force an HA failover to make the Active appliance the Standby appliance by performing the
procedure Force an HA failover on page 546.
17. After the failover completes, the IZChannel service will be in the Failed state, so you must rearm
the appliance by performing the procedure Rearm the Standby appliance on page 547.
18. Repeat steps 8 through 15 for the second CCM and the next MM.
19. If applicable, repeat steps 8 through 15 for each remaining MM, one at a time.
In step 10 do not select a CCM. At this point it is necessary to upgrade only the remaining MMs.
20. Validate each zone you upgraded by performing the procedure Validate a zone after a deployment,
rollback, or other operations on page 638.

3.3.5 Install an OS patch from the command line within a single maintenance window
Perform this procedure to install an OS (operating system) patch on an appliance within a single
maintenance window.
This procedure applies only to appliances associated with IPC products other than Unigy or Blue Wave.
For information on installing an OS patch for a Unigy or Blue Wave appliance, refer to one of the
following topics:
• Install an OS patch in a single zone from the UMS – automatic install on page 131
• Install an OS patch in a single zone from the UMS - manual install on page 134
• Install an OS patch in multiple zones from the UMS with OS Enterprise Install on page 137
• Install an OS patch from the UMS during trading hours on page 139

December 3, 2019 IPC Confidential

 3.3: Procedures 143

For overview information, refer to OS patches on page 125.

For information on setting up and installing an OS patch during separate maintenance windows, refer to
Install an OS patch from the command line within separate maintenance windows on page 144.

Note
If the Spectre and Meltdown BIOS update was not deployed for OS Patch 13 or a subsequent patch,
refer to Deploy the Spectre and Meltdown BIOS update on page 147.

Before you begin this procedure, obtain the latest OS patch ISO file from the IPC FTP site,
FilesAnywhere. You can download the file to your laptop, copy it to a network drive, or burn it to a
DVD.
Perform this procedure for each appliance that requires the OS patch upgrade.

Caution
This procedure is service impacting, so it should be performed only during non-trading hours.

1. Create an image backup of each appliance you are upgrading.

This is important because the only way to roll back an OS patch upgrade is to restore an image
backup that was created prior to the upgrade. Use a backup procedure that is appropriate for the IPC
product you are upgrading.
2. Access the command line on the appliance for which you are installing the OS patch.
3. Run the command su -lp and enter the appropriate dynamic password from Password Manager.
4. Do one of the following:
• If the ISO file is on a DVD, insert the DVD in the drive and mount it by running the following
commands:
• mkdir -p /mnt/ospatch/;
• mountpoint -q /mnt/ospatch/
• If the file is on your laptop or a network drive, do the following:
1. Use an FTP utility such as WinSCP or SCP/SFTP to copy the file to the /tmp directory on the
appliance.
2. Run the following command, where iso-file-name is the name of the patch ISO file, to
copy the file from /tmp to the /opt/ipc/cop/patch_iso/ directory.
cp /tmp/iso-file-name /opt/ipc/cop/patch_iso/iso-file-name
3. Run the following commands to create a mount point and mount the file loopback to /mnt/
ospatch:
a. mkdir -p /mnt/ospatch/;
b. mount -o loop /opt/ipc/cop/patch_iso/iso-file-name /mnt/
ospatch/, where iso-file-name is the name of the patch ISO file.
5. Change the working directory to the ISO file top directory:
cd /mnt/ospatch/
6. Run the command ./cpms.sh install to upload the OS patch ISO file, copy the patch files to
the staging directories then initiate the installation.
The script does the following:

IPC Confidential Unigy 4.3

Enterprise Guide
144 3.3: Procedures

• Installs or updates the OS patch installer RPM. This installs the latest os_patch.sh script in
the /opt/ipc/sbin directory.
• Calls the os_patch.sh script with the copy option to copy the OS patch RPM
to /opt/ipc/cop/patch to prepare it for deployment. It also deletes any previous OS patch
RPMs.
• Runs the command /opt/ipc/sbin/os_patch.sh install, which does the following:
• Installs or updates the OS patch RPM in /opt/ipc/cop/patch, which copies the
patch .tar file, containing the Red Hat RPMs and the CVE list file, to /opt/ipc/cop/
patch.
• Extracts the Red Hat RPMs from the .tar file to the /opt/ipc/cop/patch directory.
• Installs or updates the Red Hat RPMs.
7. Verify that the currently installed OS patch version is the version you deployed by running the
command /opt/ipc/sbin/os_patch.sh version.
8. Unmount the ISO file by running the command umount -q /mnt/ospatch/.
If you installed the patch from a DVD, remove it from the drive.
9. Reboot the appliance.

3.3.6 Install an OS patch from the command line within separate maintenance windows
Perform this procedure to prepare an appliance for an OS (operating system) patch installation during
one maintenance window then perform the installation during a future maintenance window.
This procedure applies only to appliances associated with IPC products other than Unigy or Blue Wave.
For information on installing an OS patch for a Unigy or Blue Wave appliance, refer to one of the
following topics:
• Install an OS patch in a single zone from the UMS – automatic install on page 131
• Install an OS patch in a single zone from the UMS - manual install on page 134
• Install an OS patch in multiple zones from the UMS with OS Enterprise Install on page 137
• Install an OS patch from the UMS during trading hours on page 139
For overview information, refer to OS patches on page 125.
For information on installing an OS patch from the command line within a single maintenance window,
refer to Install an OS patch from the command line within a single maintenance window on page 142.

Note
If the Spectre and Meltdown BIOS update was not deployed for OS Patch 13 or a subsequent patch,
refer to Deploy the Spectre and Meltdown BIOS update on page 147.

Before you begin this procedure, obtain the latest OS patch ISO file from the IPC FTP site,
FilesAnywhere. You can download the file to your laptop, copy it to a network drive, or burn it to a
DVD.
Perform this procedure for each appliance that requires the OS patch upgrade.

Caution
This procedure is service impacting, so it should be performed only during non-trading hours.

December 3, 2019 IPC Confidential

 3.3: Procedures 145

1. Create an image backup of each appliance you are upgrading.

This is important because the only way to roll back an OS patch upgrade is to restore an image
backup that was created prior to the upgrade. Use a backup procedure that is appropriate for the IPC
product you are upgrading.
2. Access the command line on the appliance for which you are installing the OS patch.
3. Run the command su -lp and enter the appropriate dynamic password from Password Manager.
4. Do one of the following:
• If the ISO file is on a DVD, insert the DVD in the drive and mount it by running the following
commands:
• mkdir -p /mnt/ospatch/;
• mountpoint -q /mnt/ospatch/
• If the file is on your laptop or a network drive, do the following:
1. Use an FTP utility such as WinSCP or SCP/SFTP to copy the file to the /tmp directory on the
appliance.
2. Run the following command, where iso-file-name is the name of the patch ISO file, to
copy the file from /tmp to the /opt/ipc/cop/patch_iso/ directory.
cp /tmp/iso-file-name /opt/ipc/cop/patch_iso/iso-file-name
3. Run the following commands to create a mount point and mount the file loopback to /mnt/
ospatch:
a. mkdir -p /mnt/ospatch/;
b. mount -o loop /opt/ipc/cop/patch_iso/iso-file-name /mnt/
ospatch/, where iso-file-name is the name of the patch ISO file.
5. Change the working directory to the ISO file top directory:
cd /mnt/ospatch/
6. Run the command ./cpms.sh copy to upload the OS patch ISO file and copy the patch files to
the staging directories.
The script does the following:
• Installs or updates the OS patch installer RPM. This installs the latest os_patch.sh script in
the /opt/ipc/sbin directory.
• Calls the os_patch.sh script with the copy option to copy the OS patch RPM
to /opt/ipc/cop/patch to prepare it for deployment. It also deletes any previous OS patch
RPMs.
7. Display the latest COP patch version that is available for installation by running the
command /opt/ipc/sbin/os_patch.sh avail.
Confirm that this is the version you want to install.
8. If you are preparing the appliance for an OS patch installation that you will complete during a future
maintenance window, stop now then proceed with the next step when you are ready to perform the
installation.
9. Install the patch by running the command /opt/ipc/sbin/os_patch.sh install.
The script does the following:
• Installs or updates the OS patch RPM in /opt/ipc/cop/patch, which copies the patch .tar
file, containing the Red Hat RPMs and the CVE list file, to /opt/ipc/cop/patch.

IPC Confidential Unigy 4.3

Enterprise Guide
146 3.3: Procedures

• Extracts the Red Hat RPMs from the .tar file to the /opt/ipc/cop/patch directory.
• Installs or updates the Red Hat RPMs.
10. Verify that the currently installed OS patch version is the version you deployed by running the
command /opt/ipc/sbin/os_patch.sh version.
11. Unmount the ISO file by running the command umount -q /mnt/ospatch/.
If you installed the patch from a DVD, remove it from the drive.
12. Reboot the appliance.

3.3.7 Upload or download an OS patch ISO file

Use this procedure to upload an OS (operating system) patch ISO file from the UMS.
1. Click Tools ➤ Deployment ➤ Software Deployment.
2. Within the OS Patch tab, click Upload OS Patch.
3. Upload the file from your laptop, an OS patch DVD, or another external data storage device or
download the file from a corporate server or another Unigy appliance:
• To upload the file:
1. In Local File, click Browse.
2. Locate and select the file then click Open.
• To transfer the file from a corporate server or another Unigy appliance:
1. Identify the location of the file.
2. In IPC URL, enter the URL for the file. The URL must contain the server or appliance IP
address, not the hostname.
4. Click Upload to upload the file or click Download from URL to download the file.
A progress bar is displayed.
When the upload or download is complete, the system validates the ISO and displays one of the
following messages:
• File Uploaded Successfully. ISO is good ... verification passed
• File Downloaded Successfully. ISO is good ... verification passed
The value in the Status column within the Available OS Patch Releases panel should be
not_installed.

3.3.8 Delete an OS patch ISO file from the UMS

Use this procedure to remove an OS patch ISO file that is not needed.
You can delete an ISO file only if it has not been deployed on an appliance.
1. Log in to the UMS in the zone from which you are deleting the OS patch ISO file.
2. Click Tools ➤ Deployment ➤ Software Deployment.
3. Click the OS Patch tab.
4. In the Available OS Patch Releases panel, click the ISO file you are deleting.
The file Status must be not_installed.

December 3, 2019 IPC Confidential

 3.3: Procedures 147

5. Click Delete OS Patch.

6. In the Confirmation message box, click OK.

3.3.9 Deploy the Spectre and Meltdown BIOS update

This update protects Unigy appliance processors from Spectre and Meltdown attacks.

Note
The files for this update are included in Unigy OS Patch 13. Perform this procedure only if the BIOS
update was not deployed for Patch 13 or a subsequent patch. To determine whether it is necessary to
upgrade the BIOS, refer to step 7 below to identify the current BIOS version.

For each CCM, ACCM, and MM appliance you are upgrading, you will use one of the following
BIOS .bin update files to perform the upgrade. These files are available in the IPC Software Unigy
Core OS Patches patch_13 folder within the IPC FTP site, FilesAnywhere:

Appliance product version Directory BIOS update .bin file

R620 appliances PE_R620 BIOS_NGYCX_LN_2.7.0.BIN
R630 appliances PE_R630 BIOS_2JFRF_LN_2.8.0.BIN
R640 appliances PE_R640 BIOS_422T0_LN_1.4.9.BIN

To access these folders in FilesAnywhere, run a search for PE_R6, which will return all three folders.
1. Copy the appropriate .bin file to a directory on the appliance you are upgrading.
For example, for an R640 appliance, copy the BIOS_422T0_LN_1.4.9.BIN file.
2. From the appliance command line, change the current directory to the directory to which you copied
the .bin file in the previous step.
3. Display the release information by running the following command, where bios-bin-file is the
name of the file you copied to the appliance in step 1:
./bios-bin-file --version
4. Download and install any prerequisites identified in the release information displayed in the previous
step.
5. Deploy the BIOS update by running the following command, where bios-bin-file is the name
of the file you copied to the appliance in step 1:
./bios-bin-file
For each prompt that asks if you want to continue, type Y.
For R620 and R630 appliances, if you see the message USB is not enabled. Please
enable USB and try update again., do the following:
1. In the /etc/modprobe.conf file, comment out (#) the line install usb-storage :.
2. Reboot the appliance.
3. Rerun the BIOS upgrade.

IPC Confidential Unigy 4.3

Enterprise Guide
148 3.3: Procedures

4. In the /etc/modprobe.conf file, remove the comment character (#) you inserted into the line
install usb-storage :.
5. Reboot the appliance.
6. Determine whether the upgrade was successful by reviewing the log file in /var/log/dell/
updatepackage/log/support.
7. Confirm that the correct BIOS version is deployed by running the following command:
dmidecode -t bios -q
The BIOS version should be one of the following:

Table 3: BIOS versions

Appliance product version Updated BIOS version

R620 appliances 2.7.0
R630 appliances 2.8.0
R640 appliances 1.4.9

December 3, 2019 IPC Confidential

 149

4 Single Click Deployment (SCD)

Single Click Deployment (formerly known as Enterprise Deployer and One-click Deployer) is an
application that automates software deployments, upgrades, image backups, rollbacks, and Enterprise
database restores.
SCD consists of the following components:
• Single Click Deployment appliance: An appliance that is configured to run the SCD application for
the automated tasks supported.
• Single Click Deployment agent: A process, initiated by a script, that runs on all Unigy CCM, ACCM,
and MM appliances for the purpose of registering the appliance with an SCD appliance and for
communication between the appliance and Single Click Deployment.
Both SCD components are delivered in the Unigy appliance personality software ISO file.
The SCD appliance provides the following functionality:
• Performs pre-deployment validation procedures.
• For upgrades, places all applicable zones into maintenance mode and disables data replication at the
appropriate point in the deployment process.
• Performs image backups when requested.
• Deploys the Common Operating Platform (COP) software.
• Configures the appliance network settings.
• Deploys the appliance personality software.
• Deploys the zone for each appliance.
• Restores Enterprise backup files when applicable.
• Performs post deployment validation.
• Enables data replication in all applicable zones.
• Restores image backups when requested.

Note
Single Click Deployment is available only for Unigy v3.0 or higher. It cannot be used for Blue Wave
deployments or upgrades.

Beginning with Unigy v4.1, a Single Click Deployment appliance can run in a virtual machine (VM)
within a virtual environment. For information on running SCD in a VM, refer to Single Click
Deployment (SCD) in a virtual environment on page 151.

Note
To avoid possible version compatibility issues, always use the latest available SCD version (v4.x or
higher).

IPC Confidential Unigy 4.3

Enterprise Guide
150 4.1: Single Click Deployment appliances

Caution
All Single Click Deployment tasks are service impacting; perform them only during non-trading hours.

For additional information, refer to the following sections:

• Single Click Deployment appliances on page 150
• Single Click Deployment tasks on page 159
• Single Click Deployment panels on page 171

4.1 Single Click Deployment appliances

A Single Click Deployment appliance enables you to run automated deployments, upgrades, rollbacks,
and other related tasks for one or more Unigy Converged Communications Manager (CCM),
Aggregated Converged Communications Manager (ACCM), and Media Manager (MM) appliances.
Beginning with Unigy v4.1, Single Click Deployment appliances can be physical appliances or
appliances running in a virtual machine (VM). The virtual appliances can run on a host server or on a
laptop through an application such as VMWare's Workstation Pro by importing an OVA Open
Virtualization Application) file. Their primary purpose is to enable you to perform the automated tasks
that Single Click Deployment provides and to store all required Unigy .iso and appliance image backup
files that are created prior to an upgrade. For information on these tasks, refer to Single Click
Deployment (SCD) on page 149.
The physical appliances are R430 servers with 16 GB of memory, three 1 TB hard drives in a RAID 5
array, and redundant power supplies. These appliances cannot be used as Unigy appliances for enterprise
configuration or call processing, however, they can be used for restoring enterprise backups and image
backups.
Use of these appliances is restricted to IPC Service and Support personnel.

Hardware specifications

Table 4: Single Click Deployment appliance hardware specifications

Component Quantity
Dell PowerEdge R430 1
PowerEdge R430/R530 Motherboard 1
On-Board LOM 1GBE (Dual Port for Towers, Quad Port for Racks) 1
iDRAC Port Card 1
iDRAC8 Enterprise, integrated Dell Remote Access Controller, Enterprise 1
2.5" Chassis with up to 8 Hot Plug Hard Drives 1
PowerEdge R430, 8 Drive Chassis 1
Performance BIOS Settings 1
RAID 5 for H330/H730/H730P (3-8 HDDs or SSDs) 1
PERC H330 Integrated RAID Controller 1
Intel Xeon E5-2620 v3 2.4GHz,15M Cache,8.00GT/s QPI,Turbo,HT,6C/12T (85W) 1
Max Mem 1866MHz

December 3, 2019 IPC Confidential

 4.2: Single Click Deployment (SCD) in a virtual environment 151

Table 4: Single Click Deployment appliance hardware specifications (continued)

Component Quantity
8GB RDIMM, 2133MT/s, Dual Rank, x8 Data Width 2
2133MT/s RDIMMs 1
Performance Optimized 1
1TB 7.2K RPM SATA 6Gbps 2.5in Hot-plug Hard Drive,13G 3
DVD ROM SATA Internal 1
ReadyRails Sliding Rails Without Cable Management Arm 1
Dual, Hot-plug, Redundant Power Supply (1+1), 1
NEMA 5-15P to C13 Wall Plug, 125 Volt, 15 AMP, 10 Feet (3m), Power Cord, North 2
America
DIMM Blanks for System with 1 Processor 1
135W Heatsink for PowerEdge R430 1

4.2 Single Click Deployment (SCD) in a virtual environment

Single Click Deployment can run on a physical appliance, or beginning with Unigy v4.1, within a virtual
machine (VM) on a virtual host server or a laptop.
After you deploy SCD in a virtual environment, its operation is the same as is it is on a physical
appliance. The advantages of deploying SCD in a VM are lower computer resource requirements,
redundancy, and easier maintenance and deployment of subsequent SCD appliances, which can be
deployed with an Open Virtual Appliance (OVA) file. It also provides portability when the VM is on a
laptop.

Note
To avoid possible version compatibility issues, always deploy the latest available SCD version (v4.x or
higher).

The VMware vSphere ESXi v6.0, 6.5, and 6.7 hypervisors are supported for Single Click Deployment in
a virtual environment.
For additional information, refer to the following topics:
• Single Click Deployment (SCD) appliance VM hardware resource requirements on page 151
• Create a Single Click Deployment (SCD) appliance VM on a host server on page 152
• Create a Single Click Deployment (SCD) appliance VM on a laptop on page 154

4.2.1 Single Click Deployment (SCD) appliance VM hardware resource requirements

This topic describes the minimum requirements for each VM that Single Click Deployment runs in.
Specifications are provided for running the VM on a host server and within a workstation host on a
laptop.

IPC Confidential Unigy 4.3

Enterprise Guide
152 4.2: Single Click Deployment (SCD) in a virtual environment

Virtual machine on a host server

Below are the minimum resource requirements for a Single Click Deployment appliance VM on a
virtual host server.

Table 5: Minimum hardware requirements – virtual host server

Device Requirement
CPU 2 sockets with 4 cores per socket
Memory Initial build 24 GB
Runtime 8 GB (minimum) 16 GB (recommended)
Hard drive 200 GB, thin provisioned
Network adapter NIC: type E1000
DVD drive Configured and active on boot up
Video card 1 display, 8 MB of video memory
SCSI controller 0 lsilogic

Virtual machine on a laptop

Below are the minimum resource requirements for a Single Click Deployment appliance VM in a virtual
desktop host on a laptop. The laptop must have sufficient resources for normal operation in addition to
these requirements.

Table 6: Minimum hardware requirements – laptop

Device Requirement
CPU 1 socket with 4 cores per socket (minimum), 2 sockets with 4 cores per socket
(recommended)
Memory 8 GB (minimum), 24 GB (recommended)
Hard drive Partition with at least 250 GB of free space.
Network adapter NIC: type E1000
Video card 1 display, 8 MB of video memory
DVD drive Optional but recommended
Operating system The VM was tested on laptops running the Windows 7 x64 operating system.

4.2.2 Create a Single Click Deployment (SCD) appliance VM on a host server

This topic describes how to create a Single Click Deployment appliance in a VM on a host server.
For information on creating a Single Click Deployment appliance VM on a laptop, refer to Create a
Single Click Deployment (SCD) appliance VM on a laptop on page 154.
Prerequisites
The process for creating an SCD VM on a host server involves importing an Open Virtual Appliance
(OVA) file to create the VM. Before you begin this procedure, download the OVA file that you will use
to create the VM. The OVA files are available on the IPC FTP site, FilesAnywhere. The file naming
convention is scd_version.ova, where version is the SCD version.

December 3, 2019 IPC Confidential

 4.2: Single Click Deployment (SCD) in a virtual environment 153

Note
When you create an SCD appliance in a VM from an OVA file, the new VM will be an exact copy of the
VM from which the OVA was created. To avoid hardware issues when bringing up the appliance, the
method used to create the OVA enables the appliance to come up with a different MAC address. After
you deploy the VM, you will change the network settings to match the customer network.

These instructions are based on VMWare's vSphere Client version 6.0.0 Build 5318172; the steps might
be different for other vSphere versions, but they should be similar. The OVA file was created with
VMWare ESXi 6.
1. Within the vSphere Navigator panel, right-click the host server on which you are creating the SCD
VM then click Deploy OVF Template.
If you are prompted to download the Client Integration Plug-in, click Download Client Integration
Plug-in, click Run and follow the installation wizard, then reopen vSphere and right-click the host
server.
2. Do one of the following to specify the OVA file you are deploying then click Next:
• Select the URL option button then type the URL for accessing the OVA file.
• Select the Local file option button then click Browse and select the OVA file.
3. Review the OVA file (OVF template) details then click Next.
4. Type a name for the VM you are creating and specify the folder or data center where the VM will be
located then click Next.
5. Select the resource where the VM will run then click Next.
6. Select the data store where the virtual disks will be stored then click Next.
7. Specify the network the VM should use then click Next.
8. Review the settings to be sure they are correct then click Finish.
If the settings are not correct, click Back and make the necessary changes.
The VM is created in the location you specified.
9. To improve performance for the remainder of the steps in this procedure, if the host has sufficient
resources, upgrade the VM memory to 24 GB prior to starting the VM.
10. Change the VM IP address and other network values by performing the procedure Configure the
appliance network settings with Network Configurator on page 450.
At the end of the wizard, when you are prompted to run the IP change scripts, type y.
While the appliance reboots, WebLogic might not shut down. If it does not, power down the
appliance or force a shutdown from the hypervisor then power it back up.
11. Run the makeOCDfromCCM.sh script to set up the SCD appliance and assign the SCD ipc and
admin user account passwords:
a) Access the appliance command line with the shelldiag user account.

Note
Unless you have a utility that allows you to copy and paste values between the laptop and the VM,
you will have to manually enter the token and dynamic password values. If you mistype the
password twice, the system will lock the account for fifteen minutes.

IPC Confidential Unigy 4.3

Enterprise Guide
154 4.2: Single Click Deployment (SCD) in a virtual environment

When you access the command line for the first time, the date and time will be wrong. These will
self-correct after a few minutes.
b) Run the command su -lp and enter the dynamic password.
c) Change the directory to /opt/ipc/ocd.
d) Run the following command, where scd-ipc-password is the password you are assigning to
the SCD ipc user account and scd-admin-password is the password you are assigning to the
SCD admin account. There are no restrictions on the password length or valid characters.
./makeOCDfromCCM.sh ipc_password=scd-ipc-password
admin_password=scd-admin-password
e) Reboot the appliance by running the reboot command.
You might see a number of Error 9s indicating that certain default ISO files, such as COP ISOs, could
not be uploaded from the SCM site. You might also see removable device errors. Both of these errors
are expected, so you can ignore them. You will upload the applicable ISO files in step 13.
The appliance can now support all Single Click Deployment functions.
12. Use the following URL and the passwords you created in the previous step to access Single Click
Deployment to be sure it opens properly with the credentials you specified; appliance-ip is the
IP address you assigned to the SCD appliance.
https://appliance-ip/svc/oneclick/
Enter the ipc or admin user name and the appropriate password.
13. Click the Help link within Single Click Deployment or refer to the Single Click Deployment topic in
the Enterprise Guide for information on uploading COP and appliance ISO files, registering
appliances with the Single Click Deployment appliance, performing deployments and upgrades, and
other related topics.

4.2.3 Create a Single Click Deployment (SCD) appliance VM on a laptop

Perform this procedure to create a Single Click Deployment appliance virtual machine (VM) on a laptop
that you can transport to customer sites for Unigy software deployments and upgrades.
For information on creating an SCD appliance VM on a host server, refer to Create a Single Click
Deployment (SCD) appliance VM on a host server on page 152.
Prerequisites
The process for creating an SCD VM on a laptop involves importing an Open Virtual Appliance (OVA)
file. Before you begin this procedure, download the OVA file that you will use to create the VM. The
OVA files are available on the IPC FTP site, FilesAnywhere. The file naming convention is
scd_version.ova, where version is the SCD software version.

December 3, 2019 IPC Confidential

 4.2: Single Click Deployment (SCD) in a virtual environment 155

Important
Consider the following before you create an SCD VM on the laptop:
• When you create a VM from an OVA file, the new VM will be an exact copy of the VM from which the
OVA was created. To avoid hardware issues when bringing up the appliance, the method used to
create the OVA enables the appliance to come up with a different MAC address. After you deploy the
VM, you will change the network settings to match the customer network.
• To ensure optimal stability and performance, run Single Click Deployment on a wired ethernet network,
not a wireless network.
• The workstation ethernet adapter must initially be set to Host-only, however, at the customer site, you
will change this to Bridged networking to expose the VM IP address to the CCMs and MMs that will be
deployed by the SCD appliance.
• Each customer must provide routable access to the subnet where the CCM and MM appliances are
deployed.
• The IP address, subnet mask, and default gateway you configure for the VM must be part of the
customer network addressing. Replicate the customer network when you set up the VM on the laptop.
You will change these values for each customer.

Note
This procedure is based on deployment using VMware Workstation Pro 12. For some of the steps in the
procedure, Workstation Pro provides multiple ways to perform the step; for example, to create a
snapshot, you can click the VM in the Library section then click VM ➤ Snapshot ➤ Take Snapshot, you
can right-click the VM then click Snapshot ➤ Take Snapshot, or you can click the Take a snapshot of this
virtual machine icon in the toolbar. When multiple options are available, use the one you prefer.

1. On the laptop, create a folder for the VM files.

2. Within Workstation Pro, click File ➤ Open.
3. Browse to and select the OVA file you are importing to create the VM then click Open.
The Import Virtual Machine dialog box is displayed.
4. Type a name for the VM you are creating (or accept the default name), click Browse to select the
folder you created in step 1, then click Import.
Workstation Pro performs OVF specification conformance and virtual hardware compliance checks
and displays a status bar that indicates the progress of the import process.
If you see the following message, the laptop hardware resources are not adequate to support the
resources specified for the VM in the OVA file. Upgrade the laptop hardware before creating the VM.
The import failed because VMOCD1.ipc.com.ova did not pass OVF
specification conformance or virtual hardware compliance checks.
Click Retry to relax OVF specification and virtual hardware
compliance checks and try the import again, or click Cancel to
cancel the import. If you retry the import, you might not be able to
use the virtual machine in VMware Workstation.
After Workstation Pro imports the OVA, the VM it created is displayed in the virtual machine Library
frame on the left and the basic resource properties are displayed in the Devices section. Confirm that
the settings are correct:
• Memory: 8 GB minimum, 12 GB recommended
• Processors: 1 socket with 4 cores minimum, 2 sockets with 4 cores recommended

IPC Confidential Unigy 4.3

Enterprise Guide
156 4.2: Single Click Deployment (SCD) in a virtual environment

• Hard Disk (SCSI): partition with at least 200 GB of free space, 250 GB recommended
• Network Adapter: The default value is Bridged (Automatic), however, when you set up the VM,
the value must be Host-only. You change this value in the next step.
5. Change the network adapter and any other settings you need to change:
a) Within the Library section, click the VM.
b) Click Edit virtual machine settings.
c) Click the device type you are changing then change the value.
For the Network Adapter device, select Host-only: A private network shared with the host.
d) Click OK.
6. Create a snapshot of the VM that you can restore as needed to reset the VM for use with another
customer enterprise:
a) Within the Library section, right-click the VM then click Snapshot ➤ Take Snapshot.
b) Enter the snapshot name and description then click Take Snapshot.
7. Provide customer-specific subnet values for the VM:
a) Within the Library section, click the VM.
b) Click Edit ➤ Virtual Network Editor.
c) Click Change Settings.
If the system displays the User Account Control message box, click Yes.
d) Click the adapter that has the Host-only value in the Type column (usually VMnet1).
e) Clear the Use local DHCP service to distribute IP address to VMs check box if it is selected.
f) In Subnet IP, enter the customer network subnet IP (first three octets with 0 as the fourth octet).
g) In Subnet Mask, enter the customer network subnet mask.
h) Click OK.
8. Reboot the VM by clicking VM ➤ Power ➤ Restart Guest.
9. Set the customer-specific IP address and other network values for the SCD appliance by performing
the procedure Configure the appliance network settings with Network Configurator on page 450.
After the last screen, when you are prompted to run the IP change scripts, type y.

Note
While the appliance reboots after the scripts run, WebLogic might not shut down. If it does not, restart
the VM by clicking VM ➤ Power ➤ Restart Guest.

10. Start the VM by clicking VM ➤ Power ➤ Start Up Guest.

The Warning Notice and dynamic password token are displayed then you are prompted to log in.
11. Log in to the appliance with the shelldiag user account.

Note
Unless you have a utility that allows you to copy and paste values between the laptop and the VM, you
will have to manually enter the token and dynamic password values. If you mistype the password two
times, the system will lock the account for fifteen minutes.

When you access the command line for the first time, the date and time will be wrong. These will
self-correct after a few minutes.

December 3, 2019 IPC Confidential

 4.2: Single Click Deployment (SCD) in a virtual environment 157

12. Run the makeOCDfromCCM.sh script to set up the SCD appliance and assign the SCD ipc and
admin user account passwords:
a) Run the command su -lp and enter the dynamic password.
b) Change the directory to /opt/ipc/ocd.
c) Run the following command, where scd-ipc-password is the password you are assigning to
the SCD ipc user account and scd-admin-password is the password you are assigning to the
SCD admin account. There are no restrictions on the password length or valid characters.
./makeOCDfromCCM.sh ipc_password=scd-ipc-password
admin_password=scd-admin-password
You might see a number of Error 9s indicating that certain default ISO files, such as COP ISOs, could
not be uploaded from the SCM site. You might also see removable device errors. Both of these errors
are expected, so you can ignore them. You will upload the applicable ISO files in step 19.
13. Reboot the appliance by running the reboot command.
14. Confirm that there is a proper SCD appliance ethernet network adapter for the customer network:
a) Access the appliance command line.
b) Run the command ifconfig.
c) Confirm that there is a network adapter for the customer network that has Host-only assigned.
15. Use the following URL and the passwords you created in step 12 to access Single Click Deployment
to be sure it opens properly with the credentials you specified; appliance-ip is the IP address you
assigned to the SCD appliance.
https://appliance-ip/svc/oneclick/
Enter the ipc or admin user name and the appropriate password. It takes approximately eight
minutes for the application to open the first time.
16. Create a bootable ISO file for each COP ISO you will be uploading to Single Click Deployment.
For upgrading from a pre-Unigy v3.0 version, you will need a file for the 02.00.00.00.1888 COP (in
case you need to roll back) and the 03.00.00.00.1272 ISO. For an upgrade from Unigy v3.0 or higher,
you need only the 03.00.00.00.1272 COP.
a) Copy to the root directory (\) on the laptop or a network drive the COP xpp.zip file that
contains the ISO file for the version you are deploying. The COP files are available from the IPC
FTP site, FilesAnywhere or IPC Manufacturing. The files are
dunkin_cop_02.00.00.00.1888.xpp.zip (pre-Unigy v3.0) and
dunkin_cop_03.00.00.00.1272.xpp.zip (Unigy v3.0 or higher).
b) Extract the files from the xpp.zip file to the root directory (\).
Using the root directory is important because this is the path the system expects for the bootable
ISO file.
c) Within the \SCM-bin folder, run ImgBurn.exe to create the bootable ISO.
The ImgBurn dialog box is displayed.
d) Choose Create image file from files/folders.
e) In the toolbar to the right of the Source section, click the Browse for a file icon, select the COP
ISO file and the associated .md5 file that you extracted then click Open.
f) In the File System field within the Options tab on the right, confirm that ISO 9660 + UDF is
selected.

IPC Confidential Unigy 4.3

Enterprise Guide
158 4.2: Single Click Deployment (SCD) in a virtual environment

g) Within the Labels tab, specify ISO9660 and UDF labels and any other information you want to
provide.
h) In the Destination field, click the Browse for a file icon and specify the folder in which ImgBurn
will create the bootable ISO file and a name for the file then click Save.
Specify a different path and file name from the xpp.zip file. The folder should be in a location
that is accessible from the VM and that will be available each time you need to upload the bootable
ISO so you do not have to recreate the file for each customer deployment. The maximum file name
length is 128 characters and the maximum length for the combined path and file name is 219
characters. The recommended file name is bootable_dunkin_cop_version.iso, where
version is the COP software version.
i) Click the Build icon then click OK.
17. To prepare to upload a bootable COP ISO file to Single Click Deployment, mount the ISO file on the
SCD appliance:
1. Create a directory on the SCD appliance in which you can store the bootable ISO files by running
the following command:
mkdir /opt/ipc/ocd/cops/
2. Use an FTP utility such as WinSCP or SCP/SFTP to copy the COP ISO file to the /tmp directory
on the appliance.
3. Run the following command to copy the bootable ISO file from /tmp to the /opt/ipc/ocd/
cops/ directory; iso-file-name is the name of the ISO file:
cp /tmp/iso-file-name /opt/ipc/ocd/cops/iso-file-name
4. Run the following commands to create a mount point and mount the file loopback to /mnt/cop,
where iso-file-name is the name of the bootable ISO file:
a. mkdir -p /mnt/cop/;
b. mount -o loop /opt/ipc/ocd/cops/iso-file-name /mnt/cop/.
18. Click the Help link within Single Click Deployment or refer to the Single Click Deployment chapter
in the Enterprise Guide for information on uploading COP and appliance ISO files, registering
appliances with the Single Click Deployment appliance, performing deployments and upgrades, and
other related topics.
19. Before you travel to a customer site, upload all files that you will need for the deployment or upgrade
to the SCD appliance or to your laptop file system. These include the following files, which are
available from the IPC FTP site, FilesAnywhere:
• Appliance personality software ISO file for the applicable update.
• OS patch ISO file: If a version of the OS patch that is newer than the OS patch included in the
appliance personality software ISO file is available, include this file. You will install it manually
after the deployment or upgrade is complete.
• Any workaround scripts that are required.
When you upload the COP ISO files, use the DVD option and select a bootable ISO file you created in
step 16.
20. When you arrive at the customer site, change the Network Adapter value within the Virtual Machine
Settings panel to Bridged.

December 3, 2019 IPC Confidential

 4.3: Single Click Deployment tasks 159

a) Within VMware Workstation Pro, click the SCD VM in the Library frame on the left then click
Edit virtual machine settings.
b) Within Virtual Machine Settings, click Network Adapter.
c) Select Bridged: Connected directly to the physical network.
d) Click OK.
21. Change the network adapter value within the Virtual Network Editor:
a) Within the Library section, click the VM.
b) Click Edit ➤ Virtual Network Editor.
c) Click Change Settings.
If the system displays the User Account Control message box, click Yes.
d) Click the adapter that has the Host-only value in the Type column (usually VMnet1).
e) In the VMnet Information section, select the Bridged (connect VMs directly to the external
network) option button.
f) Click OK.
22. After you return from the customer site, restore the VM snapshot you created in step 6 to reset the
VM:
a) Within the Library frame in Workstation Pro, right-click the VM then click Snapshot ➤ Revert
to Snapshot: snapshot-name, where snapshot-name is the name of the snapshot you
created.
b) Click Yes.

4.3 Single Click Deployment tasks

The topics in this section describe the tasks you can perform with Single Click Deployment.
The following topics are included:
• Upgrade a Single Click Deployment appliance on page 170
• Register a Unigy appliance with a Single Click Deployment appliance on page 160
• Confirm that an appliance is registered with a Single Click Deployment appliance on page 162
• Unregister a Unigy appliance from a Single Click Deployment appliance on page 162
• Confirm that an appliance is not registered with a Single Click Deployment appliance on page 163
• Configure SMTP for Single Click Deployment notifications on page 163
• Import an artifact on page 164
• Create an image backup (restore point) with Single Click Deployment on page 165
• Import an Enterprise backup file to a Single Click Deployment appliance on page 166
• Deploy a software update that requires a new COP with Single Click Deployment on page 31
• Roll back the zones in an enterprise with Single Click Deployment on page 167
• View and update a Unigy appliance profile in Single Click Deployment on page 168
• Remove a Unigy appliance from a Single Click Deployment appliance on page 168
• Confirm that an appliance was removed from a Single Click Deployment appliance on page 169

IPC Confidential Unigy 4.3

Enterprise Guide
160 4.3: Single Click Deployment tasks

• Change a Single Click Deployment user account password on page 169

• Assign an appliance to a different Single Click Deployment user account on page 170

4.3.1 Register a Unigy appliance with a Single Click Deployment appliance

To use Single Click Deployment to deploy or upgrade Unigy appliances, you must register each Unigy
CCM, ACCM, and MM appliance with a Single Click Deployment appliance.
When an appliance registers with a Single Click Deployment appliance, the system assigns it to the
default Single Click Deployment user account. To change the account the appliance is assigned to, refer
to Assign an appliance to a different Single Click Deployment user account on page 170.

Note
If you are performing a partial upgrade in which one or more zones will remain at the previous software
version and one of these zones will provide the database dump for the zones being upgraded, this source
zone must be registered with, or must have been registered with at a previous time, a Single Click
Deployment appliance. This ensures that the file, OCDBBSnotice4agents.txt, that Single Click
Deployment requires is installed on the appliance. The appliance can register with any Single Click
Deployment appliance to install this file. It does not have to be registered at the time of the upgrade
because only the presence of the file on the source appliance is required for this scenario. The file is not
removed when you unregister an appliance. To determine whether the file is already on the appliance,
look for OCDBBSnotice4agents.txt in the /var/www/html/ directory. If the file is in the
directory, it is not necessary to re-register the appliance.

If a Unigy appliance is registered with a Single Click Deployment appliance, there is no harm in
rerunning the registration script for the appliance, however, if you run the script when Single Click
Deployment is running a task for the appliance, the task terminates after the current step in the process
completes, but does not complete any remaining steps.
1. Log in to the Unigy appliance from the command line.
2. Run the command su -lp and enter the appropriate password.
3. Run the command /opt/ipc/cop/ksrecop/recop54.sh eda_ip_address.
eda_ip_address is the IP address of the Single Click Deployment appliance with which you are
registering the appliance.
You will see the following output:
• If the appliance is not registered with a Single Click Deployment appliance, you will see a
message similar to:

Interactive env
Running iplan_agent.sh in /opt/ipc/cop/iPlan ...
Installing in /opt/ipc/cop/iPlan ...
iState update: agent-hold
==== mac:24B6FDF48E30 host:unigytpccm1 ip:20.40.60.80 mask:
255.255.255.230 gateway:20.40.60.97 ====
Server of MAC=24B6FDF48E30 has been successfully signed up and
assigned to ipc. The ini File has been successfully saved in: /var/
spool/backup/OneClick/clients/24B6FDF48E30/info.ini

**** OCD agent V2.1 install, exit code = 0 ****

December 3, 2019 IPC Confidential

 4.3: Single Click Deployment tasks 161

• If the appliance is already registered with the current Single Click Deployment appliance, you will
see a message similar to:
Called by recop54 ver 20120122 , verify pre-req
127.0.0.1 20.40.60.80
Services will be subject to WAN bandwidth test !!!!
AutoDeploy active, must disable before continue
Disable iPlan now [y/n]:

Type y then press Enter.

The output should look similar to the following:
Interactive env
Running iplan_agent.sh in /opt/ipc/cop/iPlan ...
Uninstalling in /opt/ipc/cop/iPlan ...
Uninstall done ...
chmod: cannot access `/opt/ipc/cop/iPlan/iplan_agent.sh': No such file
or direct ory
Signup4 OCD v2 with 40.50.60.70
Interactive env
Running iplan_agent.sh in /opt/ipc/cop/iPlan ...
Installing in /opt/ipc/cop/iPlan ...
iState update: agent-hold
==== mac:24B6FDF46E30 host:unigyccm1 ip:20.40.60.80 mask:
255.255.255.230 ga teway:20.40.60.97 ====
Server of MAC=24B6FDF46E30 has been successfully signed up and
assigned to ipc. The ini File has been successfully saved in: /var/
spool/backup/OneClick/clients/ 24B6FDF48E30/info.ini

**** OCD agent V2.1 install, exit code = 0 ****

• If the appliance is registered with another Single Click Deployment appliance, you will see a
message similar to:
Called by recop54 ver 20120122 , verify pre-req
127.0.0.1 20.40.60.80
AutoDeploy active, must disable before continue
Disable iPlan now [y/n]:

Type y then press Enter.

The output should look similar to the following:
Interactive env
Running iplan_agent.sh in /opt/ipc/cop/iPlan ...
Uninstalling in /opt/ipc/cop/iPlan ...
Uninstall done ...
chmod: cannot access `/opt/ipc/cop/iPlan/iplan_agent.sh': No such file
or direct ory
Signup4 OCD v2 with 40.50.60.70
Interactive env
Running iplan_agent.sh in /opt/ipc/cop/iPlan ...
Installing in /opt/ipc/cop/iPlan ...
iState update: agent-hold
==== mac:24B6FDF46E30 host:unigyccm1 ip:20.40.60.80 mask:
255.255.255.230 ga teway:20.40.60.97 ====
Server of MAC=24B6FDF46E30 has been successfully signed up and
assigned to ipc. The ini File has been successfully saved in: /var/
spool/backup/OneClick/clients/ 24B6FDF48E30/info.ini

IPC Confidential Unigy 4.3

Enterprise Guide
162 4.3: Single Click Deployment tasks

**** OCD agent V2.1 install, exit code = 0 ****

4. Confirm that the appliance is registered with the Single Click Deployment appliance by performing
the procedure Confirm that an appliance is registered with a Single Click Deployment appliance on
page 162.

4.3.2 Confirm that an appliance is registered with a Single Click Deployment appliance
This procedure describes how to confirm that a Unigy appliance is registered with a Single Click
Deployment appliance.
You can determine this information from the Single Click Deployment appliance the appliance registers
with or from Enterprise Watch.
1. Do one of the following:
• Determine the registration status from the Single Click Deployment appliance:
1. Access Single Click Deployment from a browser: https://scd_ip/svc/oneclick/,
where scd_ip is the IP address of the Single Click Deployment appliance.
2. Log in to Single Click Deployment.
3. Within the Main Menu, click Show All Servers.
4. Locate the appliance in the list. If the appliance is in the list and it has a white background, it is
registered with the Single Click Deployment appliance. If the appliance entry has a red
background, either the appliance is not communicating with the Single Click Deployment
appliance or it is not currently registered with the appliance.
• Determine the registration status from Enterprise Watch:
1. Access Enterprise Watch from a browser: https://vip/deployment/
EnterpriseWatch.html, where vip is the zone VIP.
2. Log in with the install user account credentials.
3. Click Refresh Status.
4. Expand the zone entry.
5. Expand the appliance entry.
6. Locate the OCDagent parameter, which should look similar to the following (with different IP
addresses):
OCDagent Done, 10.20.30.40 signup with OCD host 10.20.50.60
2. If the appliance did not register successfully, rerun the registration script.

4.3.3 Unregister a Unigy appliance from a Single Click Deployment appliance

After you use Single Click Deployment to deploy or upgrade Unigy appliances, you should unregister
each Unigy CCM, ACCM, and MM appliance from the Single Click Deployment appliance to prevent
possible system and security impacts.
This procedure unregisters the appliance, but the appliance directory remains on the Single Click
Deployment appliance and the appliance entry remains in the Single Click Deployment Show all
Servers list. If you want to remove an appliance from the Single Click Deployment appliance, perform
this procedure then perform the procedure Remove a Unigy appliance from a Single Click Deployment
appliance on page 168.

December 3, 2019 IPC Confidential

 4.3: Single Click Deployment tasks 163

1. Log in to the Unigy appliance from the command line.

2. Run the command su -lp and enter the appropriate password.
3. Run the command /opt/ipc/cop/iPlan/iplan_agent.sh uninstall.
Information similar to the following is displayed:
Interactive env
Running iplan_agent.sh in /opt/ipc/cop/iPlan ...
Uninstalling in /opt/ipc/cop/iPlan ...
Uninstall done ...

4. Confirm that the appliance was unregistered by performing the procedure Confirm that an appliance
is not registered with a Single Click Deployment appliance on page 163.

4.3.4 Confirm that an appliance is not registered with a Single Click Deployment appliance
This procedure describes how to confirm that a Unigy appliance that you unregistered from a Single
Click Deployment appliance is not registered.
You can determine this information from the Single Click Deployment appliance the appliance was
registered with or from Enterprise Watch.
After you unregister an appliance the /tmp/iplan_agent.sh.log file is no longer available on
the appliance, however, the appliance directory should still be in the /var/spool/backup/
OneClick/clients directory and the appliance should still be visible in the Single Click
Deployment Show All Servers list, but the OCDagent parameter should not be in Enterprise Watch.
Do one of the following:
• Determine the registration status from the Single Click Deployment appliance:
1. Access Single Click Deployment from a browser: https://scd_ip/svc/oneclick/,
where scd_ip is the IP address of the Single Click Deployment appliance.
2. Log in to Single Click Deployment.
3. Within the Main Menu, click Show All Servers.
4. Confirm that the appliance is in the list, but the entry has a red background. It can take up to
two hours for the background color to change.
• Determine the registration status from Enterprise Watch:
1. Access Enterprise Watch from a browser: https://vip/deployment/
EnterpriseWatch.html, where vip is the zone VIP.
2. Log in with the install user account credentials.
3. Click Refresh Status.
4. Expand the zone entry.
5. Expand the appliance entry.
6. The OCDagent parameter should not be in the list.

4.3.5 Configure SMTP for Single Click Deployment notifications

Use this procedure to configure a connection to the customer's SMTP server for Single Click
Deployment e-mail notifications.

IPC Confidential Unigy 4.3

Enterprise Guide
164 4.3: Single Click Deployment tasks

Single Click Deployment sends deployment and upgrade progress e-mail messages to the e-mail
addresses specified in the Single Click Deployment SMTP configuration. Messages are sent every thirty
minutes. If you do not configure the SMTP connection, these messages will not be sent.
1. Log in to Single Click Deployment: https://scd_ip/svc/oneclick/, where scd_ip is the
IP address of the Single Click Deployment appliance.
2. In the Main Menu, click SMTP Configuration.
3. Enter the appropriate values for each field.
For information on these fields, refer to SMTP Configuration: Configure SMTP Server on page 224.
4. Click Save.
5. Click Send Test Mail to test the configuration.

4.3.6 Import an artifact

When you use a Single Click Deployment appliance to deploy or upgrade the Unigy software, you select
the applicable artifact, which is a COP software .iso file or an appliance personality software .iso
file. If the version of the artifact you need is not available in Single Click Deployment, you can import
the artifact.
This feature enables you to import an .iso file from a network file store or a DVD. To use a DVD, you
can access the .iso file on the IPC FTP site, FilesAnywhere, and burn it to a DVD as you do the .iso
files for Unigy patches.
The size of the COP .iso file list is limited to ten files. If the list is full and you import a new file, the
oldest file is replaced by the new file.
1. If you are importing a COP .iso file, copy the file to the following directory on the Single Click
Deployment appliance:
/var/www/html/
2. Log in to Single Click Deployment: https://scd_ip/svc/oneclick/, where scd_ip is the
IP address of the Single Click Deployment appliance.
3. In the Single Click Deployment Main Menu, click Import Artifact.
4. In the Artifacts list, select the type of artifact you are importing.
• APP: appliance personality software .iso file
• COP: COP software .iso file
5. In From URL DVD, select the option that identifies the source of the artifact.
• If you select URL, enter the appropriate URL to the ISO file.
If you copied a COP .iso file to the SCD appliance in step 1, enter the following URL, where
appliance_ip is the IP address of the SCD appliance and version is the version of the COP
file; for example dunkin_03.00.01.00.0018:
http://appliance_ip/dunkin_version.iso
• If you select DVD, place the DVD in the DVD drive on the laptop computer on which you are
running Single Click Deployment.
6. Click Submit.
The system displays a status message then begins the import.
7. Go to the bottom of the Import Status log to view the import result.

December 3, 2019 IPC Confidential

 4.3: Single Click Deployment tasks 165

Click Refresh to refresh the log. It takes approximately twenty minutes for a COP or
personality .iso file to import.

4.3.7 Display available artifacts

Use this procedure to display the COP and appliance personality .iso files that are available on a
Single Click Deployment appliance.
If the files you need for an upgrade are not available on the Single Click Deployment appliance, contact
IPC Manufacturing or refer to Import an artifact on page 164.
1. Log in to Single Click Deployment: https://scd_ip/svc/oneclick/, where scd_ip is the
IP address of the Single Click Deployment appliance.
2. In the Single Click Deployment Main Menu, click Available Artifact.
The COP and appliance personality .iso files are displayed.

4.3.8 Create an image backup (restore point) with Single Click Deployment
Use this procedure to create an image backup file for one or more Unigy CCM or ACCM appliances
with Single Click Deployment. Single Click Deployment image backups are not supported for MMs.
The following image backup options are available:
• External Backup: Creates an image backup on the Unigy appliance and copies the backup file to the
Single Click Deployment appliance. This option stops after the file is copied to the Single Click
Deployment appliance, it does not perform any other tasks. This is the preferred option for creating
image backups.
Single Click Deployment performance will be impacted while the image files are being transferred to
the Single Click Deployment appliance. It takes approximately thirty minutes to transfer a backup file
to the appliance.
• Backup: Creates an image backup on the Unigy appliance, but does not copy the backup file to the
Single Click Deployment appliance. If the check box in the Install App ISO column or Enterprise
DB Restore column is selected, Single Click Deployment performs these tasks after it completes the
backup.
Perform this procedure only for CCM or ACCM appliances.
1. For each HA zone for which you are creating image backups, do the following:
a) Disable data replication by performing the procedure Disable data replication on page 498.
b) Place the cluster into maintenance mode by performing the procedure Place a cluster into
maintenance mode to enable control of HA failovers on page 598.
c) Place the Standby appliance into maintenance mode by performing the procedure Place an
appliance or Media Gateway into maintenance mode to indicate it is unavailable on page 599.
2. Log in to Single Click Deployment: https://scd_ip/svc/oneclick/, where scd_ip is
the IP address of the Single Click Deployment appliance.
3. In the Main Menu, click Enterprise Servers Plan.
4. In the Select column, select the check box for all of the appliances for which you are creating an
image backup then click Next.
5. In the Task column, select either External Backup or Backup for all of the appliances.
In most cases, you should always use External Backup. To prevent Single Click Deployment from
performing any other tasks after creating the backup, clear the check box in the Install App ISO and
Enterprise DB Restore columns.

IPC Confidential Unigy 4.3

Enterprise Guide
166 4.3: Single Click Deployment tasks

6. Click Save to save and validate the backup plan.

7. Click View Map to determine whether there are any issues prior to running the backup.
8. Close the Enterprise Map window and return to the Show Servers panel.
9. In the Active column, select the check box for each of the appliances.
10. Click Save.
11. In the confirmation message box, click OK.
Single Click Deployment initiates the backups.
12. Click Monitor to monitor the backup progress for all appliances.
The image backup progress will update within two minutes and every two minutes thereafter. The
time required to complete the backup varies based on the size of the database, but it requires a
minimum of twenty-five minutes for a CCM or ACCM appliance. If multiple backups are run at the
same time, they will end at different times approximately five minutes apart.
You can click the current process hyperlink to view the last forty lines of the agent log file.
The backup and transfer to the Single Click Deployment appliance is complete when the progress bar
is 100% and the date and time of the backup are displayed in the External Backup column.
13. For each HA zone:
a) Take the Standby appliance out of maintenance mode by performing the procedure Take an
appliance or Media Gateway out of maintenance mode on page 600.
b) Indicate that the Standby appliance maintenance is complete by performing the procedure Indicate
that maintenance on the Standby appliance is complete on page 601.
c) Take the cluster out of maintenance mode by performing the procedure Take a cluster out of
maintenance mode to resume normal HA operation on page 599.
d) Enable data replication by performing the procedure Enable data replication on page 497.

4.3.9 Import an Enterprise backup file to a Single Click Deployment appliance

Use this procedure to upload an Enterprise database backup file that was created in the UMS to a Single
Click Deployment appliance.
This procedure assumes that you already created the backup file and downloaded it to an external data
storage device that Single Click Deployment can access.

1. Log in to Single Click Deployment: https://scd_ip/svc/oneclick/, where scd_ip is the

IP address of the Single Click Deployment appliance.
2. Within the Main Menu, click Import Enterprise DB.
3. In the Enterprise DB List, confirm that the backup file is not already on the Single Click Deployment
appliance.
If the backup file is in the list, it is not necessary to complete this procedure.
4. In the Upload Enterprise DB field, click Browse then select the appropriate backup file.
5. Click Upload.
The system displays the file in the Enterprise DB list.
6. Confirm that the backup file is in the Enterprise DB list.

December 3, 2019 IPC Confidential

 4.3: Single Click Deployment tasks 167

4.3.10 Roll back the zones in an enterprise with Single Click Deployment
Use this procedure to roll back the appliances in one or more zones to a previous Unigy software
version.
You can perform the following types of rollback to restore the software to a previous version:
• External Rollback: Restores the software to a previous version from the image backup file that is
stored on the Single Click Deployment appliance. To use this option, the image backup file must have
been copied to the Single Click Deployment appliance during an External Backup. The rollback
process copies the image file to the appliance you are rolling back then performs the rollback. This is
the preferred roll back option.
Single Click Deployment redeploys the appropriate COP software then restores the image you
specify.
Only the latest backup image file is stored on the Single Click Deployment appliance. If an earlier
version is required, refer to the manual rollback procedures.
• Rollback: Restores the software to a previous version from an image backup file that is stored on the
appliance in the Unigy zone you are rolling back. This option cannot be used to roll back to a version
that requires a lower version COP.
Single Click Deployment stores only the latest image backup file for each appliance.
1. Log in to Single Click Deployment: https://scd_ip/svc/oneclick/, where scd_ip is the
IP address of the Single Click Deployment appliance.
2. In the Main Menu, click Enterprise Servers Plan.
3. In the Select column, select the check box for all of the appliances you are rolling back then click
Next.
4. If you are performing an External Rollback, in the External Backup column for each appliance you
are rolling back, confirm that an image backup file is displayed in the column. You will see the date
and time the file was created.
5. In the Task column for each appliance you are rolling back, select one of the following options:
• External Rollback: to roll back from the image backup file stored on the Unigy appliance.
• Rollback: to roll back from an image backup file stored on the Unigy appliance.
6. If you selected External Rollback and are rolling back to a version that requires a lower version COP,
in the COP ISO column, select the appropriate COP version.
For a pre-Unigy v3.0 version the COP is 02.00.00.00.1888.
7. Click Save to save the settings.
8. Click View Map to validate the configuration.
If there are any issues, correct them before proceeding to the next step.
9. In the Active column, select the check box for all of the appliances you are rolling back.
10. Click Save to execute the rollback.
11. Click Monitor to monitor the progress of the rollback for each appliance.
The progress is displayed in the Status column. To display details of the current status, click the
status link. The last 40 lines of the agent log are displayed.
The deployment is complete when the progress is 100% and the status of all appliances is agent-
hold.
12. Perform the following substeps for each zone you are rolling back:

IPC Confidential Unigy 4.3

Enterprise Guide
168 4.3: Single Click Deployment tasks

a) Downgrade the software on CDIs and Media Managers by performing the procedure Downgrade
(roll back) the CDI software on page 562.
b) Downgrade the Media Gateway software by performing the procedure Downgrade the Media
Gateway software on page 572.
c) Validate the zone by performing the procedure Validate a zone after a deployment, rollback, or
other operations on page 638.
13. If you rolled back to a pre-Unigy v2.0.1.7 version, run the
updateToneCadenceFreqForExistingInstances.sh script to copy the Tone Cadence
Frequency settings from a zone in the default instance to the zones in all other instances by
performing the procedure Run the updateToneCadenceFreqForExistingInstances.sh script on page
567.
14. If a recurring Archive all Zone backup job and backup file retention policy are not configured for at
least one zone in each realm in the enterprise, perform the procedure Configure a recurring archive
backup job and retention policy on page 612.
This helps to prevent out of memory issues due to high volumes of call history data. If partial
replication is enabled, the zone must be a collector zone.

4.3.11 View and update a Unigy appliance profile in Single Click Deployment
Use this procedure to view a Unigy appliance profile, and if necessary, change the Single Click
Deployment user account to which the appliance is assigned.
1. Log in to Single Click Deployment: https://scd_ip/svc/oneclick/, where scd_ip is the
IP address of the Single Click Deployment appliance.
2. Within the Single Click Deployment Main Menu, click Server Profile.
3. In the Select column, select the appliance for which you want to view the profile then click Next.
4. To change the user account the appliance is assigned to, select one or more accounts in the Users list.
To select multiple user accounts, you can use the Ctrl or Shift keys.
5. Click Save.

4.3.12 Remove a Unigy appliance from a Single Click Deployment appliance

Use this procedure to remove a Unigy appliance from a Single Click Deployment appliance when the
appliance is no longer needed or when you are moving the appliance to a different Single Click
Deployment appliance. You should also use this procedure to remove an appliance after replacing the
hardware.
This procedure removes the appliance from all lists and removes all associated files on the Single Click
Deployment appliance.
Prior to removing an appliance, you unregister the appliance to remove the associated files from the
Unigy appliance.
If the appliance is assigned to more than one Single Click Deployment user and you want it to remove it
for some or all of these users, log in to Single Click Deployment with each user account and perform
this procedure to remove the appliance. If you do not do this, the appliance will continue to be displayed
in the Show All Servers panel.

December 3, 2019 IPC Confidential

 4.3: Single Click Deployment tasks 169

1. Unregister the appliance before removing it from the Single Click Deployment appliance by
performing the procedure Unregister a Unigy appliance from a Single Click Deployment appliance
on page 162.
2. Log in to Single Click Deployment: https://scd_ip/svc/oneclick/, where scd_ip is the
IP address of the Single Click Deployment appliance.
3. Within the Single Click Deployment Main Menu, click Remove Server.
4. In the Select column, select the check box for the appliance you want to remove.
5. Click Delete.
6. In the confirmation message box, click OK.
The appliance is removed from all appliance lists, the registration with the Single Click Deployment
appliance is revoked, and the image backup file is removed. History related to the appliance is not
removed.
7. Confirm that the appliance was removed from the Single Click Deployment appliance by performing
the procedure Confirm that an appliance is registered with a Single Click Deployment appliance on
page 162.

4.3.13 Confirm that an appliance was removed from a Single Click Deployment appliance
This procedure describes how to confirm that a Unigy appliance that you removed from a Single Click
Deployment appliance is no longer registered or visible on the Single Click Deployment appliance.
After you remove an appliance from a Single Click Deployment appliance, the /tmp/
iplan_agent.sh.log file is no longer available on the appliance, the appliance directory is
removed from the Single Click Deployment appliance /var/spool/backup/OneClick/
clients directory, and the appliance is no longer visible in the Single Click Deployment Show All
Servers list.
1. Access the Unigy appliance command line.
2. Confirm that the /tmp/iplan_agent.sh.log file does not exist.
3. Access the Single Click Deployment appliance command line.
4. Display the contents of the /var/spool/backup/OneClick/clients directory.
You should not see a directory for the appliance identified by the appliance MAC address.
5. Confirm that the appliance is not displayed in the Single Click Deployment Show All Servers list:
a) Log in to Single Click Deployment: https://scd_ip/svc/oneclick/, where scd_ip is
the IP address of the Single Click Deployment appliance.
b) Within the Main Menu, click Show All Servers.
c) Confirm that the appliance is not in the list.

4.3.14 Change a Single Click Deployment user account password

Use this procedure to change the password for the current Single Click Deployment user account.
The Email field in the User Profile panel is reserved for future use, so the panel is used only for
changing the password for the currently logged in user.

IPC Confidential Unigy 4.3

Enterprise Guide
170 4.3: Single Click Deployment tasks

1. Log in to the Single Click Deployment appliance with the user account for which you are changing
the password: https://scd_ip/svc/oneclick/, where scd_ip is the IP address of the
Single Click Deployment appliance.
2. Within the Main Menu, click User Profile.
3. Enter then confirm the account password.
4. Click Change.

4.3.15 Assign an appliance to a different Single Click Deployment user account

When Unigy appliances register with a Single Click Deployment appliance, they are assigned to the
default Single Click Deployment user account. To make it easier to manage the appliances in large
enterprises, you can assign subsets of the appliances to one or more user accounts.
Only Single Click Deployment administrators can add a new user account. If a custom account exists,
you can assign a subset of appliances to the account. When you log in to Single Click Deployment with
the new user account, you see only the appliances assigned to the account when you use the Enterprise
Servers Plan, Server Profile, and Remove a Server features.
1. Log in to the Single Click Deployment appliance that the Unigy appliance is registered with and enter
the credentials for the user account that the appliance is currently assigned to: https://
scd_ip/svc/oneclick/, where scd_ip is the IP address of the Single Click Deployment
appliance. .
2. Click Server Profile.
3. Locate the appliance you are reassigning in the appliance list, click the option button in the Next
column, then click Next.
4. In the Users list, click the new user account you are assigning the appliance to then click Save.
To select multiple users, you can use the Ctrl or Shift keys.
The system changes the assignment and in the Enterprise Servers Plan, Server Profile, and
Remove a Server features, the appliance will be visible only to the user accounts it is assigned to.

4.3.16 Upgrade a Single Click Deployment appliance

When Single Click Deployment software updates are released, use this procedure to upgrade the Single
Click Deployment appliances. The software is included in Unigy appliance personality .iso files.

Note
Perform this procedure only if you are permitted to do so. If the current IPC policy on upgrading Single
Click Deployment appliances is that all upgrades will be handled by IPC Manufacturing, do not perform
this procedure. Instead, return the Single Click Deployment appliance to IPC Manufacturing in
Westbrook. If you are not sure whether you are permitted to upgrade the appliance, contact IPC Support.

This procedure is for upgrading a Single Click Deployment appliance. For information on using Single
Click Deployment to upgrade Unigy appliances, refer to Deploy a software update that requires a new
COP with Single Click Deployment on page 31 or Deploy a software update that does not require a new
COP with Single Click Deployment on page 60.
The following upgrade options are available:
• APP ISO: Use this option for most Single Click Deployment appliance upgrades. It requires
importing the Unigy appliance personality software .iso file that contains the Single Click
Deployment updates prior to performing the upgrade.

December 3, 2019 IPC Confidential

 4.4: Single Click Deployment panels 171

• IP: Use this option when it is not possible to use the APP ISO option due to bandwidth or access
issues. You specify the IP address of another Single Click Deployment appliance that has the correct
software deployed. The system retrieves the required files from the referenced Single Click
Deployment appliance then performs the upgrade.
• From /tmp: This option applies only to emergency fixes that require Development assistance. It
involves copying a .tgz archive file to the Single Click Deployment appliance /tmp directory.
When you click Update Now, the system uses the .tgz file to perform the upgrade.
This procedure is only for upgrades, do not downgrade the software to a previous version.
Refer to Upgrade SCD on page 222 for information on the associated fields and buttons.
1. Log in to Single Click Deployment: https://scd_ip/svc/oneclick/, where scd_ip is the
IP address of the Single Click Deployment appliance.
2. In the Main Menu, click Upgrade SCD.
3. Do one of the following:
• If you are using the APP ISO option and the appliance personality software .iso file that includes
the Single Click Deployment updates is not available on the Single Click Deployment appliance,
import the .iso file by performing the procedure Import an artifact on page 164.
• If you are using the IP option, determine the IP address of the Single Click Deployment appliance
that will serve as the source for the required files.
• If you are using the From /tmp option, copy the .tgz file to the Single Click Deployment
appliance /tmp directory.
4. Do one of the following:
• In APP ISO, select the appropriate appliance personality .iso file.
• In IP, type the appropriate IP address for the Single Click Deployment appliance that serves as the
source for the required update files.
• In From /tmp, the .tgz file you copied to the /tmp folder will be displayed. There is nothing to
do for this option.
5. Click Check for Update to determine whether an upgrade is required.
The system displays one of the following:
• If the software version you are deploying is different from the version currently deployed on the
Single Click Deployment appliance, the system displays the Single Click Deployment software
version followed by the Unigy software version for the software to be deployed below the list of
upgrade options. Compare the Unigy version to the OCD Version for the existing version
displayed at the top of the panel. Confirm that the new version is higher than the existing version.
• If the software versions are the same, the system displays the message Update not required
indicating that it is not necessary to upgrade the software.
6. To upgrade the software. click Update Now.
During the upgrade, the system logs you out of Single Click Deployment. The upgrade requires
approximately ten minutes to complete.

4.4 Single Click Deployment panels

The topics in this section describe the Single Click Deployment panels.
The following topics are included:

IPC Confidential Unigy 4.3

Enterprise Guide
172 4.4: Single Click Deployment panels

• Main Menu on page 173

• Enterprise Servers Plan: Select Servers on page 176
• Enterprise Servers Plan: Selected Servers on page 181
• Enterprise Server Plan: Map Details on page 188
• Enterprise Servers Plan: Monitor on page 190
• Server Profile: Select a Server on page 195
• Server Profile on page 196
• Remove Server: Delete a Server on page 199
• Servers History: Transactions on page 201
• Show All Servers: Servers on page 206
• OCD Build Report on page 208
• Import Artifact: Import an Artifact on page 211
• Available Artifact on page 212
• Import Enterprise DB: Enterprise DB upload form on page 213
• Enterprise Watch on page 215
• New Servers on page 221
• Upgrade SCD on page 222
• SMTP Configuration: Configure SMTP Server on page 224
• User Profile on page 226

4.4.1 Login Form

Use the Login Form to log in to Single Click Deployment.
To access this panel, use the Single Click Deployment URL https://scd_ip/svc/oneclick/,
where scd_ip is the IP address of the Single Click Deployment appliance.
Figure 3: Login Form

December 3, 2019 IPC Confidential

 4.4: Single Click Deployment panels 173

Table 7: Login Form fields

Name Description Values Notes

User Name User name assigned to a user User account name. Custom user accounts
account that has access to Single Default: ipc can be configured by a
Click Deployment. Single Click Deployment
administrator.
Password Single Click Deployment user You can change the
account password. password from the
Single Click Deployment
User Profile option after
you log in.

Table 8: Buttons and links

Name Description
Help Displays the Single Click Deployment online help.
login Logs the specified user in to Single Click Deployment.
Reset Clears the User Name and Password fields so new credentials can be entered.

4.4.2 Main Menu

The Main Menu is the launchpad for all Single Click Deployment features.
To access this panel, log in to Single Click Deployment. The Single Click Deployment URL is
https://scd_ip/svc/oneclick/, where scd_ip is the IP address of the Single Click
Deployment appliance.

IPC Confidential Unigy 4.3

Enterprise Guide
174 4.4: Single Click Deployment panels

Figure 4: Main Menu

December 3, 2019 IPC Confidential

 4.4: Single Click Deployment panels 175

Table 9: Main Menu

Name Description Values Notes

Location Descriptive text This is the value located
assigned by the Single to the left of the Single
Click Deployment Click Deployment
administrator appliance IP address at
the top, left corner of the
panel.
Single Click Deployment IP address of the Single IP address in dot- Displayed to the right of
IP address Click Deployment decimal format the location at the top,
appliance within ###.###.###.### left corner of the panel.
parentheses.
Help Link to the Single Click Click the link to access
Deployment help, which the help.
is included in the UMS Context-sensitive help is
online help. not available for Single
Click Deployment fields.
User Name User account of the Located in the top, right
currently logged in user. corner of the panel.
Logout Link for logging out of Click the link to log out.
Single Click
Deployment.

Table 10: Buttons

Name Description
Enterprise Displays the panel for performing Single Click Deployment tasks including
Servers Plan deployments, upgrades, image backups and rollbacks, database restores, and
appliance reboots.
Server Profile Provides access to configuration details for each Unigy appliance registered with the
Single Click Deployment appliance and the ability to assign an appliance to a
different Single Click Deployment user account.
Remove Server Provides the ability to remove an appliance from the Single Click Deployment
appliance.
Show All Servers Displays a list of all Unigy appliances registered with the Single Click Deployment
appliance and basic details about each appliance. This also provides a link to the
latest build report for each appliance, which includes information on the RPMs
installed and links to the appliance deployment log and UMS.
Servers History Displays Single Click Deployment history transactions for all Unigy appliances.
Import Artifact Enables you to import COP and appliance personality .iso files to a Single Click
Deployment appliance.
Available Artifact Displays all COP and appliance personality .iso files that are currently available
on a Single Click Deployment appliance.
Import Enterprise Enables you to import an Enterprise database backup file that was created in the
DB UMS. The file can be restored during an upgrade.
Enterprise Watch Displays Enterprise Watch for analyzing the health and status of the appliances in
an enterprise.

IPC Confidential Unigy 4.3

Enterprise Guide
176 4.4: Single Click Deployment panels

Table 10: Buttons (continued)

Name Description
New Servers Displays Unigy appliances that are registered with a Single Click Deployment
appliance, but for which no tasks have been performed.
Upgrade SCD Enables you to upgrade the Single Click Deployment appliance when software
updates are available.
SMTP Enables you to configure a connection to a customer's SMTP server for Single Click
Configuration Deployment notifications.
User Profile Enables you to change the password for a Single Click Deployment user account.

4.4.3 Enterprise Servers Plan: Select Servers

The Select Servers panel displays all appliances assigned to your Single Click Deployment user account.
Within it you can view basic appliance network and zone properties and status information, access
related links, and select all or a subset of the appliances for which you want to perform the tasks that
Single Click Deployment provides.

Note
Rows displayed with a red background are in an error state that requires investigation. In most cases, the
appliance is not communicating with the Single Click Deployment appliance or is not currently registered
with the appliance.

To access this panel, log in to the Single Click Deployment appliance then in the Main Menu, click
Enterprise Servers Plan. The Single Click Deployment URL is https://scd_ip/svc/
oneclick/, where scd_ip is the IP address of the Single Click Deployment appliance.
Figure 5: Select Servers

December 3, 2019 IPC Confidential

 4.4: Single Click Deployment panels 177

Table 11: Select Servers

Name Description Values Notes

Host Name Host name assigned to Click the host name link
the appliance in Network to display the
Configurator. transaction history.
Order Name assigned to a
deployment job.
IP Appliance IP address Click the IP address link
assigned to the to display the associated
appliance in Network build report.
Configurator.
MAC Appliance MAC
address.
Zone Zone ID assigned to the
appliance in Zone
Deployer.
Select Check box for selecting • Select the check box
the appliances to deploy, to include the
upgrade, roll back, or for appliance in the list of
which you want to appliances for which
perform other related you are performing a
tasks. task.
• Clear the check box
to exclude the
appliance from the
task to be performed.

IPC Confidential Unigy 4.3

Enterprise Guide
178 4.4: Single Click Deployment panels

Table 11: Select Servers (continued)

Name Description Values Notes

Status Status of the current • ks-invoked: Kickstart Click in the +- area to
task, including the process started, and display the Single Click
current state, progress, if applicable, an Deployment log.
and time remaining in image backup is The status value does
minutes. created then the COP not update
software is deployed. automatically. For status
information, refer to
• ks-invoked build: Enterprise Servers Plan:
• ks-invoked boot Monitor on page 190.
signup
• ks-invoked boot IP
validation:
• ks-wait
• ks-wait Push conf
files to OCD
• ks-done: The
kickstart process
completed, and if
applicable, Network
Configurator starts to
run.
• nc-done: Network
Configurator is
complete.
• app-wait:
• app-invoked:
• app-install:
Personality
Deployment is
running to deploy the
appliance personality
software.
• app-done:
• zone-check:
• zone-deploy:
• enable-ha
• all-done
• agent-hold:
Deployment is
complete.
• agent-hold Stopped
at app-wait
• maint-in: The system
is performing a task
such as an image
backup.

December 3, 2019 IPC Confidential

 4.4: Single Click Deployment panels 179

Table 11: Select Servers (continued)

Name Description Values Notes

Logs Reserved for future use.
Links Link to a set of • Minimal Deployment: You can access each
applications and logs. Accesses Personality application for the
Deployment if it has current appliance, the
not been run or is appliance's peer
running. appliance (HA zones),
and the zone VIP.
• Zone Deployer:
Accesses Zone
Deployer if it has not
been run or is
running.
• Deployment report:
Displays the
deployment report for
the appliance type
you select. This
includes the time the
deployment
completed, a link to
the deployment log,
access to the UMS
and WebLogic Admin
Console, a list of the
RPMs installed, and
segments of the
deployment log that
could indicate issues.
If you select this
option for the VIP, the
system displays the
report for the primary
appliance.
• Deployment Log:
Displays the
Personality
Deployment log.
Some entries are
truncated.
• Host Info: Provides
network, software
version, personality,
peer appliance, HA,
hardware model,
NTP, and other
information related to
the appliance.
• UDA Client: Enables
you to download or
deploy the Unigy Soft

IPC Confidential Unigy 4.3

Enterprise Guide
180 4.4: Single Click Deployment panels

Table 11: Select Servers (continued)

Name Description Values Notes

Client software on
your client computer.
• UMS client: Displays
the UMS Login page.
• Weblogic: Access
WebLogic. To access
WebLogic, you must
open port 7001.
• CheckHA: Runs
checkMyStatus
to display the current
status of the various
Unigy services for the
appliance you select.
• CheckHA: same as
CheckHA above.
• checkReplication:
Runs the
checkReplicati
on script to display
the current replication
status.
• checkTransientChann
el: Runs the
checkTransient
Channel script to
display detailed
information related to
the transient
channels.
• Orchestrator
CheckHAStatus:
Runs
checkHAStatus
to display the current
state of the services
for both appliances in
an HA zone.
• VA Life Cycle
Manager: For future
use.
• Blue Wave API:
Accesses the Blue
Wave Admin Console
if the Blue Wave
Director software is
deployed.

December 3, 2019 IPC Confidential

 4.4: Single Click Deployment panels 181

Table 11: Select Servers (continued)

Name Description Values Notes

• DS-Notification: For
future use.
• Enterprise Watch:
Displays Enterprise
Watch for analyzing
the current state of
appliances in the
enterprise based
either on individual IP
addresses or on zone
VIPs.

Table 12: Buttons

Name Description
Main Menu Closes the current page and displays the Single Click Deployment Main Menu.
Next Proceeds to the next page to perform a task for the appliances you select.

4.4.4 Enterprise Servers Plan: Selected Servers

Within this panel you configure the Single Click Deployment plan for the appliances you selected in the
Select Servers panel.
To access this panel, do the following:
1. Log in to the Single Click Deployment appliance associated with the appliances you are managing.
Use the credentials for the user account to which the appliances are assigned. The Single Click
Deployment URL is https://scd_ip/svc/oneclick/, where scd_ip is the IP address of
the Single Click Deployment appliance.
2. Within the Main Menu, click Enterprise Servers Plan.
3. In the Select Servers panel, select the check box in the Select column for each appliance you want to
include in the plan.
4. Click Next.
For information on the Advance panel, refer to Advance view on page 187.
Figure 6: Selected Servers

IPC Confidential Unigy 4.3

Enterprise Guide
182 4.4: Single Click Deployment panels

Table 13: Selected Servers – main view

Name Description Values Notes

Order Name assigned to the System generated or The order ID can be
current job. manually entered job ID. automatically assigned
by Single Click
Deployment or you can
override the system-
generated value with
your own custom ID.
The order is assigned to
all appliances for which
the current job is run.
Displayed above the
grid.
Force Activate On error Enables you to perform • Selected: continue Do not use this option
the task even if there the task despite the unless instructed to do
are errors displayed. fact that there are so by IPC Support or
errors indicated. Development.
Displayed above the
• Cleared: do not grid.
continue the task.

Host Name(IP) Host name, followed in Both values are

parentheses by the assigned in Network
appliance IP address. Configurator.
Active Indicates that the task • Select the check box Select this check box
selected for the to run the specified only when you are ready
appliance will be run task for the to perform the task. For
when you click the Save appliance. most tasks you should
button. save the plan and click
• Clear the check box View Map to validate the
to indicate that the plan before you select
task should not be this check box.
run for the appliance.

External Backup Displays the day, date, • No Backup: indicates Always create an image
and time of the latest that an image backup backup before
appliance image backup file is not available. performing an upgrade.
file created when you Single Click Deployment
run External Backup. • Backup file name: stores only the most
name of the backup recent backup file for
file stored on the each appliance.
Single Click
Deployment
appliance.

December 3, 2019 IPC Confidential

 4.4: Single Click Deployment panels 183

Table 13: Selected Servers – main view (continued)

Name Description Values Notes

Task • None: Does not
perform any task in
this list, but performs
other tasks that are
selected, such as
Install App ISO or
Enterprise DB
Restore.

• Recop: Deploys the

COP software and
performs any other
tasks specified.
• External Backup:
Creates an image
backup of the
appliance and copies
the backup file to the
Single Click
Deployment
appliance.
• External Rollback:
Performs a reCOP
then rolls back the
appliance to the
version specified in
the Install App ISO
column using the
backup file stored on
the Single Click
Deployment
appliance.
• Check Backup:
verifies the image
backup file.
• Rollback: Rolls back
the appliance to the
version specified in
the Install App ISO
column. Uses the
backup file stored on
the Unigy appliance.
• Backup: Creates an
image backup of the
appliance, but does
not copy the backup
file to the Single Click
Deployment
appliance. If an
appliance personality
software .iso file is

IPC Confidential Unigy 4.3

Enterprise Guide
184 4.4: Single Click Deployment panels

Table 13: Selected Servers – main view (continued)

Name Description Values Notes

selected, this deploys

the software.
• Reboot: Reboots the
appliance.

COP ISO If the COP software is

being deployed, this
indicates the ISO
version.
Personality Appliance personality. • CCM
• ACCM
• MM
Server Type Indicates whether the • Standalone: The value for MMs is
appliance is a appliance is a always Standalone.
standalone appliance or standalone ACCM or
a member of an HA is an MM.
cluster.
• HA: appliance is a
member of an HA
pair.

Install App ISO Indicates whether the • Check box selected:

appliance personality run Personality
software will be Deployment with the
deployed with appliance
Personality Deployment, personality .iso file
and if it is, the ISO selected.
version that will be
deployed. • Check box cleared:
do not run Personality
Deployment.

Zone Deploy & Data Indicates whether Zone • Check box selected: The Data Source (peer
Source Deployment will be run, run Zone Deployer. zone) provides the
and if it will, identifies customer digital
the zone that will be the • Check box cleared: certificates, certificate
first zone deployed do not run Zone keys, and the initial
(peer zone), and if Deployer. database for other
applicable, the zone in VIP of the peer zone in zones.
which the Enterprise dot -decimal format: For MMs, do not select
database backup will be ###.###.###.###. the check box, but the
restored. Data Source text box
should contain the same
peer zone value as the
associated zone's CCM
or ACCM appliances.

December 3, 2019 IPC Confidential

 4.4: Single Click Deployment panels 185

Table 13: Selected Servers – main view (continued)

Name Description Values Notes

Enterprise DB Restore Indicates whether an • Check box selected: The database can be
Enterprise database restore the Enterprise restored only on the
backup will be restored database specified. primary appliance in the
after the software zone you select as the
deployment is complete • Check box cleared: Data Source.
and if it will, identifies do not restore the This field applies only if
the name of the backup Enterprise database. you are upgrading all
file. Name of the Enterprise zones in the enterprise
database backup file. at the same time.

Preferred Zone Preferred zone that will • Check box selected: The preferred zone
be assigned to the preferred zone will be provides the database
appliance for database assigned. dump for an appliance
dumps when the zone is when the appliance
deployed. • Check box cleared: reboots after Zone
preferred zone will Deployer completes.
not be assigned. If partial replication is
VIP of the preferred enabled, the preferred
zone in dot -decimal zone for a collector zone
format: should be another
###.###.###.###. collector zone at the
same or a higher
software version.
If Multi-tier Replication is
enabled, the preferred
zone for a portal zone
should be another portal
zone.

IPC Confidential Unigy 4.3

Enterprise Guide
186 4.4: Single Click Deployment panels

Table 13: Selected Servers – main view (continued)

Name Description Values Notes

Deployment Status Process that is being • ks-invoked: Kickstart The progress is
run, current task process started, and displayed as a progress
progress, time if applicable, an bar and the percent
remaining, and access image backup is completed and
to a tail of the created then the COP represents the entire
deployment log. software is deployed. deployment process.
The progress is an
• ks-invoked build: estimate based on
• ks-invoked boot historical data. It is also
signup a reflection of all
processes selected to
• ks-invoked boot IP run for the deployment.
validation:
For example, if CCMs
• ks-wait and MMs are being
deployed, Zone
• ks-wait Push conf Deployer is not run for
files to OCD
the MMs, so the
• ks-done: The progress for the MM can
kickstart process jump from 50%, when
completed, and if Personality Deployment
applicable, Network completes, to 100%.
Configurator starts to Click the process name
run. to display a tail of the
deployment log.
• nc-done: Network
Mouse over the process
Configurator is
name to display the time
complete.
remaining to complete
• app-wait: the entire task.
• app-invoked:
• app-install:
Personality
Deployment is
running to deploy the
appliance personality
software.
• app-done:
• zone-check:
• zone-deploy:
• enable-ha
• all-done
• agent-hold:
Deployment is
complete.
• agent-hold Stopped
at app-wait
• maint-in: The system
is performing a task
such as an image
backup.

December 3, 2019 IPC Confidential

 4.4: Single Click Deployment panels 187

Table 13: Selected Servers – main view (continued)

Name Description Values Notes

Time Running time for the Time in hh:mm:ss The time is updated
current process. format. every 30 seconds and
restarts when the
process in Deployment
Status changes.
If the deployment for
one appliance
completes before the
deployment of the other
appliances, the time for
the last process
continues to update until
all appliances are
deployed.
Date Last time the panel was Shown in red text below
accessed. the grid.

Table 14: Buttons

Name Description
Main Menu Returns to the Single Click Deployment Main Menu.
Save Saves the plan configuration changes and if the Active check box is selected, initiates
the task selected in the Task column.
Registered Displays the fingerprints for all of the appliances displayed in this panel.
Fingerprints
View Map Validates the plan configuration and displays associated error messages or a
confirmation that the configuration is correct with no issues.
Map Details Displays information related to the appliances including zone, instance, host name, IP
address, MAC address, iDRAC IP address, subnet mask, default gateway, NTP
servers, NIC configuration type, domain, personality type, peer appliance IP address,
zone VIP, EVIP (data source), dependency VIP, and time zone.
Advance Displays details related to the associated appliance, highlighted in yellow, including
host name, domain, IP address, peer appliance IP address, zone VIP, Zone ID,
Instance ID, NTP servers, NIC configuration type, time zone, and Dependency VIP.
Hide Hide the Advance details.

Advance view
To access detailed information for each appliance, click the Advance button. This information is pulled
from each appliance when it registers with the Single Click Deployment appliance.

Important
Do not change any values unless instructed to do so by IPC Support or Development.

IPC Confidential Unigy 4.3

Enterprise Guide
188 4.4: Single Click Deployment panels

Table 15: Selected Servers – Advance view

Name Description Values Notes

Host Name Host name assigned to
the appliance in Network
Configurator.
Domain Domain assigned to the
appliance in Network
Configurator.
IP IP address assigned to IP address in dot-
the appliance in Network decimal format
Configurator. ###.###.###.###
Peer IP For a CCM or ACCM in IP address in dot-
an HA zone, this decimal format
displays the peer ###.###.###.###
appliance. For an MM,
the associated zone VIP
is displayed.
VIP The zone VIP assigned IP address in dot-
in Zone Deployer and decimal format
the zone configuration. ###.###.###.###
Zone ID Zone ID assigned to the
appliance in Zone
Deployer.
Instance ID Instance assigned to the This is not the instance
appliance within Single ID assigned in the Unigy
Click Deployment. database
NTPD NTP servers. IP address in dot- Multiple servers are
decimal format separated by commas.
###.###.###.###
NIC Type of NIC • Legacy: Single NIC.
configuration specified
in Network Configurator. • Bonded: Redundant
NICs.

Time Zone Time zone associated

with the zone's
backroom location.
Dependency VIP For CCMs or ACCMs, a IP address in dot- Specify this value only
zone that should be decimal format when it is necessary for
brought up before the ###.###.###.### a zone to wait to load
current zone. the database from a
specific zone. The zone
waits indefinitely for the
VIP to be active

4.4.5 Enterprise Server Plan: Map Details

This panel displays network-related information for the appliances selected in the Selected Servers
panel.
To access this panel:

December 3, 2019 IPC Confidential

 4.4: Single Click Deployment panels 189

1. Log in to the Single Click Deployment appliance. The Single Click Deployment URL is https://
scd_ip/svc/oneclick/, where scd_ip is the IP address of the Single Click Deployment
appliance.
2. Within the Main Menu, click Enterprise Servers Plan.
3. In the Select Servers panel, select the appliances to include in the plan then click Next.
4. In the Selected Servers panel (not labeled), click Map Details.
Figure 7: Map Details

Table 16: Map Details panel

Name Description Values Notes

Zone Zone ID assigned to the
appliance in Zone
Deployer.
Instance Instance associated with Instances are assigned
the appliance. at the zone level at
Configuration ➤
Enterprise ➤ System ➤
Zones.

Host Name Host name assigned to

the appliance in Network
Configurator.
IP IP address assigned to IP address in dot-
the appliance in Network decimal format
Configurator. ###.###.###.###
MAC Appliance MAC
address.
DRAC iDRAC IP address. IP address in dot-
decimal format
###.###.###.###
Subnet Mask Subnet mask assigned IP address in dot-
to the appliance in decimal format
Network Configurator. ###.###.###.###

IPC Confidential Unigy 4.3

Enterprise Guide
190 4.4: Single Click Deployment panels

Table 16: Map Details panel (continued)

Name Description Values Notes

Default Gateway Default gateway IP address in dot-
assigned to the decimal format
appliance in Network ###.###.###.###
Configurator.
NTPD NTP servers. IP address in dot- Multiple servers are
decimal format separated by commas.
###.###.###.###
NIC Type of NIC • Legacy: Single NIC.
configuration specified
in Network Configurator. • Bonded: Redundant
NICs.

Domain Domain assigned to the

appliance in Network
Configurator.
Personality Appliance personality • CCM This relates to the
type. personality software that
• ACCM is deployed.
• MM
Peer For a CCM or ACCM in IP address in dot-
an HA zone, this decimal format
displays the peer ###.###.###.###
appliance. For an MM,
the associated zone VIP
is displayed.
VIP Zone VIP assigned in IP address in dot-
Zone Deployer and the decimal format
zone configuration. ###.###.###.###
EVIP For CCMs or ACCMs, IP address in dot-
the VIP of the zone that decimal format
serves as the Data ###.###.###.###
Source (peer zone),
which provides the
customer digital
certificates, certificate
keys, and the initial
database.
Dependency VIP For CCMs or ACCMs, a IP address in dot- The zone waits
zone that should be decimal format indefinitely for this zone
brought up before the ###.###.###.### to be available.
current zone.
Time Zone Time zone associated
with the zone's
backroom location.

4.4.6 Enterprise Servers Plan: Monitor

After you initiate a Single Click Deployment task, use this panel to monitor the task progress.

December 3, 2019 IPC Confidential

 4.4: Single Click Deployment panels 191

Review the information in the Deployment Status column. The panel refreshes every two minutes.
To access this panel, start a Single Click Deployment task then click the Monitor button. The Single
Click Deployment URL is https://scd_ip/svc/oneclick/, where scd_ip is the IP address
of the Single Click Deployment appliance.
Figure 8: Monitor

Name Description Values Notes

Host name(IP) Host name assigned to Both values are
the appliance followed in assigned in Network
parentheses by the Configurator.
appliance IP address.
Active Indicates that the task is • Check box selected:
in progress. task is in progress.
• Check box cleared:
task is not selected to
run or is complete.

IPC Confidential Unigy 4.3

Enterprise Guide
192 4.4: Single Click Deployment panels

Name Description Values Notes

Deployment Status Process that is being • ks-invoked: Kickstart The progress is
run, current progress of process started, and displayed as a progress
the task, and access to if applicable, an bar and the percent
a tail of the agent log. image backup is completed and
created then the COP represents the entire
software is deployed. task process. The
progress is an estimate
• ks-invoked build: based on historical data.
• ks-invoked boot It is also a reflection of
signup all processes selected to
run for the task. For
• ks-invoked boot IP example, if CCMs and
validation:
MMs are being
• ks-wait deployed, Zone
Deployer is not run for
• ks-wait Push conf the MMs, so the
files to OCD
progress for the MMs
• ks-done: The can jump from 50%,
kickstart process when Personality
completed, and if Deployment completes,
applicable, Network to 100%.
Configurator starts to Click the process name
run. hyperlink to display a tail
of the last 40 lines of the
• nc-done: Network
agent log.
Configurator is
Mouse over the process
complete.
name to display the time
• app-wait: remaining to complete
• app-invoked: the entire task.

• app-install:
Personality
Deployment is
running to deploy the
appliance personality
software.
• app-done:
• zone-check:
• zone-deploy:
• enable-ha
• all-done
• agent-hold:
Deployment is
complete.
• agent-hold Stopped
at app-wait
• maint-in: The system
is performing a task
such as an image
backup.

December 3, 2019 IPC Confidential

 4.4: Single Click Deployment panels 193

Name Description Values Notes

Time hh:mm:ss Running time for the Time in hh:mm:ss The time is updated
current process. format. every 30 seconds and
restarts when the
process in Deployment
Status changes.
If the deployment for
one appliance
completes before the
deployment of the other
appliances, the time for
the last process
continues to update until
all appliances are
deployed.
Task Task being performed. • None
• Recop
• External Backup
• External Rollback
• Check Backup
• Rollback
• Backup
• Reboot

COP ISO If the COP software is

being deployed, this
indicates the ISO
version.
Personality Appliance personality. • CCM
• ACCM
• MM
Server Type Indicates whether the • Standby The value for MMs is
appliance is a Standalone.
standalone appliance or • HA
a member of an HA
cluster.
Install App ISO Indicates whether the • Check box selected:
appliance personality run Personality
software is being Deployment.
deployed with
Personality Deployment, • Check box cleared:
and if it is, the ISO do not run Personality
version that will be Deployment.
deployed. Version of the appliance
personality .iso file.

IPC Confidential Unigy 4.3

Enterprise Guide
194 4.4: Single Click Deployment panels

Name Description Values Notes

Zone Deployment Indicates whether Zone • Check box selected: The
Deployment will be run, run Zone Deployer. Data Source
and if it will, identifies (peer zone) provides the
the zone that will be the • Check box cleared: customer digital
first zone deployed do not run Zone certificates, certificate
(peer zone), and if Deployer. keys, and the initial
applicable, the zone in VIP of the peer zone in database for other
which the Enterprise dot -decimal format: zones.
database backup will be ###.###.###.###.
restored.
Enterprise DB Restore Indicates whether an • Check box selected: The database can be
enterprise database backup will be restored only on the
backup will be restored restored. primary appliance in the
after the software zone you select as the
deployment is complete • Check box cleared: Data Source.
and if it will, the name of backup will not be This field applies only if
the backup file. restored. you are upgrading all
Path to the enterprise zones in the enterprise
database backup file. at the same time.

Preferred Zone Preferred zone that will • Check box selected: The preferred zone
be assigned to the assign the preferred provides the database
appliance for database zone. dump for an appliance
dumps when the zone is when the appliance
deployed. • Check box cleared: reboots after Zone
do not assign the Deployer completes.
preferred zone. If partial replication is
VIP of the preferred enabled, the preferred
zone in dot -decimal zone for a collector zone
format: should be another
###.###.###.###. collector zone at the
same or a higher
software version.
If Multi-tier Replication is
enabled, the preferred
zone for a portal zone
should be another portal
zone.
Date Indicates the last time Shown in a red font.
the panel was accessed.

Name Description
Main Menu Closes the panel and displays the Single Click
Deployment Main Menu.
Edit Displays the Selected Servers panel from which
the task you are monitoring was initiated.

December 3, 2019 IPC Confidential

 4.4: Single Click Deployment panels 195

4.4.7 Server Profile: Select a Server

This panel displays a list of the appliances registered with the Single Click Deployment appliance that
are assigned to the user account with which you logged in. It displays basic information about each
appliance and enables you to select the appliance for which you want to view the profile details.
To access this panel, log in to the Single Click Deployment appliance then in the Main Menu, click
Server Profile. The Single Click Deployment URL is https://scd_ip/svc/oneclick/, where
scd_ip is the IP address of the Single Click Deployment appliance.

Note
Rows displayed with a red background have not communicated with the Single Click Deployment
appliance for at least two hours. This usually indicates an issue that should be investigated. It might
indicate that the appliance is no longer registered with the Single Click Deployment appliance.

Figure 9: Select a Server

Table 17: Select a Server

Name Description Values Notes

Host Name Host name assigned to
the appliance in Network
Configurator.
MAC Address Appliance MAC
address.
IP IP address assigned to IP address in dot-
the appliance in Network decimal format
Configurator. ###.###.###.###
Subnet Mask Subnet mask assigned IP address in dot-
to the appliance in decimal format
Network Configurator. ###.###.###.###
Default Gateway Default gateway IP address in dot-
assigned to the decimal format
appliance in Network ###.###.###.###
Configurator.

IPC Confidential Unigy 4.3

Enterprise Guide
196 4.4: Single Click Deployment panels

Table 17: Select a Server (continued)

Name Description Values Notes

Order Name assigned to a The same name is
deployment job. assigned to all
appliances associated
with the job.
Zone Zone ID assigned to the
appliance in Zone
Deployer.
Select Radio button for Selected option button Click the option button
selecting the appliance identifies the appliance to select the appliance
for which you want to for which the profile then click Next to display
display the profile information will be the profile information.
details. displayed.

Table 18: Buttons

Name Description
Main Menu Closes the current page and displays the Single Click Deployment Main Menu.
Next Proceeds to the appliance Server Profile panel where the profile details are displayed.

4.4.8 Server Profile

This panel displays detailed information related to an appliance including network properties, Unigy
appliance personality, instance, zone, VIP, and peer zone information, associated Single Click
Deployment user accounts, iDRAC IP address, location, and notes you can enter for the appliance.
To access this panel do the following:
1. Log in to the Single Click Deployment appliance. The Single Click Deployment URL is https://
scd_ip/svc/oneclick/, where scd_ip is the IP address of the Single Click Deployment
appliance.
2. In the Main Menu, click Server Profile.
3. In the Select column, click the radio button for the appliance for which you want to display the
appliance profile.
4. Click Next.

December 3, 2019 IPC Confidential

 4.4: Single Click Deployment panels 197

Figure 10: Server Profile

Table 19: Server Profile

Name Description Values Notes

MAC Address Appliance MAC
address.
Host Name Host name assigned to
the appliance in Network
Configurator.
Server IP IP address assigned to IP address in dot-
the appliance in Network decimal format
Configurator. ###.###.###.###
Subnet Mask Subnet mask assigned IP address in dot-
to the appliance in decimal format
Network Configurator. ###.###.###.###
Default Gateway Default gateway IP address in dot-
assigned to the decimal format
appliance in Network ###.###.###.###
Configurator.

IPC Confidential Unigy 4.3

Enterprise Guide
198 4.4: Single Click Deployment panels

Table 19: Server Profile (continued)

Name Description Values Notes

Peer HA Host For a CCM or ACCM in IP address in dot-
an HA zone, this decimal format
displays the peer ###.###.###.###
appliance. For an MM,
the associated zone VIP
is displayed.
NTPD NTP servers. IP address in dot- Multiple servers are
decimal format separated by commas.
###.###.###.###
Domain Domain assigned to the
appliance in Network
Configurator.
NIC Type of NIC • Legacy: Single NIC.
configuration specified
in Network Configurator. • Bonded: Redundant
NICs.

Personality Appliance personality • CCM This relates to the

type. personality software that
• ACCM is deployed.
• MM
Order Name assigned to The same order is
aSingle Click assigned to each
Deployment job. appliance for which the
job was run.
Instance ID Instance assigned to the
appliance in the
associated zone
configuration.
Zone ID Zone ID assigned to the
appliance in Zone
Deployer.
Local Zone VIP Zone VIP assigned in IP address in dot-
Zone Deployer and the decimal format
zone configuration. ###.###.###.###
Peer Zone VIP For CCMs or ACCMs, IP address in dot-
the VIP of the zone that decimal format
serves as the peer zone, ###.###.###.###
which provides the
customer digital
certificates, certificate
keys, and initial
database.
Users Single Click Deployment Single Click Deployment
user accounts to which user accounts are
the appliance is added from the
assigned. Administration menu.

December 3, 2019 IPC Confidential

 4.4: Single Click Deployment panels 199

Table 19: Server Profile (continued)

Name Description Values Notes

DRAC Appliance iDRAC IP IP address in dot-
address for remote decimal format
access. ###.###.###.###
Location Backroom location
assigned to the
appliance in the zone
configuration.
Notes Notes you can enter to
provide additional
information related to
the appliance.

Table 20: Buttons

Name Description
Main Menu Closes the current page and displays the Single Click Deployment Main Menu.
Save Saves the configuration changes you made.
Reset Reverts any changes to the last saved values.

4.4.9 Remove Server: Delete a Server

Within this panel, you can remove one or more Unigy appliances from a Single Click Deployment
appliance for the current Single Click Deployment user account.
This panel displays all Unigy appliances assigned to the current Single Click Deployment user.
To access this panel, log in to the Single Click Deployment appliance with which the appliance you are
removing is registered then within the Main Menu, click Remove Server. The Single Click Deployment
URL is https://scd_ip/svc/oneclick/, where scd_ip is the IP address of the Single Click
Deployment appliance.
Prior to removing an appliance, unregister the appliance to remove the associated files from the Unigy
appliance by performing the procedure Unregister a Unigy appliance from a Single Click Deployment
appliance on page 162.
If the appliance is assigned to more than one Single Click Deployment user and you want it to remove it
for some or all of the users, log in to Single Click Deployment with each user account then remove the
appliance. If you do not do this, the appliance will continue to be displayed in the Show All Servers list.

IPC Confidential Unigy 4.3

Enterprise Guide
200 4.4: Single Click Deployment panels

Figure 11: Delete a Server

Table 21: Delete a Server

Name Description Values Notes

Host Name Host name assigned to
the appliance in Network
Configurator.
MAC Address Appliance MAC
address.
IP IP address assigned to IP address in dot-
the appliance in Network decimal format
Configurator. ###.###.###.###
Subnet Mask Subnet mask assigned IP address in dot-
to the appliance in decimal format
Network Configurator. ###.###.###.###
Default Gateway Default gateway IP address in dot-
assigned to the decimal format
appliance in Network ###.###.###.###
Configurator.
Order Name assigned to a
deployment job.
Zone Zone ID assigned to the
appliance in Zone
Deployer.
Select Check box for selecting Select the check box to Select the appropriate
the appliances to indicate that the check boxes then click
remove. appliance will be Next to delete the
removed. selected appliances.

December 3, 2019 IPC Confidential

 4.4: Single Click Deployment panels 201

Table 22: Buttons

Name Description
Main Menu Closes the current page and displays the Single Click Deployment Main Menu.
Delete Removes the appliance from the Single Click Deployment appliance for the current
user.

4.4.10 Servers History: Transactions

Use this panel to view the Single Click Deployment appliance transaction history.
Sixty days of history are maintained. Beyond this threshold, old records are replaced by new records.
To display only the data associated with a specific appliance, click the MAC Address or IP hyperlink.
To access this panel, log in to the Single Click Deployment appliance then in the Main Menu, click
Servers History. The Single Click Deployment URL is https://scd_ip/svc/oneclick/,
where scd_ip is the IP address of the Single Click Deployment appliance.
Figure 12: Servers History: Transactions

IPC Confidential Unigy 4.3

Enterprise Guide
202 4.4: Single Click Deployment panels

Name Description Values Notes

MAC Address Appliance MAC This hyperlink redisplays
address. the Transactions panel
with data associated
with the appliance for
which you clicked the
link.
IP IP address assigned to IP address in dot- This hyperlink redisplays
the appliance in Network decimal format the Transactions panel
Configurator. ###.###.###.### with data associated
with the appliance for
which you clicked the
link.
Agent Alive Internal indicator. Information is not
applicable to general
task analysis.
Active Indicates whether the • No: process was not
associated process was active.
active when the
transaction record was • Yes: process was
written. active.

Host Name Host name assigned to

the appliance in Network
Configurator.
Plan The task performed.
Cop Build COP software build
number.
APP ISO Indicates whether the • Yes: the software was
appliance personality deployed.
software was deployed.
• No: the software was
not deployed.

APP Build If the appliance

personality software was
deployed, this indicates
the software build
number.
ServerType Indicates whether the • Stateful The value for MMs is
appliance is a Standalone.
standalone appliance or • Stateless
a member of an HA • Standalone
cluster. If it is an
appliance in an HA
zone, the HA type is
displayed (Stateful or
Stateless)

December 3, 2019 IPC Confidential

 4.4: Single Click Deployment panels 203

Name Description Values Notes

Peer Host Zone that served as the Zone IP address of VIP This is the source for
Data Source (peer zone) in dot-decimal format customer digital
for a zone deployment ###.###.###.### certificates and
or upgrade. certificate keys that are
synchronized with the
zone and the source for
the database dump.
Personality Appliance personality • CCM
software deployed.
• ACCM
• MM
Zone Deployment Indicates whether Zone • Yes: Zone Deployer
Deployer was run to was run.
deploy the zone.
• No: Zone Deployer
was not run.

Enterprise Restore Indicates whether the • Yes: the database

enterprise database was was restored.
restored.
• No: the database was
not restored.

Enterprise DB Name of the Enterprise

database backup file
that was restored.
Preferred Zone Preferred zone that will • Yes: a preferred zone
be assigned to the was specified.
appliance for database
dumps when the zone is • No: a preferred zone
deployed. was not specified.

Preferred Zone IP If a preferred zone was IP address or VIP of the

specified, this identifies preferred zone in dot -
the zone's IP address decimal format:
(standalone zone) or ###.###.###.###.
VIP (HA zone).
VIP Virtual IP address IP address or VIP of the
assigned to the zone in preferred zone in dot -
Zone Deployer. decimal format:
###.###.###.###.
Zone ID Zone ID assigned to the
appliance in Zone
Deployer.
Instance ID Instance assigned to the
appliance in the
associated zone
configuration.

IPC Confidential Unigy 4.3

Enterprise Guide
204 4.4: Single Click Deployment panels

Name Description Values Notes

Dependency VIP VIP of a specific zone IP address or VIP of the The zone will wait
that must be available preferred zone in dot - indefinitely for the
before the zone can decimal format: dependency zone to be
load the database from ###.###.###.###. available.
the zone.
Order Name assigned to a
deployment job.
Enterprise VIP The first zone to be
deployed, and if
applicable, the zone in
which the Enterprise
database backup was
restored (Data Source).
DB Indicates whether an • Yes: a database
Enterprise database backup was restored.
was restored.
• No: a database
backup was not
restored.

DB URL This field is not

supported.
License This field is not
supported.
Work around Indicates whether one or • Yes: workarounds Workarounds are
more workarounds were were run. available only for
run after a deployment emergency situations.
or rollback. • No: workarounds
were not run.

December 3, 2019 IPC Confidential

 4.4: Single Click Deployment panels 205

Name Description Values Notes

Status • ks-invoked: Kickstart
process started, and
if applicable, an
image backup is
created then the COP
software is deployed.
• ks-invoked build:
• ks-invoked boot
signup
• ks-invoked boot IP
validation:
• ks-wait
• ks-wait Push conf
files to OCD
• ks-done: The
kickstart process
completed, and if
applicable, Network
Configurator starts to
run.
• nc-done: Network
Configurator is
complete.
• app-wait:
• app-invoked:
• app-install:
Personality
Deployment is
running to deploy the
appliance personality
software.
• app-done:
• zone-check:
• zone-deploy:
• enable-ha
• all-done
• agent-hold:
Deployment is
complete.
• agent-hold Stopped
at app-wait
• maint-in: The system
is performing a task
such as an image
backup.

IPC Confidential Unigy 4.3

Enterprise Guide
206 4.4: Single Click Deployment panels

Name Description Values Notes

Last Update Date and time the last Date and time format.
Single Click Deployment
task was run.
User This field is not
supported.
Method Name of the API that • Change Status
generated the history
record. • Change the Plan
• New Server
• Server Assigned
• Server Deleted
• Server Unassigned

Mask Subnet mask assigned IP address in dot-

to the appliance in decimal format
Network Configurator. ###.###.###.###
Gateway Default gateway IP address in dot-
assigned to the decimal format
appliance in Network ###.###.###.###
Configurator.
NTPD NTP servers. IP address in dot- Multiple servers are
decimal format separated by commas.
###.###.###.###
NIC Type of NIC • Legacy
configuration specified
in Network Configurator. • Bonded
Domain Domain assigned to the
appliance in Network
Configurator.
Country Code that identifies the
country assigned to the
appliance through the
zone backroom location.

4.4.11 Show All Servers: Servers

This panel displays a list of all appliances registered with the Single Click Deployment appliance you
are logged in to and basic network and user information for each of them.

Note
Rows displayed with a red background are not communicating with or are not registered with the Single
Click Deployment appliance.

To access this panel, log in to Single Click Deployment then click Show All Servers. The Single Click
Deployment URL is https://scd_ip/svc/oneclick/, where scd_ip is the IP address of the
Single Click Deployment appliance.

December 3, 2019 IPC Confidential

 4.4: Single Click Deployment panels 207

Figure 13: Servers

Table 23: Servers

Name Description Values Notes

MAC Appliance MAC
address.
IP IP address assigned to IP address in dot- The link is for future use.
the appliance in Network decimal format
Configurator. ###.###.###.###
Subnet Mask Subnet mask assigned IP address in dot-
to the appliance in decimal format
Network Configurator. ###.###.###.###
Default Gateway Default gateway IP address in dot-
assigned to the decimal format
appliance in Network ###.###.###.###
Configurator.

IPC Confidential Unigy 4.3

Enterprise Guide
208 4.4: Single Click Deployment panels

Table 23: Servers (continued)

Name Description Values Notes

Host Name Host name assigned to
the appliance in Network
Configurator.
User The Single Click User account name Appliances are usually
Deployment user assigned to the default
account to which the user account, but they
appliance is assigned. can be assigned to
another account if
necessary.

Table 24: Button

Name Description
Main Menu Closes the current panel and displays the Single Click Deployment Main Menu.

4.4.12 OCD Build Report

This panel displays the latest build report for an appliance, which includes information on the RPMs
installed, possible issues, and links to the Main Menu, appliance deployment log, and UMS.
To access this panel:
1. Log in to Single Click Deployment.
2. Within the Main Menu, click Enterprise Servers Plan.
3. In the Links column, click View.
4. Click one of the Go links for Deployment report.
5. Log in with the install user account.
The Single Click Deployment URL is https://scd_ip/svc/oneclick/, where scd_ip is the
IP address of the Single Click Deployment appliance.

December 3, 2019 IPC Confidential

 4.4: Single Click Deployment panels 209

Figure 14: OCD Build Report - main section

IPC Confidential Unigy 4.3

Enterprise Guide
210 4.4: Single Click Deployment panels

Figure 15: OCD Build Report possible errors section

Name Description Values Notes

OCD Host Link to the Single Click Click the link to close
Deployment Main Menu. this panel and return to
the Main Menu.
Latest Not currently supported.
Deployment log Link to the appliance Log contents. Click the link to access
deployment log. the Personality
Deployment
deployment.log
file.
UMS Link that opens the UMS This opens the UMS for
interface for the the appliance, not the
appliance. VIP.
WebLogic Accesses the WebLogic You must open port
console. 7001 to access the
console.

December 3, 2019 IPC Confidential

 4.4: Single Click Deployment panels 211

Name Description Values Notes

RPMs Installed Number of RPMs Details include the line
installed and a list of number in the
each RPM with pertinent deployment log that
details. indicates when the RPM
was installed, number of
files in the package,
time required to install
the RPM, and the order
in which the RPMs were
installed.
Possible errors Segments of the The messages are
deployment log that displayed in red text.
indicate messages that Not all messages
might require indicate an issue.
investigation. Review the information
and refer to the full
deployment log for
additional details. If you
are not sure whether an
message is an issue,
contact IPC Support.

4.4.13 Import Artifact: Import an Artifact

Use this panel to upload Unigy COP and appliance personality software .iso files to the Single Click
Deployment appliance.
To access this panel, log in to Single Click Deployment then click Import an Artifact. The Single Click
Deployment URL is https://scd_ip/svc/oneclick/, where scd_ip is the IP address of the
Single Click Deployment appliance.
Figure 16: Import an Artifact

IPC Confidential Unigy 4.3

Enterprise Guide
212 4.4: Single Click Deployment panels

Table 25: Import an Artifact

Name Description Values Notes

Artifacts Artifacts are the ISO • APP Select the artifact type
files required to deploy you are importing.
the COP or appliance • COP
personality software.
From Specifies the local, • URL For a file stored on a
network, or optical drive local or network file
from which the artifact • DVD system, select URL then
can be uploaded. type the URL that
identifies the path to the
file in the text box on the
right of the field.
If you select DVD, Single
Click Deployment finds
the file on the DVD in
the local optical drive.
Import Status Displays the progress Review the output for
and status of an artifact errors.
upload.

Name Description
Main Menu Closes the current page and displays the Single Click Deployment Main Menu.
Submit Initiates the import and displays the status information.
Refresh Refreshes the status information while the import is in progress.

4.4.14 Available Artifact

This panel displays all Unigy COP and appliance personality software .iso files that have been
uploaded to the Single Click Deployment appliance.
To access this panel, log in to Single Click Deployment then within the Main Menu, click Available
Artifact. The Single Click Deployment URL is https://scd_ip/svc/oneclick/, where
scd_ip is the IP address of the Single Click Deployment appliance.

December 3, 2019 IPC Confidential

 4.4: Single Click Deployment panels 213

Figure 17: Available Artifacts

Name Description Values Notes

COP ISOs List List of COP .iso files Files in the .iso
on the Single Click format.
Deployment appliance.
APP ISOs List List of appliance Files in the .iso
personality .iso files format.
on the Single Click
Deployment appliance.

Name Description
Main Menu Closes the current page and displays the Single Click Deployment Main Menu.

4.4.15 Import Enterprise DB: Enterprise DB upload form

In this panel you can upload or delete Unigy Enterprise database backup files. When applicable, you can
restore these files as part of an appliance upgrade or when an Enterprise backup must be restored to
recover a corrupt database or when a database is missing data after a database dump.
To access this panel, log in to the Single Click Deployment appliance then in the Main Menu, click
Import Enterprise DB. The Single Click Deployment URL is https://scd_ip/svc/oneclick/,
where scd_ip is the IP address of the Single Click Deployment appliance.

IPC Confidential Unigy 4.3

Enterprise Guide
214 4.4: Single Click Deployment panels

Figure 18: Enterprise DB upload form

Table 26: Enterprise DB upload form

Name Description Values Notes

Enterprise DB List List of Enterprise Unigy Enterprise
backup files that have backup .tar files.
been uploaded
(imported) to the Single
Click Deployment
appliance.
Select Enterprise DB to Name of an Enterprise List of Enterprise Select the file you want
delete backup file to delete. backup files that were to delete.
uploaded to the Single
Click Deployment
appliance.
Upload Enterprise DB Name of an Enterprise Unigy Enterprise Click Browse to locate
backup file you want to backup .tar file. and select the database
upload. backup file then click
Upload to upload the file.

Table 27: Buttons

Name Description
Main Menu Closes the current page and displays the Single Click Deployment Main Menu.
Delete Deletes from the Single Click Deployment appliance the Enterprise database backup
file in the Select Enterprise DB to delete field.
Browse Enables you to locate and select the Enterprise backup file you want to upload.
Upload Uploads to the Single Click Deployment appliance the Enterprise backup file you
select.

December 3, 2019 IPC Confidential

 4.4: Single Click Deployment panels 215

4.4.16 Enterprise Watch

Enterprise Watch is an enterprise analysis tool that enables you to determine the state and health of
various components within a Unigy enterprise.
To access this panel, do one of the following:
• Log in to a Single Click Deployment appliance then within the Main Menu, click Enterprise Watch.
• If you do not have access to a Single Click Deployment appliance, access https://vip/
deployment/EnterpriseWatch.html from your browser, where vip is the VIP of the zone
from which you are accessing Enterprise Watch. Prior to accessing Enterprise Watch, you must
enable Web links by performing the procedure Enable or disable WebLogic, SWMS, and Enterprise
Watch Web link access on page 337.
Enterprise Watch provides the following benefits:
• Shortens triage time.
• Concurrent execution of all tests on all nodes.
• Composite enterprise with color coded heat-map.
• Easy visualization of abnormal data point test results.
• Minimizes the number of steps required to collect information.
• Any appliance or zone in the enterprise can be the access point.
• No performance impact on live production Unigy appliances. Every test is cached for 10 seconds on
each appliance.
• Graceful degradation for interoperability.
• Compressed enterprise information (Heat-map).
Look and feel
• Expandable view
• Composite Heat icon for data point
• Double view for visual comparison
• Upward propagating Heat icon
• Clickable nodes for current information
• Dual views for Side by Side Comparison
• Data points to consider
• Version
• Uptime
• https response time
• Last node state change (min ago)
• NTP drift
• Disk usage
Health state:
• Healthy ( Green )
• Warning ( Amber )

IPC Confidential Unigy 4.3

Enterprise Guide
216 4.4: Single Click Deployment panels

• Error ( Red)
When monitoring the Enterprise Watch job that is created when an Enterprise Install is run, the system
updates the status of the Enterprise Install job every two minutes. If the upgrade does not complete
successfully on all zones within two hours, the status of the upgrade is failed.
Figure 19: Enterprise Watch window

Table 28: Enterprise Watch window

Name Description Values Notes

Show only transitions Displays only unique • Select the check box
samples. to show only unique
samples.
• Clear the check box
to show all samples.

VIP (no label) VIP of the zone from VIP in dot decimal
which you are viewing format
the status of other ###.###.###.###
zones.
Triage Data Points Tests that determine the Click a TDP to run the
(TDPs) state of a system associated test. The
service or entity. result is displayed below
the panel.
This data is cached for
15 seconds and saved
for historical view.

Table 29: Enterprise Watch Buttons

Name Description
Refresh Status Displays the current state of all zones as viewed from the zone
specified in the VIP field.
Toggle Expands and collapses the view.
Navigation arrows << < > >>

December 3, 2019 IPC Confidential

 4.4: Single Click Deployment panels 217

To view the status of Enterprise components and processes, click Refresh Status and expand the tree as
illustrated in the following figure.
Figure 20: Unigy Enterprise Watch window - Refresh Status

Table 30: Enterprise Watch properties

Test Description
Current State For CCMs and ACCMs, this indicates the appliance role in the HA cluster: Active
or Standby. For Media Managers, the role is Active.
The information at the bottom of the panel identifies the appliance IP address and
indicates the up time and average load.
Registration Indicates whether the appliance is registered with the zone. ok indicates that the
appliance is registered.
Vitals Indicates the source of the information displayed.
Does not apply to the primary appliance in the first zone deployed.
Summary Displays the following information:
• Indicates whether the appliance is the Primary (CCM1 or ACCM1) or Secondary
(CCM2 or ACCM2) appliance in the HA pair or is a Media Manager (MM)
• State: Active, Standby, or unavailable
• Time the test was run
• Up time
• Device name.domain name

IPC Confidential Unigy 4.3

Enterprise Guide
218 4.4: Single Click Deployment panels

Table 30: Enterprise Watch properties (continued)

Test Description
DevReg Indicates whether the appliance is registering or registered with the associated
zone and the period of time since the last registration check. The details at the
bottom of the panel include:
• Last Registration Status: 22=registered
• Last Registration Date: Date and time the appliance last registered with the
zone. An appliance re-registers within three minutes of the previous registration.
• List of registration events.
HW_SW Displays the following information:
• Appliance model number: R620, R630, or virtual vendor. For a physical server,
the Model identifies the server model. For an appliance deployed in a VM, the
Model identifies the virtualization hypervisor vendor; for example, Model
VMware.
• RAM installed: current customer configurations have 64 GB for R620s and 128
GB for R630s
• COP software version: must be 03.00.00.00.1272
• Appliance personality software version: can be a patch, service pack, or hotfix
• OS patch version: current operating system patch deployed
The status indicator is amber and !!! Now Deploying !!! is displayed
when the appliance is being deployed or upgraded.
The status indicator is red when the appliance is not an R620 or R630 appliance.
The following information is displayed at the bottom of the panel:
• Base board information
• BIOS information
• Platform information
• Last deployment information
• Last RPM installed
• History of patch installs
• Last IPC RPM installed
• Enterprise Watch recent views
• Cached Enterprise Watch maps

NTP# Tests the appliance time offset from one or more NTP servers. The warning
threshold is 0.1 seconds and the error threshold is 1 second. The following
information is displayed:
• NTP server IP address
• Time offset in seconds
NTP from NTP offset from another appliance in the enterprise. If the appliance is the primary
appliance in an HA zone, the offset is determined from the peer appliance in the
zone. If the appliance is the secondary appliance, the offset is determined from the
primary appliance in another zone.
BWdly Bandwidth delay test, which provides the network bandwidth to the indicated IP
address and the packet/ping delay in seconds.

December 3, 2019 IPC Confidential

 4.4: Single Click Deployment panels 219

Table 30: Enterprise Watch properties (continued)

Test Description
ipmitool Hardware tests that Indicate the state of the appliance power supplies and the
internal appliance temperature.
In a virtual environment, the RAG color is orange, which is normal. The VM physical
resources are managed by the hypervisor.
portchk Scans all ports that are required for Unigy to fully function and indicates whether
these ports are open. The scanned ports are a subset of the ports described in the
Ports and Protocols Guide. They are based on the firewall rules. Third-party ports
are not scanned.
The following information is displayed below the panel:
• RAGG portchk: Number of IP addresses in the enterprise, including CCMs,
ACCMs, MMs, and VIPs.
Number of ports that are open. The number varies between the Active
and Standby appliance because the three SIP ports (defaults: 5060,
5061, and 5062) are port-forwarded by the firewall to the Active
appliance, and therefore, are not reported for the Standby appliances.
The ports that are scanned do not include the ports for the appliance
from which the scan is performed.
• Last scan: Previous time the ports were scanned.

• Port Scan Configuration: Ports scanned for each CCM, ACCM, CCM VIP, ACCM
VIP, and MM.
timer:portchk runs automatically every 14 minutes. It also runs when
you click the portchk service in Enterprise Watch, but when it is run
manually, it can run only once every two minutes.
inter_port_pause: indicates the time the system waits before scanning
each port to reduce overhead and network traffic. This is set to 500
micro seconds.
• Source appliance from which the scan was run and the date and time it was run.
If one or more ports that should be open are not open, the first few ports are
displayed in the panel and the remaining ports are displayed below the panel. Ports
that are closed are reported in the system logs and an alert is generated.
portchk is not run from Media Managers.
If the portchk service detects that at least one appliance in the enterprise has a
different software build version from the other enterprise zones, it disables closed
port alerting for all zones in the enterprise, displays NOTE: interop
enterprise, alerting disabled in the portchk output, and logs this
status to the system logs. This alerting cannot be performed in a mixed zone
enterprise. To reenable the alerting, restart all of the appliances in the enterprise
after all zones have been upgraded to the same build.
SLOAD HTTPS request rate per second. The warning threshold is 120 requests per second
and the error threshold is 150 requests per second.
This does not apply to Media Managers.
ULOGR Number of lines per second that the system is writing log records to the
Unigy.log file. The warning threshold is 2000 and the error threshold is 2500.
HTTPS Apache service delay. The warning threshold is 4 seconds and the error threshold
is 6 seconds, worst case response for a static page.
This does not apply to Media Managers.

IPC Confidential Unigy 4.3

Enterprise Guide
220 4.4: Single Click Deployment panels

Table 30: Enterprise Watch properties (continued)

Test Description
Space Usage Percentage of disk space used by each partition.
The information below the panel includes the largest five files greater than 90 MB in
each partition and the results of the /bin/df -Ph --no-sync command
that displays additional partition information.
The warning threshold is 80% and the error threshold is 90%. A warning is also
displayed if any file that is greater than 4 GB.
Inode Usage Indicates the inode space usage for each partition.
The information below the panel includes the largest five files greater than 90 MB in
each partition and the results of the /bin/df -Phi --no-sync command
that displays additional partition information.
The warning threshold is 60% and the error threshold is 70%.
HaPeer Identifies the peer appliance in the HA pair and indicates whether certificate and
key exchange is occurring between the appliances.
This does not apply to Media Managers.
OCCAS Provides information on the WebLogic servers. For the primary appliance in a zone,
information is displayed for the AdminServer, replica, and engine servers. For the
secondary appliance, information is displayed for the replica and engine servers.
This does not apply to Media Managers.
MySQL server Provides information on the database schema and MySQL service.
This does not apply to Media Managers.
SWMS Media ProvidesMedia Manager service and port information including the service status,
Manager information related to the RPM, port listener information, app_start.log data, date
and time of the last boot event and last exit event.
Applies only to ACCMs and Media Managers.
VIPq Indicates the success or failure of a VIP query sent by the appliance to the peer
appliance in the zone. If the request is successful the system identifies the
appliance that answered the request.
OpenSIPS server Indicates whether the OpenSIPs proxy server is running and displays status details.
Syslog-ng Indicates whether Syslog is running.
NICspeed Indicates whether the appliance NIC(s) are bonded or not bonded (Legacy) and the
current negotiated speed. It also provides configuration and history information for
each NIC port in use.
The threshold for ACCMs and MMs is 1000 Mb/s.
Firewall Indicates whether the firewall is up and whether it is set to Active when the
appliance boots. It also provides general information on the firewall rules.
Swaping If the space used for swapping exceeds 1 MB, this could indicate a system RAM
shortage and associated performance impact.
Replication Provides replication information including whether data replication is enabled for the
zone, if Multi-tier Replication is enabled, whether the zone is a portal zone, and the
number of members in the JGroups view.
The information below the panel includes Multi-tier Replication and data replication
status, realm size, JGroups view size, and JGroups view.
The warning is indicted if the JGroups view size is not correct.
This does not apply to Media Managers.

December 3, 2019 IPC Confidential

 4.4: Single Click Deployment panels 221

Table 30: Enterprise Watch properties (continued)

Test Description
JGroup Identifies the JGroups view and provides the results of the Enterprise Replication
Diagnostic test and JGroups details.
This does not apply to Media Managers.
Transient LSN Displays transient line status notification channel member and status information.
This does not apply to Media Managers.
Transient LSN Displays the number of transient line status notification channels and their status.
channels This does not apply to Media Managers.
Orchestrator Displays the Orchestrator service status information and the results fo the
checkMyStatus Web service for the appliance.
This does not apply to Media Managers.
License Indicates whether all Anonymous licenses have been consumed.
This does not apply to Media Managers.
OCDagent Applies only to appliances that are registered with a Single Click Deployment
appliance. Identifies the Single Click Deployment appliance that the appliance is
registered with and the current SCD deployment status. The status indicator is
amber when Single Click Deployment is in progress. The indicator is green at all
other times.

4.4.17 New Servers

This panel displays new CCM, ACCM, or MM appliances that registered with the Single Click
Deployment appliance through the bootable DVD and for which no tasks have been performed.
To access this panel, log in to the Single Click Deployment appliance then within the Main Menu, click
New Servers. The Single Click Deployment URL is https://scd_ip/svc/oneclick/, where
scd_ip is the IP address of the Single Click Deployment appliance.
Figure 21: New Servers

IPC Confidential Unigy 4.3

Enterprise Guide
222 4.4: Single Click Deployment panels

Table 31: New Servers

Name Description Values Notes

IP IP address assigned to IP address in dot-
the appliance in Network decimal format
Configurator. ###.###.###.###
MAC Appliance MAC
address.
Subnet Mask Subnet mask assigned IP address in dot-
to the appliance in decimal format
Network Configurator. ###.###.###.###
Default Gateway Default gateway IP address in dot-
assigned to the decimal format
appliance in Network ###.###.###.###
Configurator.

Table 32: Button

Name Description
Main Menu Closes the current page and displays the Single Click Deployment Main Menu.

4.4.18 Upgrade SCD

Use this panel to upgrade the Single Click Deployment appliance software. The software is included in
Unigy appliance personality .iso files.
This panel provides the following options for upgrading the software on a Single Click Deployment
appliance:
• APP ISO: Use this option for most Single Click Deployment appliance upgrades. It requires
importing the Unigy appliance personality software .iso file that contains the Single Click
Deployment updates prior to performing the upgrade.
• IP: Use this option when it is not possible to use the APP ISO option due to bandwidth or access
issues. You specify the IP address of another Single Click Deployment appliance that has the correct
software deployed. The system retrieves the required files from the other Single Click Deployment
appliance then performs the upgrade.
• From /tmp: This option applies only to emergency fixes that require Development assistance. It
involves copying a .tgz archive file to the Single Click Deployment appliance /tmp directory.
When you click Update Now, the system uses the .tgz file to perform the upgrade.
To access this panel, log in to Single Click Deployment with the then within the Main Menu, click
Upgrade SCD. The Single Click Deployment URL is https://scd_ip/svc/oneclick/, where
scd_ip is the IP address of the Single Click Deployment appliance.

December 3, 2019 IPC Confidential

 4.4: Single Click Deployment panels 223

Figure 22: Upgrade SCD

Table 33: Upgrade SCD

Name Description Values Notes

Single Click Deployment Version of the Unigy Before you upgrade the
Version appliance personality software, click Check for
software currently Update and compare the
deployed on the Single version displayed in the
Click Deployment output at the bottom of
appliance. the panel to this version
to be sure that the
version to be deployed
is higher than the
existing version.
If the versions are the
same, the system
displays the message
Update not
required.
Do not downgrade the
software to a previous
version.
APP ISO Option to upgrade the Name of the appliance This is the preferred
software from a Unigy personality .iso file option for Single Click
appliance personality that contains the Single Deployment appliance
software .iso file. Click Deployment upgrades.
updates that will be If the file that is required
deployed. is not in the list, use the
Select the Import Artifact option in
appropriate .iso file. the Main Menu to import
the file to the Single
Click Deployment
appliance.

IPC Confidential Unigy 4.3

Enterprise Guide
224 4.4: Single Click Deployment panels

Table 33: Upgrade SCD (continued)

Name Description Values Notes

IP Option to upgrade the IP address of a Single Use this option only if
software from another Click Deployment you cannot use the APP
Single Click Deployment appliance that has the ISO option.
appliance. appliance With this option, the
personality .iso file system retrieves the
that contains the Single required files from
Click Deployment another Single Click
updates that will be Deployment appliance.
deployed.
###.###.###.###
From /tmp Option to upgrade the Name of a .tgz file This option is only for
software from a .tgz that includes updates for emergency procedures
file for an emergency fix. emergency fixes. when Development
provides a .tgz file
with the required fixes.
Copy the file to
the /tmp directory.

Table 34: Buttons

Name Description
Update Now Performs the software upgrade. You will be logged out of Single Click
Deployment during the upgrade.
Check for Update Determines whether an upgrade is required. If the file referenced in the second
column is different from the version currently deployed, the system displays the
Single Click Deployment version and the Unigy software version. If an upgrade
is not required because the file referenced is the same as the version currently
deployed, the system displays the message Update not required.

Main Menu Closes the current panel and returns to the Main Menu.

4.4.19 SMTP Configuration: Configure SMTP Server

Use this panel to configure a connection to a customer's SMTP server for delivery of Single Click
Deployment e-mail notifications.
Single Click Deployment sends progress e-mail messages to the e-mail addresses specified in the Single
Click Deployment SMTP configuration. Messages are sent every thirty minutes.
To access this panel, log in to Single Click Deployment then within the Main Menu, click SMTP
Configuration. The Single Click Deployment URL is https://scd_ip/svc/oneclick/, where
scd_ip is the IP address of the Single Click Deployment appliance.

December 3, 2019 IPC Confidential

 4.4: Single Click Deployment panels 225

Figure 23: Configure SMTP Server Details for OCD

Table 35: Configure SMTP Server Details for OCD

Name Description Values Notes

SMTP Server Name or Name or IP address of Valid host name or IP
IP Address the customer's SMTP address in dot-decimal
server. format
###.###.###.###
SMTP Server Port Port to use for SMTP
communication.
Is Authentication Indicates whether • Selected:
Required authentication of server authentication is
access is required. required.
• Cleared:
authentication is not
required.

SMTP User Name User account that has

access to the SMTP
server.

IPC Confidential Unigy 4.3

Enterprise Guide
226 4.4: Single Click Deployment panels

Table 35: Configure SMTP Server Details for OCD (continued)

Name Description Values Notes

SMTP Password Password of the SMTP
user account.
Is SSL Required Indicates whether SSL • Selected: SSL is
security is required. required.
• Cleared: SSL is not
required.

Is TLS Required Indicates whether TLS • Selected: TLS is

security is required. required.
• Cleared: TLS is not
required.

To Addresses (comma E-mail address of all Valid e-mail address. For multiple recipients,
separated) notification recipients. separate the e-mail
addresses with
commas.
User's Text to Include in Custom text that can be
Mail included in the
messages sent.
Activate Configuration Indicates whether the • Selected: activate the You must select this
SMTP configuration configuration. check box to enable the
should be activated for sending of notifications.
use. • Cleared: do not
activate the
configuration.

Table 36: Buttons

Save Saves your changes.

Reset to Defaults Clears your changes and displays the last saved values.
Send Test Mail Sends an e-mail message to the e-mail addresses assigned in To Addresses.
Main Menu Closes this panel and returns to the Single Click Deployment Main Menu.

4.4.20 User Profile

Use this panel to change the password for the current Single Click Deployment user account.
To access this panel, log in to Single Click Deployment then within the Main Menu, click User Profile.
The Single Click Deployment URL is https://scd_ip/svc/oneclick/, where scd_ip is the
IP address of the Single Click Deployment appliance.

December 3, 2019 IPC Confidential

 4.4: Single Click Deployment panels 227

Figure 24: User Profile

Table 37: User Profile

Name Description Values Notes

Choose a password New password to be
assigned to the current
user account.
Re-enter password Password confirmation. Retype the value you
entered in Choose a
password.

Email Reserved for future use.

Table 38: Buttons

Name Description
Main Menu Closes the current panel and returns to the Single Click Deployment Main Menu.
Change Saves the new values.
Reset Clears any unsaved values and displays the last saved Email value.

IPC Confidential Unigy 4.3

Enterprise Guide
228 4.4: Single Click Deployment panels

December 3, 2019 IPC Confidential

 229

5 Multi-tier Replication
As IPC continues to develop the Unigy platform, we are announcing the next generation in backend data
replication called Multi-tier Replication. This new replication strategy leverages the existing
technologies (improved for resiliency) and new technologies, which allow customers to grow their
enterprises and become more fault tolerant to network disruptions over the WAN.
With the release of Unigy v3.0.0.1, IPC introduces the first generation of this improved Wide Area
Network data replication strategy. It continues to use the existing data replication infrastructure for
database replication within data centers and for Transient Channel Replication (line status and presence)
and Blue Wave Global Replication clusters across the enterprise, but it now offers a WAN-based data
replication structure.
When enabled, this replication structure maintains two layers of clustering:
1. Local Area Data Replication (LADR): Replicates data within each data center.
2. Wide Area Data Replication (WADR): Provides a data replication layer that introduces the following
improvements:
• Reduced bandwidth for data replication between data centers. Rather than replicate from all zones
to all zones, each data center has a portal zone. Each portal zone forms a WAN-based data cluster
with the other data center portal zones. Because data flows only between portal zones in the WAN,
data replication bandwidth requirements are reduced.
• Higher resiliency to network outages on the WAN. The WADR design provides approximately
three days (varies according to the size of the data center) of data retention should a prolonged
outage occur on the WAN. When the WAN connection is restored, the WADR enhanced indexing
design identifies the changes that occurred in both the local data center and global data centers and
resynchronizes the enterprise data accordingly.
• Increased expandability of the Unigy enterprise. Leveraging the WADR design, Unigy enterprises
can now exceed thirty zones.
The diagram below illustrates data replication between the zones in an enterprise in which Multi-tier
Replication is not enabled. All zones replicate their data to all other zones in the enterprise through
Local Area Data Replication.

IPC Confidential Unigy 4.3

Enterprise Guide
230

Figure 25: Default data replication architecture

The illustration below shows the same enterprise with Multi-tier Replication enabled for all data centers.
Data synchronization between the distributed data centers is through Wide Area Data Replication, which
replicates data only between the portal zones in each data center. Within each data center, replication
between the zones is through Local Area Data Replication.

December 3, 2019 IPC Confidential

 231

Figure 26: Multi-tier Replication

1 Default data center with Multi-tier Replication enabled.

2 Independent data centers with Multi-tier Replication enabled.
3 Wide Area Data Replication between portal zones.

Important
Before you enable Multi-tier Replication, develop a detailed implementation plan to optimize replication
and minimize or eliminate factors that can result in the loss of data. For Information to gather during your
planning, refer to the Multi-tier Replication pre-implementation checklist on page 244.

Note
To enable Multi-tier Replication, all zones within the enterprise must have Unigy v3.0.0.1 or higher
deployed and partial replication must be enabled.
To ensure optimal performance and minimize the chance of lost data, enable Multi-tier Replication for all
data centers as soon as possible.

IPC Confidential Unigy 4.3

Enterprise Guide
232

Terminology
The following terms describe the various components of Multi-tier Replication. For illustrations that will
help you understand these terms, refer to Multi-tier Replication activation example on page 238.
• Address: The street, city, state, country, and postal code that identify a building where Unigy
backrooms, front rooms, or both are located. You assign addresses to locations.
• Data center: A collection of backroom locations that share the same address. A data center can
include up to thirty Unigy and Blue Wave zones associated with one or more instances. Backroom
address and data center are synonymous. Data centers are instance agnostic.
• Location: The location within a building at a specific address where Unigy backrooms, front rooms,
or both are located; for example, ground floor server room or second floor trading center. You assign
locations to zones, Media Gateways, prototype devices, and CDIs.
• Multi-tier Replication: An extension of the default Unigy data replication architecture that reduces
the volume of data replicated throughout the enterprise, expands the enterprise zone capacity beyond
the thirty zone limit, and provides increased WAN resiliency. It includes the Local Area Data
Replication tier for data replication within data centers and a Wide Area Data Replication tier for
replication between data centers. Line status, presence, and Blue Wave data continue to be replicated
throughout the enterprise through a separate JGroups replication cluster.
• Local Area Data Replication (LADR): LAN-based JGroups mesh replication cluster that replicates
database data between the zones within a data center, and when Multi-tier Replication is not fully
enabled, between the zones within the data centers associated with the default data center.
This replication architecture continues to replicate transient data (presence and line status) and Blue
Wave data to all zones in the enterprise. These are not limited to a data center boundary.
• Wide Area Data Replication (WADR): Kafka replication cluster that optimizes data synchronization
between data centers across the WAN when Multi-tier Replication is enabled. The data is replicated
through a portal zone in each data center. Within the UMS, this feature is referred to as the Global
replication tier.
• Global replication tier: Within the UMS this term represents the WADR tier of Multi-tier
Replication. You configure the Global replication tier to enable, disable, suspend, or resume Multi-
tier Replication for a data center.
• Portal zone: A zone within a data center that replicates Unigy database data changes between its data
center and each data center in the WADR cluster. Each portal zone pulls data from the portal zones in
the other Multi-tier Replication-enabled data centers. You assign one portal zone to each data center.
• Local zone: A zone within a data center that is not a portal zone.
• Default data center: Provides a transitional Local Area Data Replication cluster for data centers that
do not have Multi-tier Replication enabled. One address is selected as the default data center for the
enterprise. It is the first data center for which you assign a portal zone and enable Multi-tier
Replication. When the zones in a new enterprise are deployed or the zones in an existing enterprise
are upgraded from a pre-Unigy v3.0.0.1 version, the zones and their associated data centers are
members of the default data center cluster. When you enable Multi-tier Replication for each of the
data centers in the cluster, their association with the default data center is broken and they become
members of the Wide Area Data Replication tier (cluster). When the enterprise is fully Multi-tier
Replication-enabled, the default data center cluster includes only the default data center. If you
disable Multi-tier Replication for a data center, it rejoins the default data center cluster. You can
change the default data center if necessary.
• Independent data center: A data center for which Multi-tier Replication is enabled. These data
centers are members of the Wide Area Data Replication tier.

December 3, 2019 IPC Confidential

 233

Tasks supported
Unigy supports the following Multi-tier Replication-related tasks:
• Assign a portal zone to a data center.
• Remove a portal zone from a data center.
• Enable Multi-tier Replication for a data center.
• Disable Multi-tier Replication for a data center.
• Suspend Multi-tier Replication for a data center to temporarily disconnect the data center from the
Wide Area Data Replication tier.
• Resume Multi-tier Replication for a data center to reconnect the data center to the Wide Area Data
Replication tier.
• Switch the default data center to a different data center.
Before you perform these tasks, confirm that the affected portal zones are healthy and operational to
ensure that the zones are fully synchronized.

Important
Multi-tier Replication must be enabled or disabled for one data center at a time. Enabling or disabling in
parallel is not supported.
All other Multi-tier Replication operations should also be performed one at a time. Multiple operations
performed simultaneously, especially when performed by different people in different zones, can result in
unexpected behavior. Each task indicates when it is complete.
To avoid data loss, no configuration changes should be made in any zone when Multi-tier Replication
tasks are being performed.

All changes should be coordinated to avoid conflicts.

Configuration
Multi-tier Replication configuration consists of the following high-level steps:
1. Confirm that the addresses required for all data centers are configured.
2. Confirm that all backroom locations required for all data centers are configured and the appropriate
address is assigned to each.
3. Assign the appropriate backroom location to each zone.
4. Enable partial replication if it is not already enabled.
5. Assign one of the addresses as the default data center.
6. Enable Multi-tier Replication for the default data center.
7. Enable Multi-tier Replication for each additional data center, one data center at a time.

Relationship between partial replication and Multi-tier Replication

For information on the different replication types Unigy supports and the data replicated by each, refer
to Replication on page 698.
To enable Multi-tier Replication, you must first enable partial replication. To disable partial replication,
you must first disable Multi-tier Replication in all data centers.

IPC Confidential Unigy 4.3

Enterprise Guide
234

Partial replication works independently of Multi-tier Replication. The data that partial replication
maintains is replicated only to the collector zones in the associated realm and is stored in a data store in
each collector zone that is separate from the Unigy data that is replicated through Multi-tier Replication.
Collector zones for a realm can be in different data centers, but when bandwidth is an issue, the
enterprise should be designed to minimize replication across the WAN.
Portal zones have a separate data store to which data changes made within the associated data center are
logged. If the data center is placed in the Suspended state, the data collected in the data store is not
replicated to the other data centers until Multi-tier Replication is resumed for the data center. Portal
zones can be collector zones or generator zones, however, to simplify upgrades, portal zones should be
collector zones. Blue Wave zones, which are always collector zones, are preferred for portal zones
because they have fewer programmatic and configuration changes.
To prevent the loss of partial replication data, there should be at least two collector zones in each realm.
When the enterprise includes Blue Wave zones, they must be collector zones and Monitor API rules
must be enforced to ensure that the history data is available to applications such as Proteus.
When a collector zone is restarted, it loads the Unigy database from a portal zone then pulls partial
replication data that was updated while the zone was offline from the generator and collector zones
within the associated realm. When a collector zone is reCOPed, the zone loads the Unigy database from
a portal zone then resynchronizes its partial replication data store from another collector zone in the
realm.
The sample enterprise below illustrates one way to configure an enterprise to support partial replication
and Multi-tier Replication. The enterprise consists of two realms, each with two instances. Data center 2
(dc2) spans two instances, a Unigy instance (I1) and a Blue Wave instance (I2). Each realm includes two
collector zones. The collector zone in Data center 2 is a Blue Wave zone, the other collector zones are
Unigy zones. There is one portal zone for each data center.
For simplicity, this diagram does not include lines that depict the replication of partial replication data
between the generator zones and collector zones within each realm. The generator zones and collector
zones in Data center 1 and Data center 2 replicate their partial replication data to the Unigy and Blue
Wave collector zones in Realm 1 and the generator zones and collector zones in Data center 3, Data
center 4, and Data center 5 replicate their partial replication data to the two Unigy collector zones in
Realm 2.

December 3, 2019 IPC Confidential

 235

Figure 27: Partial replication - Multi-tier Replication example

1 Realms
2 Instances
3 Data centers
4 Wide Area Data Replication between portal zones
5 Local zones
6 Local Area Data Replication between the zones within a data center
7 Blue Wave zone (Blue Wave zones are always collector zones)
8 Portal zones
9 Unigy collector zones

Portal zone data logging – transaction data store

The portal zone in each data center logs transaction data from its local zones in transaction data store
files. This data is exchanged with the portal zones in all other data centers in the enterprise. The initial
transaction data store file for each portal zone grows until it reaches 1 GB in size. At this point, the
system labels the file as eligible for deletion then creates a new file to collect subsequent
data. When the new file reaches 1 GB, the system marks it as eligible for deletion, creates a
new file, then deletes the oldest file; it repeats this cycle as the new file grows. This makes up to 2 GB of
data available to synchronize with the other data centers if the portal zone is temporarily unavailable

IPC Confidential Unigy 4.3

Enterprise Guide
236

because Multi-tier Replication for the associated data center is suspended, the portal zone is undergoing
a maintenance operation, or there is a network interruption. It takes approximately seven days to reach
the 1 GB limit, however, this can vary greatly according to the number of data transactions.
When Multi-tier Replication is suspended for a data center, the transaction data store continues to grow
as long as the portal zone is active, however, there is no exchange of data with the other data centers in
the enterprise. When Multi-tier Replication is resumed for the data center, the data in both transaction
data store files (if two are available) is exchanged with the other data centers. If more than 2 GBs of data
is sent to the data store files during the suspension, transaction data is lost because only two data store
files are maintained at any given time. Therefore, it is important to ensure that Multi-tier Replication for
a data center is resumed as soon as possible. A data center should be suspended only for upgrade or
other maintenance operations, and to be safe, it should be suspended for no more than two days.

Resiliency
Multi-tier Replication resiliency is provided through portal zone cluster high availability (HA). To help
prevent possible data loss, portal zones should be HA zones. If a portal zone fails, no data replication
between the associated data center and other data centers occurs until the zone returns to service.
If both appliances fail, take corrective action to bring the data center back into sync with the other data
centers. This involves repairing the issue that caused the failure then restarting the portal zone.

Restarting zones in a data center

If you have to restart all of the zones in a data center, restart the portal zone before you restart the local
zones. In general, it is necessary to restart the data center zones only if a portal zone data store exceeds
the 2 GB threshold while Multi-tier Replication is suspended for a data center or a data center is not
accessible. Restarting the portal zone resynchronizes the database if it is out of sync with the other portal
zone databases. While the portal zone is restarting, no configuration changes should be made in the local
zones because while the portal zone is inaccessible, it cannot collect the data changes in its data store, so
these changes will be lost when the zones resynchronize.
It is important that you understand the following scenarios related to a portal zone that goes down:
• Scenario 1: When the portal zone for a data center goes down:
• The local zones in the impacted data center will not receive updates from zones in other data
centers while the portal zone is down.
• The local zones in the impacted data center will receive alerts that the portal zone is down, but the
zones in the other data centers will not receive this alert.
• Any user configuration changes made in the local zones will not be replicated to the zones in other
data centers because the data store on the portal zone is not available to collect the data.
• For partial replication data, if the collector zone is not a local zone in the impacted data center,
partial replication data from the local zones in the impacted data center will not be replicated to the
collector zone in a different data center.
• Scenario 2: When the portal zone comes back up:
• When the portal zone restarts, if its database is out of sync, it loads the database from another
portal zone then continues to receive updates from the other portal zones.
• The local zones in the impacted data center start receiving the enterprise updates that were made in
the other data centers while the portal zone was down and also begin to receive real-time updates
through the portal zone. Any user configuration data changes that were made in the local zones
while the portal zone was down are lost.

December 3, 2019 IPC Confidential

 237

• For partial replication data, if the collector zone for a realm is one of the local zones in the
impacted data center and zones in other data centers are in the same realm, the collector zone
receives updated partial replication data for the zones in the other data centers only if you restart
the collector zone. When the collector zone restarts, it resyncs itself.

Upgrades and zone restarts

Each data center has one portal zone that serves as the preferred zone for the local zones within the data
center. Within a data center, the portal zone must be restarted or upgraded before the local zones to
ensure that the data is synchronized properly within the data center and with the other data centers in the
enterprise.
When you are upgrading the zones in multiple data centers, the first portal zone upgraded should be the
preferred zone for at least one other portal zone to ensure that the database that the portal zones load has
the highest schema version. For example, if Zone 1 is the first portal zone to be upgraded and Zone 10 is
the next portal zone to be upgraded, Zone 1 should be the preferred zone for Zone 10. Other portal zones
can get the database from Zone 1 or Zone 10 or any other portal zone that has the latest database
schema. Plan your upgrades carefully to ensure that all upgraded zones will have the latest database
schema.
The software version deployed on the appliances in the portal zone for the default data center and each
independent data center must be equal to or higher than the highest version deployed for the local zones
in the associated data center. The version deployed for the default data center must be equal to the
highest version deployed in the enterprise to accommodate any data center that rejoins the default data
center when Multi-tier Replication is disabled for the data center. All zones within a data center should
be upgraded to the same version as soon as possible.
If Multi-tier Replication is enabled, it must be enabled for all data centers in the enterprise, or the data
centers must be members of the default data center, before you upgrade any of the zones. Before you
upgrade a portal zone, you must suspend Multi-tier Replication for the associated data center. It is not
necessary to suspend Multi-tier Replication prior to upgrading local zones.
During an upgrade, if you are restoring the Enterprise database, restore it on the primary appliance in a
portal zone to ensure that no data is lost. Collector zones should be upgraded before generator zones to
be sure that they always have the latest database schema.

Alerts, monitoring, and diagnostics

Unigy generates alerts for various events throughout the Multi-tier Replication operations. It also
provides the following monitoring and diagnostic information:
• Over-all Multi-tier Replication-related system health. You can display this information through the
automated health check script.
• Multi-tier Replication-related zone connectivity status. You can display this information with the
following Web service-based diagnostic tests:
• Check an enterprise’s Multi-tier Replication status on page 258
• Check a zone’s Multi-tier Replication status on page 250
• Diagnose latency for Multi-tier Replication on page 260
• Multi-tier Replication replication role and status information. This information is available within
Enterprise Watch.

IPC Confidential Unigy 4.3

Enterprise Guide
238 5.1: Multi-tier Replication activation example

5.1 Multi-tier Replication activation example

This topic illustrates the different transitional stages involved in enabling Multi-tier Replication in a
Unigy enterprise and provides a high-level description of the replication of data throughout the
enterprise.
For information on Multi-tier Replication basic concepts and terminology, refer to Multi-tier Replication
on page 229.

Initial enterprise – default data replication architecture

Figure 28: Enterprise before Multi-tier Replication is enabled

After the zones in a new enterprise are deployed or the zones in an existing enterprise are upgraded from
a pre-Unigy v3.0.0.1 version, all data centers in the enterprise and their associated zones are in the Local
Area Data Replication tier. Each data center represents a different backroom address that can have one
or more backroom locations. Within this tier, all zones replicate data changes to all other zones through
Local Area Data Replication.
The sample enterprise in this topic consists of three data centers. Data center 1 includes two backroom
locations and Data center 2 and Data center 3 each include a single backroom location. Each location
includes two zones. Data center 1 BR Location A and Data center 2 BR Location C are in the same
instance, Instance A. Data center 1 BR Location B is in a separate instance, Instance B, and Data center
3 is in Instance C. The instances have no affect on Multi-tier Replication.

December 3, 2019 IPC Confidential

 5.1: Multi-tier Replication activation example 239

Transitional stage 1: enabling the default data center

Figure 29: Enabling Multi-tier Replication for the default data center

When you configure Multi-tier Replication, you enable one data center at a time, starting with the data
center that is designated as the default data center. To enable Multi-tier Replication for the default data
center, do the following:
1. Enable partial replication if it is not already enabled.
2. At Configuration ➤ Enterprise ➤ System ➤ Addresses, select the address that will serve as the
default data center (Address 1 in this example).
3. Within the Address Details panel, select the Default Data Center check box.
4. Within the Global Replication Tier Configuration panel, assign a portal zone to the data center (Zone
4 in BR Location B).
5. Click the Enable Global Replication Tier button.
After you enable Multi-tier Replication for the default data center, data replication between the zones
continues to be through Local Area Data Replication because all data centers are still members of the
Local Area Data Replication tier.
Zones that are not assigned as the portal zone for a data center are referred to as local zones. These
zones always replicate data with each other and with their portal zone through Local Area Data
Replication.

IPC Confidential Unigy 4.3

Enterprise Guide
240 5.1: Multi-tier Replication activation example

Data centers within the Local Area Data Replication tier that are not the default data center remain
associated with the default data center for replication purposes until they join the Wide Area Data
Replication tier when you enable Multi-tier Replication for them.

Transitional stage 2 – assigning a data center to the Wide Area Data Replication tier
Figure 30: Enabling Multi-tier Replication for the first independent data center

To enable Multi-tier Replication for a data center, do the following:

1. Within the Global Replication Tier Configuration panel, assign a portal zone to the data center (Zone
2 in Data Center 3 in this example).
2. Click the Enable Global Replication Tier button.
This removes the data center from its association with the default data center and makes it an
independent data center in the Wide Area Data Replication tier, converting the enterprise to a Multi-tier
Replication enterprise with Local Area Data Replication and Wide Area Data Replication tiers.
In this scenario, when a data change is made in a zone associated with the default data center, the system
does the following to replicate the data:
1. Replicates the data to all of the zones in the default data center (Zones 1 – 4 in Data Center 1) and the
zones in all data centers associated with the default data center (Zones 1 and 2 in Data Center 2)
through Local Area Data Replication.

December 3, 2019 IPC Confidential

 5.1: Multi-tier Replication activation example 241

2. Replicates the data from the default data center portal zone to the independent data center portal zone
through Wide Area Data Replication.
3. Within the independent data center, replicates the data from the portal zone to the local zones through
Local Area Data Replication.
If the data change is made in a zone within the independent data center, the system does the following:
1. Within the independent data center, replicates the data to the local zones and portal zone through
Local Area Data Replication.
2. Replicates the data from the independent data center portal zone to the default data center portal zone
through Wide Area Data Replication.
3. Replicates the data from the default data center portal zone to the zones in the default data center and
the zones in all data centers associated with the default data center through Local Area Data
Replication.

Transitional stage 3 – assigning the remaining data centers to the Wide Area Data
Replication tier
Figure 31: Enabling Multi-tier Replication for the remaining independent data centers

The final transitional stage involves activating Multi-tier Replication for each of the remaining data
centers. During this transition, all data centers, including the default data center, become independent
data centers within the Wide Area Data Replication tier. Data replication between the independent data
centers is Wide Area Data Replication through the portal zone in each data center. Replication within
each data center is through Local Area Data Replication.
In this scenario, when a data change is made in any zone, the system does the following to replicate the
data:

IPC Confidential Unigy 4.3

Enterprise Guide
242 5.2: Add, edit, or delete an address

1. Replicates the data to all of the zones within the associated data center through Local Area Data
Replication.
2. Replicates the data from the data center portal zone to the portal zones in each of the other data
centers through Wide Area Data Replication.
3. Within each data center that receives the change, replicates the data from the data center's portal zone
to its local zones through Local Area Data Replication.

5.2 Add, edit, or delete an address

Use this procedure to add, edit, or delete addresses.
Addresses identify the street, city, state, country, and postal code where Unigy front rooms, backrooms,
or both reside. For Multi-tier Replication, you also specify the default data center for the enterprise and
configure Multi-tier Replication. After you configure the addresses, assign them to locations.
Prior to Unigy v3.0, addresses were configured as part of location configuration. For pre-v3.0 zones,
continue to configure the addresses at Configuration ➤ Enterprise ➤ System ➤ Locations or
Tools ➤ Deployment ➤ Configure Location. Addresses that were configured in pre-v3.0 versions are
included in the Address Details panel. During the upgrade from a pre-v3.0 version to the current
software version, the data migration process populates the address Name field with the first 15
characters of the Address 1 field followed by the internal address ID.
For information on configuring and enabling or disabling Multi-tier Replication, refer to Enable Multi-
tier Replication on page 243 and Disable Multi-tier Replication on page 246.
If Multi-tier Replication is enabled for the data center associated with an address, you cannot change the
address name, but all other properties can be edited.
You can delete an address only if it is not assigned to any locations, it is not the default data center, and a
portal zone is not assigned to it.
For details on the values you enter for the address fields, refer to the UMS online help or the UMS UI
Guide.
1. Click Configuration ➤ Enterprise ➤ System ➤ Addresses.
2. Do one of the following in the Addresses list:
• To add an address, click +Add New.
• To edit an existing address, click the address.
3. Provide a unique name that identifies the address throughout the enterprise.
If the address is assigned to a backroom location, this name identifies the associated data center.
4. Add or modify the values for the remaining address properties.
5. Click Save.
6. To assign the address as the default data center for Multi-tier Replication:
• Assign the address to a backroom location as described in Add or edit a location on page 516.
• Return to this panel, select the Default Data Center check box, then click Save.
To change the address from the default data center to a non-default data center, perform the procedure
Change the default data center for Multi-tier Replication on page 249.

December 3, 2019 IPC Confidential

 5.3: Assign the default data center for Multi-tier Replication 243

5.3 Assign the default data center for Multi-tier Replication

If Multi-tier Replication is being enabled for the enterprise, assign one address to serve as the default
data center. After Multi-tier Replication is fully enabled, you can change the default data center if
necessary.
Prerequisites:
Before you assign the default data center, the following procedures should be complete:
• Configure the address that represents the default data center by performing the procedure Add, edit,
or delete an address on page 242.
• Configure a backroom location and assign the address to the location by performing the procedure
Add or edit a location on page 516.
• Assign the appropriate Backroom Location to the zones that are associated with the data center that
you are assigning as the default data center at Configuration ➤ Enterprise ➤ System ➤ Zones.
Only one default data center can be assigned for the enterprise. Perform this procedure only if a default
data center is not assigned. To change the default data center, refer to the procedure Change the default
data center for Multi-tier Replication on page 249.
1. Click Configuration ➤ Enterprise ➤ System ➤ Addresses.
2. In the Addresses list, click the backroom address (data center) that you are assigning as the default
data center.
Backroom addresses are identified by DC or Both in the Type column.
3. Click the Global Replication Tier Configuration tab and ensure that a portal zone is selected for the
data center.
4. Within the Address Details tab, select the Default Data Center check box then click Save.

5.4 Enable Multi-tier Replication

Perform this procedure to enable Multi-tier Replication to optimize configuration data replication,
increase WAN network resiliency, and allow enterprise expansion beyond thirty zones.
Prerequisites
Before you begin this procedure, design an implementation plan that will maximize performance and
minimize loss of data. For overview information and details that should be included in the plan, refer to
Multi-tier Replication on page 229 and the Multi-tier Replication pre-implementation checklist on page
244.

Important
Perform this procedure for one data center at a time. The enabling of one data center must complete
before you enable another data center. Unigy does not support enabling or disabling Multi-tier Replication
for multiple data centers in parallel. The system indicates when the process is complete; this generally
requires less than seven minutes.
Before you perform this procedure, all zones must be at Unigy v3.0.0.1 or higher.

Prior to enabling Multi-tier Replication for a data center, the system performs a series of validation
checks. If any of these tests fails, the system does not enable Multi-tier Replication for the data center.

IPC Confidential Unigy 4.3

Enterprise Guide
244 5.4: Enable Multi-tier Replication

1. If the enterprise will use automatic BCP plan activation for zone resiliency and disaster recovery,
configure the BCP plan and automatic BCP plan activation, if they are not already configured by
performing the procedure Configure a BCP plan on page 290.
2. Enable partial replication if it is not already enabled by performing the procedure Enable partial
replication on page 316.
3. Configure one address as the default data center by performing the procedure Assign the default data
center for Multi-tier Replication on page 243.
4. Enable Multi-tier Replication for each data center.
Begin with the default data center then enable each data center, one data center at a time.
a) Log in to the UMS in the zone that will serve as the data center's portal zone.
b) Determine whether the portal zone you are assigning to the data center is active and in a healthy,
operational state by performing the procedure Validate a zone before an upgrade, rollback, or
other operations on page 636.
Do not enable a data center if the portal zone appliances are not fully operational because this can
result in an inconsistent state that requires restarting the impacted zone.
c) Click Configuration ➤ Enterprise ➤ System ➤ Addresses.
d) In the Addresses list, click the data center for which you are enabling Multi-tier Replication.
Data center addresses are identified by DC or Both in the Type column.
e) Click the Global Replication Tier Configuration tab.
f) Click +Assign.
g) In the Available to Assign panel, select the check box for the zone you are assigning as the portal
zone then click < Assign.
The zone you select should be the zone you are currently logged in to.
The zone you selected is added to the Portal Zones section.
h) Click Enable Global Replication Tier.
The system enables Multi-tier Replication for the data center. Data is now replicated through Wide
Area Data Replication between the data center's portal zone and the portal zone in each
independent data center within the Wide Area Data Replication tier.
i) Validate the zone by performing the procedures in the Post-Maintenance Validation Test Suite. If
you do not have access to this document, perform the procedure Validate a zone after a
deployment, rollback, or other operations on page 638.

5.4.1 Multi-tier Replication pre-implementation checklist

Before you enable Multi-tier Replication, use this checklist to help ensure that you have done all that is
required to prepare the enterprise for this task.
Prior planning and preparation are essential to a successful Multi-tier Replication implementation. To
assist in the planning process, create a topology spreadsheet with the following columns and populate
the cells with the information described in the Pre-implementation checklist table below.
• Data center: Provide an entry for each data center, then for each data center, provide rows for each
of the zones within the data center.
• Default data center: Identify the default data center with an X in the column.
• Zone: Specify the zone name.
• VIP: Specify the zone VIP.

December 3, 2019 IPC Confidential

 5.4: Enable Multi-tier Replication 245

• Instance: Specify the instance assigned to each zone.

• Realm: Specify the realm that each zone is assigned to through its instance.
• Zone type: Indicate whether the zone is a Unigy zone or a Blue Wave zone.
• Location: Specify the backroom location for each zone.
• Portal zone: Identify each portal zone with an X in the column.
• Collector zone: Identify each collector zone with an X in the column.
• Preferred zone: Specify the preferred zone for each portal zone.
• IP address: Specify the IP address for each CCM or ACCM appliance in each zone.
• MAC address: Specify the MAC address for each CCM or ACCM appliance in each zone.
It will also be helpful to create a diagram that illustrates the relationships between the data centers and
their portal zones, collector zones, and preferred zones.

Table 39: Pre-implementation checklist

Task Notes
Refer to the topic Multi-tier Replication on page
229 for overview information and important
considerations for this feature.
Determine the data centers that are required for There can be up to 20 data centers per
the enterprise. enterprise.
Determine the zones that are in each data There can be up to 30 zones per data center,
center. not to exceed 58 zones per enterprise.
Determine the instance each zone is associated Data centers are instance agnostic, so they can
with. be associated with multiple Unigy and Blue
Wave instances.
Determine the realm(s) each data center is This is necessary to identify the zones that
associated with. should be assigned as partial replication
collector zones.
Determine which zones will be collector zones There must be at least two collector zones and
and which will be generator zones for partial one generator zone per enterprise when partial
replication. replication is enabled. To help ensure that there
is no loss of partial replication data, there
should be at least two collector zones per realm
for redundancy.
Collector zones can be Unigy or Blue Wave
zones. Blue Wave zones must always be
collector zones.
Determine the data center address that will Any backroom address can serve as the default
serve as the default data center. data center.
After Multi-tier Replication is enabled for all data
centers, you can change this designation, if
necessary.
For each data center, determine the zone that You can assign only one portal zone per data
will be assigned as the portal zone. center.

IPC Confidential Unigy 4.3

Enterprise Guide
246 5.5: Disable Multi-tier Replication

Table 39: Pre-implementation checklist (continued)

Task Notes
For each portal zone, determine the preferred The preferred zone for a portal zone must be
zone from which it will load the database when another portal zone, preferably from the nearest
the zone is restarted (refreshed). data center. The preferred zone should also be
a portal zone that is at an equal or higher
schema version to avoid loss of data.
When you upgrade the portal zones, designate
one zone as the first zone to be upgraded and
designate this zone as the preferred zone for at
least one other portal zone. As each portal zone
(except the first zone) is upgraded, the preferred
zone should be a portal zone that was already
upgraded to ensure that the database that will
be loaded always has the latest schema
version.
It is not necessary to determine the preferred
zone for local zones because the preferred
zone will always be the associated data center's
portal zone.
Determine the sequence in which you will You must enable Multi-tier Replication for the
enable Multi-tier Replication for each data default data center first.
center.
Confirm that all addresses required for the Refer to the procedure Add, edit, or delete an
enterprise data centers are configured. If they address on page 242.
are not, configure them.
Confirm that all backroom locations are Refer to the procedure Add or edit a location on
configured. If they are not, configure the page 516.
locations and assign the appropriate address to
each.
Confirm that the appropriate Backroom Location Configuration ➤ Enterprise ➤ System ➤ Zones.
is assigned to each zone in the enterprise. If it is
not, set the correct location.
For each portal zone, confirm that the preferred Configuration ➤ Enterprise ➤ System ➤ Zones.
zone is correct. If it is not set the correct zone.
If the enterprise consists of more than twenty Configuration ➤ Enterprise ➤ System
zones, confirm that the JGroups Minimum Thread Features ➤ Interzone Communication.
Pool Size and JGroups Maximum Thread Pool Refer to the UMS online help or UMS UI Guide
Size are set properly for the number of zones. for details.
Confirm that all zones in the enterprise have All zones must be at v3.0.0.1 or higher before
been upgraded to Unigy v3.0.0.1 or higher. you can enable Multi-tier Replication in any
zone.

5.5 Disable Multi-tier Replication

Use this procedure to disable Multi-tier Replication for one or more data centers.

December 3, 2019 IPC Confidential

 5.6: Suspend or resume Multi-tier Replication 247

Important
Disable Multi-tier Replication for one data center at a time. Unigy does not support disabling Multi-tier
Replication for multiple data centers in parallel.
If you are disabling Multi-tier Replication for all data centers, disable the default data center last.

When you disable Multi-tier Replication for a data center, the zones are not restarted and it is not
necessary to manually restart them.
1. Log in to the UMS in the portal zone for the data center you are disabling.
2. Determine whether the portal zone is active and in a healthy, operational state by performing the
procedure Validate a zone before an upgrade, rollback, or other operations on page 636.
Do not disable Multi-tier Replication for a data center if the portal zone appliances are not fully
operational because this can result in an inconsistent state that requires restarting the impacted zone.
3. Click Configuration ➤ Enterprise ➤ System ➤ Addresses.
4. In the Addresses list, click the address associated with the data center for which you are disabling
Multi-tier Replication.
5. Within the Global Replication Tier Configuration tab, click the portal zone in the Portal Zones list
then click Remove to remove the zone as the portal zone.
6. Click Disable Global Replication Tier.
The data center becomes a data center associated with the default data center Local Area Data
Replication tier.
7. If you are deactivating Multi-tier Replication for all data centers in the enterprise, repeat steps 1
through 6 for each data center, ending with the default data center.
8. Confirm that disabling Multi-tier Replication was successful by performing the procedures in the
Post-Maintenance Validation Test Suite. If you do not have access to this document, perform the
procedure Validate a zone after a deployment, rollback, or other operations on page 638. .

5.6 Suspend or resume Multi-tier Replication

When you suspend Multi-tier Replication for a data center, it temporarily disconnects from the Wide
Area Data Replication tier and stops replicating data with the other independent data centers in the
enterprise, however, Local Area Data Replication within the data center continues as long as the portal
zone is available.

Note
When Multi-tier Replication is suspended for a data center, the data center does not join the default data
center as it would if you disabled Multi-tier Replication for the data center.

The zones in a suspended data center continue to write configuration changes to the portal zone
transaction data store, but the data center does not send the updates to or receive updates from other
independent data centers until Multi-tier Replication is resumed for the data center. When you resume
Multi-tier Replication, the portal zone for the data center you resumed pushes the changes made within
the Local Area Data Replication tier while the data center was suspended to the other independent data
centers and pulls the changes made in the other data centers during the suspension to resynchronize the
database.
If Multi-tier Replication is suspended for an extended period of time, transaction data might be lost. This
happens if the transaction data store files (backup file plus current file) in the local or other portal zones
exceed the 2 GB limit while the data center was suspended. In this situation the local database will be

IPC Confidential Unigy 4.3

Enterprise Guide
248 5.6: Suspend or resume Multi-tier Replication

out of sync and the portal zone and local zones will have to be refreshed. To prevent this, when possible,
suspend Multi-tier Replication for no more than two days. For information on the transaction data store
threshold, refer to Portal zone data logging – transaction data store on page 235.
If the portal zone is not available (that is, the HA cluster is down due to zone refresh, upgrade when both
appliances are being upgraded at the same time, network interruption, or other issue) while the data
center is in the suspended state, configuration changes made in the local zones cannot replicate to the
transaction data store in the portal zone. This results in the local zones being out of synch with the portal
zone. To resynchronize the zones, restart all of the local zones in the data center when the portal zone is
available. The local changes that were made while the portal zone was down will be lost, but the zones
will be synchronized. If you do not restart the local zones, the local data will be available in these zones,
but not on the portal zone or in the rest of the enterprise. The next time the local zones are refreshed,
they will lose the data because refreshing the local zones loads the database from the portal zone.
Certain operations, such as disabling and enabling data replication for a portal zone, require suspending
the data center.
You cannot suspend Multi-tier Replication for the default data center. If it is necessary to suspend the
default data center, you must first make another data center the default data center by performing the
procedure Change the default data center for Multi-tier Replication on page 249. This is required
during upgrades of the portal zone in the default data center.
You can disable data replication for a zone in a data center that is in the Suspended state.
If a data center is in the Suspended state, you cannot clear alerts for zones in other data centers from a
zone in the suspended data center.
Suspend does not trigger alerts due to Wide Area Data Replication connectivity issues.
Suspend Multi-tier Replication only to perform upgrades or other maintenance operations. Changes
made while Multi-tier Replication is suspended should be kept to a minimum to reduce the chance for
data loss and to reduce the load placed on the portal zone when Multi-tier Replication is resumed.
Before you restart a portal zone so it can load the database from another zone, be sure that Multi-tier
Replication for the associated data center is not in the Suspended state. If it is, resume Multi-tier
Replication by performing the procedure Suspend or resume Multi-tier Replication on page 247.
Normally it should not be necessary to restart a portal zone unless the transaction data store exceeds the
2 GB limit.
The following configuration changes and actions should not be performed for or from a zone in a data
center that is in the Suspended state because these changes will not be synchronized when the data
center is resumed.
• Configure Open Connexion lines.
• Configure Alliance MX interoperability.
• Add a zone associated with a suspended data center.
• Perform a Force Logoff operation from the UMS or from a CDI for a device that is connected to a
zone in a suspended data center.
Suspending a data center usually takes less than seven minutes to complete. When you resume a
suspended data center, it can take between fifteen and forty-five minutes for replication to completely
synchronize the database with changes that were made while the data center was suspended.
1. Log in to the UMS in the portal zone for the data center you are suspending or resuming.
2. Determine whether the portal zone for the data center is in a healthy, operational state by performing
the procedure Validate a zone before an upgrade, rollback, or other operations on page 636.

December 3, 2019 IPC Confidential

 5.7: Change the default data center for Multi-tier Replication 249

Do not suspend or resume a data center if the portal zone appliances are not fully operational, because
this can result in an inconsistent state that requires restarting the impacted zone.
3. Click Configuration ➤ Enterprise ➤ System ➤ Addresses.
4. In the Addresses list, click the data center address for which you are suspending or resuming Multi-
tier Replication.
5. Click the Global Replication Tier Configuration tab.
6. Click Suspend or Resume depending on the operation you are performing.
7. If you resumed Multi-tier Replication for the data center, and while the data center was suspended,
the portal zone data store in another data center in the enterprise exceeded the 2 GB threshold, you
will see a message near the top of the Global Replication Tier Configuration panel that indicates a
full data center refresh is necessary to resynchronize the database with the other independent data
centers. Perform the procedure Refresh (restart) a portal zone on page 320.
8. Confirm that the data center is suspended or resumed by performing the procedure Check a zone’s
Multi-tier Replication status on page 250 for each zone in the data center.

5.7 Change the default data center for Multi-tier Replication

Use this procedure to change the data center that is assigned as the default data center for Multi-tier
Replication.
Prerequisite:
Perform this procedure only if Multi-tier Replication is enabled for all data centers in the enterprise. If
the enterprise is not Multi-tier Replication-enabled, this operation will fail.
You cannot change the default data center if the current default data center or the data center that you
want to make the default data center are in the Suspended state.
Switching the default data center requires up to seven minutes to complete.
1. Determine whether the portal zone in the existing default data center and the data center you are
making the new default data center are active and in a healthy, operational state by performing the
procedure Validate a zone before an upgrade, rollback, or other operations on page 636.
Do not switch the default data center if the appliances in the portal zone are not fully operational.
2. Within the UMS for any zone in the enterprise, click Configuration ➤ Enterprise ➤ System ➤
Addresses.
3. In the Addresses list, click the address that will become the new default data center.
4. Click the Switch Default Data Center button.
The system clears the Default Data Center check box for the existing default data center then selects
the check box for the current data center.

5.8 Change the portal zone for a data center

Use this topic to change the portal zone assigned to a data center for Multi-tier Replication.
1. Log in to the UMS in the current portal zone.
2. Determine whether the existing portal zone and the portal zone you are making the new portal zone
are active and in a healthy, operational state by performing the procedure Validate a zone before an
upgrade, rollback, or other operations on page 636.
Do not change the portal zone if the appliances in the portal zones are not fully operational.

IPC Confidential Unigy 4.3

Enterprise Guide
250 5.9: Check a zone’s Multi-tier Replication status

3. Disable Multi-tier Replication for the data center by performing the procedure Disable Multi-tier
Replication on page 246.
4. Within the Global Replication Tier Configuration tab, click the current portal zone in the Portal
Zones list then click Remove.
5. Click +Assign.
6. In the Available to Assign panel, select the check box for the zone you are assigning as the new portal
zone then click < Assign.
The zone is added to the Portal Zones section.
7. Click Enable Global Replication Tier.
The system reenables Multi-tier Replication for the data center with the new portal zone.

5.9 Check a zone’s Multi-tier Replication status

The checkGlobalReplicationTier tool displays status information about the Multi-tier
Replication processes running in the zone.
Duration: Seconds, but varies depending upon the number of zones in the data center.
Usage: Run this tool after enabling Multi-tier Replication for the first time or thereafter, after
suspending or resuming Multi-tier Replication, after switching the portal zone, and after a system
upgrade to ensure that the data centers are functioning properly. Also, run this tool to gather information
for debugging and troubleshooting if there are problems with Multi-tier Replication.
Use of this tool is not intrusive.
This tool is intended to be used by field operations and development staff.
1. Within a Web browser, access the URL https://vip/haservices/
checkGlobalReplicationTier, where vip is the VIP of the active CCM of the portal zone
and check the following against the output to verify data center status.
2. Verify the Global Replication Tier Status. It should show enabled.
For example, Global Replication Tier status of MyDC: ENABLED
3. Verify the CCM role. It should display APZA.
For example, MyZone role: APZA.
4. Verify the Jgroups Channel Name (if this is the default data center, the channel name is the same
name as the enterprise, otherwise it is enterprise name_datacenterID).
To check the name, log in to https://vip/haservices/checkReplication. Note that the
JGroups view size should be equal to the JGroups expected view size. (The expected view size
indicates the number of zones in a data center.)
5. Verify that the zookeeper process is running by looking for the PID of the zookeeper. For example:
ZOOKEEPER:
PID : 9827
6. Verify that the kafka process is running by looking for the PID of the Kafka. For example:
KAFKA:
Kafka Process Information:
PID : 29198
a) The ISR list should also contain the second CCM if it is online. The standby CCM should be the
next insync replica. For example:
Topic Info:

December 3, 2019 IPC Confidential

 5.9: Check a zone’s Multi-tier Replication status 251

1140850690_persistent Partition: 0 Leader: 2041775 Replicas:

2041776,2041775 Isr: 2041775,2041776
1140850691_persistent Partition: 0 Leader: 2041775 Replicas:
2041776,2041775 Isr: 2041775,2041776
7. The server should have N-1 for N number of data centers that are Multi-tier Replication enabled. The
zookeeper connected to string should be connected to each of the remote portal zones. For
example:
MIRROR MAKER PROCESSES:
PID : 10544
CPU Usage : 0.3
Memory Usage : 203500
File Descriptor Used : 141
Service/Topic Name : 1140850690_persistent
ZooKeeper connected to : 10.204.177.52:2181
8. Next, run checkGlobalReplicationTier on the standby CCM of the portal zone.
9. Verify the CCM role. It should display APZS.
For example, MyZone role: APZS.
10. Verify that the kafka process is running by looking for the PID of the Kafka. For example:
KAFKA:
Kafka Process Information:
PID : 29198
For additional information on the output produced by the checkGlobalReplicationTier tool,
see also: Check Multi-tier Replication status output details on page 251.

5.9.1 Check Multi-tier Replication status output details

This topic describes the output presented by the checkGlobalReplicationTier tool.
To run checkGlobalReplicationTier, refer to Check a zone’s Multi-tier Replication status on
page 250.
The information displayed is for the zone from which you ran the tool.
The following is sample output followed by an explanation of the information presented.
Replication is enabled.

Partial Replication is enabled.

DataCenter ID: 1140850999, DataCenter Name: DC1

Portal Zone Data:

DC ChannelName: Enterprise4020000020018664
GlobalReplicationTier: ENABLED
Zone ROLE: APZA
GlobalReplicationTier Operation: No GlobalReplicationTier operation is
running.
Last Resumed at: Not Resumed so far
Portal Zone Re-sync Enabled?: true
Portal Zone Re-sync Executed?: false

IPC Confidential Unigy 4.3

Enterprise Guide
252 5.9: Check a zone’s Multi-tier Replication status

ZOOKEEPER:
PID : 23701
CPU Usage : 0.1
Memory Usage : 235368
File Descriptor Used : 237
ZooKeeper Log Disk Usage : 23M
Zookeeper State: ActiveActive
Zookeeper Mbean:
org.apache.ZooKeeperService:name0=StandaloneServer_port-1:
Version : 3.4.6-2557--1, built on 07/14/2015 12:48 GMT StartTime : Fri
Jun 15 05:40:30 EDT 2018 TickTime : 2000 MinSessionTimeout : 4000
MaxSessionTimeout : 40000 NumAliveConnections : 4
MaxClientCnxnsPerHost : 60 PacketsReceived : 2291979 PacketsSent :
2292006 OutstandingRequests : 0 ClientPort : 20.33.149.191:2181
MinRequestLatency : 0 AvgRequestLatency : 2 MaxRequestLatency :
9676

KAFKA:
Kafka Process Information:
PID : 23814
CPU Usage : 1.4
Memory Usage : 1042832
File Descriptor Used : 347
Kafka Log Disk Usage : 240M

BrokerInfo:
20.33.149.194
20.33.149.191

Topic List:
1140850690_persistent
__consumer_offsets
1140850691_persistent

Topic Info:
1140850690_persistent Partition: 0 Leader: 53148191 Replicas:
53148191,53148194 Isr: 53148191,53148194
1140850691_persistent Partition: 0 Leader: 53148191 Replicas:
53148191,53148194 Isr: 53148191,53148194

Kafka Mbean:

kafka.log:type=Log,name=LogStartOffset,topic=1140850690_persistent,partitio
n=0:
Value : 0
kafka.log:type=Log,name=LogEndOffset,topic=1140850690_persistent,partition=
0:
Value : 21355
kafka.log:type=Log,name=NumLogSegments,topic=1140850690_persistent,partitio
n=0:
Value : 1
kafka.log:type=Log,name=Size,topic=1140850690_persistent,partition=0:
Value : 77880301
kafka.log:type=Log,name=LogStartOffset,topic=__consumer_offsets,partition=0

December 3, 2019 IPC Confidential

 5.9: Check a zone’s Multi-tier Replication status 253

:
Value : 0
kafka.log:type=Log,name=LogEndOffset,topic=__consumer_offsets,partition=0:
Value : 0
kafka.log:type=Log,name=NumLogSegments,topic=__consumer_offsets,partition=0
:
Value : 1
kafka.log:type=Log,name=Size,topic=__consumer_offsets,partition=0:
Value : 0
kafka.log:type=Log,name=LogStartOffset,topic=1140850691_persistent,partitio
n=0:
Value : 0
kafka.log:type=Log,name=LogEndOffset,topic=1140850691_persistent,partition=
0:
Value : 7958
kafka.log:type=Log,name=NumLogSegments,topic=1140850691_persistent,partitio
n=0:
Value : 1
kafka.log:type=Log,name=Size,topic=1140850691_persistent,partition=0:
Value : 172701268
kafka.network:type=RequestChannel,name=RequestQueueSize:
Value : 0
kafka.network:type=RequestChannel,name=ResponseQueueSize:
Value : 0
kafka.server:type=BrokerTopicMetrics,name=BytesInPerSec:
Count : 250507295 EventType : bytes RateUnit : SECONDS MeanRate :
538.7228537189126 OneMinuteRate : 268.8449055329615 FiveMinuteRate :
294.594535042079 FifteenMinuteRate : 299.24998997055445
kafka.server:type=KafkaServer,name=BrokerState:
Value : 3
kafka.server:type=OffsetManager,name=NumGroups:
Value : 0

MIRROR MAKER PROCESSES:

PID : 27564
CPU Usage : 0.2
Memory Usage : 205448
File Descriptor Used : 210
Service/Topic Name : 1140850691_persistent
ZooKeeper connected to : 20.33.149.27:2181

MirrorMaker Consumer Threads:

topic_name: 1140850691_persistent offset:7915 lag 1

Unigy Consumer Threads:

topic_name: 1140850691_persistent offset:7958 lag 0

IPC Confidential Unigy 4.3

Enterprise Guide
254 5.9: Check a zone’s Multi-tier Replication status

Table 40: https://vip/haservices/checkGlobalReplicationTier

Name Description Values Notes

Replication is Replication
enabled - replication is
activation.
enabled.
disabled - replication is
disabled.

Partial Replication Partial replication

enabled - partial replication is
is activation.
enabled.
disabled - partial replication is
enabled.

DataCenter ID ID of the data center. The unique identifier of the

DataCenter in reference.
DataCenter Name Name of the data The name of the DataCenter. The name displays in
center. the Name field of the
following UMS panel:
Enterprise ➤
Addresses ➤ Address
Page

Portal Zone Data

DC ChannelName Channel name of the
enterprise name - If Multi-
JGroups channel.
tier Replication is enabled and
this is the default data center.

enterprise
name_datacenterID - If Multi-
tier Replication is enabled and
this is a simple data center.

Global Replication Status of the Global

DISABLED - tier one is
Tier replication tier
activated but Multi-tier
Replication is not activated on
this data center.

ENABLED - tier-one and Multi-

tier Replication are enabled
on this data center and the
data center is activated for
Multi-tier Replication.

SUSPENDED - data center is

provisioned to participate in
the global replication tier,
however is not actually
replicating over the global
replication tier.

December 3, 2019 IPC Confidential

 5.9: Check a zone’s Multi-tier Replication status 255

Table 40: https://vip/haservices/checkGlobalReplicationTier (continued)

Name Description Values Notes

Zone ROLE This zone’s role in the
APZA - the active
data center.
CCM or
ACCM on the active portal
zone.

APZS - the standby

CCM or
ACCM on the active portal
zone.

FAILED - the appliance has

failed and is not in a good
state to serve tier-one or tier-
two replication.

LOCALZONE - associated with

the local tier-one data center.

NOROLE - a zone that does

not have a role in Multi-tier
Replication and Multi-tier
Replication is not activated.

GlobalReplicationTi Status of a Multi-tier

er Operation Replication operation,
if one is running.
Last Resumed at The last time when The last time resumed, otherwise
Multi-tier Replication Not Resumed so far.
was resumed in case
it was suspended.
Portal Zone Re- • true Set the value to false
sync Enabled before you restart a
• false portal zone to load the
Default: true database from another
portal zone.
Portal Zone Re-
sync Executed
ZOOKEEPER Information about ZooKeeper only runs
ZooKeeper, which is on an APZA, so this
the centralized section of the Web
service that maintains page will only contain
the Multi-tier values if the zone is an
Replication active portal zone on
configuration an active data center.
information and Otherwise, the values
provides clustering in this section will be
services. null.
PID ZooKeeper process Server process ID.
ID.

IPC Confidential Unigy 4.3

Enterprise Guide
256 5.9: Check a zone’s Multi-tier Replication status

Table 40: https://vip/haservices/checkGlobalReplicationTier (continued)

Name Description Values Notes

CPU Usage CPU usage
consumed by the
ZooKeeper process.
Memory Usage Memory usage
consumed by the
ZooKeeper process.
File Descriptor File descriptor used
Used by the ZooKeeper
process.
Zookeeper Log Log disk usage of the
Disk Usage ZooKeeper process.
Zookeeper State State of the The ZooKeeper state
ACTIVEACTIVE - when
ZooKeeper state must match the Multi-
machine. ZooKeeper is in this state, the tier Replication role of
Multi-tier Replication Role of the zone as defined in
the zone must be APZA. the previous column
otherwise there is a
ACTIVESTANDBY - when problem.
ZooKeeper is in this state, the
Multi-tier Replication Role of
the zone must be APZS.

FAILED

LOCALZONE

NOROLE

WAIT
- intermediate state, waiting
for another portal zone to
come up.

Zookeeper Mbean Information from the Used by a developer

Zookeeper Mbean. during troubleshooting.
Version
KAFKA Information about Kafka only runs on an
Kafka, which is a APZA, so this section
server process that of the Web page will
connects to the only contain values if
Zookeeper. Kafka the zone is an active
runs on CCMS and portal zone on an
ACCMS in an APZA active data center.
or an APZS. Otherwise, the values
in this section will be
null.
Kafka Process
Information
PID Kafka process ID.

December 3, 2019 IPC Confidential

 5.9: Check a zone’s Multi-tier Replication status 257

Table 40: https://vip/haservices/checkGlobalReplicationTier (continued)

Name Description Values Notes

CPU Usage CPU usage
consumed by the
Kafka process.
Memory Usage Memory usage
consumed by the
Kafka process.
File Descriptor File descriptor used
Used by the Kafka process.
Kafka Log Disk Log disk usage of the
Usage Kafka process.
BrokerInfo Information about the The number of brokers
Kafka brokers that should be equal to the
are connected to number of CCMs and
Zookeeper. ACCMs in the active
and standby portal
zones.
Topic List List of topics that the
data center is
producing and
receiving data for.
Topic Info Displays Kafka
partition, leader,
replicas, and Isr
information for each
data center.
Kafka Mbean Information from the
Kafka MBean.
Used by a developer during
troubleshooting.

MIRROR MAKER Information about Each Mirror Maker process MirrorMaker only runs
PROCESSES MirrorMaker represents a topic. on an APZA, so this
processes, which are section will only
server processes that contain values if the
pull data from remote zone is an active portal
data centers and zone on an active data
publishes them center. Otherwise, the
locally. values in this section
The messages from will be null.
remote DCs first is If there are N data
taken in by centers, then there are
MirrorMaker threads N-1 Mirror Maker
and then is passed processes.
on to the Unigy
consumer threads.
PID Mirror Maker process
ID.

IPC Confidential Unigy 4.3

Enterprise Guide
258 5.10: Check an enterprise’s Multi-tier Replication status

Table 40: https://vip/haservices/checkGlobalReplicationTier (continued)

Name Description Values Notes

CPU Usage CPU usage
consumed by the
Mirror Maker
process.
Memory Usage Memory usage
consumed by the
Mirror Maker
process.
File Descriptor File descriptor used
Used by the Mirror Maker
process.
Service/Topic name
ZooKeeper
connected to
MirrorMaker One Mirror Maker Topic name is the remote If the lag keeps
Consumer Threads: consumer thread for DataCenter ID_persistent. growing and not
each topic. (# topics Offset - each message in Kafka is decreasing, then this
= # remote DCs) identified by its offset number. It indicates that there is a
starts from 0 and keeps problem.
incrementing. Offset for each
topic identifies at what point the
message was consumed.
Lag is a number of messages
pending to be written to the disk
or committed.
Unigy Consumer One Unigy Consumer Same info as mentioned above. Same info as
Threads: thread for each topic. mentioned above.

5.10 Check an enterprise’s Multi-tier Replication status

The checkEnterpriseConfiguration tool displays a global status view of Multi-tier
Replication across the enterprise. It displays information about addresses and zones associated with local
zones and portal zones, with links to their status details.
Prerequisite: Prior to activating Multi-tier Replication, you should have completed a pre-
implementation checklist, which included creating a topology spreadsheet to record information about
the topology in each zone and each zone’s role in the Multi-tier Replication environment. For example,
the sheet should identify the IP address, MAC address, and physical backroom location of each relevant
device, each zone’s VIP, the portal zones and local zones, and which zones comprise which Data
Centers. For more information, refer to the Multi-tier Replication pre-implementation checklist on page
244.
Duration: Seconds, but varies depending upon the number of zones in the data center.
Usage: Using the topology sheet, validate the status of the following against the URL: portal zone, local
zone, data center, default data center, which data centers are enabled or disabled, and the distribution of
the zones in each data center.

December 3, 2019 IPC Confidential

 5.10: Check an enterprise’s Multi-tier Replication status 259

Run this tool after deploying Multi-tier Replication for the first time, after resuming Multi-tier
Replication, after switching the portal zone, and after a system upgrade to ensure that the data centers
are functioning properly and to validate the accuracy of the topology sheet. Also, run this tool to gather
information for debugging and troubleshooting if there are problems with Multi-tier Replication.
Use of this tool is not intrusive.
This tool is intended to be used by field operations and development staff.
1. Within a Web browser, access the URL https://vip/haservices/
checkEnterpriseConfiguration, where vip is the zone's VIP.
2. Review the output details. For information on the output, refer to Check enterprise Multi-tier
Replication status output details on page 259.

5.10.1 Check enterprise Multi-tier Replication status output details

This topic describes the output presented by the checkEnterpriseConfiguration tool.
To run checkEnterpriseConfiguration, refer to Check an enterprise’s Multi-tier Replication
status on page 258.
This tool provides a global view of Multi-tier Replication and can be accessed from any zone where
Multi-tier Replication is enabled.
The output includes:
• Which data centers have Multi-tier Replication ENABLED.
• Which data centers have Multi-tier Replication SUSPENDED.
• Which data center is the Default data center.
• The zone name, zone ID (enclosed in square brackets), and the VIP of each active portal zone and
each local zone.
• URL web page links to the checkGlobalReplicationTier tool and the
checkReplication tool for each zone. Use the checkReplication tool to check the
replication page of any server and compare the data center information with the JGroups view
members. Each enabled Data Center has it’s own view and each CCM physical IP address of the
Data Center should be listed as a member of this view. If the Data Center is configured but
suspended, the view will be the same. If a Default Data Center is configured but Multi-tier
Replication is not enabled, then the CCMs will appear as local zones.
• Whether the CCM of the zone is the ACTIVE CCM, STANDBY CCM, or the information is
UNKNOWN.
• Which data centers have Multi-tier Replication DISABLED.

IPC Confidential Unigy 4.3

Enterprise Guide
260 5.11: Diagnose latency for Multi-tier Replication

Figure 32: https://vip/haservices/checkEnterpriseConfiguration

5.11 Diagnose latency for Multi-tier Replication

The testEnterpriseReplication tool calculates a zone's replication health. It displays the time
delay in milliseconds between the zones in the enterprise.
Duration: Seconds, but varies depending upon the number of zones in the data center.
Usage: Run this tool after enabling Multi-tier Replication for the first time, after resuming Multi-tier
Replication, after switching the portal zone, and after a system upgrade to ensure time delay between
zones is acceptable and to make sure that the database replication is working properly to the zones. Also
run this tool when there is a need to debug or troubleshoot latency issues.
The tool can be run from any zone where Multi-tier Replication is enabled. It is recommended that you
run this tool for all zones to determine the overall health of the enterprise.
Use of this tool is not intrusive.
This tool is intended for field operations and development staff.
1. Within a browser, access the URL https://vip/haservices/
testEnterpriseReplication.

December 3, 2019 IPC Confidential

 5.11: Diagnose latency for Multi-tier Replication 261

2. Review the output details. For more information on the output, refer to Test Multi-tier Replication
status on page 261.
The response time is acceptable if the zone-to-zone time delay is less than 15 seconds (15000
milliseconds). The exception is when you run this tool after suspending or resuming Multi-tier
Replication, in which case the time delay will be longer than 15 seconds and could be up to 15 minutes.
If the delay between any two zones is 10 seconds, contact eTAC for further evaluation. If a zone does
not respond to another zone within 15 seconds, this indicates there is an issue and you should contact
eTAC.
If the response time is greater than the values mentioned above it may be due to:
• Network latency
• Busy threads in the zone
If there is network latency, check the network and adjust network settings accordingly.
If there are busy threads in the zone, check the zone to understand why there are so many threads and try
to correct the problem.

Note
When resuming from a suspend, the system may take up to 45 minutes before data replication is
complete. In order to verify if a resume has completed, go to the URL: checkReplication and view
the status on the GlobalReplicationTier Operation line. For more information about this URL, refer to:
Check replication output details on page 507.
Once the resume is complete, the testEnterpriseReplication tool can be run again.

5.11.1 Test Multi-tier Replication status

This topic describes the output presented by the testEnterpriseReplication tool.
To run the tool, refer to Diagnose latency for Multi-tier Replication on page 260.
The following is sample output followed by an explanation of the information presented.

IPC Confidential Unigy 4.3

Enterprise Guide
262 5.11: Diagnose latency for Multi-tier Replication

Figure 33: https://vip/haservices/testEnterpriseReplication

The tool calculates and displays the one-way delay in milliseconds between zones in an enterprise with
Multi-tier Replication enabled (from a particular zone to all other zones). Zones include:
• Local zones (zones within the data center).
• Remote zones (zones outside of this zone's data center).
Information in this panel is presented in UTC time.
A zone is considered to fail the test if no replication is occurring or if the time delay from one zone to
another zone is greater than 15 seconds. To understand the failure, check the replication log
file: /var/opt/ipc/log/RepDSGrp/RepDSGrp.log.
This tool runs the latency test using a 15-second timer. Timing is configurable by editing the property:
diag.test.timeout=15 in the following properties file: /etc/opt/ipc/replicator/
resources/replicator.properties.

Important
Do not make changes to this file unless directed by eTAC Tier 3 support.

December 3, 2019 IPC Confidential

 263

6 Secure communications
Unigy supports the HTTPS, secure SIP, and secure RTP protocols.
HTTPS is a protocol for secure communication over a network that provides authentication of web
site/web server and client communications and protects the integrity and privacy of the data being
exchanged. It also protects bi-directional communication between client and server.
Secure SIP is a security mechanism for sending SIP messages over a transport layer security-encrypted
channel and protects SIP session communications from eavesdropping or tampering.
Secure RTP is a profile of RTP that provides encryption message authentication and integrity and replay
protection to the RTP data (audio).
Communications can be secure between the devices listed in the following table in enterprises running
Unigy software version 3.1 or higher.

CDIs SIP trunks MMs CCMs

CDIs 1 Secure RTP Secure RTP Secure RTP Secure SIP
CCMs Secure SIP Secure SIP Secure SIP Secure SIP
MMs Secure RTP Secure RTP Secure RTP Secure SIP
PBXs 2 Secure RTP Secure RTP Secure RTP Secure SIP
SBCs 3 Secure RTP Secure RTP Secure RTP Secure SIP
Voice Secure RTP N/A Secure RTP Secure SIP
Recorders 4
MGs 5 (MG Secure RTP Secure RTP Secure RTP Secure SIP
trunks)

Front room endpoint syslog transmissions are also encrypted. This includes Unigy log messages for
supported CDIs and backroom appliances. The logs are stored unencrypted but no sensitive information
is contained in the logs.
The following figure illustrates the secure communications supported by Unigy. Solid red lines represent
secure SIP, dashed blue lines represent secure RTP, dotted green lines represent HTTPS. Gray lines
indicate the communication is not secure.
Bear in mind that securing a device’s communications may impact response time.

1 IQ/MAX TOUCH, Pulse, Pulse Enterprise, and IQ/MAX Omni.

2 Refer to the Unigy Release Notes for a complete list of supported PBXs.
3 Unigy is designed to have secure RTP and secure SIP function with an SBC. Interoperability with third-party
SBC’s requires certification and can be done on a per case basis.
4 IPC Media Recorders (IMR) and NICE Trading Recording (NTR) devices.
5 MG secure communications requires Unigy software version V3.1.0.1 and MG Chassis B (not A).

IPC Confidential Unigy 4.3

Enterprise Guide
264

Figure 34: Secure component interaction

Z Unigy zones
1 Converged Communications Managers (CCMs)
2 Media Managers (MMs)
3 Media Gateways (MGs)
4 Session Border Controllers (SBCs)
5 Channel Banks (CBs)
6 Voice recorder subsystems that support secure communication
7 Unigy Management System (UMS)
8 Supported Communications device interfaces (CDIs)
9 Secure SIP communications (solid red lines)
Includes Unigy SIP trunks
10 Secure RTP communications (dashed blue lines)
11 Web Services HTTPS communications (dotted green lines)
12 External lines (TDM or analog) (dashed black lines)
13 HTTPS communications (dotted green lines) for CDI software downloads from the CCM

December 3, 2019 IPC Confidential

 265

The following figures illustrate several scenarios involving secure communications.

Between CDIs
Point-to-point calls between IQ/MAX TOUCH, Pulse, and Pulse Enterprise devices can be configured
for secure communications.
Figure 35: Point-to-point secure communication between CDIs

1 CDIs
2 Converged Communications Manager (CCM)
A Secure SIP communications (solid red lines)
B Secure RTP communications (dashed blue lines)

Between CDIs and MMs and MGs

Communication involving an MM can be secure and the next figure shows the secured hops of an MRD
call. Note that the communication between CCMs and MGs and MMs and MGs can also be secure.
Figure 36: MRD private line call using a secure Media Manager and Media Gateway

1 CDIs
2 Converged Communications Manager (CCM)
3 Media Manager (MM)
4 Media Gateway (MG)
A Secure SIP communications (solid red lines)
B Secure RTP communications (dashed blue lines)

IPC Confidential Unigy 4.3

Enterprise Guide
266

Any type of call, including dial tone calls involving a media bridge can be secure as illustrated by the
following figure. The interzone communication here is secure from end to end. Also, although not
depicted in the diagram, communication involving a media gateway can be made secure as well.
Figure 37: Dial tone calls over a secure media bridge

Z Unigy zones
1 CDIs
2 Converged Communications Manager (CCM)
3 Media Manager (MM)
A Secure SIP communications (solid red lines)
B Secure RTP communications (dashed blue lines)

Between mixed (secure and non-secure) zones

If there is interzone communication and not all zones are configured for secure communication,
unencrypted communication occurs in zones where it is not configured. In the next diagram,
communication is secure in the zone at the top of the diagram and unencrypted in the zone at the bottom
of the diagram.

December 3, 2019 IPC Confidential

 267

Figure 38: Dial tones calls with one zone is secure and another non-secure

Z Unigy zones
1 CDIs
2 Converged Communications Manager (CCM)
3 Media Manager (MM)
A Secure SIP communications (solid red lines)
B Secure RTP communications (dashed blue lines)
C Unencrypted communications (gray lines)

Communications involving SIP trunks

Communications across SIP trunks to supported PBXs can also be secured. Note that the audio stream is
secure from the CDI to the endpoint, not on a hop by hop basis.

IPC Confidential Unigy 4.3

Enterprise Guide
268 6.1: Certificates supported for device communication

Figure 39: Calls placed on secure SIP trunks

1 CDIs
2 Converged Communications Manager (CCM)
A Secure SIP communications (solid red lines)
B Secure RTP communications (dashed blue lines)
C Secure SIP communication (SIP Trunk) (solid red lines)
3 Supported PBXs

6.1 Certificates supported for device communication

Unigy uses certificates of authority (CAs) to validate and trust the device certificate used during a secure
communication set up to establish secure communication channels between turrets and CCM or ACCM
appliances and between MMs and CCMs or ACCMs.
Unigy employs a dual domain approach (internal and external) to managing CAs.
Each Unigy enterprise uses a unique IPC self-signed Enterprise CA certificate for all Unigy component
communication. This consists of CCMs, ACCMs, MMs, MGs, turrets, and Soft Clients and is
considered to be the internal domain. Customers can also install their own CA certificate and Unigy can
use this to issue the certificates.
The external domain is considered to consist of customer and third-party devices such as supported
PBXs, Session Border Controllers, voice recorders, UMS clients, and Soft Clients running on a customer
PC. Appliance-side authentication occurs between Unigy zones and the PBXs and SBCs (represented by
Unigy SIP trunks) and between zones and voice recorders. The customer can use IPC or customer
certificates for this.
The following table describes the types of certificates that are supported for communication between a
zone and the different communication devices in the two domains.

Table 42: Certificates supported for communication devices

Device Interactions

End End point Unigy Enterprise CA signed External CA signed

point certificates certificates
Zone Supported hard CDIs Yes No
Zone Supported Soft Clients Yes Yes
Zone Media Manager Yes No

December 3, 2019 IPC Confidential

 6.1: Certificates supported for device communication 269

Table 42: Certificates supported for communication devices (continued)

Device Interactions

End End point Unigy Enterprise CA signed External CA signed

point certificates certificates
Zone PBX No Yes
Zone Session Border Yes Yes
Controller
Zone Voice recorder Yes Yes
Zone Browser (for UMS) Yes Yes
Zone Media Gateway Yes No

For information on uploading self-signed third-party certificates for voice recorders, SBCs, and PBXs,
refer to Upload a self-signed third-party certificate for secure communications on page 269.
For information on importing and installing customer-signed or external CA-signed certificates for
Unigy Soft Clients refer to Install a customer certificate for Soft Client secure communications on page
270.
For more information about certificates, refer to the Security Administrator Guide.

6.1.1 Upload a self-signed third-party certificate for secure communications

Use this procedure when it is necessary to upload a self-signed certificate for a third-party device that
communicates with Unigy over a secure connection.
This procedure is required only when a self-signed certificate is used for secure communications
between Unigy and a third party device such as a PBX, voice recorder, or Session Border Controller. If
the third-party certificate is signed by a customer, external, or IPC CA, this procedure is not required.
The upload adds the self-signed certificate to the Unigy CA trust bundle, which is uploaded to the third-
party devices when you configure secure communications for these devices. Perform this procedure for
each zone that communicates with the third-party devices for each third-party device type that uses a
self-signed certificate for secure communications. It must be performed the first time the certificate is
required and after every software upgrade.

IPC Confidential Unigy 4.3

Enterprise Guide
270 6.1: Certificates supported for device communication

Note
Before you upload a certificate, determine whether it contains carriage return (CR) characters. Unigy
does not support these characters, so it prevents you from uploading a certificate that contains them.
Figure 40: Certificate with carriage return (CR) characters

To clean the certificate file, use a text editor or other appropriate tool to remove the Block carriage return
(CR) characters then save the file. For example, you can use the Edit ➤ EOL Conversion ➤ UNIX/OSX
Format option in NotePad++ to remove the CRs. To avoid corrupting the certificate, you should not
manually delete the CR characters in a text editor.

1. Click Configuration ➤ Enterprise ➤ Security ➤ PKI ➤ Unigy CA Certificates..

2. Click the 3rd party integration tab.
3. Within Upload Third Party Certificate Bundle, click Browse, select the self-signed certificate you
are uploading, then click Open.
4. Click Save to upload the certificate.
If you are uploading more than one certificate, for each certificate, click the View tab to refresh the panel
then repeat steps 2 through 4.

6.1.2 Install a customer certificate for Soft Client secure communications

If a customer-signed or external CA-signed root certificate is being used for secure communications, you
must install the certificate on each personal computer running IQ/MAX Omni or Pulse Enterprise that
needs to be secured.
Before you begin this procedure, be sure you have access to the certificate you are installing.
This procedure is not required if a Unigy self-signed certificate is being used for secure
communications.
To install the certificate, follow the procedure that is used at the customer site. If there is no established
procedure, use one of the following options:
• If the certificate is stored on a Certificate Authority Server, refer to the topic Installing a root
certificate in the Microsoft MSDN Library.
• If you have a copy of the certificate file, use the procedure below.
1. Open the Microsoft Internet Explorer browser on the client PC.
2. Click Tools ➤ Internet options.
3. Within the Security tab, determine the security level for the Internet zone. If it is High, complete the
following substeps to set it to Medium because you cannot install certificates when the level is High.

December 3, 2019 IPC Confidential

 6.2: Secure Communications configuration 271

a) Click Custom level.

b) In the Reset to field, select Medium then click OK.
You are returned to the Internet Options dialog box.
4. Within the Content tab, click Certificates.
5. Click Import.
The Certificate Import Wizard is displayed.
6. Click Next.
7. For the File name text box, click Browse, select the certificate file you are importing, then click
Open.
8. Click Next.
The Certificate Store page is displayed,
9. Select Place all certificates in the following store then click Browse.
The Select Certificate Store dialog box is displayed.
10. Click Trusted Root Certification Authorities then click OK.
11. Click Next.
The Completing the Certificate Import Wizard page is displayed.
12. Click Finish.
13. In the Security Warning message box, click Yes to install the certificate.
14. In the Certificate Import Wizard message box, click OK.
15. Confirm that the certificate was installed properly:
a) Within the Internet Options dialog box, click the Content tab.
b) Click Certificates then click the Trusted Root Certification Authorities tab.
c) Scroll through the list to locate the certificate you installed.
16. If you changed the security level in step 3, set the level back to High.

6.2 Secure Communications configuration

Configuration of secure communication is supported by location (instance or trunk level) so if a specific
location is or is not bandwidth sensitive this can be configured accordingly.
Device overrides can also be set for CDIs, MMs, or MGs. These devices inherit the secure
communication setting (enable or disable) for the Instance except when a specific device’s secure
communication override is set. In that case the override setting is retained. For example, a customer
might want to enable secure communication between head traders’ CDIs but not other traders.
Note that secure communication configuration of software clients is separate from hard turrets.
Therefore, Soft Clients that have mobility, such as Pulse Enterprise, can use encryption while
communication involving hard turrets can remain unencrypted.

Important
Following any configuration changes to secure communications, all supported hard turrets must be
rebooted and all supported Soft Clients must be logged off and logged on again.

Media Gateway
Support for secure communications on the MG requires Unigy V3.1.0.1 or higher.

IPC Confidential Unigy 4.3

Enterprise Guide
272 6.2: Secure Communications configuration

For detailed configuration instructions, refer to Enable secure communications for Media Gateways on
page 273.
SIP Trunks
The destination port on the SIP Trunk must be set to a secure port. Also, if the SIP trunk connects to a
PBX, SBC, or voice recorder, additional requirements must be met, including generating and importing
externally signed certificates and trust bundles. For more information, refer to the Application Notes for
the applicable PBX or SBC product, for example, the Application Notes for Unigy 3.1 and Cisco CUCM
10.5 Secured Comm Configuration with 3rd Party CA.
Also note that SIP trunks are not configured as part of the Instance-level secure communications feature;
they are enabled or disabled separately using the Configuration ➤ Enterprise ➤ Trunks ➤ SIP Trunk
panel.
Voice Recorders
For supported voice recorders, secure communication is dictated by the configuration on the recorder. If
the SIP link is configured on the recorder to be secure, then all SIP communication between a Unigy
zone and the recorder will occur over TLS instead of UDP. If the HTTP link is configured on the
recorder to be secure, then all HTTPS communication between a Unigy zone and the recorder will occur
over TLS instead of TCP.
Prior to configuring these aspects of secure communications for the voice recorders, installation of the
appropriate CA certificates on both the Unigy system and voice recorder is also required for
authentication. For information about installing and using the CA certificates, refer to the Unigy Security
Administrator Guide.
For IMR, use the Recorder Manager to configure the security setting for the Unigy WebServices client
adapter. For information about configuring IMR certificates and security, refer to the IPC Unigy Switch
Integration with IPC Unified Media Recorder Guide. For NTR, refer to the IPC Unigy/CTI Active CTI
IP Recording INTEGRATION MANUAL or How to configure secure Web and SIP link with Unigy V3.01.
Media communication (audio) to the voice recorders is controlled by the turrets’ secure communication
configuration. Also, note that Secure RTCP encryption is not supported between Unigy zones and
recorders.
Deployment
Instance level secure communication is disabled by default for the first zone that is deployed, regardless
of whether it is a new deployment or an upgrade. Subsequent zones that are deployed or upgraded
inherit the instance level secure communication setting.
To have secure communications, all zones involved in the communications need to be V3.1 or higher or
3.1.0.1 or higher if Media Gateways are to be included.
For example, if a multi-instance system is in the process of being upgraded to V3.1, inter-instance
communication between a V3.0 instance and a V3.1 instance will not be secured.
Only UMS users with the IPC Certified Tech role and authorization to get a dynamic password can
configure the secure communications feature.

6.2.1 Configure secure communications for an instance

Complete this procedure to configure Secure SIP and Secure RTP for an instance. This enables the
protocols for all supported communications devices, Media Gateways (MG), and Media Managers
(MMs) in the instance but requires CDI reboots and Soft Client re-logon to take effect.

December 3, 2019 IPC Confidential

 6.2: Secure Communications configuration 273

Prerequisites: Only UMS users with the IPC Certified Tech role and authorization to obtain a dynamic
password can configure the secure communications.
Before you begin, log in to the Dynamic Password Manager web application. For more information
about this application, refer to the appendix of the Enterprise Guide.
Media Gateways have other prerequisites as well as additional configuration steps. Refer to Enable
secure communications for Media Gateways on page 273.
1. Log in to the UMS of the zone that has Unigy software version 3.1 or higher installed. Media
Gateways require Unigy version 3.1.0.1 or higher to be installed. You should also already have open,
in another IE tab, the Dynamic Password Manager web application.
2. Click Configuration ➤ Enterprise ➤ Security ➤ Secure Communications.
The Secure Communication Authentication window is displayed.
Figure 41: Secure Communication Authentication window

3. Copy the Token, switch to the Dynamic Password Manager web application and paste the token into
the Token field, then click Generate Output.
This generates a password in the Output field of the Dynamic Password Manager.
4. Copy the password, switch back to the UMS and paste it into the Password field of the Secure
Communication Authentication window, then click Validate.
The Secure Communications UMS menu is expanded in the navigation tree in the left pane of the
panel.
5. Click Instance.
A list of instances in the enterprise is displayed.
6. Click the instance you want to configure.
The Instance panel is displayed.
7. Select the Enabled option button then click Save.
This enables the Secure SIP and Secure RTP for all supported CDIs and MMs in the instance.
8. Reboot all turrets and Pulse devices and log off and log on Soft Client end users for the changes to
take effect. Media Gateways involve additional steps as mentioned above.

6.2.2 Enable secure communications for Media Gateways

Use this procedure to generate and import CSR device certificates and configure MGs for secure
communications.

IPC Confidential Unigy 4.3

Enterprise Guide
274 6.2: Secure Communications configuration

This procedure can only be performed from a Unigy V3.1.0.1 or higher zone. In addition, the MG is
required to be a chassis B and to have a minimum of Unigy 3.1.0.1 software deployed (that is, MG
firmware 7.0 or higher).

1. Ensure that the MG is running Unigy software V3.1.0.1 or higher and if not, upgrade. Go to Tools ➤
Deployment ➤ Software. Click Deployment and select the MG.
2. Perform an Upload Default INI operation on the MG. Go to Configuration ➤ Sites ➤ Trunks ➤
Media Gateways, select the MG, click Media Gateway Maintenance tab, scroll to the File
Management section and click Upload Default INI.
3. Set or confirm the NTP server for the Media Gateway by performing the procedure Configure the
NTP Server for a Media Gateway on page 587.
If the value is not correct, change it to the correct value.
4. Configure the secure communications feature for an instance (refer to Configure secure
communications for an instance on page 272) or as an override for the MG (refer to Override secure
communications settings for specific CDIs, MGs, or MMs on page 276).
5. Generate a device certificate for the MG.
a) Click Configuration ➤ Sites ➤ Trunks ➤ Media Gateways.
b) Click the MG you are configuring.
c) Click the Properties button.
d) Click the Media Gateway Maintenance tab.
e) Expand the Generate Device Certificate section.
f) Click the Generate Device Certificate button.
This generates a Unigy-signed certificate, uploads it to the MG, and then reboots the MG.
6. Perform the Apply operation and reboot the MG.
7. If you have not done so already, configure MG modules, ports, lines, etc. as required, then perform
the Apply operation and reboot the MG. If you are configuring and associating new resource AORs to
this MG, after doing so in the UMS you must access the Media Gateway web user interface (not the
UMS) and manually update the Tel Profile Name parameter of each new channel in the Trunk Group
Table to match the CAS Pattern configured for the new channel in the UMS, click Submit, and Burn.
Also, during the upgrade the Enable Hold parameter becomes disabled and you must use the Media
Gateway web user interface to manually enable it. To do this, click Advanced, then go to
Configuration ➤ VoIP ➤ Gateway ➤ DTMF and Supplementary ➤ Supplementary Services,
select Enable from the Enable Hold parameter list box, click Submit, and then reboot the MG.
8. Repeat for all MGs that require secure communications.

6.2.3 Disable secure communications for Media Gateways

Use this procedure to disable secure communications for MGs.
1. Disable the secure communications feature for an instance (refer to Configure secure communications
for an instance on page 272) or as an override for the MG (refer to Override secure communications
settings for specific CDIs, MGs, or MMs on page 276).
2. Perform an Apply operation on the MG. Go to Configuration ➤ Sites ➤ Trunks ➤ Media
Gateways. Click the MG, then click Apply.
3. Reboot the MG.

December 3, 2019 IPC Confidential

 6.2: Secure Communications configuration 275

6.2.4 Enable secure communications for SIP trunks for PBXs and Session Border Controllers
Use this procedure to configure SIP trunks and device certificates to provide secure communications for
PBXs and Session Border Controller (SBCs).

This procedure can be performed only from a Unigy v3.1 or higher zone.
To perform this procedure, your user account must have the IPC Certified Tech role assigned and you
must have access to the applicable Application Notes for the PBX or SBC product you are configuring,
for example, the Application Notes for Unigy 3.1 and Cisco CUCM 10.5 Secured Comm Configuration
with 3rd Party CA.
1. Perform the procedures described in the PBX or SBC Application Notes document for the device you
are configuring.
The following topics provide additional details on the Unigy configuration steps:
• Configure secure communications for an instance on page 272
• Configure a secure SIP trunk to an external device on page 275
• Configure secure communication for SIP trunks on page 275
2. Reboot all IQ/MAX TOUCH turrets and Pulse devices that are being secured.

6.2.4.1 Configure a secure SIP trunk to an external device

Complete this procedure to correctly configure the parameters for a dial tone SIP trunk from Unigy to a
PBX, SBC, or voice recorder to enable use of the secure SIP protocol
1. Click Configuration ➤ Sites ➤ Trunks ➤ SIP Trunks
2. Click +Add New.
3. In the Select Connection Type panel, select either Private Line or Dial Tone (depending on the type of
connection you are securing) then click Continue.
The Trunk panel is displayed.
4. Type the name of the SIP trunk in the Trunk Name field.
5. Type the IP address of PBX in the Destination Address field.
6. Type 5061 as the Destination Port.
7. Select the Zone for the PBX connection (that is, where the trunk terminates).
8. Type 30 in the Channels field.
9. Click Show Advanced.
10. Select Diversion as the Diversion Header.
11. Select UDP as the Outgoing Transport Type.
12. Uncheck the Options Supported check box to disable it.
13. Click Save.

6.2.4.2 Configure secure communication for SIP trunks

Complete this procedure to configure the secure communications feature for one or more SIP trunks in
your enterprise.
Prerequisites: Only UMS users with the IPC Certified Tech role and authorization to obtain a dynamic
password can configure the secure communications.
Before you begin, log in to the Dynamic Password Manager web application. For more information
about this application, refer to the appendix of the Enterprise Guide.

IPC Confidential Unigy 4.3

Enterprise Guide
276 6.2: Secure Communications configuration

In addition, ensure that the SIP trunk is configured to use a secure destination port, such as 5061. Also,
if the trunk is connecting to a PBX, voice recorder, or SBC, set additional parameters as described in the
instructions to Configure a secure SIP trunk to an external device on page 275.
1. Log in to the UMS of the zone that has Unigy software version 3.1 or higher installed. You should
also already have open, in another IE tab, the Dynamic Password Manager web application.
2. Click Configuration ➤ Enterprise ➤ Security ➤ Secure Communications.
The Secure Communication Authentication window is displayed.
Figure 42: Secure Communication Authentication window

3. Copy the Token, switch to the Dynamic Password Manager web application and paste the token into
the Token field, then click Generate Output.
This generates a password in the Output field of the Dynamic Password Manager.
4. Copy the password, switch back to the UMS and paste it into the Password field of the Secure
Communication Authentication window, then click Validate.
The Secure Communications UMS menu is expanded in the navigation tree in the left pane of the
panel.
5. Click Trunks, then SIP Trunk.
A list of the SIP trunks that exist in the enterprise is displayed.
6. Click the SIP trunk you want to configure.
The SIP Trunk panel is displayed.
7. Select Enabled from the Secure SIP drop-down, then click Save.
This enables the Secure SIP protocol for this SIP trunk.

Note
Secure communication Override is disabled because it is not applicable to SIP trunks.

8. Repeat the process for any other SIP trunks that you want to secure.

6.2.5 Override secure communications settings for specific CDIs, MGs, or MMs
Complete this procedure to override the instance level settings for one or more communication devices,
Media Gateways, or Media Managers in your enterprise.
Prerequisites: Only UMS users with the IPC Certified Tech role and authorization to obtain a dynamic
password can configure the secure communications.

December 3, 2019 IPC Confidential

 6.2: Secure Communications configuration 277

Before you begin, log in to the Dynamic Password Manager web application. For more information
about this application, refer to the appendix of the Enterprise Guide.
It is possible that only certain point-to-point calls need to be secure. For example, perhaps only the head
traders’ CDIs require encryption. In such a scenario, you would disable secure communication for the
instance but enabled it (as an override) for each head traders’ CDI.
Media Managers (which control media bridges) or Media Gateways (which connect calls between Unigy
and lines outside of Unigy) can also be set for a secure communications override. However, this
procedure uses CDIs as an example. Bear in mind that Media Gateways have other prerequisites as well
as additional configuration steps. Refer to Enable secure communications for Media Gateways on page
273.
1. Log in to the UMS of the zone that has Unigy software version 3.1 or higher installed. (For MGs, the
zone must have Unigy software version 3.1.0.1 or higher installed.) You should also already have
open, in another IE tab, the Dynamic Password Manager web application.
2. Click Configuration ➤ Enterprise ➤ Security ➤ Secure Communications.
The Secure Communication Authentication window is displayed.
Figure 43: Secure Communication Authentication window

3. Copy the Token, switch to the Dynamic Password Manager web application and paste the token into
the Token field, then click Generate Output.
This generates a password in the Output field of the Dynamic Password Manager.
4. Copy the password, switch back to the UMS and paste it into the Password field of the Secure
Communication Authentication window, then click Validate.
The Secure Communications UMS menu is expanded in the navigation tree in the left pane of the
panel.
5. Click Instance.
A list of Instances is displayed.
6. click the instance you want to configure.
The Instance panel is displayed.
7. Ensure that the Disabled option button is selected. If it is not, select Disabled then click Save.
This disables the Secure SIP and Secure RTP for all supported CDIs, MGs, and MMs in the instance.
8. Select the device you want to secure.
a) In the Secure Communications navigation tree, expand Communication Devices.
b) Click the type of device you want to secure (IQ/MAX TOUCH, Pulse, or Soft Client), then click a
specific device from the list.

IPC Confidential Unigy 4.3

Enterprise Guide
278 6.2: Secure Communications configuration

9. Click the Secure communication Override check box, select Enabled for both Secure RTP and
Secure SIP, then click Save.
10. Repeat the process for any other CDIs.
11. Reboot turrets and Pulse devices that you have configured and have Soft Client end users log off and
log back on end users of Soft Client that you have configured. This step is required in order for the
changes to take effect.
The overrides are set for these devices. Future changes to the Instance level configuration will not
impact these devices. If you want the instance level configuration to impact these devices, you need
to uncheck the override and again reboot or logoff and logon to the Soft Clients.

December 3, 2019 IPC Confidential

 279

7 Replica system workflow

7.1 Build a replica system

A replica system is a Unigy enterprise that reproduces a customer enterprise for support or testing
purposes. The replica has the same hardware and network configuration and database as the customer
system. The data is obtained by restoring a backup of the customer enterprise data.
Before you begin this procedure, collect the following items:
• System, network, and HA property values recorded during deployment of the customer enterprise.
These should be available in the customer Unigy Data Collection document or the Network
Configurator properties worksheet. Use these values for the replica appliances.
• COP (if needed) and personality software DVDs.
• License for the replica CCM or ACCM appliances. A new license is required because the replica
appliances have different MAC addresses from the appliances in the customer enterprise.
• Enterprise database backup from the customer enterprise.
Prior to performing this procedure, the following prerequisites must be complete for all applicable
appliances:

Procedure References and notes

Appliance hardware is installed (racked) and Refer to the Common Appliance Platform Onsite
connected to the network. Installation Manual.
Unigy Common Operating Platform (COP) Deploy the COP (Common Operating Platform)
software is deployed on the appliance(s). software on page 448
This software is usually deployed by IPC Determine the current COP version on page 450
Manufacturing prior to appliance shipment. Deploy
the COP only if it is not on the appliance(s) or if the
wrong version is deployed.
Appliance network settings are configured. Configure the appliance network settings with
Network Configurator on page 450
You have the Unigy personality software DVD for This procedure assumes that you will always
the latest software version or have access to the deploy the latest software to obtain the benefits of
personality ISO file on an external data storage the most recent fixes and functionality.
device.
You have the customer's Unigy enterprise license This should have been delivered with the Unigy
file. The license must be based on the new hardware. If you do not have the license, submit a
hardware. request to Westbrook Orders or contact the Project
Manager in your region who is responsible for
providing licenses.
You have the credentials and Certified Admin IPC If you do not have the license, submit a request to
Technician license file for the user account you will Westbrook Orders or contact the Project Manager
use to perform the deployment. in your region who is responsible for providing
Unigy licenses.

IPC Confidential Unigy 4.3

Enterprise Guide
280 7.1: Build a replica system

The replica zones should match the customer zones, including deployment of the same COP and
personality software for each zone.
When you deploy zones, the following options are available:
• Prepare all of the appliances for all zones prior to deploying each zone. This involves configuring the
appliance network settings and deploying the personality software.
• Fully deploy one zone before deploying the next zone.
This procedure assumes that you are building a multizone enterprise and you prepared all of the
appliances in advance. For a single zone enterprise, perform steps 1 through 13.

Important
The CCM or ACCM members of an HA pair are designated as primary and secondary appliances. The
primary appliance is always the appliance with the lower IP address. The WebLogic AdminServer runs
only on the primary appliance.

1. Deploy the appliance personality software on the primary and secondary CCMs or ACCMs, and if
applicable, the Media Managers, in each zone by performing the procedure Deploy the appliance
personality software with Personality Deployer on page 465.
2. Deploy the first zone by performing the procedure Deploy the first or only zone with Zone Deployer
on page 489.
Perform this procedure on the primary and secondary appliances in the zone that is to serve as the
peer zone from which all subsequent zones will be deployed. Assign the same zone ID for both
appliances.
3. Check the state of the zone by performing the procedure Check the state of a zone from a browser on
page 499.
4. Log in to the UMS with the zone VIP and the secadmin user account: https://vip.
5. Upload and restore the backup data file from the customer system by performing the procedure
Restore an Enterprise backup file in a multizone enterprise on page 377.
6. Log in to the UMS with a user account that has the IPC Certified Tech role assigned: https://
vip.
7. Install the enterprise license that was generated from the fingerprints of the replica CCM or ACCM
appliances by performing the procedure Install an enterprise license file on page 481.
8. Remove the customer enterprise appliances and devices from the replica database by performing the
procedure Remove hardware from the database on page 359.
9. Enable device registration by performing the procedure Enable device registration on page 496.
Devices that are assigned to register with the zone automatically register.
10. If applicable, add one or more Media Gateways to the zone by performing the procedure Add a Media
Gateway on page 568, or if you are adding Media Gateways in a BCP environment, perform Add
Media Gateways for BCP on page 569.
11. Deploy the software on other devices, including Media Gateways, turrets, Pulse devices, and Unigy
Soft Clients by performing the procedure Upgrade the software on system devices on page 558.
12. Enable data replication in the first zone by performing the procedure Enable data replication on page
497.
13. Change the zone's BCP status to Active by performing the procedure Change a zone's BCP status to
Active on page 498.

December 3, 2019 IPC Confidential

 7.1: Build a replica system 281

14. Deploy a subsequent zone from the peer zone by performing the procedure Deploy subsequent zones
on page 495.
Use the deployment values specified in the customer enterprise.
15. Check the state of the zone by performing the procedure Check the state of a zone from a browser on
page 499.
16. Log in to the UMS with the zone VIP: https://vip.
17. Enable data replication for the new zone by performing the procedure Enable data replication on
page 497.
If you do not enable replication at this point, data that you enter for the zone will not be replicated to
the other zones.
18. If applicable, add one or more Media Gateways to the zone by performing the procedure Add a Media
Gateway on page 568, or if you are adding Media Gateways in a BCP environment, perform Add
Media Gateways for BCP on page 569.
19. Deploy the software on other devices, including Media Gateways, turrets, Pulse devices, and Unigy
Soft Clients by performing the procedure Upgrade the software on system devices on page 558.
20. Change the zone's BCP status to Active by performing the procedure Change a zone's BCP status to
Active on page 498.
21. Check the state of the zone and confirm that the zones are communicating by performing the
procedure Check the state of a zone from a browser on page 499.
22. If you are deploying additional zones, repeat steps 16 through 21 for each zone.

IPC Confidential Unigy 4.3

Enterprise Guide
282 7.1: Build a replica system

December 3, 2019 IPC Confidential

 283

8 BCP workflows
This chapter includes the procedures required to configure and manage BCP plans.
For overview information on BCP, refer to BCP on page 283.

8.1 BCP
Unigy provides Business Continuity Planning (BCP) support for disaster recovery and enterprise
maintenance purposes.
BCP controls the redirection of lines and CDIs in response to failure of one or more backroom zones. If
an active resource zone (lines) or home zone (CDIs) is not available due to loss of network connectivity,
hardware or software failure, or maintenance or repair operations, the lines and CDIs are redirected to
one or more available zones that are specified in the line configuration (lines) or defined in the BCP plan
(CDIs).
Unigy does not provide system level support for recovery from loss of front room devices (CDIs) or loss
of an entire front room. It also does not support BCP for Blue Wave applications. The BCP functions
focus on providing redirection for CDIs that lose access to their home zone and for line rerouting. To
provide Blue Wave application redundancy, the customer client applications must provide the support
required for BCP redirection. For additional information, refer to the Blue Wave API Developer’s Guide.

BCP components
BCP consists of the following components:
• Backroom Zone: The CCMs or ACCMs associated with zones at a backroom location (data center).
• Front room Zone: The CDIs at a front room location. Front room and backroom locations can be at
the same address.
• Home Zone: Every CDI (turrets, Pulse devices, and Unigy Soft Clients) registers with a Unigy zone.
This zone is the home zone. During normal operation, a CDI always logs in to its home zone.
• Active zone: Lines are assigned a resource zone for each zone associated with the line's controlling
instance. One of these zones is designated as the active resource zone that handles all features for all
line appearances and performs all status updates for the line. When a BCP event occurs, the system
promotes another zone to take over the functions of the active zone. The zone selected is based on the
zone sequence and availability within the Zones tab in the line's configuration. You can change the
active zone and order of zone precedence for each individual line of each line type at
Configuration ➤ Enterprise ➤ Lines and Extensions.

When a BCP plan is activated, the system checks the zone preferences specified for each line to
determine the new active zone to assign. The line AOR becomes active in the first available resource
zone in the list. For manual BCP plan activation, line redirection is dependent on the availability of
zones within the preference list. For example, in a three zone enterprise with Zone A, Zone B, and
Zone C, the resource zone preference sequence for lines 1 – 10 in Zone A is Zone B then Zone C. The
zone preference sequence for lines 11 – 20 in Zone A is Zone C then Zone B. If Zone B is not
available when the BCP plan for Zone A is manually activated, lines 1 – 10 will not be redirected
because Zone B is not available to assume the active role or to redirect the lines to Zone C, however,
lines 11 – 20 will be redirected to Zone C because there is no dependency on the availability of Zone

IPC Confidential Unigy 4.3

Enterprise Guide
284 8.1: BCP

B. To redirect lines 1 – 10 to Zone C, you must also activate the BCP plan for Zone B. Automatic
BCP plan activation does not have this zone availability dependency.
When a BCP plan is deactivated, after the event that triggered the redirection is resolved, the system
directs control of every line AOR in the instance associated with the BCP plan to the resource zone at
the top of the Zones preference list specified in the line configuration. Depending on how the zones
list was configured, this might not be the same zone in which the line AOR was active before the
BCP plan was activated. For an example of the redirection behavior, refer to BCP line redirection
example on page 299. For additional information on resource zones and specifying zone preferences,
refer to the following sections in the Lines, Trunks, and Routing Guide: Active zones and the section
for each line type in the UMS client user interface reference appendix.
• Backup Zone: In a BCP plan, the CDI devices at a front room location are configured to be
redirected to one or more different zones if the home zone is not accessible. These zones are referred
to as backup (BCP) zones. With Basic BCP, only a single backup (standby) zone is available. With
Campus BCP, a zone can serve as the backup zone for multiple front rooms and you can redirect the
devices to different zones for load-balancing. You can also specify multiple backup zones for each
front room, so if the preferred backup zone is not available, the system can direct the devices to one
or more secondary backup zones.
Backup zones must be within the same instance as the home zone and active resource zone from
which the CDIs and lines are being redirected when a BCP plan is activated.

BCP types
Two types of BCP are available based on the license purchased:
• Basic BCP: supports two backrooms in an active and standby relationship, with one active zone and
one standby zone per Unigy instance. The standby zone is in a warm standby state waiting to assume
the active role if the active zone is not accessible. This is comparable to the BCP supported in Unigy
v1.x. Configuring preferences, percentages, and user priorities is not available for Basic BCP. When a
BCP plan is activated, all lines and CDIs are redirected to the standby zone.
• Campus BCP: supports CDI redirection and line rerouting to any zones within an instance. Each
zone can be actively involved in configuration, management, and call processing. Plan activation
(failover) can be automatic or manual. If automatic plan activation is not enabled, a Unigy
administrator performs a manual failover after receiving alerts from the system or prior to zone
maintenance operations. When a BCP plan is activated, a backup zone supports call processing for
the redirected CDIs and lines in addition to those for which it is the home zone. The BCP plan and
line configurations can include multiple backup zones, listed in preference order, to help ensure that
at least one zone will be available during a failover. For CDIs, you can specify redirection of specific
percentages of CDIs to different backup zones. You can also define user priority lists that control end
user access based on user priority when end user session capacity has been reached. For example, if
Zone 1 fails, the plan can stipulate that 50% of its CDIs are redirected to Zone 2 and 50% are
redirected to Zone 3. If Zone 3 is not available, the system can redirect the CDIs to Zone 4. If login
session capacity is reached for a backup zone after a failover, session access is determined by a 3-tier
priority feature. Users who are assigned to priority level 1 are always granted access. Users in priority
level 2 are granted access if a login session is available, but lose access if a priority 1 user needs
access. Priority 3 level users are granted access only if a login session is available. If a priority 1 or 2
end user needs access, the priority 3 end user loses future access until the BCP plan is deactivated.
BCP is controlled by BCP plans, and with Campus BCP, user priority designations. Plans are configured
at the instance level with overrides available at the CDI level. A plan consists of a set of preferences and
priorities that define where the system directs CDIs when a zone is not available and who is able to

December 3, 2019 IPC Confidential

 8.1: BCP 285

access available login sessions (Campus BCP only). Device redirection is only to other zones within the
instance. BCP plans cannot cross instances.

Note
Local survivability zones, as described in pre-Unigy v2.0.1.5 versions, are not supported. To provide the
same functionality, deploy an active or standby BCP zone at a front room address. For information on
converting existing local survivability zones to regular zones, refer to the topic Convert a Local
Survivability zone to an active or standby zone in the Enterprise Guide.

CDI overrides
You can override the backup zone preferences set in the BCP plan for individual CDIs by configuring
device-specific preferences within in the BCP Preferences tab at Configuration ➤ Sites ➤
Communication Devices. If the Protect from override by BCP Configuration property is enabled, the
preference set at the CDI level will not be overwritten if the backup zones are changed in the BCP plan.
If this check box is not selected, the system uses the new backup zone defined in the BCP plan.

BCP actions
The following actions are available for a BCP plan:
• Activate: BCP plan activation is the process of redirecting CDIs and line AORs to backup zones
when their home or active resource zone is not available. Redirection of turrets and Pulse devices
automatically registers the devices in a backup zone based on the preferences set in the BCP plan.
Redirection of Soft Clients is a manual process that must be performed on each client through the
Unigy Client Configuration Tool. For lines, the system makes each line AOR active in the first
available resource zone in the zone preference list. This list is specified within the Zones tab in the
line configuration.
Plan activation can be manual or automatic (Campus BCP only).
When a plan is activated, the firewall fence is raised in each active zone to prevent access by the
failed zones.
• Reactivate: If one or more backup zones fails after plan activation, Reactivate activates the plan
again for the newly impacted zones. If any of the zones that failed prior to or during the initial plan
activation come back into service, Reactivate directs the associated CDIs, lines, or both to an
available zone. You can also use Reactivate to rerun the initial activation in the event that all of the
plan processes do not complete.
• Deactivate: Plan deactivation directs CDIs back to their home zone and makes line AORs active in
the appropriate resource zone after the event that triggered a BCP plan activation is resolved. When
you deactivate a plan, each turret and Pulse automatically re-registers with its home zone and every
line AOR in the instance associated with the BCP plan becomes active in the resource zone at the top
of the Zones list specified in the line configuration. You must manually redirect each Unigy Soft
Client to its home zone through the Unigy Client Configuration Tool.
After the plan is deactivated, the firewall fence is lowered in each active zone to reenable access by
the zones that had failed.
• Retry Deactivate: Use Retry Deactivate to rerun a deactivation if all of the Deactivate processes do
not complete.

IPC Confidential Unigy 4.3

Enterprise Guide
286 8.1: BCP

When one or more zones fail, the BCP plan is activated for those zones. When the failed zones are
returned to normal operation, you manually deactivate the BCP plan, which directs the impacted CDIs
and lines back to their home or active resource zone.

Automatic BCP plan activation

Automatic BCP plan activation automatically redirects the turrets and Pulse devices (Soft Clients must
be manually redirected) and lines connected to failed zones to the appropriate backup zones configured
in the BCP plan and line configuration when a BCP event is detected. The system checks for a failure
condition every five minutes. If it detects a failure, it waits nine minutes before activating the plan to
confirm that the issue was not the result of a temporary network outage. An automatic failover requires
ten to twenty minutes to complete, depending on the number of zones and lines involved. Additional
time is required for each of the redirected CDIs to restart. This time varies based on the time required for
each CDI to register with the backup zone.
Beginning with Unigy v4.1, when all zones in the enterprise have v4.1 or higher deployed, automatic
BCP plan activation is triggered only when all zones within a data center have failed or are unavailable
due to a network outage. The zones within the data center must be at Unigy v4.1 or higher and the
backup zones must be in a different data center within the same instance. Automatic plan activation is
usually triggered by a WAN outage rather than hardware failure.
Unigy does not support automatic plan activation for the failure of more than one data center within an
instance. For example, in an instance with three data centers, the BCP plan specifies that the zones in
Data center 2 are the Preference 1 backup zones for Data center 1 and the zones in Data center 3 are the
Preference 2 backup zones for Data center 1. If Data center 2 is in the failed state when Data center 1
fails, the Data center 1 CDIs and lines will not fail over to the zones in Data center 3. To support BCP
for a data center failure that occurs while another data center is in the failed state, do the following:
1. After the first data center fails, make adjustments to the BCP plan and line configurations for the data
centers that are still healthy to redirect their CDIs and lines to available zones.
2. If another data center fails while the failed data center is still unavailable, perform a manual BCP plan
activation to redirect the lines and CDIs.
In a mixed zone enterprise that includes Unigy v4.1 or higher zones and at least one pre-Unigy v4.1
zone, the v4.1 plan activation behavior is not applied. In this scenario, failure of a single zone can trigger
automatic plan activation as it did in previous Unigy versions.
If it is necessary to activate a BCP plan when only a subset of zones within a data center are not
available, use the manual BCP plan activation procedure.
If the enterprise will use Multi-tier Replication, to improve system performance and WAN resiliency,
and will also use automatic BCP plan activation, configure the BCP plan and enable automatic BCP plan
activation before you enable Multi-tier Replication.
Sample automatic BCP plan activation scenarios
• In a single zone data center, if the zone fails or experiences a network outage, the system activates the
BCP plan because there are no zones in the data center to communicate with the other zones in the
enterprise.
• In a multi-zone data center, if one or more of the zones, but not all of the zones fail or experience a
network outage, the system does not activate the BCP plan because at least one zone in the data
center can communicate with the other zones in the enterprise.
• If a data center experiences a WAN outage equal to or greater than nine minutes in length, the system
activates the BCP plan.

December 3, 2019 IPC Confidential

 8.1: BCP 287

• If a data center experiences a temporary WAN outage of less than nine minutes, the system does not
activate the BCP plan.
• If all zones within a data center fail, the system activates the BCP plan.

Plan activation behavior

When a BCP plan is activated, the system redirects the impacted turrets, Pulse devices, and lines to the
appropriate backup zones then automatically logs on turret and Pulse end users who were logged on
prior to the failover. The system does not redirect Unigy Soft Clients, so after the plan is activated, Soft
Client end users must select a backup zone in the BCP field of the Unigy Client Configuration Tool and
indicate that the client is to be redirected to that zone by selecting the Use BCP check box and clicking
Save.

If data replication is disabled for a zone that is involved in a BCP plan activation, the system redirects
the lines associated with the zone, but it does not redirect the associated CDIs. If you are activating a
BCP plan to prepare for a pending disaster, to perform a maintenance operation during business hours,
or for testing purposes, confirm that data replication is enabled before you activate the BCP plan by
performing the procedure Enable data replication on page 497.

Maintenance mode behavior

In a mixed zone enterprise with pre-Unigy v4.1 zones and Unigy v4.1 or higher zones, if automatic BCP
is enabled, when a zone is in BCP maintenance mode, the system cannot activate the BCP plan for the
zone, so the CDIs and lines connected to it are not redirected to the backup zone. However, if a backup
zone is in maintenance mode, the lines and CDIs connected to the failed zone are redirected to the
backup zone.
In an enterprise that includes only Unigy v4.1 or higher zones, when automatic BCP is enabled and the
plan is activated, if a zone in the failed data center is in maintenance mode, the system cannot activate
the BCP plan for that zone, so the lines and CDIs connected to it are not redirected to the backup zones.
If a backup zone is in maintenance mode, the lines connected to a failed zone cannot be redirected to the
backup zone, but the system does redirect the CDIs. For example, in a two data center enterprise, Data
center 1 has two zones, Zone 1 and Zone 2, and Data center 2 has two zones, Zone 3 and Zone 4. Zone 3
is the backup zone for Zone 1 and Zone 1 is the backup zone for Zone 3. Zone 4 is the backup zone for
Zone 2 and Zone 2 is the backup zone for Zone 4. The BCP Status in the Zone Configuration panel for
Zone 1, Zone 3, and Zone 4 is Active. The BCP Status for Zone 2 is Maintenance.
Scenario 1
If the zones in Data center 1 fail, the CDIs and lines connected to Zone 1 are redirected to Zone 3, but
the CDIs and lines connected to Zone 2 are not redirected because Zone 2 is in maintenance mode.
Scenario 2
If the zones in Data center 2 fail, the CDIs and lines connected to Zone 3 are redirected to Zone 1 and
the CDIs connected to Zone 4 are redirected to Zone 2, but the lines connected to Zone 4 are not
redirected because Zone 2 is in maintenance mode.

Troubleshooting
After a BCP plan is activated, if the message Waiting for telephony is displayed on one or
more CDIs beyond the time it takes for the failover to complete, the backup zone to which the devices
were redirected might also be unavailable. Check the BCP Status field for the backup zone at
Configuration ➤ Enterprise ➤ System ➤ Zones. If the status is Inactive, CDIs will not be able to
register with the zone. When a backup zone or the home zone become available, use the Reactivate or

IPC Confidential Unigy 4.3

Enterprise Guide
288 8.1: BCP

Deactivate option to correct this issue based on which zone becomes available first. For example, if the
backup zone that was unavailable becomes available or another backup zone is available before the
home zone returns to service, use Reactivate. If the home zone is available, use Deactivate. The CDIs
should register with the appropriate zone.
After an Automatic BCP plan activation from a Unigy v3.1.0.2 or higher zone to a pre-v3.1.0.2 zone,
monitoring of the CDI devices that failed over stops in the pre-v3.1.0.2 zone. To start the monitoring,
restart the CDIs.
For Unigy v4.1 or higher zones, all backup zones must also be at Unigy v4.1 or higher and they must be
in a different data center than the home zone, but the data center must be within the same instance.
If network connectivity for a CDI is lost prior to deactivating a BCP plan, an unavailability alert is
generated as expected, however, when the network connection is restored after the fail back, the alert in
the Monitoring Summary panel is not cleared automatically. In the Topology panel, the Availability
Status for the device is green, but the Alert Status is red. Clear the alert manually to resolve this issue.

If a BCP plan is activated during a WAN outage, some line connections might not be interpreted
properly by one or more data centers after the failover completes. For example, in a three data center
enterprise, if during the WAN outage, Data center1 and Data center 2 cannot communicate with each
other, but both can communicate with Data center 3, Data center 3 might determine that some lines are
active in Data center 1 or Data center 2, which could present functional issues. To resolve this issue, do
the following to reactivate the BCP plan for the zones in one of the impacted data centers so at least two
of the data centers agree on where the lines are active (in the example, you would reactivate the plan for
the zones in either Data center 1 or Data center 2):
1. Click Tools ➤ BCP Monitoring then click the instance associated with the data center for which you
are reactivating the BCP plan.
2. Click the Plan tab.
3. Within the Select for Action column, select the check box for all zones in the data center for which
you are reactivating the plan.
4. Click Reactivate.

BCP planning
Prior to configuring BCP plans, develop a master plan that maps the relationships between the front
rooms, their home zones, and the backup zones to which the system redirects the lines and CDIs during
BCP plan activation. While developing this plan, determine the number of CDIs in each zone, the spare
capacity of each zone, and the capacity required for failover of each zone. The CDIs connected to a zone
can be redirected to different zones to maximize load balancing. If BCP override preferences will be set
at the CDI level for certain CDIs, determine these preferences.

December 3, 2019 IPC Confidential

 8.1: BCP 289

Note
To avoid compatibility issues, it is strongly recommended that home zones and backup zones have the
same major software version deployed. This might require temporary modifications to BCP plans for
upgrades in which the zones within an instance are being upgraded during different maintenance
windows.
If it is not possible for the home and backup zones to be at the same software version, keep the following
in mind. Lower version zones might not support the types of CDIs that will be redirected to them; for
example, zones with software versions prior to Unigy v3.1 do not support IQ/MAX TOUCH turrets. With
lower version backup zones, any features that were introduced in the higher version software will not be
supported when the CDIs and lines fail over to the backup zone. This also applies to settings that were
configured in the higher version. For example, the spatial audio feature, introduced in Unigy v4.0 for
IQ/MAX TOUCH turrets, enables you to specify one of five different spatial positions for each speaker
channel. If the backup zone for a v4.0 or higher zone is a pre-v4.0 zone, spatial audio will not be
supported and the speaker used for speaker calls will default to the left speaker.

8.1.1 During a BCP event

During a BCP event, a BCP plan can be activated to redirect the CDIs and lines connected to a failed
zone to one or more backup zones.
BCP applies to IQ/MAX, IQ/MAX Edge, and IQ/MAX TOUCH turrets, Pulse devices, Unigy Soft
Clients, and Unigy lines.
BCP plan activation (failover) behavior depends on the type of BCP license installed for the enterprise:
• Basic BCP: The CDIs are redirected to the Standby zone and end users can log on to a device
connected to the backup zone on a first-come, first-served basis. The BCP plan is always activated
manually.
• Campus BCP: The CDIs and lines are redirected to one or more backup zones. In the unlikely event
that there are not enough BCP licenses for each end user, the users log on to devices connected to the
backup zone based on the BCP user priorities configured for the plan. Priorities remain in effect while
the BCP plan is active, but can be changed at any time. End users can be assigned to one of the
following priority lists:
1. Priority 1 End Users (Always Survive): These end users have the highest priority for logging on
to a device registered with a backup zone. If user capacity is reached, they can force the log off of
lower priority users.
2. Priority 2 End Users (Contend for space): These end users can log on to a device connected to a
backup zone on a first-come, first-served basis if logins are available. If user capacity is reached,
they can force a log off of lower priority users.
3. Priority 3 End Users (May not log in): These end users can log on if user capacity has not been
reached. If they are forced off by a higher priority user or intentionally log off, they cannot log on
again while the BCP plan is active.
Forced logoffs are immediate, without any warning to the end user who is forced off.

Note
Desktop devices log on automatically after a failover only if there was an active user logon session
prior to the BCP plan activation.

A Campus BCP plan can be activated manually or automatically. CDIs and lines automatically
attempt to connect to an appropriate backup zone, based on the zone preferences specified in the plan

IPC Confidential Unigy 4.3

Enterprise Guide
290 8.2: Configure a BCP plan

or the line's list of resource zones, if they cannot reach the failed zone. They try each of the zones in
the list until they can connect to an active zone.
Beginning with Unigy v4.1, when Automatic Plan Activation is enabled for a BCP plan, the plan is
activated only if all zones within the associated data center fail or are not available. If it is necessary
to activate a BCP plan when only a subset of zones within the data center fail, activate the plan
manually.
Unlike turrets and Pulse devices, Soft Clients are not automatically redirected to a backup zone when a
BCP plan is activated; each must be manually redirected through the Unigy Client Configuration Tool on
each client computer.
Home zones and backup zones should be located in different data centers within the same instance.
When a turret or Pulse is redirected to a backup zone, BCP licenses are consumed when end users log on
and are released when the users log off or are forced to log off. BCP licenses are not required for Soft
Clients.
CDI recovery can take up to 2 minutes after a manual plan activation. Automatic plan activation
includes a built in-delay of nine minutes to allow time for a temporary failure condition to resolve on its
own (for example, a momentary network outage), and can take ten to twenty minutes to complete after
the plan is activated, depending on the number of zones and lines involved.

Note
CDI re-registration on a backup zone does not create a new device entry. The system regards the CDI as
being homed to the configured home zone.

8.1.2 Constraints
This topic describes constraints and limitations associated with BCP support and behavior.
The following constraints apply to BCP:
• Free seating requires a per-user Mobility license for logging on at a different address (normal
operation) or BCP license for logging on to a different zone (BCP failure scenario).
• Line sharing between zones is supported only for Campus BCP configurations.
• License counts and usage are enforced in the active zones.
• Updates to the system are replicated only within the active zones; changes are replicated to the failed
zones when they are brought back into service.
• Call state is not maintained during a BCP failover.
• Turrets and Pulse devices can automatically log on to a backup zone if the zone that is assigned is
available; Soft Clients must be reconfigured, through the Unigy Client Configuration Tool, to point to
a backup zone.
• In a Unigy v4.1 or higher enterprise, if Automatic Plan Activation is enabled for a BCP plan, the
plan is activated only if all zones within the associated data center fail or are not available.

8.2 Configure a BCP plan

A BCP plan defines the backup zones and behavior for CDI redirection when the plan is activated.
Business Continuity Planning (BCP) is Unigy's solution for zone-level fault-tolerance and disaster
recovery. BCP can also be used for system maintenance during business hours by temporarily

December 3, 2019 IPC Confidential

 8.2: Configure a BCP plan 291

redirecting lines and CDIs (turrets, Pulse devices, and Unigy Soft Clients) to other zones while a zone is
being repaired.
Prerequisites
BCP is based on the relationships between front room CDIs and backroom appliances (CCMs or
ACCMs). Plans are configured for zones at the instance level with overrides available at the CDI level.
A plan consists of a set of preferences and priorities that define where the system directs CDIs when a
zone is not available and who is able to access available licenses.
For BCP overview information and considerations, refer to BCP on page 283.
Complete the following procedures before you configure a BCP plan:
• Deploy and configure the enterprise zones.
• Determine the type of BCP the Unigy enterprise license supports. The following types are available:
• Basic
• Campus
• Develop a BCP master plan that maps the relationships between the front room zones, their home
zones, and the backup zones to which the system redirects the CDIs during BCP plan activation.
You can configure the BCP preferences from any zone. For each front room, you can define multiple
preferences that instruct the system to direct CDIs to different backup zones during a failover based on
their availability.
For information on configuring alternate resource zone priorities for lines, refer to the Lines, Trunks, and
Routing Guide.
For details on the fields and buttons in the BCP panels, refer to the UMS online help or the UMS UI
Guide.
1. Log in to the UMS with the zone VIP: https://vip.
2. Click Configuration ➤ Enterprise ➤ BCP ➤ CDI Configuration.
3. In the Instance list, click the instance for which you are configuring the BCP plan.
The Communication Devices tab is displayed showing all of the front room and backroom zones
within the instance. You can mouse-over each front room or backroom zone to display the number of
CDI devices in or connected to the zone, and the home zone connections.
4. Click the front room zone (light green) you want to configure.
The system displays the BCP Preferences tab.
5. Click Add Preferences.
The Add Preferences dialog box is displayed.
6. In BCP Zone, select the backup zone to which the system directs some or all of the CDIs in the front
room when the BCP plan is activated.
The zone must be in the same instance as the home zone and should be in a different data center. For
Unigy v4.1 or higher, if you are enabling automatic BCP plan activation, the backup zone you select
must be a Unigy v4.1 or higher zone and it must be in a different data center.
7. In Preference, select the position in the sequence of preferred zones that this zone occupies. For
example, if you specify three backup zone preferences for the zone, the system first attempts to
redirect the CDIs to the zone you specify as preference 1. If that zone is not available, the system
attempts to redirect the CDIs to the zone you specify as preference 2. If this zone is not available, the
system attempts to redirect the CDIs to the zone you specify as preference 3.
8. In Percentage, specify the percentage of CDIs the system redirects to the backup zone you specified
in BCP Zone during a failover. For example, if you are specifying three backup zone preferences for

IPC Confidential Unigy 4.3

Enterprise Guide
292 8.3: Configure Campus BCP login priorities for users

the zone and you specify 50% for the first zone, 25% for the second zone, and 25% for the third zone,
during BCP plan activation, the system redirects 50% of the CDIs to zone 1, 25% of the CDIs to zone
2, and 25% of the CDIs to zone 3, if the zones are available.
9. Click OK.
The preference is added to the grid.
10. Repeat steps 5 through 9 for each preference you are configuring.
11. If you want to enable automatic BCP plan activation, refer to Enable automatic BCP plan activation
(failover) on page 293.
12. After you add or change a BCP plan, reboot all turrets and Pulse devices affected by the plan by
performing the procedure Reboot communication devices on page 591.
13. To configure the user access priority that is enforced after BCP plan activation, refer to Configure
Campus BCP login priorities for users on page 292.

8.3 Configure Campus BCP login priorities for users

In Enterprise systems that have Campus BCP licensing, you can configure priorities to determine which
end users can log in after a BCP failover event.
This panel is available only if a Campus BCP license is installed. The following roles have access to the
panel: Basic Administrator, Advanced Administrator, and IPC Certified Tech.
End users can be assigned to one of the following priority levels:
• Priority 1: When a backup zone reaches its maximum end user capacity after activation of a BCP
plan, these users receive preference over Priority 2 and Priority 3 end users. When a Priority 1 end
user attempts to log in, the system looks for a Priority 3 user who is logged in. If a user is found, the
system logs that user out and logs in the Priority 1 user. If a Priority 3 end user is not found, the
system searches for a Priority 2 end user and if one is found, logs that user out and logs in the Priority
1 user.
• Priority 2: When a backup zone reaches its maximum end user capacity after activation of a BCP
plan, these users receive preference over Priority 3 end users. When a Priority 2 end user attempts to
log in, the system looks for a Priority 3 user who is logged in. If a user is found, the system logs that
user out and logs in the Priority 2 end user. If a Priority 3 end user is not found, the Priority 2 login
request fails.
• Priority 3: These users cannot log in after a BCP plan is activated unless the backup zone's
maximum end user capacity has not been reached. When the zone capacity is reached, a login request
from a Priority 1 or Priority 2 end user can force off a Priority 3 user without notification. If a Priority
3 end user logs off or is forced off, the user cannot log in again until normal operation resumes.

Important
User priorities are not considered until a zone's end user session capacity is reached. Until then, all login
requests are treated as first come first serve, irrespective of the priority of the end user. If all BCP
licenses are consumed before the zone capacity is reached, higher priority users will not be able to seize
a BCP license and force off a lower priority user.

1. In the menu bar, click Configuration ➤ Enterprise ➤ BCP ➤ BCP User Priority.
The BCP User Priority panel is displayed. By default, all end users are listed under Priority 3 End
Users (May not log in).
2. In the View Users of drop-down, select the priority level that contains the users you are reassigning.
A list of end user groups is displayed. Expand a group to view all users in the group.

December 3, 2019 IPC Confidential

 8.4: Enable automatic BCP plan activation (failover) 293

3. To change a group's priority or a user's priority, select the check box for the group, or select the check
box for specific users in the group.
4. In Change User Priority to, select the priority level for the group or for specific users.
5. Click Save.

8.4 Enable automatic BCP plan activation (failover)

This topic describes how to set automatic BCP plan activation, which is available only for Campus BCP.
BCP plans provide the rules for zone failover and the resulting line rerouting and CDI connection
redirection. The plans can be activated manually or automatically when the system detects a failure.
Automatic activation can result in a more prompt response to issues that cause a zone to fail.
For overview information on BCP plans, refer to BCP on page 283.
Beginning with Unigy v4.1, when you enable automatic BCP plan activation, the backup zones you
select for the plan must be at Unigy v4.1 or higher and must be in a different data center within the same
instance.

Note
After a BCP plan is activated automatically, do one of the following in the zones for which the plan was
activated to ensure that the CDI licenses are released for use with the backup zone(s) while the plan is
active. Do not perform this action if Multi-tier Replication is enabled.
• If the zone is operational and you can access the UMS, disable data replication in the failed zone(s).
• If you cannot access the UMS, power down the zone CCM or ACCM appliances.

1. Log in to the UMS with the zone VIP: https://vip.

2. Click Configuration ➤ Enterprise ➤ BCP ➤ CDI Configuration.
3. In the Instances list, click the instance for which you are enabling automatic plan activation.
4. Click the Plan tab.
5. In the Automatic Plan Activation list, select Enabled.
6. Click Save.
The system monitors the zones for alerts that indicate a problem with one or more zones. The zone
that detects zone failure and activates the BCP Plan is the BCP Initiation zone. The BCP Initiation
zone sends Plan Activation event messages to the BCP event log.

8.5 Disable automatic BCP plan activation

This topic describes how to disable automatic plan activation.
BCP plans provide the rules for zone failover and the resulting CDI and line redirection. The plans can
be activated manually or automatically for disaster recovery or maintenance operations.
For BCP overview information, refer to BCP on page 283.
1. Log in to the UMS with the zone VIP: https://vip.
2. Click Configuration ➤ Enterprise ➤ BCP ➤ CDI Configuration.
3. In the Instances list, click the instance for which you are disabling automatic plan activation.
4. Click the Plan tab.

IPC Confidential Unigy 4.3

Enterprise Guide
294 8.6: Manually activate a BCP plan (fail over)

5. In the Automatic Plan Activation list, select Disabled.

6. Click Save.
If the firewall fence for the zone is raised, the message Do you want to drop the fence?
is displayed. Select one of the following options:
• Yes: The system disables Automatic Plan Activation and lowers the firewall fence to enable the
zones to replicate data with other zones.
• No: The system disables Automatic Plan Activation, but the firewall fence remains raised to
prevent replication with other zones. This prevents the appliances from loading the database from
another zone when they reboot. You might want to select this option if there is still an issue with a
zone and you do not want it to rejoin the JGroups cluster.
When Automatic Plan Activation is disabled, the system monitors the zones, but does not
automatically activate the BCP plan when it detects a data center failure. You must activate the plan
manually.

8.6 Manually activate a BCP plan (fail over)

This topic describes how to activate a plan manually.
BCP plans provide the rules for zone failover and the resulting CDI and line redirection. The plans can
be activated manually or automatically when the system detects a failure. Manual activation can be used
for greater control over the failover process and to redirect CDIs and lines prior to zone maintenance
activities.
When you activate a BCP plan, turrets and Pulse devices automatically register with a backup zone
based on the preferences set in the BCP plan. Redirection of Soft Clients is a manual process that must
be performed on each client through the Unigy Client Configuration Tool. For information on this
procedure, refer to Redirect a Soft Client after a BCP event on page 298. For lines, the system makes
each line AOR active in the first available resource zone in the zone preference list. This list is specified
for each line within the Zones tab in the line's configuration. For an example of the redirection behavior,
refer to BCP line redirection example on page 299.
Prerequisite:
Before you activate a BCP plan, be sure the backup zones are in a healthy state by performing the
procedure Validate a zone before an upgrade, rollback, or other operations on page 636. If one or more
backup zones are not fully operational, correct the issues or change the backup zones in the plan.
If a zone is in maintenance mode, the system cannot activate a BCP plan for the zone. If a backup zone
is in maintenance mode, lines and CDIs will be redirected to the zone.
In zones where data replication is disabled when a BCP plan is activated, the system redirects the lines
to the backup zones, but it does not redirect the CDIs. If you are using this procedure to prepare for a
pending disaster, to perform a maintenance operation during business hours, or for testing purposes,
confirm that data replication is enabled before you activate the BCP plan by performing the procedure
Enable data replication on page 497.
For Basic BCP, activating a BCP plan makes the Active zone inactive and the Standby zone active. For
Campus BCP, the plan redirects the impacted lines and devices to their backup zones.

December 3, 2019 IPC Confidential

 8.6: Manually activate a BCP plan (fail over) 295

Note
For manual BCP plan activation, line redirection is dependent on the availability of zones within the
preference sequence list. For example, in a three zone enterprise with Zone A, Zone B, and Zone C, the
backup zone priority sequence for lines 1 – 10 in Zone A is Zone B then Zone C. The backup zone
priority sequence for lines 11 – 20 in Zone A is Zone C then Zone B. If Zone B is not available when the
BCP plan for Zone A is manually activated, lines 1 – 10 will not be redirected because Zone B is not
available to assume the active role or to redirect them to Zone C, however, lines 11 – 20 will be redirected
to Zone C because there is no dependency on the availability of Zone B. To redirect lines 1 – 10 to Zone
C, you must also activate the BCP plan for Zone B. Automatic BCP plan activation does not have this
zone availability dependency.

If possible, do not manually activate a BCP plan during a WAN outage. If you do, and the outage
remains in effect for more than nine minutes, functional issues could be seen when WAN connectivity is
restored. Enabling Multi-tier Replication helps to prevent this problem.
1. Log in to the UMS in a healthy zone within the instance associated with the BCP plan.
Do not log in to a failed or failing zone from which the CDIs and lines will be redirected when the
plan is activated.
2. Click Tools ➤ BCP Monitoring.
3. In the Summary list, click the instance for which you are activating the plan.
4. Click the Plan tab.
5. In the Select for Action column, select the check box for the zone(s) for which you are activating the
plan (zones that will fail over). The check box label changes to Deactivating indicating that the
zone will be deactivated.
This step applies only to Campus BCP. For Basic BCP, the system automatically selects the Standby
zone.
6. Click Activate then in the BCP Plan Activate Confirmation box, click OK.
The system activates the plan for the zones you selected by doing the following:
• Changes the Plan Status to Active.
• Changes the zone Status to Inactive.
• Redirects the turrets and Pulse devices to a backup zone (for Unigy Soft Clients, refer to step 9).
• Makes each line AOR active in the first available resource zone in the zone preference list
specified within the Zones tab in the line's configuration.
7. Refer to the Enactment and Events tabs for information about the plan activation events.
If the plan does not fully activate, click Reactivate to rerun the plan activation.
The Enactment tab is displayed only during the current plan activation.
To refresh the Events tab, you might have to exit BCP Monitoring then re-access the tab.
8. If Multi-tier Replication is not enabled for the data center associated with the BCP plan, do one of the
following in the zone(s) for which you activated the plan to ensure that the CDI licenses are released
for use with the backup zone(s) while the plan is active. This step is not required if you activated the
BCP plan as part of a maintenance operation or the plan will be active only during non-trading hours.
• If the zone is operational and you can access the UMS, disable data replication in the failed zone(s)
by performing the procedure Disable data replication on page 498.

IPC Confidential Unigy 4.3

Enterprise Guide
296 8.7: Reactivate a BCP plan

• If you cannot access the UMS, power down the zone CCM or ACCM appliances.
9. Redirect the Unigy Soft Clients to a backup zone by performing the procedure Redirect a Soft Client
after a BCP event on page 298.

8.7 Reactivate a BCP plan

After a BCP plan is activated, if one or more backup zones fail or the Activate process does not
complete, you can reactivate the plan to redirect the CDIs to the appropriate backup zones.
If any of the zones that failed prior to or during the initial plan activation come back into service,
Reactivate directs the associated CDIs, lines, or both to an available zone. You can also use Reactivate if
an activation did not complete. This reruns the Activate process so it can complete successfully.
1. Log in to the UMS with the zone VIP: https://vip.
2. Click Tools ➤ BCP Monitoring.
3. In the Summary list, click the instance that includes the zones for which you running Reactivate.
4. Click the Plan tab.
5. In the Select for Action column, select the check box for the zones you are reactivating.
6. Click Reactivate.
The system reactivates the plan and redirects the CDIs for any zones that were placed back in service
to their home zone.

8.8 Deactivate a BCP plan (fail back)

After the issues or maintenance operations that triggered the activation of a BCP plan are resolved,
deactivate the plan to reconnect the redirected CDIs to their home zone and to make the line AORs
active in the first resource zone in the zones list.

Note
When you deactivate a BCP plan, the system makes each line AOR, in the instance associated with the
BCP plan, active in the resource zone at the top of the zone preference list. This list is defined within the
Zones tab in the line configuration. Depending on how the zones list was configured, this might not be the
same zone in which the line AOR was active before the BCP plan was activated. For an example of the
redirection behavior, refer to BCP line redirection example on page 299. For additional information on
resource zones and specifying zone preferences, refer to the following sections in the Lines, Trunks, and
Routing Guide: Active zones and the section for each line type in the UMS client user interface
reference appendix.

Note
Perform this procedure during non-trading hours.

Note
Before you deactivate a BCP plan, confirm that the zones to which the CDIs and lines are being
redirected are in a healthy state by performing the procedure Check the state of a zone from a browser
on page 499.

December 3, 2019 IPC Confidential

 8.8: Deactivate a BCP plan (fail back) 297

1. If you powered down the appliances in the zone(s) that failed over when you activated the BCP plan,
power up the appliances.
2. Log in to the UMS in each of the zones that failed.
If the BCP plan was activated through automatic plan activation, log in to all zones in the failed data
center.
3. If the plan was activated through automatic plan activation and Multi-tier Replication is enabled for
the data center that failed, suspend Multi-tier Replication for the failed data center by performing the
procedure Suspend or resume Multi-tier Replication on page 247.
4. If Automatic Plan Activation is enabled for the BCP plan, disable it by performing the procedure
Disable automatic BCP plan activation on page 293.
If you are prompted to drop the firewall fence, select Yes, unless there is a reason that you do not
want the zone to rejoin the JGroups cluster; for example, if there is still an issue with a zone.
5. Do one of the following:
• If you did not suspend Multi-tier Replication in step 3, and if after you activated the BCP plan you
disabled data replication for the zone(s) that failed (instead of powering them down), enable data
replication for each of the zones by performing the procedure Enable data replication on page
497.
• If you suspended Multi-tier Replication in step 3, resume it by performing the procedure Suspend
or resume Multi-tier Replication on page 247 then refresh all of the zones in the failed data center,
starting with the portal zone.
Whether the appliances in the zones load the database from another zone after they reboot will
depend on the option you selected when you disabled automatic plan activation in the previous step,
if applicable.
6. After all of the zones are up, run Automated Health Check (AHC) to confirm that all of the zones
affected by the BCP plan activation are healthy. Perform one of the following procedures:
• Run automated health check from the command line on page 639
• Run TAC Health Check from the UMS on page 640
If AHC discovers issues, correct them before you proceed to the next step.
7. Click Tools ➤ BCP Monitoring.
8. In the Summary list, click the instance for which you are deactivating the plan.
9. Click the Plan tab.
10. In the Select for Action column, select the check box for the zones for which you are deactivating
the plan.
The check box label changes to Activating indicating that the zone will be activated.
11. Click Deactivate then in the BCP Plan Deactivate Confirmation box, click OK.
The system does the following:
• Changes the Plan Status to Inactive.
• Changes the zone Status to Active.
• Redirects the turrets and Pulse devices back to their home zone (for Unigy Soft Clients, refer to
step 13).
• Makes each line AOR in the instance associated with the BCP plan active in the resource zone at
the top of the Zones preference list specified in the line configuration.
Plan deactivation messages are written to the BCP event log. Refer to the Enactment and Events
tabs for information about the plan deactivation events. The Enactment tab is displayed only during

IPC Confidential Unigy 4.3

Enterprise Guide
298 8.9: Retry Deactivation for a BCP plan

the current plan deactivation. To refresh the Events tab, you might have to exit BCP Monitoring then
re-access the tab.
If the deactivation does not complete, click Retry Deactivation to rerun the plan deactivation process.
12. If you disabled automatic BCP plan activation in step 4, reenable it by performing the procedure
Enable automatic BCP plan activation (failover) on page 293.
13. Redirect the Unigy Soft Clients back to their home zone by performing the procedure Redirect a Soft
Client after a BCP event on page 298.

8.9 Retry Deactivation for a BCP plan

Retry Deactivation reruns the Deactivate process for situations where Deactivate does not complete
successfully.

Note
Unless it is necessary to perform this procedure during business hours,IPC recommends that you
perform the procedure after business hours.

1. Log in to the UMS with the zone VIP: https://vip.

2. Click Tools ➤ BCP Monitoring.
3. In the Summary list, click the instance that is associated with the plan you are redeactivating.
4. Click the Plan tab.
5. In the Select for Action column, select the check box for the zones for which you are retrying
deactivation.
6. Click Retry Deactivation.
The system reruns Deactivate so it can complete successfully.

8.10 Redirect a Soft Client after a BCP event

Perform this procedure to redirect a Soft Client to a backup zone when a BCP plan is activated or to
direct the Soft Client back to the home zone when it is available again.
Unlike turrets and Pulse devices that are automatically redirected when a BCP plan is activated or
deactivated, Unigy Soft Client end users must manually redirect their Soft Clients to a backup zone or
the home zone based on the type of BCP event.
1. Within the Microsoft Windows desktop, click Start ➤ All Programs ➤ IPC Systems Inc ➤ Unigy
Client Configuration Tool.
2. If you are redirecting the Soft Client to a backup zone, within the Basic tab, in the BCP field, select
the backup zone you want the Soft Client to connect to.
Contact the Unigy administrator for the name of an appropriate zone.
3. Do one of the following:
• To redirect the Soft Client to a backup zone, select the Use BCP check box. This instructs the
system to connect the Soft Client to the zone specified in the BCP field, instead of the zone
specified in the Primary field, when you log in.

December 3, 2019 IPC Confidential

 8.11: BCP line redirection example 299

• To direct the Soft Client back to the home zone when it is available, clear the Use BCP check box.
This instructs the system to connect the Soft Client to the home zone specified in the Primary
field, instead of the zone specified in the BCP field, when you log in.
4. Click Save.

8.11 BCP line redirection example

This is an example of how lines are redirected during activation and deactivation of a BCP plan.
When a line is redirected, the line AOR becomes active in a different zone. The redirection process
when activating a BCP plan is different from the plan deactivation process.
In the following illustration:
• Dark gray boxes represent the zone preference lists for lines A, B, C, and D. The lists are defined
within the Zones tab for each line at Configuration ➤ Enterprise ➤ Lines and Extensions.
• Number to the left of each zone is the position in the list (0, 1, 2).
• Light gray boxes represent the resource zone that each line AOR is active in.
Figure 44: BCP line redirection example

To ensure that a line is active in the same zone before and after a BCP plan is activated then deactivated,
make the preferred active zone the first zone in the list. You can do this by using the Make Active and
Reorder button within the Zones tab in the line configuration.

IPC Confidential Unigy 4.3

Enterprise Guide
300 8.11: BCP line redirection example

December 3, 2019 IPC Confidential

 301

9 Enterprise and instance management

workflows
9.1 Change the enterprise name
If it becomes necessary to change the name of the Unigy enterprise; for example, because the company
name changed, you can change the name in one zone and the system replicates it to all active zones
throughout the enterprise.

Caution
Do not change the enterprise name within a zone that has data replication disabled. This prevents the
zone from rejoining the enterprise when replication is enabled. Change the name only when the change
can be replicated to the other zones in the enterprise at the time the name is changed.
If a zone is offline at the time of the name change, manually change the enterprise name within the zone
when it is back online.

Important
This procedure requires that you reboot the appliances in all zones in the enterprise to update the name
change in JGroups. This is service-impacting, so you should perform this procedure during non-business
hours.

1. Log in to the UMS in any active zone.

2. Click Configuration ➤ Enterprise ➤ System ➤ Enterprise.
3. In the Enterprise Name field, type a new name that is unique throughout the network.
4. Click Save.
The system replicates the change to the appliances in all active zones.
5. Reboot (refresh) all of the zones in the enterprise by performing the procedure Refresh (restart) a
zone in a single zone enterprise on page 318 or Refresh (restart) zones in a multizone enterprise on
page 319, depending on the number of zones in the enterprise.

9.2 Change the enterprise domain name

Within Unigy, the system uses the enterprise domain name for end user and presence URIs and SIP
messaging.
The URIs have the format login_name@enterprise_domain_name, where login_name is
the login ID assigned to the users when they were added to the enterprise and
enterprise_domain_name is the domain name configured for the enterprise. When you change
the enterprise domain name in one zone, the change is replicated to the other zones. After you change
the domain name, reboot the appliances in all zones.

IPC Confidential Unigy 4.3

Enterprise Guide
302 9.2: Change the enterprise domain name

Note
Changing the enterprise domain name does not change the domain name assigned to the enterprise
appliances. The appliance domain names are separate from the enterprise domain name. They are used
only within Unigy and should not be changed. For additional information on the different types of domain
names within Unigy, refer to the Domain names topic in the System Installation and Deployment Guide.

Caution
This procedure is service impacting, so it should be performed at a time when the zones are not
processing calls or configuration requests.

1. Place each zone within the enterprise into maintenance mode by performing the following
procedures:
• Disable SNMP forwarding for a zone on page 596.
• Place a zone into maintenance mode to disable BCP plan activation on page 597.
Start with the zone with the lowest zone ID, which is usually the first zone that was deployed in the
enterprise, and work up through the zones in zone ID sequence to the zone with the highest zone ID.
2. In all zones in the enterprise, place the cluster and Standby appliance into maintenance mode by
performing the following steps for each zone. Start with the zone with the lowest zone ID and work
your way up through the zones in zone ID sequence from lowest to highest.
a) Place the cluster into maintenance mode by performing the procedure Place a cluster into
maintenance mode to enable control of HA failovers on page 598.
b) Place the Standby appliance into maintenance mode by performing the procedure Place an
appliance or Media Gateway into maintenance mode to indicate it is unavailable on page 599.
3. Select the zone in which to change the enterprise domain name:
• In a mixed zone enterprise that includes Unigy v2.0.1 zones, select a v2.0.1 zone. If the first zone
that was deployed in the enterprise is a v2.0.1 zone, select that zone.
• In an enterprise that consists of zones that have Unigy v2.0.1.5 or higher deployed, select a zone
with the highest software and schema version.
4. In the zone you selected in step 3, change the enterprise domain name:
a) Click Configuration ➤ Enterprise ➤ System ➤ Enterprise.
b) Change the value for the Domain Name field then click Save.
5. Reboot the appliances in the zone by performing the procedure Reboot CCM on page 587.
6. Monitor the state of the zone until the Service Status for all services is RUNNING and the Remarks
for all services, except Replicator, are Change role completed by performing the procedure
Check the state of a zone from a browser on page 499.
7. Take the zone cluster and Standby appliance out of maintenance mode by performing the following
steps:
a) Take the Standby appliance out of maintenance mode by performing the procedure Take an
appliance or Media Gateway out of maintenance mode on page 600.
b) Inform the system that maintenance on the Standby appliance is complete by performing the
procedure Indicate that maintenance on the Standby appliance is complete on page 601.
c) Take the cluster out of maintenance mode by performing the procedure Take a cluster out of
maintenance mode to resume normal HA operation on page 599.

December 3, 2019 IPC Confidential

 9.3: Change a stateless HA enterprise to stateful HA 303

8. Take the zone out of maintenance mode by performing the following procedures:
• Take a zone out of maintenance mode to reenable BCP plan activation on page 598.
• Reenable SNMP forwarding for a zone on page 596.
9. Repeat steps 5 through 8 for each of the remaining zones.
In a mixed zone enterprise that includes Unigy v2.0.1 zones, perform these steps for all v2.0.1 zones
before you perform the steps for higher version zones. To ensure proper replication, allow the
appliances in one zone to be fully operational before rebooting the appliances in the next zone. In an
HA zone, you can reboot both appliances at the same time.
10. Confirm that the domain name in the presence URI is correct. Use the legacy (Flash) UMS
(https://<your_VIP>/ums/UMSClient.html) or Mass Edit Client to accomplish this task.
This is necessary because the Users menu is not available in the HTML5 interface. This step
describes the legacy Use the legacy (Flash) UMS (https://<your_VIP>/ums/
UMSClient.html) or Mass Edit Client to accomplish this task. option.
a) Click Configuration ➤ Users.
b) In the Users list, click a user account.
c) Within the Attributes tab, confirm that the Presence URI includes the new domain name.

9.3 Change a stateless HA enterprise to stateful HA

The type of HA that is supported for an enterprise is determined by the type of enterprise license
installed. This topic describes how to change a stateless HA enterprise to a stateful HA enterprise when
a customer upgrades their enterprise license from a Standard license, which provides stateless HA, to an
Enterprise license, which provides stateful HA,
Prerequisite:
This procedure requires an Enterprise license to replace the Standard license. Obtain this license prior to
beginning this procedure by sending a request to Westbrook Orders or to the Project Manager in your
region who is responsible for providing licenses.
1. Log in to the UMS in one of the zones.
2. To provide a list of end users who are currently assigned the Enterprise Trader License, perform the
procedure Generate assigned license report on page 689.
3. Revoke the Enterprise Trader License from all end users who are currently assigned this license by
performing the procedure Revoke feature licenses from users on page 487.
4. Install the new Enterprise license by performing the procedure Install an enterprise license file on
page 481.
5. Reassign the Enterprise Trader License to the end users for whom you revoked the license by
performing the procedure Assign feature licenses to users on page 484.

9.4 Add an instance

During initial deployment of the first Unigy zone, the system adds the Default Instance and assigns it to
the zone. In a multizone enterprise, you can use this instance for all zones or create separate instances
for organizational and performance purposes. Use this procedure to add one or more instances to an
enterprise.
In a multizone enterprise, you can use instances to organize the zones in the enterprise into logical
groupings based on country, region, or any other organizational structure. Instances are used primarily

IPC Confidential Unigy 4.3

Enterprise Guide
304 9.5: Change an instance name

for line control, segregating Unigy and Blue Wave zones, and configuring and managing BCP plans,
which provide line and CDI resiliency.
Prior to Unigy v3.1, to avoid performance issues, Unigy and dedicated Blue Wave zones had to be
associated with separate instances. However, beginning with v3.1, these zones can be associated with
the same instance without a performance impact if the CDI Support and Line Support properties for
each Blue Wave zone are set properly. These are configured at Configuration ➤ Enterprise ➤
System ➤ Zones.

For information on the fields in the Instance Configuration panel, refer to the online help or UMS UI
Guide.
1. Click Configuration ➤ Enterprise ➤ System ➤ Instances.
2. In the Instances list, click the +Add New.
3. Type the Instance Name.
4. Type the instance Domain Name.
5. If necessary, change the other instance properties.
6. Click Save.

9.5 Change an instance name

Use this procedure when it is necessary to change the name of an instance.
Changing an instance name triggers update operations within the system that can result in a performance
impact if there is a high volume of alert and history data. To minimize this impact, perform an Archive
all Zone backup prior to changing the name of an instance that has more than fourteen days of history.

Note
If you change the name of the first instance that was created for the enterprise and you add a zone to
that instance after you change the name, the instance name Default Instance will be displayed for the
instance when you view it from the zone you added. The instance name is displayed properly from
existing zones.

1. Log in to a zone that is associated with the instance you are renaming.
2. Perform an Archive all Zone backup for the realm that includes the instance by performing the
procedure Create or schedule a new backup on page 363. Set a scope of fourteen days.
This archives and purges all except the last fourteen days of data for the realm.
3. Click Configuration ➤ Enterprise ➤ System ➤ Instances.
4. In the Instances list, click the instance you are changing.
5. Change the instance name then click Save.
The system replicates the name change and creates or updates various entities with the new name.

9.6 Change an instance domain name

Within Unigy, the system uses the instance domain name for call synchronization with PBXs and for
Alliance MX and third-party application interoperability where the applications must survive a zone
failure. Within a DNS, it is used to resolve the zone IP addresses or VIPs for the zones within an
instance for round robin zone look up.

December 3, 2019 IPC Confidential

 9.7: Merge two Unigy enterprises 305

When you change an instance domain name, the value is replicated throughout the enterprise, however,
you must refresh all zones within the instance to update lines and other Unigy entities associated with
the instance.

Caution
This procedure is service impacting, so it should be performed at a time when the zones within the
instance are not processing calls or configuration requests.

1. Log in to the UMS in one of the zones within the instance for which you are changing the domain
name.
2. Click Configuration ➤ Enterprise ➤ System ➤ Instances.
3. In the Instances list, click the instance for which you are changing the domain name.
4. Change the value in the Domain Name field then click Save.
5. Reboot theCCM or ACCM appliances in all of the zones within the instance by performing one of the
following procedures:
• Reboot CCM on page 587. In an HA zone, reboot both appliances at the same time.
• Refresh (restart) a zone in a single zone enterprise on page 318.
• Refresh (restart) zones in a multizone enterprise on page 319.
6. Change the instance domain name value on any applicable DNS, within the Alliance MX
interoperability configuration, and if applicable, in any other entity that uses this domain name,
including third-party applications and PBXs.
For information on changing the instance name for Alliance MX interoperability, refer to the Alliance
MX Interoperability Guide.

9.7 Merge two Unigy enterprises

A Unigy customer can have only Unigy enterprise. If the customer acquires another company that also
uses Unigy, the two enterprises must be merged.
Before you begin the process of merging two enterprises, determine which enterprise will remain as the
surviving enterprise and which zone in the surviving enterprise will serve as the peer zone for the new
zones that are added to the enterprise.
An automated merge process is not available, therefore, you must manually merge the two enterprises by
entering the data from one enterprise into the surviving enterprise.
1. Create a disk image backup for each appliance in the enterprise being merged into the surviving
enterprise.
2. Download the disk image files to a remote storage device.
3. Generate and download the fingerprint files for all of the appliances in both enterprises by performing
the procedure Obtain license fingerprints on page 479.
4. Obtain a license for the merged enterprise by performing the procedure Obtain license files on page
480.
5. Log in to the UMS in the peer zone in the surviving enterprise.
6. Install the new license by performing the procedure Install an enterprise license file on page 481.
7. Add the instances, zones, addresses, locations, users and any other applicable data from the zone that
is being merged into the surviving zone.

IPC Confidential Unigy 4.3

Enterprise Guide
306 9.7: Merge two Unigy enterprises

8. Redeploy each of the CCM, MM, and ACCM appliances in the enterprise that is being merged so
they can be used for new zones . Perform these steps for the primary and secondary appliances in
each zone you are adding to the surviving enterprise.
a) Deploy the COP software by performing the procedure Deploy the COP (Common Operating
Platform) software on page 448.
b) Configure the network settings by performing the procedure Configure the appliance network
settings with Network Configurator on page 450.
If possible, use the same IP addressing as was used in the enterprise being merged.
c) Deploy the personality software by performing the procedure Deploy the appliance personality
software with Personality Deployer on page 465.
9. Add each of the new zones:
a) Deploy the zone by performing the procedure Deploy subsequent zones on page 495.
b) Check the health of the zone by performing the procedure Check the state of a zone from a browser
on page 499.
c) Enable data replication for the zone you are deploying by performing the procedure Enable data
replication on page 497.
d) If applicable, add one or more Media Gateways by performing the procedure Add a Media
Gateway on page 568.
e) Deploy the software on other devices, including Media Gateway, turrets, Pulse devices, and Unigy
Soft Clients by performing the procedure Upgrade the software on system devices on page 558.
f) Change the zone's BCP status to Active by performing the procedure Change a zone's BCP status
to Active on page 498.
g) Confirm that the services for the new zone are running and there are no errors by performing the
procedure Check the state of a zone from a browser on page 499.
h) Repeat steps 9a through 9g for each zone you are adding.
10. Enter any additional configuration data that is required from the enterprise that is being merged into
the surviving zone.
11. Update the CDI devices (turrets, Pulse devices, andSoft Clients) to connect to a zone in the surviving
enterprise by performing the procedure Move an IQ/MAX or IQ/MAX Edge turret to a different zone
on page 355. For Soft Client, do the following:
a) On the Microsoft Windows desktop, click Start ➤ All Programs ➤ IPC Systems Inc ➤ Unigy
Client Configuration Tool.
b) In the Primary field, type the new zone IP address (single appliance zone), VIP (HA zone), or
FQDN then click Save.
The IP address, VIP, or FQDN must be specified as the Common Name or Alternate Name in the
client certificate.
12. Create an enterprise backup by performing the procedure Create or schedule a new backup on page
363.

December 3, 2019 IPC Confidential

 307

10Zone management workflows

10.1 Change a zone name
Use this procedure when it is necessary to change the name of a zone.
Changing a zone name triggers update operations within the system that can result in a performance
impact if there is a high volume of alert and history data. To minimize this impact, perform an Archive
all Zone backup prior to changing the name of a zone that has more than fourteen days of history.
1. Log in to the zone for which you are changing the name.
2. Perform an Archive all Zone backup for the realm that includes the zone you are renaming by
performing the procedure Create or schedule a new backup on page 363. Set a scope of fourteen
days.
This archives and purges all except the last fourteen days of data for the realm.
3. Click Configuration ➤ Enterprise ➤ System ➤ Zones.
4. In the Zones list, click the zone you are changing.
5. Change the zone name then click Save.
The system replicates the name change and creates or updates various entities with the new name.

10.2 Add a zone to a Unigy enterprise

After you deploy the first zone in a Unigy enterprise, you can add zones to the enterprise.

Important
If you are adding a Unigy v3.0 or higher zone to an enterprise that has pre-v3.0 zones, the JGroups
protocols in all of the lower version zones must have been updated to MERGE3, NAKACK2, FD_ALL,
and UNICAST3 by running the appropriate scripts after deploying one of the bridge patches or hotfixes.

Prerequisites:
Prior to performing this procedure, the following prerequisites must be complete for all applicable
appliances:

Procedure References and notes

Appliance hardware is installed (racked) and Refer to the Common Appliance Platform Onsite
connected to the network. Installation Manual.
Unigy Common Operating Platform (COP) Deploy the COP (Common Operating Platform)
software is deployed on the appliance(s). software on page 448
This software is usually deployed by IPC Determine the current COP version on page 450
Manufacturing prior to appliance shipment. Deploy
the COP only if it is not on the appliance(s) or if the
wrong version is deployed.
Appliance network settings are configured. Configure the appliance network settings with
Network Configurator on page 450

IPC Confidential Unigy 4.3

Enterprise Guide
308 10.2: Add a zone to a Unigy enterprise

Procedure References and notes

You have the Unigy personality software DVD for This procedure assumes that you will always
the latest software version or have access to the deploy the latest software to obtain the benefits of
personality ISO file on an external data storage the most recent fixes and functionality.
device.
You have the customer's Unigy enterprise license This should have been delivered with the Unigy
file. The license must be based on the new hardware. If you do not have the license, submit a
hardware. request to Westbrook Orders or contact the Project
Manager in your region who is responsible for
providing licenses.
You have the credentials and Certified Admin IPC If you do not have the license, submit a request to
Technician license file for the user account you will Westbrook Orders or contact the Project Manager
use to perform the deployment. in your region who is responsible for providing
Unigy licenses.

Confirm that the instance to which you are adding the zone is available. If it is not, add the instance by
performing the procedure Add an instance on page 303.
Confirm that the backroom location you will assign to the zone is configured. If it is not, add the
location, and if necessary, the associated address by performing the procedures Add, edit, or delete an
address on page 242 and Add or edit a location on page 516.
Select a zone to serve as the peer zone for the new zone. It can be any deployed zone, but preferably
should be a zone that has the same personality software version as the zone you are deploying.

Note
Do not assign a zone ID to the new zone that was previously assigned to a zone that was deleted;
however, you can reuse the zone name.

If partial replication is enabled, any new Unigy zones that are added to the enterprise will initially be
generator zones; new Blue Wave zones will be collector zones. If partial replication is disabled, new
zones added to the enterprise will be collector zones.
If Multi-tier Replication is enabled, the new zone will be a member of the data center associated with the
backroom location you assign to the zone.
To avoid potential issues with the new zone, avoid adding zones if other zones in the enterprise are
down or isolated. Completely add one zone before adding another zone.
If you add a zone to an enterprise in which the name of the first instance that was created in the
enterprise was changed after initial deployment, the name for that instance, when displayed from the
zone you added, will be Default Instance, not the custom name. The name will be displayed properly
from all existing zones.
1. Confirm that data replication is enabled in all of the existing zones in the enterprise by performing the
procedure Check the data replication status for all zones in the enterprise on page 513.
If replication is not enabled, enable it in all applicable zones by performing the procedure Enable
data replication on page 497.
2. Deploy the appliance personality software on the primary and secondary appliances, and if
applicable, on the MMs, by performing the procedure Deploy the appliance personality software with
Personality Deployer on page 465.
3. Perform the procedure Deploy subsequent zones on page 495.

December 3, 2019 IPC Confidential

 10.3: Remove a zone from the enterprise 309

4. Confirm that the zone services are running and there are no errors by performing the procedure Check
the state of a zone from a browser on page 499.
5. Log in to the UMS with the zone VIP: https://vip.
6. Install the new enterprise license by performing the procedure Install an enterprise license file on
page 481.
7. If the database source for the zone you are adding is a pre-v3.1 zone, confirm or configure the
following:
1. If the Name for each address is blank or not appropriate, or an address does not exist, configure the
address at Configuration ➤ Enterprise ➤ System ➤ Addresses.
2. Confirm that the appropriate address is assigned to each location associated with the zone. If it is
not, assign the address at Configuration ➤ Enterprise ➤ System ➤ Locations.
3. Confirm that the correct Backroom Location is assigned to the zone. If it is not, assign the
location at Configuration ➤ Enterprise ➤ System ➤ Zones.
8. Enable data replication for the new zone by performing the procedure Enable data replication on
page 497.
If Multi-tier Replication is enabled, the zone joins the local replication tier for the data center
associated with its location.
9. Check the state of the zone by performing the procedure Validate a zone after a deployment, rollback,
or other operations on page 638.
10. Deploy the software on other devices, including Media Managers, Media Gateway, turrets, Pulses,
and Unigy Soft Clients, by performing the procedure Upgrade the software on system devices on page
558.
11. Change the zone's BCP status to Active by performing the procedure Change a zone's BCP status to
Active on page 498.
12. If partial replication is enabled and you want to change the zone to a collector zone, refer to Enable
partial replication on page 316.
13. If the zone will be involved in enterprise to enterprise line sharing, configure a site server for the zone
as described in the procedure Configure enterprise to enterprise line sharing on page 439.
14. If the System Logging and Information Collector (SLIC) feature is implemented to forward customer
log data to a data analytics engine such as Splunk, refer to the System Logging and Information
Collector Service Installation and Administration Guide for information on the following tasks:
• Requesting that the Splunk Deployment Group add the new appliances (nodes) to the
u360_node.xlsx workbook and send you a copy of the u360_node.csv file.
• Uploading the updated u360_node.csv file to the Ad Hoc server.
• Adding the new appliances to the slic-nodes.conf file on the associated SLIC instance.
• Enabling SLIC and Filebeat on each new CCM and MM or ACCM appliance you added.

10.3 Remove a zone from the enterprise

This topic describes how to delete a zone from a Unigy enterprise.

IPC Confidential Unigy 4.3

Enterprise Guide
310 10.3: Remove a zone from the enterprise

Note
You cannot remove the first zone that was deployed in the enterprise from the Unigy database. This zone
serves as the enterprise base zone and the data must be present. However, you can take the zone out of
operation by removing the zone CCM or ACCM appliances, disconnecting their IP addresses, the zone
VIP, and the zone Certificate Authority IP address from the network, and redirecting all CDIs and other
devices that are registered with the zone to a different zone.
The base zone is assigned zone ID 1. You can identify the base zone within the Install tab at Tools ➤
Deployment ➤ Software Deployment.
Unigy displays the message You can not delete the base zone if you attempt to remove
the zone configuration through the UMS.

Prerequisites:
A new enterprise license that reflects removal of the zone appliances is required. If possible, obtain this
license before you remove the zone.
If partial replication is enabled, ensure that the enterprise will have at least one generator zone and two
collector zones after you remove the zone.
1. If the zone you are removing is a member of a data center that has Multi-tier Replication enabled,
change the location assigned to the zone to a location at an address that is not associated with a data
center that has Multi-tier Replication enabled.
If all data centers have Multi-tier Replication enabled, create a temporary address and location to
assign to the zone. To change the location, change the value in the Backroom Location field at
Configuration ➤ Enterprise ➤ System ➤ Zones. To add an address and location, refer to Add,
edit, or delete an address on page 242 and Add or edit a location on page 516.
If the zone is a portal zone in a single zone data center, disable Multi-tier Replication for the data
center before you remove the zone by performing the procedure Disable Multi-tier Replication on
page 246.
2. If the zone is connected to one or more delegated authentication servers (Microsoft Active Directory),
remove the zone from the associated servers:
a) Click Configuration ➤ Enterprise ➤ Security ➤ Delegated Authentication ➤ Authentication
Servers.
b) In the Authentication Servers list, click a server associated with the zone.
c) In the Zone list within the Zones tab, click the zone then click Remove.
d) Click Save.
3. Update all Unigy entities affected by removal of the zone.
a) Update all applicable end user Button Sheets (Face Layouts) to remove line associations for lines
in the zone you are removing. For information on removing button associations, refer to Remove
button association properties on page 673 or Edit button sheets with Mass Edit Client on page
686. Within Mass Edit Client, change the Button Type for each applicable button to Invalid
Button Type and delete any editable fields, especially the Button Label.
If you delete a line, the associated button properties are automatically removed from all Button
Sheets.
b) Update the Active Zone field for Resource AORs that are assigned the zone you are removing.
The most efficient way to do this is to use Mass Edit Client. For the appropriate ResourceAOR
data, change the Active Zone value to a valid zone, save the changes, then apply the updated data.

December 3, 2019 IPC Confidential

 10.3: Remove a zone from the enterprise 311

For information on changing resource AORs, refer to Create, edit, or delete lines and extensions
with Mass Edit Client on page 676.
c) If a BCP plan that includes the zone you are removing is configured, update the plan to change the
backup zones by performing the procedure Configure a BCP plan on page 290.
d) Change the home zone for any CDIs that are assigned the zone you are removing then remove the
devices from the database, after which they will register with the new zone. Refer to the following
topics:
• Turrets: Configure turret network settings on page 674
• Pulse devices: Configure Pulse network settings on page 676
• Unigy Soft Clients: Configure the Soft Client network connection on page 623
• Remove hardware from the database on page 359
4. Log in to the UMS in the zone you are removing.
5. Place the zone into maintenance mode by performing the following procedures:
• Disable SNMP forwarding for a zone on page 596
• Place a zone into maintenance mode to disable BCP plan activation on page 597
6. Disable data replication in the zone you are removing by performing the procedure Disable data
replication on page 498.
7. Change the enterprise name to a different value by performing the procedure Change the enterprise
name on page 301.
Because replication is disabled for the zone you are removing, this change applies only to the current
zone. This step prevents the appliances in the zone from connecting to the enterprise after the zone is
removed.
8. Log in to the UMS in a zone that is not the zone you are removing.
This can be any zone except the one you are removing.
9. Delete the zone from the database:
a) Click Configuration ➤ Enterprise ➤ System ➤ Zones.
b) In the Zones list, click the zone you are deleting.
c) Click Delete then in the confirmation box, click Yes.
10. Obtain and install a new enterprise license that does not include the appliances in the zone you
deleted by performing the procedures Obtain license fingerprints on page 479, Obtain license files on
page 480, and Install an enterprise license file on page 481.
11. Confirm that the zone you removed is no longer displayed:
a) Click Configuration ➤ Enterprise ➤ System ➤ Zones.
b) In the Zones list, confirm that the zone you removed is not displayed.
12. Do one of the following to decommission the zone appliances:
• If the appliances will not be used in a Unigy enterprise, power them down and disconnect them
from the network.
• If the appliances will be used in a Unigy enterprise in the future, deploy the COP software on both
appliances to clear the current configuration data by performing the procedure Deploy the COP
(Common Operating Platform) software on page 448. When you are ready to add the appliances to
the enterprise, perform the applicable deployment workflow.

IPC Confidential Unigy 4.3

Enterprise Guide
312 10.4: Move zones to a different instance

10.4 Move zones to a different instance

This topic describes the procedure for moving zones and the associated Media Gateways, users, lines,
trunks, and routing constructs from one instance to a different instance.
Prerequisites:
Before you begin this procedure, obtain the following:
• DVD that contains the appropriate Unigy COP software version.
• Unigy appliance personality software DVD or access to the ISO file on an external data storage
device. This version should be the same as the software deployed in any zones that are currently
associated with the new instance.
• Network settings that were set in Network Configurator for the appliances in the zones you are
moving. This information should be recorded in the customer Unigy Data Collection document or the
Network Configurator properties worksheet. You can also obtain this information by running the
hostinfo command on each appliance from the command line. This might be necessary if the
values were changed after the initial deployment. You will reuse these values when you redeploy the
appliances in the zones you are moving.
• The zone configuration values assigned to the zones you are moving. Refer to the customer Unigy
Data Collection document or click Configuration ➤ Enterprise ➤ System ➤ Zones and record the
current values.
You cannot change the instance assigned to a zone from the UMS and cannot rerun Zone Deployer on
appliances that were previously deployed successfully; therefore, moving zones to a different instance
includes redeploying the COP software on the appliances in the zones you are moving, configuring their
network settings, deploying the personality software, removing the zones from the enterprise database,
adding and configuring new zones that are associated with the new instance, and deploying the zones.
You cannot reuse the original zone IDs for the zones that are being moved because they are assigned to
zones that are associated with the original instance. For example, in a four zone enterprise with zone IDs
1, 2, 3, and 4, zones 2 and 4 are being moved to a different instance. When you add the zones that
replace zones 2 and 4 within the UMS, you assign the new instance to each zone. When you redeploy
the zones with Zone Deployer, the system assigns zone IDs 5 and 6 to the zones. Do not attempt to
reassign the original zone IDs.

Caution
This procedure is service impacting, so it should be performed at a time when the zones are not
processing calls or configuration requests. The procedure requires that you reboot the appliances in all of
the zones you are not moving to synchronize the database.

1. Log in to the UMS in each of the zones you are moving to the new instance.
2. Disable SNMP forwarding for the zones you are moving, and if applicable, place them into
maintenance mode to prevent automatic BCP plan activation by performing the following procedures:
• Disable SNMP forwarding for a zone on page 596.
• Place a zone into maintenance mode to disable BCP plan activation on page 597.
3. Disable data replication in each of the zones you are moving by performing the procedure Disable
data replication on page 498.
4. Redeploy the appliances in the zones you are moving by performing the following procedures on
each appliance:
a) Deploy the COP (Common Operating Platform) software on page 448.

December 3, 2019 IPC Confidential

 10.4: Move zones to a different instance 313

b) Configure the appliance network settings with Network Configurator on page 450.
c) Deploy the appliance personality software with Personality Deployer on page 465.
5. Log in to the UMS in one of the zones you are not moving.
6. To eliminate hardware conflicts, remove from the database the appliances that were in the zones you
are moving by performing the procedure Remove hardware from the database on page 359 .
7. If you are moving the zones to an instance that does not exist, add the new instance by performing the
procedure Add an instance on page 303.
8. If necessary, add addresses and locations for the new zones by performing the procedures Add, edit,
or delete an address on page 242 and Add or edit a location on page 516.
9. Add and configure the zones that will be associated with the new instance by performing the
procedure Add or edit a zone on page 515.
Refer to the values you recorded in the prerequisites. Specify the new instance in the Instance field.
10. For each end user group associated with the zones you are moving, change the location, and if
applicable, the home zone.
These changes will be applied to new end users who are added to the groups, but not to users who are
already members of the groups.
Use the legacy (Flash) UMS (https://<your_VIP>/ums/UMSClient.html) or Mass Edit
Client to accomplish this task. this is necessary because the Group Features tab is not available in
the HTML5 interface. This step describes the legacy interface procedure.
a) Click System Designer ➤ End User Configuration.
b) In the End User Groups list, click the end user group you are changing.
c) Within the Group Features tab, change the Unigy Location to the new location, and if applicable,
change the Home Zone to one of the new zones.
11. For each end user account that is currently a member of an end user group that is associated with a
zone you are moving, change the location, and if applicable, the home zone. Use Mass Edit Client or
the following procedure:
Use the legacy (Flash) UMS (https://<your_VIP>/ums/UMSClient.html) or Mass Edit
Client to accomplish this task. This is necessary because the Users list is not available in the HTML5
interface. This step describes the legacy interface procedure.
a) Click System Designer ➤ End User Configuration.
b) In the Users list, click the end user login ID.
c) Within the Trader Features tab, change the Unigy Location to the new location, and if applicable,
change the Home Zone to one of the new zones.
It is not necessary to change user contact addresses.
12. Add new trunks to replace the trunks you are moving to the new instance:
a) Add the Media Gateways to the zones associated with the new instance. For information on adding
and configuring Media Gateways, refer to the Media Gateway Hardware Installation Manual. For
information on adding Media Gateways in a BCP environment, refer to Add Media Gateways for
BCP on page 569.
b) Duplicate the SIP, CAS, and Analog trunks in the new zones. For information on adding trunks,
refer to the Lines, Trunks, and Routing Guide.
c) Remove from the database the Media Gateways associated with the old instance that were replaced
by the Media Gateways you added in step 12a by performing the procedure Remove hardware
from the database on page 359.

IPC Confidential Unigy 4.3

Enterprise Guide
314 10.4: Move zones to a different instance

13. Replace all lines that are associated with the old instance with new lines that are associated with the
new instance:
a) Export the current line data to use as a reference for creating the lines associated with the new
instance by performing the procedure Create, edit, or delete lines and extensions with Mass Edit
Client on page 676.
b) Delete each line that is being moved by clicking Configuration ➤ Enterprise ➤ Lines and
Extensions, clicking the line type, clicking the line, then clicking Delete.
Use the legacy (Flash) UMS (https://<your_VIP>/ums/UMSClient.html) or Mass
Edit Client to accomplish this task. This is necessary for private lines, extensions, OOPS lines, and
PBX Shared Lines because the menus for these line types are not available in the HTML5
interface. This step describes the legacy interface procedure.
c) Recreate each line for the new instance by clicking Configuration ➤ Enterprise ➤ Lines and
Extensions, clicking the line type, then clicking Add New. Refer to the Lines, Trunks, and
Routing Guide for details on adding the various types of lines.
Use the legacy (Flash) UMS (https://<your_VIP>/ums/UMSClient.html) or Mass
Edit Client to accomplish this task. This is necessary for private lines, extensions, OOPS lines, and
PBX Shared Lines because the menus for these line types are not available in the HTML5
interface. This step describes the legacy interface procedure.
14. Configure the routing constructs for the new zones:
a) Recreate the trunk groups, route lists, route plans, trunk dial plans, and dial patterns. For
information on performing these tasks, refer to the Lines, Trunks, and Routing Guide.
b) Delete the old routing constructs.
15. Reboot the appliances in all of the zones that are not being moved to synchronize the changes:
a) Reboot the appliances in a zone that has the highest software version and database schema by
performing the procedure Reboot CCM on page 587.
b) Check the status of the appliances you rebooted until they are fully operational by performing the
procedure Check the state of a zone from a browser on page 499.
c) Reboot the appliances in each additional zone, one zone at a time. Check the status of the
appliances in each zone until they are fully operational before you reboot the next zone.
16. Deploy the new zones that are associated with the new instance by performing the following steps for
each zone:
a) Deploy a zone by performing the procedure Deploy subsequent zones on page 495.
b) Confirm that the zone services are running and there are no errors by performing the procedure
Check the state of a zone from a browser on page 499.
c) Log in to the UMS in the zone you just deployed: https://vip.
d) Enable data replication for the zone by performing the procedure Enable data replication on page
497.
e) Check the state of the zone by performing the procedure Validate a zone after a deployment,
rollback, or other operations on page 638.
f) Deploy the software on other devices, including Media Managers, Media Gateways, turrets, Pulse
devices, and Unigy Soft Clients, by performing the procedure Upgrade the software on system
devices on page 558.

December 3, 2019 IPC Confidential

 10.5: Move a zone to a different data center within the same instance 315

g) Change the zone's BCP status to Active by performing the procedure Change a zone's BCP status
to Active on page 498.
h) If you are deploying additional zones, repeat steps 16a through 16g for each zone.
17. If the customer has a BCP license, configure the BCP plans for the old instance and the new instance
to reflect the zone changes by performing the following procedures as applicable for the type of BCP
license and activation preference:
• Configure a BCP plan on page 290.
• Configure Campus BCP login priorities for users on page 292.
• Enable automatic BCP plan activation (failover) on page 293.

10.5 Move a zone to a different data center within the same instance
If necessary, you can move a zone that is associated with one data center to a different data center within
the same instance.
If Multi-tier Replication is enabled for one or both of the data centers involved in this procedure, you
must disable it for both data centers before you move the zone. If the data center from which or to which
you are moving the zone is the default data center and Multi-tier Replication is enabled, you must
disable Multi-tier Replication for all data centers in the enterprise before you move the zone. Disable
Multi-tier Replication for the default data center last.
1. Do one of the following:
• If Multi-tier Replication is not enabled for the data center from which you are moving the zone or
the data center to which you are moving the zone, do the following:
1. Log in to the UMS in the zone you are moving.
2. Click Configuration ➤ Enterprise ➤ System ➤ Zones then in the Zones list, click the zone
you are moving.
3. In the Backroom Location field, select the backroom location associated with the data center to
which you are moving the zone then click Save. Do not perform the remaining steps in this
procedure.
• If Multi-tier Replication is enabled for the data center from which you are moving the zone or the
data center to which you are moving the zone, perform the remaining steps in this procedure.
2. Log in to the UMS in the portal zone of the data center from which you are moving the zone.
If this data center is the default data center, refer to the overview section of this topic for information
on disabling Multi-tier Replication.
3. If Multi-tier Replication is enabled for the data center, disable it by performing the procedure Disable
Multi-tier Replication on page 246.
4. Log in to the UMS in the portal zone of the data center to which you are moving the zone.
If this data center is the default data center, refer to the overview section of this topic for information
on disabling Multi-tier Replication.
5. If Multi-tier Replication is enabled for the data center, disable it by performing the procedure Disable
Multi-tier Replication on page 246.
6. Log in to the UMS in the zone you are moving.
7. Click Configuration ➤ Enterprise ➤ System ➤ Zones.
8. In the Zones list, click the zone you are moving.

IPC Confidential Unigy 4.3

Enterprise Guide
316 10.6: Partial replication

9. In the Backroom Location field, select the backroom location associated with the data center to
which you are moving the zone then click Save.
10. Log in to the UMS in the portal zone of the data centers for which you disabled Multi-tier Replication
and enable Multi-tier Replication for each data center by performing the procedure Enable Multi-tier
Replication on page 243.
If you disabled Multi-tier Replication for all of the data centers, enable it for the default data center
first.

10.6 Partial replication

10.6.1 Enable partial replication
This topic describes how to enable partial replication to reduce the volume of interzone notifications and
data that are replicated to the zones within an enterprise.
Prerequisites:
• Before you enable partial replication, confirm that all zones are healthy and accessible by performing
the procedure Validate a zone before an upgrade, rollback, or other operations on page 636.
• The Unigy software version deployed in the zones that will be collector zones must be at the same
version or a higher version than the generator zones. If a higher version is deployed in one or more
collector zones, deploy the highest version in all collector zones.
• If a zone that you want to make a generator zone has a scheduled Archive all Zone backup job
configured, delete the job and create a new Archive all Zone backup and retention policy in a
collector zone. These backups can run only in a collector zone.
• To prevent possible data loss, confirm that an Enterprise or Archive All Zone backup job is not
running before you change any collector zones to generator zones or generator zones to collector
zones.
When partial replication is enabled, two types of zones are assigned: collectors and generators. Initially
all zones are collector zones. These zones receive all data replicated throughout the enterprise. Before
you enable partial replication, you assign one or more zones as generator zones. To reduce notification
and data transfer volumes and zone startup times, various types of data are not replicated between the
generator zones. This data is replicated only to the collector zones.
When partial replication is enabled, an enterprise must have at least two collector zones, for redundancy,
and at least one generator zone.
For additional information on partial replication, refer to Partial replication (Regional Area Data
Replication) on page 701 or the Theory of Operation Manual.

Caution
Enabling partial replication is service-impacting, so when possible, always perform this procedure during
non-business hours.

To configure and enable partial replication, your user account must have the IPC Certified Tech role
assigned. User accounts with the Basic Administrator, Advanced Administrator, or IPC Project Manager
role can move zones from the Collector Zones list to the Generator Zones panel, or remove them from
the panel, but cannot save the changes or enable partial replication. User accounts with the Auditor and
System Auditor roles can view, but not change, the partial replication configuration.
1. Click Configuration ➤ Enterprise ➤ System Features ➤ Interzone Communication.
2. Click the Partial Replication tab.

December 3, 2019 IPC Confidential

 10.6: Partial replication 317

By default, in a new enterprise or an enterprise where partial replication was never enabled, all zones
are collector zones.
3. To designate a zone as a generator zone, drag the zone from the Collector Zones panel on the right to
the Generator Zones panel in the center.
You can select multiple zones by using the Shift or Ctrl keys on the keyboard. To remove a zone from
the Generator Zones panel, click the zone then click Remove.
4. After you assign all of the generator zones, click Enable Partial Replication.
The system displays the message This will enable Partial Replication in the
Enterprise. It is recommended that this is performed outside of
trading hours. Do you want to continue?.
5. Click Continue.
The system validates the data to determine whether the following are true:
• All zones have Unigy v2.0.1.5 or higher deployed.
• The Unigy software version deployed in the collector zones is equal to or higher than the version
deployed in the generator zones.
• There are at least two collector zones and one generator zone.
• There are no generator zones that have a scheduled Archive all Zone backup or restore job.
If the validation is successful, the system removes the partial replication data for other zones from the
generator zones, so they contain only their own partial replication data. It also changes the Enable
Partial Replication button label to Disable Partial Replication and changes the text above the button
to Partial Replication is Enabled.

10.6.2 Disable partial replication

When partial replication is enabled, you can disable this feature to change the partial replication
configuration or to make all zones collector zones.
Prerequisite:
Before you disable partial replication, confirm that all zones are healthy and accessible by performing
the procedure Validate a zone before an upgrade, rollback, or other operations on page 636.
If Multi-tier Replication is enabled, you must disable it for all data centers before you disable partial
replication. Refer to Disable Multi-tier Replication on page 246.
When you disable partial replication, the system reclassifies all generator zones as collector zones, but
does not change the partial replication configuration. If you want to change the configuration, make your
changes then reenable partial replication as described in Enable partial replication on page 316.

Caution
Disabling partial replication is service-impacting, so when possible, it should be performed during non-
business hours. For information in partial replication considerations and impacts, refer to Partial
replication (Regional Area Data Replication) on page 701.

To perform this procedure, your user account must have the IPC Certified Tech role assigned.
1. Click Configuration ➤ Enterprise ➤ System Features ➤ Interzone Communication.
2. Click the Partial Replication tab.
3. Click Disable Partial Replication.

IPC Confidential Unigy 4.3

Enterprise Guide
318 10.7: Refresh (restart) a zone in a single zone enterprise

The system displays the message This will disable Partial Replication in the
Enterprise. It is recommended that this is performed outside of
trading hours. Do you want to continue?.
4. Click Continue.
The system makes all zones collector zones, but does not remove the zones from the Generator Zones
panel. It also changes the label on the Disable Partial Replication button to Enable Partial
Replication and changes the text above the button to Partial Replication is Disabled.

10.7 Refresh (restart) a zone in a single zone enterprise

This topic describes how to refresh the appliance(s) and other devices in a single zone enterprise. The
enterprise can consist of a standalone zone or a single HA zone. Refresh is also referred to as restart.

Note
This procedure is service impacting, so when possible, it should be performed when there are no active
calls or configuration operations being performed in the zone.

1. Log in to the UMS.

2. To disable notifications to the GSOC and customer NMSs, disable SNMP forwarding by performing
the procedure Disable SNMP forwarding for a zone on page 596.
3. If data replication is enabled, disable it by performing the procedure Disable data replication on page
498.
4. Confirm that data replication is disabled by performing the procedure Check a zone's replication
status with checkReplication on page 507.
The Replicator service Service Status should be RUNNING and the Remarks value should be
Replication is disabled for the appliance(s).
If data replication is not disabled for both appliances, reboot the appliance where replication is not
disabled.
5. Enable data replication by performing the procedure Enable data replication on page 497.
6. Monitor the state of the appliance(s) in the zone until they are completely operational by performing
the procedure Check the state of a zone from a browser on page 499.
7. Confirm that data replication is enabled by performing the procedure Check a zone's replication
status with checkReplication on page 507.
If data replication is not enabled, reboot the appliance where replication is not enabled.
8. Reboot the Media Managers, Media Gateways, and desktop devices in the zone by performing the
following procedures:
• Run Reboot Media Manager on page 588
• Reboot a Media Gateway on page 591
• Reboot communication devices on page 591
9. Enable SNMP forwarding by performing the procedure Reenable SNMP forwarding for a zone on
page 596.

December 3, 2019 IPC Confidential

 10.8: Refresh (restart) zones in a multizone enterprise 319

10.8 Refresh (restart) zones in a multizone enterprise

This topic describes how to refresh the appliances and other devices in a zone that is part of a multizone
enterprise. Refresh is also referred to as restart and is performed by disabling then reenabling data
replication.

Note
This procedure is service impacting, so when possible, perform it when there are no active calls or
configuration operations being performed in the zones that are being restarted.

Note
If you are refreshing more than one zone, restart one zone and let it come up fully to ensure that there is
a stable zone in the instance before you refresh the remaining zones. If you are refreshing the zones
within multiple instances, restart the zones in one instance at a time. If there are multiple data centers
associated with an instance, restart the zones in one data center at a time.
Restart preferred zones before you start the other zones. When possible, start a preferred zone that has
the highest software version deployed first to ensure that all data is preserved.
If Multi-tier Replication is enabled for a data center and you are refreshing all of the zones in the data
center, refresh the portal zone before you refresh the local zones. For information on refreshing a portal
zone, refer to Refresh (restart) a portal zone on page 320.

Rebooting the appliances and loading the database requires approximately twenty minutes to complete.
If Multi-tier Replication is enabled, additional time is required to synchronize the database across all of
the zones in the enterprise. The time required to complete the synchronization is based on the number of
zones, but you should expect it to take at least fifteen minutes. This delay should have no impact on data
integrity.
For information on the zone selection algorithm that determines the source zone that provides the
database dump for a zone that is restarting, refer to Database source zone selection algorithms for
database dumps on page 615.
If you are refreshing multiple zones, refresh one zone first then refresh the remaining zones. You can
refresh up to eight zones at the same time.
1. Log in to the UMS in the zone you are refreshing.
2. To prevent automatic BCP plan activation, if it is enabled, and to disable notifications to the GSOC
and customer NMSs, place the zone into maintenance mode and disable SNMP forwarding by
performing the following procedures:
• Disable SNMP forwarding for a zone on page 596
• Place a zone into maintenance mode to disable BCP plan activation on page 597
3. Restart the appliances in the zone by doing the following:
a) Disable data replication in all zones you are refreshing by performing the procedure Disable data
replication on page 498.
b) Confirm that data replication is disabled by performing the procedure Check a zone's replication
status with checkReplication on page 507.
c) Enable data replication for the zone by performing the procedure Enable data replication on page
497. Enable replication for a preferred zone first. Refer to the overview information for details.
4. Monitor the state of the appliances in the zone until they are completely operational by performing
the procedure Check the state of a zone from a browser on page 499.

IPC Confidential Unigy 4.3

Enterprise Guide
320 10.9: Refresh (restart) a portal zone

5. Confirm that data replication is operating properly by performing the following procedures:
• Check a zone's replication status with checkReplication on page 507
• Run interzone diagnostic tool on page 646. Run the test for Count Comparison and Replication
Health Check.
6. After the first zone is stable, if you are refreshing additional zones, repeat steps 3 through 5.
7. Reboot the associated Media Managers, Media Gateways, and desktop devices in the zone by
performing the following procedures:
• Run Reboot Media Manager on page 588
• Reboot a Media Gateway on page 591
• Reboot communication devices on page 591
8. Take the zone out of maintenance mode and enable SNMP forwarding by performing the following
procedures:
• Take a zone out of maintenance mode to reenable BCP plan activation on page 598
• Reenable SNMP forwarding for a zone on page 596

10.9 Refresh (restart) a portal zone

When Multi-tier Replication is enabled for an enterprise, the procedure for refreshing a portal zone is
different from the procedure for refreshing the local zones. This procedure is required only when it is
necessary for a portal zone to load the database from another portal zone because the databases are out
of sync; for example, if the 2 GB data store threshold was exceeded while a data center was in the
suspended state.
After you complete the portal zone refresh, refresh each of the local zones in the data center.
1. To prevent automatic BCP plan activation, if it is enabled, and to disable notifications to the GSOC
and customer NMSs, place the zone into maintenance mode and disable SNMP forwarding by
performing the following procedures:
• Disable SNMP forwarding for a zone on page 596
• Place a zone into maintenance mode to disable BCP plan activation on page 597
2. If the data center associated with the portal zone you are refreshing is the default data center, make
another data center the default data center, by performing the procedure Change the default data
center for Multi-tier Replication on page 249.
To determine whether the data center is the default data center, determine the value of the Default
Data Center check box for the data center's address at Configuration ➤ Enterprise ➤ System ➤
Addresses.
3. If Multi-tier Replication is suspended for the data center associated with the portal zone you are
refreshing, resume it by performing the procedure Suspend or resume Multi-tier Replication on page
247.
4. Change the Tier2ReSyncEnabled property in the replicator.properties file on the portal
zone primary CCM or ACCM appliance by doing the following:
a) SSH in to the primary appliance (the appliance with the lower IP address) with root user account
privileges.
You can determine the primary appliance by performing the procedure Check the state of a zone
from a browser on page 499.

December 3, 2019 IPC Confidential

 10.10: Reboot the appliances in a single or multizone enterprise 321

b) Open the /etc/opt/ipc/replicator/resources/replicator.properties file in

edit mode.
c) Change the value of the Tier2ReSyncEnabled= property to false then save the file.
5. Do one of the following to restart both of the portal zone appliances:
• Run the Reboot CCM Diagnostic test from the UMS, selecting both appliances, by performing the
procedure Reboot CCM on page 587.
• Run the reboot command from the command line on both appliances.
6. Monitor the state of the appliances in the zone until they are completely operational by performing
the procedure Check the state of a zone from a browser on page 499.
7. Confirm that data replication is operating properly by performing the following procedures:
• Check a zone's replication status with checkReplication on page 507
• Run interzone diagnostic tool on page 646. Run the test for Count Comparison and Replication
Health Check.
8. Reboot the associated Media Managers, Media Gateways, and desktop devices in the zone by
performing the following procedures:
• Run Reboot Media Manager on page 588
• Reboot a Media Gateway on page 591
• Reboot communication devices on page 591
9. Reset the Tier2ReSyncEnabled property in the replicator.properties file by doing the
following:
a) SSH in to the portal zone primary appliance.
b) Open the /etc/opt/ipc/replicator/resources/replicator.properties file in
edit mode.
c) Change the value of the Tier2ReSyncEnabled= property to true then save the file.
10. Take the zone out of maintenance mode and enable SNMP forwarding by performing the following
procedures:
• Take a zone out of maintenance mode to reenable BCP plan activation on page 598
• Reenable SNMP forwarding for a zone on page 596
11. Refresh each of the local zones in the data center by performing the procedure Refresh (restart) zones
in a multizone enterprise on page 319.

10.10 Reboot the appliances in a single or multizone enterprise

Perform this procedure when it is necessary to reboot the appliances in a zone after performing a
deployment or maintenance procedure, or if an appliance is not operating properly.
This procedure includes instructions for rebooting appliances during business hours and during non-
business hours. Rebooting appliances during non-business hours is the preferred option, especially with
zones that include a single appliance and zones that have stateless HA, because there are no active calls
on the system that would be impacted by this operation.

IPC Confidential Unigy 4.3

Enterprise Guide
322 10.10: Reboot the appliances in a single or multizone enterprise

Important
If you are rebooting more than one zone, reboot the appliances in one zone and let them come up fully to
ensure that there is a stable zone in the instance before you refresh the remaining zones. If you are
rebooting the zones within multiple instances, reboot the zones in one instance to ensure there is a stable
instance before restarting the zones in other instances.
If you are rebooting zones in a mixed zone enterprise that includes Unigy v2.0.1 zones, reboot all v2.0.1
zones before you reboot any higher version zones to ensure that the v2.0.1 zones can properly load the
database. If you are rebooting multiple zones in an enterprise where the same major version is deployed
in all zones, reboot preferred zones before you reboot the other zones. When possible, reboot a preferred
zone that has the highest software version deployed first to ensure that all data is preserved.

1. Log in to the UMS in the zone you are restarting.

2. To prevent automatic BCP plan activation, if it is enabled, and to disable notifications to the GSOC
and customer NMSs, place the zone into maintenance mode and disable SNMP forwarding by
performing the following procedures:
• Disable SNMP forwarding for a zone on page 596
• Place a zone into maintenance mode to disable BCP plan activation on page 597
3. Do one of the following:
• If you are performing this operation during non-business hours, perform the procedure Reboot
CCM on page 587. If you are rebooting the appliances in an HA zone, select both appliances.
• If you are rebooting an appliance in a single appliance, non-HA zone during business hours,
perform the procedure Reboot CCM on page 587. All active calls are dropped and configuration
operations are aborted during this procedure.
• If you are performing this procedure during business hours for an HA zone, do the following:
1. Place the HA cluster into maintenance mode by performing the procedure Place a cluster into
maintenance mode to enable control of HA failovers on page 598.
2. Place the Standby appliance into maintenance mode by performing the procedure Place an
appliance or Media Gateway into maintenance mode to indicate it is unavailable on page 599.
3. Reboot the Standby appliance by performing the procedure Reboot CCM on page 587. When
you select the appliances to reboot, drag and drop only the Standby appliance.
4. After the reboot completes, take the Standby appliance out of maintenance mode by performing
the procedure Take an appliance or Media Gateway out of maintenance mode on page 600.
5. Indicate that maintenance is complete for the Standby appliance by performing the procedure
Indicate that maintenance on the Standby appliance is complete on page 601.
6. Confirm that the zone is in a healthy state by performing the procedure Check the state of an
HA zone from the UMS on page 500. The Role of the Active appliance should be ACTIVE and
the State should be MAINTENANCE_AVAILABLE. The Role of the Standby appliance should
be STANDBY and the State should be MAINTENANCE_AVAILABLE. If the zone is not in this
state, do not perform the next step until you resolve the issue.
7. Perform an HA failover by performing the procedure Force an HA failover on page 546. The
Standby appliance becomes the Active appliance and the Active appliance becomes the Standby
appliance.
8. Take the cluster out of maintenance mode by performing the procedure Take a cluster out of
maintenance mode to resume normal HA operation on page 599.

December 3, 2019 IPC Confidential

 10.11: Change a zone ID 323

During this process, the system reboots the appliance that is now the Standby appliance.
4. Confirm that the zone is in a healthy state by performing the procedure Validate a zone after a
deployment, rollback, or other operations on page 638.
5. Take the zone out of maintenance mode and enable SNMP forwarding by performing the following
procedures:
• Take a zone out of maintenance mode to reenable BCP plan activation on page 598
• Reenable SNMP forwarding for a zone on page 596
6. After the first zone is stable, you can repeat these steps to reboot additional zones. If you are
performing the procedure during non-business hours, the zones can be rebooted at the same time.

10.11 Change a zone ID

This procedure describes how to change the zone ID for a zone if it is discovered that the ID is not
correct.
Prerequisite:
If the zone for which you are changing the zone ID requires Unigy v2.0.1.7 hotfix 1, obtain the hotfix
software .iso file.
This procedure requires that the system created a restore point after the personality software was
deployed with Personality Deployer.

Caution
Use this procedure only if you have not fully deployed the zone, because it requires that you roll back to
the point before you originally ran Zone Deployer. When you do this, you will lose any configuration work
you performed after the initial zone deployment.

1. Roll back to the point before Zone Deployer was run by performing the procedure Restore a CCM,
ACCM, or MM disk image from the command line on page 393. If only two rollback images are
available, use the one with the more recent date and time. If there are more than two images, use the
second file that was created.
2. Rerun Zone Deployer and specify the correct zone ID:
• If you are redeploying the first zone in the enterprise, perform the procedure Deploy the first or
only zone with Zone Deployer on page 489.
• If you are redeploying a zone that is not the first zone, perform the procedure Deploy subsequent
zones on page 495.
3. If the zone for which you changed the zone ID is a Unigy or Blue Wave zone in an enterprise in
which the JGroups protocols were updated, perform the following substeps to update the protocols for
the zone:
For a Unigy only zone, do the following:
1. Deploy the appropriate Unigy patch or hotfix that provides the JGroups protocol scripts and files
for the Unigy Replicator and Line Status channels and Blue Wave Adapter Async and RPC
channels.
2. Update the JGroups protocols on individual appliances for the Unigy and Blue Wave Adapter
channels - Unigy and Blue Wave zones on page 716
For a Blue Wave zone, do the following:

IPC Confidential Unigy 4.3

Enterprise Guide
324 10.12: Configure a zone's OOPS line

1. Deploy the appropriate Unigy patch or hotfix that provides the JGroups protocol scripts and files
for the Unigy Replicator and Line Status channels and Blue Wave Adapter Async and RPC
channels.
2. Deploy the appropriate Blue Wave patch or hotfix that provides the JGroups protocol scripts and
files for the Blue Wave Director Async and RPC channels.
3. Update the JGroups protocols on individual appliances for the Unigy and Blue Wave Adapter
channels - Unigy and Blue Wave zones on page 716
4. Update the JGroups protocols on individual appliances for the Blue Wave Director channels - Blue
Wave zones on page 718

10.12 Configure a zone's OOPS line

Use this procedure to configure the OOPS line for a zone.
1. Click Configuration ➤ Enterprise ➤ System ➤ Zones.
2. In the Zones list, click the zone.
3. In the System OOPS field within the Properties section, select the appropriate resource AOR then
click Save.

10.13 Change a zone's country base

Perform this procedure to change the country base assigned to a zone.
To change the country base, your user account must have one of the following roles assigned: Advanced
Administrator, IPC Project Manager, IPC Certified Tech.

Caution
This procedure is service impacting. Perform it only when the zones you are updating are not processing
calls or configuration requests.

1. Click Configuration ➤ Enterprise ➤ System ➤ Zones.

2. In the Zones list, click the zone for which you are changing the country base.
3. Click Change Countrybase.
4. Select the new country base then click Save.
5. Reboot the zone's CCM or ACCM appliances by performing the procedure Reboot CCM on page
587.
6. Monitor the state of the zone until all services are running successfully by performing the procedure
Check the state of a zone from a browser on page 499.
7. If one or more Media Gateways are associated with the zone, perform the procedure Upload a
country.dat file to a Media Gateway on page 325 to assign the appropriate country-based properties
on each Media Gateway.
8. Reboot all turrets and Pulse devices by performing the procedure Reboot communication devices on
page 591.

December 3, 2019 IPC Confidential

 10.14: Upload a country.dat file to a Media Gateway 325

10.14 Upload a country.dat file to a Media Gateway

After you change the country base assigned to a zone, you must upload the appropriate country.dat
file to all Media Gateways that are associated with the zone to ensure that the correct tones and other
properties are applied.
1. Use an FTP utility, such as WinSCP or SFTP, to copy the appropriate country.dat file from
the /opt/ipc/deployment/stage/mediagateway/audiocodes/
msbg_sip_for_v2_i4/ToneDir/Tones_59 directory to your personal computer.
The country.dat files are stored in folders named for the country (for example, Australia) and the
file name includes the country name; for example, australia.dat.
2. Log in to the UMS in the zone for which you changed the country base.
3. Click Tools ➤ Deployment ➤ Hardware Deployment.
4. In the Deployment Zones panel, click the zone the Media Gateway is registered with.
5. Within the Media Gateways tab, click the Media Gateway you are updating then click the Admin
Console link.
The Web Login panel is displayed.
6. Type the Media Gateway administrator login credentials then click Login.
The Media Gateway Administration Console opens.
7. Click Maintenance ➤ Software Update ➤ Load Auxiliary Files.

IPC Confidential Unigy 4.3

Enterprise Guide
326 10.15: Synchronize zones that have been disconnected for more than 15 minutes

Figure 45: Media Gateway Admin Console: Load Auxiliary Files

8. Within the Call Progress Tones file field, click Browse, select the country.dat file you copied
to your computer in step 1, then click Load File.
9. Click Burn.
10. Perform a Media Gateway reset by clicking Device Actions ➤ Reset ➤ Reset.
11. Make test calls to confirm that the correct tones are played.

10.15 Synchronize zones that have been disconnected for more than 15
minutes
When the WAN (Wide Area Network) connection between zones in different geographic regions fails,
the zones continue to operate, but the system cannot replicate data between the isolated zones. This topic
describes how to recover from this problem when the network connection is restored and the zones
remerge. Recovery involves rebooting the appliances in one of the formerly isolated islands.
Prerequisite

December 3, 2019 IPC Confidential

 10.15: Synchronize zones that have been disconnected for more than 15 minutes 327

To reestablish data replication between all of the zones in the enterprise, select one of the islands within
which you will reboot all of the appliances. This is usually the island that contains the fewest end users
and CDIs, but this is not a requirement.
For information on this condition, refer to Disconnected zones on page 327.
Reboot the appliances in one zone at a time. Perform this procedure for all zones in the island you are
rebooting.
1. If a BCP plan is available, activate the plan for the zone by performing the procedure Manually
activate a BCP plan (fail over) on page 294.
2. Place the zone you are rebooting into maintenance mode by performing the procedure Place a zone
into maintenance mode to disable BCP plan activation on page 597
3. Place the cluster into maintenance mode by performing the procedure Place a cluster into
maintenance mode to enable control of HA failovers on page 598
4. Place the standby appliance into maintenance mode by performing the procedure Place an appliance
or Media Gateway into maintenance mode to indicate it is unavailable on page 599.
5. Reboot the standby appliance by performing the procedure Reboot CCM on page 587.
6. Confirm that the services for the appliance are running and there are no errors by performing the
procedure Check the state of a zone from a browser on page 499.
7. After the appliance reboots, log in to the UMS with the zone VIP: https://vip.
8. Take the standby appliance out of maintenance mode by performing the procedure Take an appliance
or Media Gateway out of maintenance mode on page 600.
9. Indicate that the maintenance for the appliance is complete by performing the procedure Indicate that
maintenance on the Standby appliance is complete on page 601.
10. Force an HA failover to make the active appliance the standby appliance by performing the procedure
Force an HA failover on page 546.
This is a stateless failover, so active calls are dropped.
11. Repeat steps 4 through 9 for the second appliance in the HA pair.
12. Take the cluster out of maintenance mode by performing the procedure Take a cluster out of
maintenance mode to resume normal HA operation on page 599.
The system reboots the standby appliance.
13. Take the zone out of maintenance mode by performing the procedure Take a zone out of maintenance
mode to reenable BCP plan activation on page 598

10.15.1 Disconnected zones

When the WAN (Wide Area Network) connection between zones in different geographic regions fails,
the zones continue to operate, but the system cannot replicate data between the isolated zones. This topic
describes the system behavior when the network connection is restored and the zones remerge.
As an example, consider four zones, A,B,C,D, in an enterprise with Zone A and Zone B located in a
backroom in the US and Zone C and Zone D located in a backroom in the UK. The WAN link between
the US and UK fails, resulting in the enterprise cluster splitting into two islands (sub-clusters), A,B and
C,D. When the network between the US and UK is restored, the two islands remerge to once again
become the enterprise A,B,C,D. The following is the system behavior in the merging zones:

IPC Confidential Unigy 4.3

Enterprise Guide
328 10.16: Redeploy (reCOP) one appliance in an HA zone

1. The states of non-idle lines in zones A and B are pushed to zones C and D and the state of the lines in
zones C and D are pushed to zones A and B. This means that line status for idle lines in each zone
changes after the merge if they were BUSY or HELD in the other zones.
2. Logon sessions in the database are synchronized between zones A,B and zones C,D.
3. As a direct result of items 1 and 2, ICM and line calls between all four zones, including conferencing
and barging, begin to work.
4. The job that synchronizes call history records in every zone, synchronizes the call records the next
time it runs after the remerge.
5. Database replication does not automatically synchronize the database records between the merging
islands. After the remerge, alarms are raised from the database replicator indicating that a network
merge occurred and the zone must be restarted for the database to synchronize with the enterprise. If
configuration changes were made in one or both of the islands during the network outage, an
administrator must reboot the appliances in one of the islands to synchronize the databases. If
configuration changes were made in one of the islands, reboot the appliances in the other island. If
configuration changes were made in both islands, determine which changes should be preserved then
reboot the appliances in the other island. The configuration changes in that island are overwritten, so
you must reconfigure them after the databases are in sync.
6. If BCP is licensed and configured, the BCP plan for the smaller island can be activated to redirect the
users and CDIs to the larger island to minimize the impact when the remerge occurs.
The procedure for synchronizing the data is Synchronize zones that have been disconnected for more
than 15 minutes on page 326.

10.16 Redeploy (reCOP) one appliance in an HA zone

If one appliance in an HA zone fails due to a software issue, perform this procedure to redeploy the
appliance.
For information on replacing an appliance due to a hardware failure, refer to Replace an appliance in an
HA zone on page 344.
For information on redeploying both appliances in a zone, refer to Redeploy (reCOP) a zone in a
multizone enterprise on page 331 or Redeploy (reCOP) a zone that must load the database from a lower
version zone on page 333.
Prerequisites:
Before you begin this procedure, obtain the following:
• DVD that contains the appropriate Unigy COP software version. The version of the COP that is
currently deployed is available from the UMS About menu.
• Personality software DVD or access to the software on an external data storage device. The software
version should be the same as the version currently deployed in the zone. This software might be on
the same DVD as the COP. The currently deployed software version is available from the UMS
About menu.
• If a hotfix is deployed on the appliances in the zone, obtain the hotfix DVD or access to the software
on an external data storage device.
• Network Configurator settings that were assigned to the appliance that is being redeployed so you can
reuse them. For information on these settings, refer to the customer Unigy Data Collection document
or to the Network Configurator properties worksheet described in the Common Appliance Platform
Onsite Installation Manual.

December 3, 2019 IPC Confidential

 10.16: Redeploy (reCOP) one appliance in an HA zone 329

• Zone ID assigned to the zone.

• If an OS patch is required to reapply operating system and security updates, ensure that you have the
OS patch ISO file. This is available from the IPC FTP site, FilesAnywhere. The currently deployed
OS patch version is available from the UMS About menu.
To perform this procedure, your user account must have the IPC Certified Tech role and you must have
access to Password Manager to generate dynamic passwords.
1. If the appliance you are redeploying is the primary appliance in the HA pair (appliance with the lower
IP address - CCM 1 or ACCM 1), power down the secondary appliance (CCM 2 or ACCM 2).
2. Deploy the COP software on the appliance you are redeploying by performing the procedure Deploy
the COP (Common Operating Platform) software on page 448.
Confirm that the COP software version is the correct version by performing the procedure Determine
the current COP version on page 450.
3. Configure the appliance network settings for the new appliance. For information on configuring the
network settings, refer to Configure the appliance network settings with Network Configurator on
page 450.
Use the network configuration settings you collected for the appliance in the prerequisites.
4. Deploy the appropriate personality software on the appliance by performing the procedure Deploy the
appliance personality software with Personality Deployer on page 465.
5. Deploy the zone on the appliance you are redeploying by performing the steps indicated in the
procedure Deploy subsequent zones on page 495.
Specify the zone ID assigned to the zone.
If the appliance you are redeploying is in the first zone deployed in the enterprise, the second zone
deployed in the enterprise should serve as the peer zone. For any other zone, any appropriate zone can
serve as the peer zone.
In a multi-zone enterprise, confirm that the preferred zone for the zone in which you are redeploying
the appliance is appropriate for providing the database dump when the new appliance comes up. If the
appliance you are redeploying is the primary appliance (CCM 1 or ACCM 1) in the first zone that
was deployed in the enterprise, assign the second zone that was deployed as the preferred zone,
unless the second zone is not appropriate; for example, because it is not available or has a lower
database schema. If you do not specify a preferred zone, Unigy uses the zone selection algorithm to
select an appropriate zone as the database source.
6. If the appliance you are redeploying is the primary appliance for the zone, do one of the following:
• If the appliance you are redeploying is the primary appliance for a zone in a multi-zone enterprise:
1. Bring up the primary appliance (CCM 1 or ACCM 1) if it is not already up. It will come up as
the Active appliance and will pull the database from the preferred zone you specified in the
previous step or the zone selected by the zone selection algorithm, if you did not specify a
preferred zone.
2. When the primary appliance is up, monitor its status until all of the services are running
successfully by performing the procedure Check the state of a zone from a browser on page
499. Use the checkMyStatus option.
3. Power up the secondary appliance (CCM 2 or ACCM 2). It will come up as the Standby
appliance and load the database from the primary appliance.
• If the appliance you are redeploying is the primary appliance in a single zone enterprise:

IPC Confidential Unigy 4.3

Enterprise Guide
330 10.16: Redeploy (reCOP) one appliance in an HA zone

1. Power down the primary appliance (CCM 1 or ACCM 1).

2. Power up the secondary appliance (CCM 2 or ACCM 2). It will come up as the Active
appliance with its local database.
3. When the secondary appliance is up, monitor its status until all of the services are running
successfully by performing the procedure Check the state of a zone from a browser on page
499. Use the checkMyStatus option.
4. Power up the primary appliance. The appliance comes up as the Standby appliance and loads
the database from the secondary appliance.
7. Check the state of the zone, and for a multizone enterprise, confirm that the zones are communicating
by performing the procedure Validate a zone after a deployment, rollback, or other operations on
page 638.
8. If a hotfix is required, deploy the hotfix on the redeployed appliance:
a) Because status data in the database indicates that the hotfix is deployed on both appliances in the
zone, perform the following steps to rename the installed_hotfix_iso.lst.peer file.
This removes the current status of the hotfix .iso file so you can deploy it from within the
Software Deployment Install panel:
1. Access the command line on the zone's Active appliance.
2. Run the command su -lp and enter the appropriate dynamic password.
3. Run the command mv /opt/ipc/deployment/iso/hotfix/
installed_hotfix_iso.lst.peer /opt/ipc/deployment/iso/hotfix/
installed_hotfix_iso.lst.peer.bak.
b) Disable data replication by performing the procedure Disable data replication on page 498. You
can start with any zone based on the following:
• If the enterprise consists of a single Unigy instance, disable replication for all zones in the
enterprise.
• If the enterprise consists of multiple Unigy instances, disable replication only for the zones in
the instance associated with the appliance for which you are deploying the hotfix.
c) Log in to the UMS with the VIP of the zone in which you redeployed the appliance.
d) Place the zone into maintenance mode and disable SNMP forwarding by performing the following
procedures:
• Disable SNMP forwarding for a zone on page 596.
• Place a zone into maintenance mode to disable BCP plan activation on page 597.
e) If the appliance you are redeploying is not the Standby appliance, force an HA failover to make it
the Standby appliance by performing the procedure Force an HA failover on page 546.
f) Place the zone cluster into maintenance mode by performing the procedure Place a cluster into
maintenance mode to enable control of HA failovers on page 598.
g) Place the Standby appliance into maintenance mode by performing the procedure Place an
appliance or Media Gateway into maintenance mode to indicate it is unavailable on page 599.
h) Perform the procedure Deploy an ISO file on page 550 to deploy the hotfix.
Because you are deploying the software only on the redeployed appliance, clear the following
check boxes after you click Install Zone to prevent the processes from being implemented:
• Automatic Deployment

December 3, 2019 IPC Confidential

 10.17: Redeploy (reCOP) a zone in a multizone enterprise 331

• Install the update simultaneously on both servers in the zone

i) After the deployment completes, monitor the state of the appliances in the zone until all services
are running successfully by performing the procedure Check the state of a zone from a browser on
page 499.
j) Confirm that the hotfix was installed by performing the procedure Confirm that an update was
deployed on page 552.
k) Take the Standby appliance out of maintenance mode by performing the procedure Take an
appliance or Media Gateway out of maintenance mode on page 600.
l) Indicate that the maintenance for the Standby appliance is complete by performing the procedure
Indicate that maintenance on the Standby appliance is complete on page 601.
m) Take the cluster out of maintenance mode by performing the procedure Take a cluster out of
maintenance mode to resume normal HA operation on page 599.
n) Take the zone out of maintenance mode and enable SNMP forwarding by performing the
following procedures:
• Take a zone out of maintenance mode to reenable BCP plan activation on page 598.
• Reenable SNMP forwarding for a zone on page 596.
o) Enable data replication in one of the zones for which you disabled it by performing the procedure
Enable data replication on page 497.

Note
If preferred zones are configured, the first zone you enable should be a preferred zone. If Multi-tier
Replication is enabled, the first zone you enable should be the portal zone for the associated data
center.

p) Enable data replication for the other zones for which you disabled it.

Note
Enable preferred zones before non-preferred zones, and if Multi-tier Replication is enabled, enable
portal zones before local zones.
Enable replication for one zone at a time. Wait for the replication to complete in one zone before
you enable replication for the next zone.

9. Confirm that the correct software versions are deployed on the Media Managers and Media Gateways
in the zone by performing the procedures Run MM software version on page 649 and Run Media
Gateway software version on page 650.
10. Restart all turrets and Pulse devices registered with the zone by performing the procedure Reboot
communication devices on page 591.
11. If it is necessary to install an OS patch, perform the procedure Install an OS patch in a single zone
from the UMS - manual install on page 134.

10.17 Redeploy (reCOP) a zone in a multizone enterprise

This topic describes how to redeploy a zone within a multizone enterprise after encountering a software
or configuration issue that renders it unusable.
For information on redeploying a zone due to a hardware failure, refer to the Hardware management
workflows chapter.

IPC Confidential Unigy 4.3

Enterprise Guide
332 10.17: Redeploy (reCOP) a zone in a multizone enterprise

Note
If you are redeploying a zone that is involved in one of the following mixed zone enterprise scenarios and
you want to retain the existing higher version data, do not use this procedure, instead, refer to Redeploy
(reCOP) a zone that must load the database from a lower version zone on page 333.
• Zone you are redeploying is at a higher software version than all of the other zones in the enterprise.
• Zone you are redeploying is at a higher software version than other zones in the enterprise, it is
assigned a preferred zone that is a lower version zone, and you cannot assign a higher version zone
as the preferred zone. If you can change the preferred zone to a zone that is at the same version, it is
not necessary to use the alternate redeployment procedure.
In both of these scenarios, if you do not use the referenced procedure, data that is supported only in the
higher version zone will be lost when the zone loads the database from a lower version zone.

This procedure includes deploying the Common Operating Platform (COP) software, setting the
network configuration, deploying the personality software, deploying the zone, and reinstalling the
enterprise license.
Prerequisites:
Before you begin redeployment of the zone, be sure you have the following:
• DVD that contains the appropriate Unigy COP software version.
• DVD for the appropriate personality software version or access to the ISO file on an external data
storage device. This software might be on the same DVD as the COP software.
• Network settings for the zone that were configured with Network Configurator. Assign the same
values that were configured during the initial deployment, unless those values were not correct or
were changed after initial deployment. These values should be available in the Unigy Data Collection
Document or the Network Configurator properties worksheet described in the Common Appliance
Platform Onsite Installation Manual. You can also obtain this information by running the hostinfo
command from the command line. This might be necessary if the values were changed after the initial
deployment. You will reuse these values when you redeploy the zone appliances.
• Most recent enterprise license file. If you discover that the license is corrupt or you do not have the
license file, request a new license by sending a request with the enterprise fingerprint to Westbrook
Orders or to the Project Manager in your region who is responsible for providing licenses.
• ID assigned to the zone you are redeploying. If the original ID was not correct, determine the correct
ID.
1. Deploy the COP software on the CCM or ACCM appliances in the zone you are redeploying by
performing the procedure Deploy the COP (Common Operating Platform) software on page 448.
2. Log in to the UMS in a zone that is not the zone you are redeploying.
3. Remove from the database the CCM or ACCM appliances in the zone you are redeploying by
performing the procedure Remove hardware from the database on page 359.
4. Configure the network settings for the appliances in the zone by performing the procedure Configure
the appliance network settings with Network Configurator on page 450.
Assign the values that you collected in the prerequisites.
5. Deploy the personality software on the appliances by performing the procedure Deploy the appliance
personality software with Personality Deployer on page 465.
6. Deploy the zone on the appliances by performing the procedure Deploy subsequent zones on page
495.
Specify the zone ID that you determined in the prerequisites.

December 3, 2019 IPC Confidential

 10.18: Redeploy (reCOP) a zone that must load the database from a lower version zone 333

7. Confirm that the zone services are running and there are no errors by performing the procedure Check
the state of a zone from a browser on page 499.
8. Log in to the UMS in the zone you are redeploying.
9. Enable data replication for the zone by performing the procedure Enable data replication on page
497.
10. Validate the zone by performing the procedure Validate a zone after a deployment, rollback, or other
operations on page 638.
11. To ensure that the enterprise license is valid, install the license file that you collected in the
prerequisites by performing the procedure Install an enterprise license file on page 481.

10.18 Redeploy (reCOP) a zone that must load the database from a lower
version zone
Use this procedure to redeploy (reCOP) a zone that during the redeployment process must load the
database from a lower version zone. This could be because the zone is the only zone in the enterprise
that is at the higher software version, because the zone's preferred zone must be a lower version zone, or
because all higher version zones in the enterprise must be redeployed at the same time.
If the zone you are redeploying can load the database from a zone that has the same software version, do
not use this procedure; instead refer to Redeploy (reCOP) a zone in a multizone enterprise on page 331.
For example, if the enterprise includes more than one higher version zone and you can reassign the
preferred zone of the zone you are redeploying to one of these zones or you can remove the preferred
zone specification and let the zone selection algorithm select a higher version zone, you can use the
standard redeployment procedure referenced previously in this paragraph instead of this alternate
procedure.
The alternate procedure is required only when the zone must load the database from a lower version
zone. It is required because features that are supported only in the higher software version are not
available in the lower version database. For example, if you redeploy a Unigy v3.1 zone that is the only
v3.1 zone in a mixed zone enterprise with pre-v3.1 zones, end users will not be able to log in to
IQ/MAX TOUCH turrets that are registered with the zone without this procedure because the database
loaded from a lower version zone does not include the data required to support the IQ/MAX TOUCH
devices. To resolve this issue, you will back up the higher version database before you reCOP the zone
then restore the database to restore the higher version data to the zone.
For information on redeploying a zone due to a hardware failure, refer to the Hardware management
workflows chapter.
Prerequisites:
Before you redeploy the zone, be sure you have the following:
• DVD that contains the appropriate Unigy COP software version.
• DVD for the appropriate personality software version or access to the ISO file on an external data
storage device. This software might be on the same DVD as the COP software.
• Network settings for the zone that were configured with Network Configurator. Assign the same
values that were configured during the initial deployment, unless those values were not correct or
were changed after initial deployment. These values should be available in the Unigy Data Collection
Document for the customer or the Network Configurator properties worksheet described in the
Common Appliance Platform Onsite Installation Manual. You can also obtain this information by
running the hostinfo command from the command line. This might be necessary if the values
were changed after the initial deployment. You will reuse these values when you redeploy the zone
appliances.

IPC Confidential Unigy 4.3

Enterprise Guide
334 10.18: Redeploy (reCOP) a zone that must load the database from a lower version zone

• Most recent enterprise license file. If you discover that the license is corrupt or you do not have the
license file, request a new license by sending a request with the enterprise fingerprint to Westbrook
Orders or to the Project Manager in your region who is responsible for providing licenses.
• ID assigned to the zone you are redeploying. If the original ID was not correct, determine the correct
ID.
This procedure assumes that the zone you are redeploying has higher version data that you want to
preserve and it is in a state that will allow you to successfully perform an Enterprise database backup
from it. If the latter is not the case, you can use a backup from a time when the zone was healthy, if one
is available.
1. Check the state of the zone you are redeploying to determine whether it is in a healthy state before
you back up the database by performing the procedure Validate a zone before an upgrade, rollback,
or other operations on page 636.
2. Perform an Enterprise backup from the zone you are redeploying and download the backup file to an
external data storage device by performing the procedures Create or schedule a new backup on page
363 and Download a backup file on page 607.
Confirm that the zone specified in Execute Backup on Zone when you schedule the backup is the
zone you are redeploying. Be sure to download the backup file to an external device because all files
and data on the appliances are cleared when you reCOP them.
3. Deploy the COP software on the CCM or ACCM appliances in the zone you are redeploying by
performing the procedure Deploy the COP (Common Operating Platform) software on page 448.
4. Log in to the UMS in a zone that is not the zone you are redeploying.
5. Remove from the database the CCM or ACCM appliances in the zone you are redeploying by
performing the procedure Remove hardware from the database on page 359.
6. Configure the network settings for the appliances in the zone you are redeploying by performing the
procedure Configure the appliance network settings with Network Configurator on page 450.
Assign the values that you collected in the prerequisites.
7. Deploy the personality software on the appliances by performing the procedure Deploy the appliance
personality software with Personality Deployer on page 465.
8. Deploy the zone for the appliances by performing the procedure Deploy subsequent zones on page
495.
Specify the zone ID that you determined in the prerequisites.
9. Confirm that the zone services are running and there are no errors by performing the procedure Check
the state of a zone from a browser on page 499.
Also determine which appliance is the Active appliance and record its IP address.
10. Change the data replication setting for the zone:
a) Access the command line on the Active appliance (refer to the previous step).
b) Run the command su -lp then enter the appropriate password.
c) Run the command /opt/ipc/ha/scripts/DisableRepl.sh.
11. Restore the Enterprise backup you downloaded in step 2 to the zone you redeployed by performing
the procedure Restore an Enterprise backup in a single zone on page 374.
12. Log in to the UMS in the zone you redeployed.
13. Enable data replication for the zone by performing the procedure Enable data replication on page
497.

December 3, 2019 IPC Confidential

 10.19: Reestablish the connection with an authentication server 335

14. To ensure that the enterprise license is valid, install the license file that you collected in the
prerequisites by performing the procedure Install an enterprise license file on page 481.
15. Validate the zone by performing the procedure Validate a zone after a deployment, rollback, or other
operations on page 638.

10.19 Reestablish the connection with an authentication server

This topic describes how to reestablish the connection between a zone and an authentication server when
the connection fails.

Users can authenticate against an authentication server only when the server is in the Connected state.
The server state is Connected when Unigy can reach and connect to the server. The state is set to
Failed when an authentication server is not available or reachable. If a connection fails, the zone
association with the server must be reestablished.
1. Click Configuration ➤ Enterprise ➤ Security ➤ Delegated Authentication ➤ Authentication
Servers.
2. Within the Authentication Servers list, click the server for which you are reestablishing the
connection.
3. Within the Zone tab, click the zone for which you are reestablishing the connection then click
Remove.
4. Click +Assign.
5. In the Available to Assign panel, select the check box for the zone you are assigning to the server then
click Save.

10.20 UMS configuration changes that require a zone reboot

This topic lists the configuration changes that require rebooting the CCM or ACCM appliances in a zone
to implement the changes.
For information on rebooting appliances, refer to Reboot the appliances in a single or multizone
enterprise on page 321.

Zone timers
• Session Timer Expires
• Session Timer MinSE
• Interzone Session Timer Expires
• Publication Timer Expires
These properties can be configured within the following panels:
• Zone Configuration panel at Configuration ➤ Enterprise ➤ System ➤ Zones
• Zone tab at Tools ➤ Deployment ➤ Hardware Deployment

Certificate upload for secure communications for PBX line sharing

If you upload new certificates for secure communications for PBX line sharing, you must refresh all
zones in the enterprise to synchronize the certificates. For additional information, refer to the Device
certificate workflow topic in the Security Administrator Guide.

IPC Confidential Unigy 4.3

Enterprise Guide
336 10.21: Convert a local survivability zone to an active or standby zone

10.21 Convert a local survivability zone to an active or standby zone

The BCP Local Survivability zone type is no longer supported, therefore, it is necessary to convert
existing zones to Active or Standby BCP zones.
The concept of a front room zone that provides call support when the WAN connection is down, is still
viable, however, the zones that provide this resiliency must have the same BCP role and location type as
other zones in a BCP instance. That is, you can deploy these zones at a front room address where they
serve as an Active zone in a Campus BCP instance or an Active or Standby zone in a Basic BCP
instance. The only difference between these zones is that they are deployed at a front room address
rather than at a data center or other backroom location.
1. Change the zone's BCP role:
a) Within the UMS, click Configuration ➤ Enterprise ➤ System ➤ Zones.
b) In the Zones list, click the zone you are converting.
c) In the BCP Role field, select Active or Standby depending on whether the zone will be an Active
zone in a Campus BCP instance or the Active or Standby zone in a Basic BCP instance.
d) Click Save.
2. Change the location type for the appliances in the zone from a front room location to a backroom
location by performing the procedure Assign or change the backroom location for a zone's appliances
on page 517.
If it is necessary to add a backroom location, refer to Add or edit a location on page 516.

10.22 Change the SIP Port for a zone

Use this procedure to change the SIP Port for a zone if the customer does not want to use the default SIP
Port. Only make the configuration change when the zone is non-operational, during non-trading hours
and when a zone refresh will occur immediately afterward.
Changing the SIP port requires performing a zone refresh immediately afterward. This enables other
peer zones within the Unigy enterprise to use the new listen port for interzone SIP communication.
1. From the UMS, access Configuration ➤ Enterprise ➤ System ➤ Zones and select a zone.
The Zone Configuration panel is displayed.
2. Change the SIP Port to a valid and available port number.
3. Apply the port configuration change to each Media Gateway in the zone by doing the following:
a) From the UMS, access Configuration ➤ Sites ➤ Trunks ➤ Media Gateways.
b) Select the Media Gateway.
c) Click Apply.
d) Repeat steps 3b and 3c for each Media Gateway in the zone.
4. Restart the zone by following one of these procedures: Refresh (restart) a zone in a single zone
enterprise on page 318 or Refresh (restart) zones in a multizone enterprise on page 319.
Part of the refresh procedure is to restart all hard communication devices registered to the zone. This
sends SIP messages to the configured port.

December 3, 2019 IPC Confidential

 10.23: Enable or disable WebLogic, SWMS, and Enterprise Watch Web link access 337

Note
If the SIP Port is changed to a port that is already in use by another process, this process will fail and
an alert will be raised.

5. Check the state of the zone to ensure that the process did not fail by following the procedure: Check
the state of a zone from a browser on page 499. If necessary, correct the SIP Port by repeating the
steps above.

10.23 Enable or disable WebLogic, SWMS, and Enterprise Watch Web link
access
This procedure describes how to enable or disable access to the Weblogic Admin Console, SWMS
Admin Console, and Enterprise Watch Web links for zone analysis and troubleshooting purposes.
To perform this procedure, your user account must have the IPC Certified Tech role.
For information and considerations related to the Web links access, refer to Web links access on page
337.
1. Click Configuration ➤ Enterprise ➤ System ➤ Zones then in the Zones list, click the zone for
which you are enabling or disabling the Web links.
2. Click one of the following buttons. The button label changes based on the current state of the Web
links access:
• Click Enable Web links to enable the Web links.
• Click Disable Web links to disable the Web links.
The Job Progress message box is displayed.
3. Review the progress then when the Job Status is Completed, click Close.

10.23.1 Web links access

For security reasons, access to the WebLogic Admin Console, SWMS Admin Console, and Enterprise
Watch is restricted. This access can be enabled or disabled for all zones by a user who has the IPC
Certified Tech role.
Access is controlled for each zone through the Enable Web links or Disable Web links button within
the Zone Configuration or Zone panel. You access these panels at Configuration ➤ Enterprise ➤
System ➤ Zones or Tools ➤ Deployment ➤ Hardware Deployment.

You can determine the current Web links access status by observing the button label, which toggles
based on the current state (Enable Web links indicates the Web links are disabled, Disable Web links
indicates the Web links are enabled), or the Web Link Access check box in the Server Cluster section
of the panel. The check box is visible to all administrative users, but the buttons are visible only to IPC
Certified Tech users.
The Web links are disabled by default. After the Web links are enabled, they remain enabled for all
zones until one of the following events occurs. These events disable Web links for all users.
• Any IPC Certified Tech user disables the Web links for the zone.
• The person who enabled the Web links logs out of the UMS.
• The browser session of the user who enabled the Web links expires.
• Someone restarts (reboots) one of the appliances in the zone. This disables the Web links only for the
appliance that is restarted.

IPC Confidential Unigy 4.3

Enterprise Guide
338 10.23: Enable or disable WebLogic, SWMS, and Enterprise Watch Web link access

The following considerations apply to the Web links status for all users who are working with appliances
in the zone where the Web links are enabled:
• If you enable the Web links from one browser session then log in to the UMS in another browser
session, you will see that the Web links are enabled.
• The status changes are dynamic within a session, but not across sessions or for other users. In these
situations, you must refresh the panel to see the latest status. You can do this by re-clicking the zone
name in the Zones list on the left.
• If the person who enables the Web links has multiple browser sessions open and one of the browser
sessions expires, the Web links will be disabled when the session expires.
• If the person who enables the Web links closes their browser session without logging out of the UMS,
the status remains Enabled until the system cleans up the expired session.
• When you restart an appliance in a zone in which the Web links are enabled, the Web links status for
that appliance changes to Disabled.
• When you restart an appliance in an HA zone, the system changes the Web links status for that
appliance to Disabled, but the status of the peer appliance and the status in the database remain
Enabled. To enable Web links access for the appliance after it restarts, do one of the following:
• Run the following script from the command line on the appliance you restarted to reenable the
Web links for the appliance:
/opt/ipc/cop/tools/weblinksCtrl.sh enable
• Within the Zone Configuration or Zone panel, click Disable Web links then click Enable Web
links. This option disables the Web links for all of the appliances in the zone then reenables the
access, however, it will impact any users who are working with the Web links on other appliances
in this zone.
• In an HA zone where the Web links are enabled for both CCM or ACCM appliances, when an HA
failover occurs, the Web links status for both appliances remains Enabled. However, if you reboot the
appliance that failed, the Web links status for that appliance changes to Disabled. If another HA
failover occurs before you can resynchronize the appliances and the second appliance that failed is
rebooted, the Web links status for both appliances will be Disabled, but the Web links status for the
zone in the database will be Enabled. To correct this situation, disable then reenable the Web links
from the Zone Configuration or Zone panel.

December 3, 2019 IPC Confidential

 339

11 Hardware management workflows

11.1 Shut down and power up appliances
11.1.1 Shutdown backroom hardware gracefully
This topic describes how to shut down backroom hardware in a controlled manner. The procedure is
useful when moving the equipment for a zone or moving staged equipment to a customer site.
1. Power down the Media Gateways (MG)s one at a time by performing the procedure Power down a
Media Gateway on page 341.
2. Power down each recording server by following the instructions in the vendor's documentation.
3. Do one of the following to power down the CCMs or ACCMs in the zone:
• In an HA zone, shut down the appliances by performing the procedure Power down the appliances
in an HA zone on page 339.
• In a standalone zone, shut down the appliance by logging in to the appliance through SSH with
root privileges, typing shutdown -h now, then pressing Enter.
4. Power down the Media Managers (MMs) one at a time by performing the procedure Power down a
Media Manager on page 340.

11.1.2 Power down the appliances in an HA zone

This topic describes the procedure for powering down the appliances in an HA zone for maintenance or
other purposes.
1. Label the Primary and Secondary CCM or ACCM appliances. You will need this information when
you power up the appliances.
2. If the Unigy enterprise is a multizone enterprise, you are performing this procedure during business
hours, you want the CDIs connected to the zone to be able to make calls while the appliances are
offline, and a BCP plan is configured, activate the plan to redirect the connected CDIs to one or more
active zones. For information on activating a BCP plan, refer to Manually activate a BCP plan (fail
over) on page 294.
Active calls are dropped.
3. Place the zone into maintenance mode by performing the procedure Place a zone into maintenance
mode to disable BCP plan activation on page 597.
4. Power down the Standby CCM or ACCM.
a) Log in to the appliance through SSH.
b) Run the command su -lp then enter the root user account password.
c) Run the shutdown -h now.
5. Power down the Active CCM or ACCM as described in step 4.
6. If applicable, power down the MMs one at a time by performing the procedure Power down a Media
Manager on page 340.

IPC Confidential Unigy 4.3

Enterprise Guide
340 11.1: Shut down and power up appliances

11.1.3 Power up the appliances in an HA zone

This topic describes the procedure for powering up the appliances in an HA zone after they were shut
down.
1. Power up the primary CCM or ACCM by pressing the Power button on the appliance. Wait for the
appliance to come up completely.
2. Power up the secondaryCCM or ACCM by pressing the Power button on the appliance.
3. Check the HA status by performing the procedure Check the state of a zone from a browser on page
499.
4. If applicable, power up the MMs, one at a time.
5. Log in to the UMS with the zone VIP: https://vip.
6. Click Configuration ➤ Sites ➤ Servers ➤ Clusters.
7. In the Clusters list, click the zone cluster then click the Members tab.
8. If the State of the standby appliance is UNKNOWN or FAILED, do the following:
a) Check the status of the HA cluster by performing the procedure Check the state of an HA zone
from the UMS on page 500.
b) Correct any issues.
c) Click Rearm Server. If this does not correct the problem, reboot the appliance.
9. Take the cluster out of maintenance mode by performing the procedure Take a cluster out of
maintenance mode to resume normal HA operation on page 599.
10. Take the zone out of maintenance mode by performing the procedure Take a zone out of maintenance
mode to reenable BCP plan activation on page 598.

11.1.4 Power down a Media Manager

This procedure describes how to power down a Media Manager (MM) as part of the process for
gracefully shutting down the hardware in a zone.
1. If you are powering down the Media Manager during business hours, place the appliance into
maintenance mode to suppress alerts and inform the enterprise that the appliance is not available by
performing the procedure Place an appliance or Media Gateway into maintenance mode to indicate it
is unavailable on page 599.
2. Access the Media Manager command line.
3. Run the command su -lp then enter the dynamic password.
4. Run the command shutdown -h now.
The appliance powers down.
For information on powering up an MM, refer to Power up a Media Manager on page 340.

11.1.5 Power up a Media Manager

This topic describes how to power up a Media Manager (MM) after it was powered down.
1. Press the Media Manager power button or power it up from iDRAC.
2. After the appliance powers up, do the following within the UMS:
a) Click Configuration ➤ Sites ➤ Servers ➤ Media Managers.

December 3, 2019 IPC Confidential

 11.2: Replace R610, R620, or R630 appliances with R640 appliances 341

b) In the Media Managers list, click the MM you powered up.

c) Within the Media Manager Maintenance tab, if the Media Manager Status is not In Traffic, click
Ready then click Save.
The system validates the MM then places it in the In Traffic state.
3. If you placed the MM into maintenance mode prior to powering it down, take it out of maintenance
mode by performing the procedure Take an appliance or Media Gateway out of maintenance mode on
page 600.

11.1.6 Power down a Media Gateway

This procedure describes how to power down a Media Gateway (MG).
1. If you are powering down the Media Gateway for a firmware upgrade, if you have not already done
so, place the MG into maintenance mode by performing the procedure Place an appliance or Media
Gateway into maintenance mode to indicate it is unavailable on page 599.
2. If the Media Gateway has a secondary power supply, remove the secondary power cable.
3. Remove the primary power cable.
The Media Gateway powers off.
For information on powering up a Media Gateway, refer to Power up a Media Gateway on page 341.

11.1.7 Power up a Media Gateway

Use this procedure to power up a Media Gateway that has been powered down.
1. Insert the power cable into the Media Gateway primary power socket.
2. If the Media Gateway has a secondary power supply, insert the power cable into the secondary power
socket.
3. If you placed the Media Gateway into maintenance mode prior to powering it down, take it out of
maintenance mode by performing the procedure Take an appliance or Media Gateway out of
maintenance mode on page 600.

11.2 Replace R610, R620, or R630 appliances with R640 appliances

Use this procedure when it is necessary to replace R610, R620, or R630 appliances with R640
appliances.
Prerequisites
Before you begin this procedure, collect the following items:
• Replacement R640 appliances.
• DVD that contains the Unigy COP version 03.00.01.00.0018 software. This COP is required for R640
appliances.
• DVD for the appropriate appliance personality software version or access to the ISO file on an
external data storage device. This software might be on the same DVD as the COP software.
• System, network, and HA property values configured during the initial deployment or that changed
after the initial deployment. These should be in the customer Unigy Data Collection document or the
Network configuration properties worksheet on page 464.
• Enterprise license file that includes the new appliances. A new license is required because the new
appliances have different MAC addresses. If you did not receive a new license with the new

IPC Confidential Unigy 4.3

Enterprise Guide
342 11.2: Replace R610, R620, or R630 appliances with R640 appliances

hardware, send a license request to Westbrook Orders or to the Project Manager in your region who is
responsible for providing licenses.
• If you are replacing the appliances in a single zone enterprise, ensure that you have access to the most
recent Enterprise database backup file on an external data storage device. The backup that is currently
accessible from the UMS will not be available after you deploy the COP software, so be sure the file
is stored remotely. You should create a backup just before you deploy the new appliances to be sure
no data is lost.
• If an OS patch is required to apply operating system and security updates that are not included in the
appliance personality software ISO, ensure that you have the OS patch ISO file. This is available
from the IPC FTP site, FilesAnywhere.
If you are replacing the appliances in multiple zones and are not using Single Click Deployment to
deploy the zones, the recommendation is to replace the appliances for one zone at a time. However, if
the maintenance window is not long enough to permit this, retain one zone as a peer zone, upgrade the
hardware in the other zones, then upgrade the appliances in the peer zone. To save time, you can perform
steps 1 through 8 for the appliances in all zones that are being upgraded, except the peer zone, at the
same time, but you must perform the remaining steps for one zone at a time.

Caution
This procedure is service impacting, so it should be performed at a time when the impacted appliances
are not processing calls or configuration requests.

1. Install the R640 appliances in a cabinet. For information on racking an appliance, refer to the
Common Appliance Platform Onsite Installation Manual.
2. If you are replacing the appliances for a zone in a single zone enterprise and have not already done
so, create an Enterprise backup file and download it to an external data storage device by performing
the procedures Create or schedule a new backup on page 363 and Download a backup file on page
607.
3. Disconnect the appliances you are replacing from the network.
If you are replacing all appliances in the enterprise, disconnect the peer zone appliances only after an
upgraded zone is available to serve as the peer zone.
4. Do one of the following:
• If you are using Single Click Deployment to deploy the appliances, refer to Deploy a software
update that requires a new COP with Single Click Deployment on page 31.
• If you are not using Single Click Deployment, complete the remaining steps in this procedure.
5. IPC Manufacturing normally deploys the Common Operating Platform (COP) software on new
appliances before they are shipped. If the COP software is not installed on the new appliances, deploy
the COP on each R640 appliance by performing the procedure Deploy the COP (Common Operating
Platform) software on page 448.
6. In a multizone enterprise, log in to the UMS in any zone, other than a zone for which you are
replacing the appliances, and remove from the database the appliances you are replacing by
performing the procedure Remove hardware from the database on page 359.
If you are replacing the appliances for all zones in the enterprise and are not replacing one zone at a
time, remove the appliances for all zones except the peer zone.
7. Configure the network settings for the new appliances. Assign the configuration values you collected
in the prerequisites.
For information on configuring the network settings, refer to Configure the appliance network
settings with Network Configurator on page 450.

December 3, 2019 IPC Confidential

 11.2: Replace R610, R620, or R630 appliances with R640 appliances 343

8. Deploy the appropriate personality software on the new appliances by performing the procedure
Deploy the appliance personality software with Personality Deployer on page 465.
9. Deploy the zone by performing one of the following procedures on the appliances in the zone.

Note
Specify the zone ID that was assigned during the initial zone deployment.

• In a single zone enterprise, perform the procedure Deploy the first or only zone with Zone
Deployer on page 489.
• In a multizone enterprise, perform the procedure Deploy subsequent zones on page 495.
10. If you are deploying the appliances in a single zone enterprise, do the following:
a) Restore the Enterprise backup file you created previously by performing the procedure: Restore an
Enterprise backup in a single zone on page 374.
b) Log in to the UMS with a user account that has the IPC Certified Tech role assigned.
If the account does not have full access privileges, reinstall the Certified Admin IPC Technician
license for the account. If an IPC Certified Tech account is not available, add a user account and
install the Certified Admin IPC Technician license for the account by performing the procedure
Add an IPC Certified Technician user on page 488.
c) Log in to the UMS and remove the old appliances from the database by performing the procedure
Remove hardware from the database on page 359.
You must do this within two hours of restoring the database.
11. Confirm that the zone services are running and there are no errors by performing the procedure Check
the state of a zone from a browser on page 499.
12. Install the new enterprise license by performing the procedure Install an enterprise license file on
page 481.
Perform this step only for the first zone you are upgrading.
13. Confirm that the appliances registered with the zone by performing the procedure Confirm that a
device registered with a zone on page 362.
14. If you deployed a higher version of the appliance personality software than the version that was
deployed on the appliances you replaced, deploy the software on other devices, including Media
Managers, Media Gateways, turrets, Pulse devices, and Unigy Soft Clients, by performing the
procedure Upgrade the software on system devices on page 558.
15. Check the state of the zone by performing the procedure Validate a zone after a deployment, rollback,
or other operations on page 638.
16. Change the zone's BCP status to Active by performing the procedure Change a zone's BCP status to
Active on page 498.
17. If it is necessary to install an OS patch, perform the procedure Install an OS patch in a single zone
from the UMS - manual install on page 134.
18. If you are replacing the appliances in multiple zones and you performed steps 1 through 8 for all of
the appliances you are replacing, repeat steps 9 through 17 for each additional zone. If you did not
perform steps 1 through 8 for all of the appliances you are replacing, perform steps 3 through 17 for
each zone.

IPC Confidential Unigy 4.3

Enterprise Guide
344 11.3: Replace an appliance in an HA zone

11.3 Replace an appliance in an HA zone

This topic describes the procedure for replacing one Converged Communications Manager (CCM) or
Aggregated Converged Communications Manager (ACCM) appliance in an HA zone.
The procedure assumes that the appliance you are replacing is a new appliance with a different MAC
address, the zone still has an active appliance, and the appliance to be replaced is the Standby appliance.
Prerequisites:
Before you begin this procedure, obtain the following:
• New appliance. The replacement appliance must be the same hardware version as the other appliance
in the HA pair, that is, if the healthy appliance is an R640, the replacement appliance must also be an
R640.
• DVD that contains the appropriate Unigy COP software version.
• Personality software DVD or access to the software on an external data storage device. The software
version should be the same as the version deployed on the Active appliance. This software might be
on the same DVD as the COP.
• If a hotfix is deployed on the appliances in the zone, the hotfix DVD or access to the software on an
external data storage device.
• Network Configurator settings that were assigned to the appliance that is being replaced so you can
reuse them for the new appliance. For information on these settings, refer to the customer Unigy Data
Collection document or to the Network Configurator properties worksheet described in the Common
Appliance Platform Onsite Installation Manual.
• Zone ID assigned to the zone.
• Enterprise license that includes the new appliance. This should be provided with the new appliance. If
it is not, send a license request to Westbrook Orders or to the Project Manager in your region who is
responsible for providing licenses.
• If an OS patch is required to reapply operating system and security updates, ensure that you have the
OS patch ISO file. This is available from the IPC FTP site, FilesAnywhere.
To perform this procedure, your user account must have the IPC Certified Tech role and you must have
access to Password Manager to generate dynamic passwords.
1. Power down the appliance you are replacing.
If the appliance is the Active appliance, wait for the Standby appliance to become the Active
appliance.
2. Install the new appliance in the cabinet. For information on installing an appliance, refer to the
Common Appliance Platform Onsite Installation Manual
3. Remove the appliance you are replacing from the Unigy database by performing the procedure
Remove hardware from the database on page 359.
In a multizone enterprise, perform this procedure from one of the other zones in the enterprise.
4. If the appliance you are replacing is the primary appliance in the HA pair (appliance with the lower
IP address - CCM 1 or ACCM 1), power down the secondary appliance (CCM 2 or ACCM 2).
5. Deploy the COP software on the new appliance, if necessary.
IPC Manufacturing usually deploys the Common Operating Platform (COP) software on a new
appliance before it is shipped. If this software is not deployed on the new appliance, deploy the COP
by performing the procedure Deploy the COP (Common Operating Platform) software on page 448.
Confirm that the COP software version is the correct version by performing the procedure Determine
the current COP version on page 450.

December 3, 2019 IPC Confidential

 11.3: Replace an appliance in an HA zone 345

6. Configure the appliance network settings for the new appliance. For information on configuring the
network settings, refer to Configure the appliance network settings with Network Configurator on
page 450.
Use the same network configuration that was used for the appliance you are replacing.
7. Deploy the appropriate personality software on the new appliance by performing the procedure
Deploy the appliance personality software with Personality Deployer on page 465.
8. Deploy the zone on the new appliance by performing the steps indicated in the procedure Deploy
subsequent zones on page 495.
Specify the zone ID that was assigned to the appliance you replaced.
If the appliance you are replacing is in the first zone deployed in the enterprise, the second zone
deployed in the enterprise should serve as the peer zone. For any other zone, any appropriate zone can
serve as the peer zone.
In a multi-zone enterprise, confirm that the preferred zone for the zone in which you are replacing the
appliance is appropriate for providing the database dump when the new appliance comes up. If the
appliance you are replacing is the primary appliance (CCM 1 or ACCM 1) in the first zone that was
deployed in the enterprise, assign the second zone that was deployed as the preferred zone, unless the
second zone is not appropriate; for example, because it is not available or has a lower database
schema. If you do not specify a preferred zone, Unigy uses the zone selection algorithm to select an
appropriate zone as the database source.
9. If the appliance you replaced is the primary appliance for the zone, do one of the following:
• If the appliance you are replacing is the primary appliance for a zone in a multi-zone enterprise:
1. Bring up the primary appliance (CCM 1 or ACCM 1) if it is not already up. It will come up as
the Active appliance and will pull the database from the preferred zone you specified in the
previous step or the zone selected by the zone selection algorithm, if you did not specify a
preferred zone.
2. When the primary appliance is up, monitor its status until all of the services are running
successfully by performing the procedure Check the state of a zone from a browser on page
499. Use the checkMyStatus option.
3. Power up the secondary appliance (CCM 2 or ACCM 2). It will come up as the Standby
appliance and load the database from the primary appliance.
• If the appliance you are replacing is the primary appliance in a single zone enterprise:
1. Power down the primary appliance (CCM 1 or ACCM 1).
2. Power up the secondary appliance (CCM 2 or ACCM 2). It will come up as the Active
appliance with its local database.
3. When the secondary appliance is up, monitor its status until all of the services are running
successfully by performing the procedure Check the state of a zone from a browser on page
499. Use the checkMyStatus option.
4. Power up the primary appliance. The appliance comes up as the Standby appliance and loads
the database from the secondary appliance.
10. Check the state of the zone, and for a multizone enterprise, confirm that the zones are communicating
by performing the procedure Validate a zone after a deployment, rollback, or other operations on
page 638.
11. If a hotfix is required. deploy the hotfix on the new appliance:
a) Because status data in the database indicates that the hotfix is deployed on both appliances in the
zone, perform the following steps to rename the installed_hotfix_iso.lst.peer file.

IPC Confidential Unigy 4.3

Enterprise Guide
346 11.3: Replace an appliance in an HA zone

This removes the current status of the hotfix .iso file so you can deploy it from within the
Software Deployment Install panel:
1. Access the command line on the zone's Active appliance.
2. Run the command su -lp and enter the appropriate dynamic password.
3. Run the command mv /opt/ipc/deployment/iso/hotfix/
installed_hotfix_iso.lst.peer /opt/ipc/deployment/iso/hotfix/
installed_hotfix_iso.lst.peer.bak.
b) Disable data replication by performing the procedure Disable data replication on page 498. You
can start with any zone based on the following:
• If the enterprise consists of a single Unigy instance, disable replication for all zones in the
enterprise.
• If the enterprise consists of multiple Unigy instances, disable replication only for the zones in
the instance associated with the appliance for which you are deploying the hotfix.
c) Log in to the UMS with the VIP of the zone in which you replaced the appliance.
d) Place the zone into maintenance mode and disable SNMP forwarding by performing the following
procedures:
• Disable SNMP forwarding for a zone on page 596.
• Place a zone into maintenance mode to disable BCP plan activation on page 597.
e) Place the zone cluster into maintenance mode by performing the procedure Place a cluster into
maintenance mode to enable control of HA failovers on page 598.
f) Place the Standby appliance into maintenance mode by performing the procedure Place an
appliance or Media Gateway into maintenance mode to indicate it is unavailable on page 599.
g) Perform the procedure Deploy an ISO file on page 550 to deploy the hotfix.
Because you are deploying the software only on the replaced appliance, clear the following check
boxes after you click Install Zone to prevent the processes from being implemented:
• Automatic Deployment
• Install the update simultaneously on both servers in the zone
h) After the deployment completes, monitor the state of the appliances in the zone until all services
are running successfully by performing the procedure Check the state of a zone from a browser on
page 499.
i) Confirm that the hotfix was installed by performing the procedure Confirm that an update was
deployed on page 552.
j) Take the Standby appliance out of maintenance mode by performing the procedure Take an
appliance or Media Gateway out of maintenance mode on page 600.
k) Indicate that the maintenance for the Standby appliance is complete by performing the procedure
Indicate that maintenance on the Standby appliance is complete on page 601.
l) Take the cluster out of maintenance mode by performing the procedure Take a cluster out of
maintenance mode to resume normal HA operation on page 599.
m) Take the zone out of maintenance mode and enable SNMP forwarding by performing the
following procedures:
• Take a zone out of maintenance mode to reenable BCP plan activation on page 598.
• Reenable SNMP forwarding for a zone on page 596.

December 3, 2019 IPC Confidential

 11.4: Replace both appliances in a zone 347

n) Enable data replication in one of the zones for which you disabled it by performing the procedure
Enable data replication on page 497.

Note
If preferred zones are configured, the first zone you enable should be a preferred zone. If Multi-tier
Replication is enabled, the first zone you enable should be the portal zone for the associated data
center.

o) Enable data replication for the other zones for which you disabled it.

Note
Enable preferred zones before non-preferred zones, and if Multi-tier Replication is enabled, enable
portal zones before local zones.
Enable replication for one zone at a time. Wait for the replication to complete in one zone before
you enable replication for the next zone.

12. Confirm that the correct software versions are deployed on the Media Managers and Media Gateways
in the zone by performing the procedures Run MM software version on page 649 and Run Media
Gateway software version on page 650.
13. Install the enterprise license you obtained in the prerequisites by performing the procedure Install an
enterprise license file on page 481.
14. Restart all turrets and Pulse devices registered with the zone by performing the procedure Reboot
communication devices on page 591.
15. If it is necessary to install an OS patch, perform the procedure Install an OS patch in a single zone
from the UMS - manual install on page 134.

11.4 Replace both appliances in a zone

This topic describes the procedure for rebuilding an HA zone that requires replacement of both
appliances.
Before you begin this procedure, collect the following items:
• Replacement appliances. The appliances must be the same hardware version, that is, if one is an
R640, the other must also be an R640.
• DVD that contains the appropriate Unigy COP software version.
• DVD for the appropriate personality software version or access to the ISO file on an external data
storage device. This software might be on the same DVD as the COP software.
• System, network, and HA property values recorded during the initial deployment. These should be in
the customer Unigy Data Collection document or the Network Configurator properties worksheet.
• Enterprise license file that includes the new appliances. A new license is required because the new
appliances have different MAC addresses. If you did not receive a new license with the new
hardware, send a license request to Westbrook Orders or to the Project Manager in your region who is
responsible for providing licenses.
• If you are deploying the appliances in a single zone enterprise, ensure that you have the most recent
enterprise database backup for the zone.
• If an OS patch is required to reapply operating system and security updates, ensure that you have the
OS patch ISO file. This is available from the IPC FTP site, FilesAnywhere.

IPC Confidential Unigy 4.3

Enterprise Guide
348 11.4: Replace both appliances in a zone

1. Remove the damaged CCM or ACCM appliances and install the new hardware in the cabinet. For
information on racking an appliance, refer to the Common Appliance Platform Onsite Installation
Manual.
2. IPC Manufacturing normally deploys the Common Operating Platform (COP) software on new
appliances before they are shipped. If the software is not installed on the new appliances, deploy the
COP on both appliances by performing the procedure Deploy the COP (Common Operating
Platform) software on page 448.
3. In a multizone enterprise, log in to the UMS in any other zone in the enterprise and remove from the
database the appliances that were in the zone you are redeploying by performing the procedure
Remove hardware from the database on page 359.
4. Configure the network settings for both appliances. Assign the configuration values you collected in
the prerequisites. For information on configuring the network settings, refer to Configure the
appliance network settings with Network Configurator on page 450.
5. Deploy the appropriate personality software on both appliances by performing the procedure Deploy
the appliance personality software with Personality Deployer on page 465.
6. Deploy the zone by performing one of the following procedures on both appliances.

Note
Specify the zone ID that was assigned during the initial zone deployment.

• In a single zone enterprise, perform the procedure Deploy the first or only zone with Zone
Deployer on page 489.
• In a multizone enterprise, perform the procedure Deploy subsequent zones on page 495.
7. Confirm that the zone services are running and there are no errors by performing the procedure Check
the state of a zone from a browser on page 499.
8. If you are deploying the appliances in a single zone enterprise, restore the database backup file by
performing the procedure Restore an Enterprise backup in a single zone on page 374.
9. Log in to the UMS with the secadmin user account.
10. Install the new enterprise license by performing the procedure Install an enterprise license file on
page 481.
11. Log in to the UMS with a user account that has the IPC Certified Tech role assigned.
If the account does not have full access privileges, reinstall the Certified Admin IPC Technician
license for the account. If an IPC Certified Tech account is not available, add a user account and
install the Certified Admin IPC Technician license for the account by performing the procedure Add
an IPC Certified Technician user on page 488.
12. Enable device registration by performing the procedure Enable device registration on page 496.
13. Confirm that the appliances registered with the zone by performing the procedure Confirm that a
device registered with a zone on page 362.
14. Deploy the software on other devices, including Media Managers, Media Gateways, turrets, Pulse
devices, and Unigy Soft Clients, by performing the procedure Upgrade the software on system
devices on page 558.
15. Enable data replication for the zone you are deploying by performing the procedure Enable data
replication on page 497.
16. Check the state of the zone by performing the procedure Validate a zone after a deployment, rollback,
or other operations on page 638.

December 3, 2019 IPC Confidential

 11.5: Restore an enterprise where one zone survived a multizone hardware failure 349

17. Change the zone's BCP status to Active by performing the procedure Change a zone's BCP status to
Active on page 498.
18. If it is necessary to install an OS patch, perform the procedure Install an OS patch in a single zone
from the UMS - manual install on page 134.

11.5 Restore an enterprise where one zone survived a multizone hardware

failure
This topic describes how to recover from a major hardware failure in a multizone enterprise that
damaged the CCM or ACCM appliances in all but one zone. The procedure describes how to restore the
enterprise from the single remaining zone.
Prerequisites: Before you begin this procedure, obtain the replacement hardware and retrieve the
network and zone information for each of the appliances in the failed zones, as well as the VIP of the
surviving zone. The surviving zone becomes the peer zone for deploying the other zones. This
information should be available in the Unigy Data Collection document for the customer or the Network
Configurator properties worksheet.

Note
Deploy the replacement appliances with the same network settings as the appliances they are replacing.

Prior to performing this procedure, the following prerequisites must be complete for all applicable
appliances:

Procedure References and notes

Appliance hardware is installed (racked) and Refer to the Common Appliance Platform Onsite
connected to the network. Installation Manual.
Unigy Common Operating Platform (COP) Deploy the COP (Common Operating Platform)
software is deployed on the appliance(s). software on page 448
This software is usually deployed by IPC Determine the current COP version on page 450
Manufacturing prior to appliance shipment. Deploy
the COP only if it is not on the appliance(s) or if the
wrong version is deployed.
Appliance network settings are configured. Configure the appliance network settings with
Network Configurator on page 450
You have the Unigy personality software DVD for This procedure assumes that you will always
the latest software version or have access to the deploy the latest software to obtain the benefits of
personality ISO file on an external data storage the most recent fixes and functionality.
device.
You have the customer's Unigy enterprise license This should have been delivered with the Unigy
file. The license must be based on the new hardware. If you do not have the license, submit a
hardware. request to Westbrook Orders or contact the Project
Manager in your region who is responsible for
providing licenses.
You have the credentials and Certified Admin IPC If you do not have the license, submit a request to
Technician license file for the user account you will Westbrook Orders or contact the Project Manager
use to perform the deployment. in your region who is responsible for providing
Unigy licenses.

IPC Confidential Unigy 4.3

Enterprise Guide
350 11.6: Restore a multizone enterprise after the failure of all appliances

1. Log in to the UMS in the peer zone (the surviving zone) and remove the appliances you are replacing
from the database by performing the procedure Remove hardware from the database on page 359.
2. Install the new enterprise license by performing the procedure Install an enterprise license file on
page 481.
3. Deploy the personality software on the primary and secondary appliances, and if applicable, Media
Manager, in all of the zones being restored by performing the procedure Deploy the appliance
personality software with Personality Deployer on page 465.
4. From the peer zone, deploy one of the zones by performing the procedure Deploy subsequent zones
on page 495 on the primary and secondary appliance in the zone.
5. Confirm that the zone services are running and there are no errors by performing the procedure Check
the state of a zone from a browser on page 499.
6. Log in to the UMS in the zone you deployed with the zone VIP: https://vip.
7. Enable device registration by performing the procedure Enable device registration on page 496.
8. Confirm that the appliances and the associated CDIs registered with the zone by performing the
procedure Confirm that a device registered with a zone on page 362.
9. Reboot the turrets and Pulse devices registered with the zone by performing the procedure Reboot
communication devices on page 591.
10. Enable data replication for the zone you are deploying by performing the procedure Enable data
replication on page 497.
11. Check the state of the zone by performing the procedure Validate a zone after a deployment, rollback,
or other operations on page 638.
12. Change the zone's BCP status to Active by performing the procedure Change a zone's BCP status to
Active on page 498.
13. Repeat steps 4 through 12 for each zone you are redeploying.
14. As applicable, add Media Gateway and Unigy Soft Clients and perform any configuration that is
required.
15. Run the tests in Validation workflow on page 635.

11.6 Restore a multizone enterprise after the failure of all appliances

This topic describes how to recover from the loss of all appliances in a multizone enterprise.
Prerequisites:
To complete this procedure, be sure that you have the following:
• Most recent enterprise database backup file. Check all backup files stored on remote servers or other
external storage devices. The file should be from the zone with the most recent version of the
database schema. If this data is not available, select the backup for the highest level database schema
available.
• Replacement hardware.
• Network and zone configuration information for each of the appliances in the failed zones. This
information should be available in the Unigy Data Collection document for the customer or the
Network Configurator properties worksheet.

December 3, 2019 IPC Confidential

 11.6: Restore a multizone enterprise after the failure of all appliances 351

Note
Deploy the replacement appliances with the same network settings as the appliances they are
replacing.

Prior to performing this procedure, the following prerequisites must be complete for all applicable
appliances:

Procedure References and notes

Appliance hardware is installed (racked) and Refer to the Common Appliance Platform Onsite
connected to the network. Installation Manual.
Unigy Common Operating Platform (COP) Deploy the COP (Common Operating Platform)
software is deployed on the appliance(s). software on page 448
This software is usually deployed by IPC Determine the current COP version on page 450
Manufacturing prior to appliance shipment. Deploy
the COP only if it is not on the appliance(s) or if the
wrong version is deployed.
Appliance network settings are configured. Configure the appliance network settings with
Network Configurator on page 450
You have the Unigy personality software DVD for This procedure assumes that you will always
the latest software version or have access to the deploy the latest software to obtain the benefits of
personality ISO file on an external data storage the most recent fixes and functionality.
device.
You have the customer's Unigy enterprise license This should have been delivered with the Unigy
file. The license must be based on the new hardware. If you do not have the license, submit a
hardware. request to Westbrook Orders or contact the Project
Manager in your region who is responsible for
providing licenses.
You have the credentials and Certified Admin IPC If you do not have the license, submit a request to
Technician license file for the user account you will Westbrook Orders or contact the Project Manager
use to perform the deployment. in your region who is responsible for providing
Unigy licenses.

1. Deploy the personality software on the primary and secondary appliances, and if applicable, Media
Managers, in all of the zones being restored by performing the procedure Deploy the appliance
personality software with Personality Deployer on page 465.
2. Deploy the first zone on the primary and secondary appliances in the zone that will serve as the peer
zone by performing the procedure Deploy the first or only zone with Zone Deployer on page 489 on
each appliance. Assign the same zone ID for both appliances.
3. Confirm that the zone services are running and there are no errors by performing the procedure Check
the state of a zone from a browser on page 499.
4. Restore the enterprise backup file you obtained in the prerequisites by performing the procedure
Restore an Enterprise backup in a single zone on page 374.
5. Log in to the UMS with a user account that has the IPC Certified Tech role assigned.
If an account is not available, log in with the secadmin account, add a user, then install the
Certified Admin IPC Technician license to assign the IPC Certified Tech role by performing the
procedure Add an IPC Certified Technician user on page 488. If an IPC user account exists, but it
does not have all access rights, reinstall the Certified Admin IPC Technician license for the account.

IPC Confidential Unigy 4.3

Enterprise Guide
352 11.7: Replace a failed Media Manager

6. Remove the replaced appliances from the database by performing the procedure Remove hardware
from the database on page 359.
7. Reboot both appliances in the peer zone by performing the procedure Reboot CCM on page 587.
8. Confirm that the zone services are running and there are no errors by performing the procedure Check
the state of a zone from a browser on page 499.
9. Install the new enterprise license by performing the procedure Install an enterprise license file on
page 481.
10. Enable device registration by performing the procedure Enable device registration on page 496.
11. Deploy the software on other devices, including Media Managers, Media Gateway, turrets, Pulse
devices, and Unigy Soft Clients, by performing the procedure Upgrade the software on system
devices on page 558.
12. Enable data replication by performing the procedure Enable data replication on page 497.
13. Check the state of the zone by performing the procedure Validate a zone after a deployment, rollback,
or other operations on page 638.
14. Change the zone's BCP status to Active by performing the procedure Change a zone's BCP status to
Active on page 498.
15. Deploy a subsequent zone from the first zone by performing the procedure Deploy subsequent zones
on page 495.
16. Confirm that the zone services are running and there are no errors by performing the procedure Check
the state of a zone from a browser on page 499.
17. Log in to the UMS in the zone you just deployed.
18. Enable data replication for the zone by performing the procedure Enable data replication on page
497.
19. Check the state of the zone by performing the procedure Validate a zone after a deployment, rollback,
or other operations on page 638.
20. Deploy the software on other devices, including Media Gateway, turrets, Pulses, and Unigy Soft
Clients by performing the procedure Upgrade the software on system devices on page 558.
21. Change the zone's BCP status to Active by performing the procedure Change a zone's BCP status to
Active on page 498.
22. If you are deploying additional zones, repeat steps 15 through 21 for each zone.
23. As applicable, add Media Gateway and Unigy Soft Clients and perform any configuration that is
required.
24. Run the tests in Validation workflow on page 635.

11.7 Replace a failed Media Manager

This procedure describes how to replace a failed Media Manager (MM) appliance.
Before you start this procedure, obtain the following items:
• The appropriate Unigy Common Operating Platform (COP) software DVD, if the COP is not already
deployed on the replacement appliance.
• Appliance personality software DVD or access to the ISO file on an external data storage device. The
software version should normally be the same as the version that was deployed on the MM you are
replacing.

December 3, 2019 IPC Confidential

 11.8: Configure Media Gateway warm standby 353

• Network Configurator settings that were assigned to the failed appliance so you can reuse them for
the new appliance. For information on these settings, refer to Information to collect prior to running
Network Configurator or performing an upgrade on page 462 or to the customer Data Collection
document.
• If an OS patch is required to reapply operating system and security updates, ensure that you have the
OS patch ISO file. This is available from the IPC FTP site, FilesAnywhere.
1. Remove the damaged appliance and install the new hardware in the cabinet. For information on
racking an appliance, refer to the Common Appliance Platform Onsite Installation Manual.
2. IPC Manufacturing normally deploys the Common Operating Platform (COP) software on an
appliance before it is shipped. If this software is not installed on the new appliance, deploy the COP
by performing the procedure Deploy the COP (Common Operating Platform) software on page 448.
3. Configure the appliance network settings. Assign the configuration values you collected in the
prerequisites. For information on configuring the network settings, refer to Configure the appliance
network settings with Network Configurator on page 450.
4. Deploy the Media Manager personality software by performing the procedure Deploy the appliance
personality software with Personality Deployer on page 465.
The MM registers with the zone specified as the Registration Host.
5. Log in to the UMS: https://vip.
6. Confirm that the new MM registered with the zone by performing the procedure Confirm that a
device registered with a zone on page 362.
7. Remove the entry for the replaced Media Manager from the database by performing the procedure
Remove hardware from the database on page 359.
8. Reboot the Media Manager by performing the procedure Run Reboot Media Manager on page 588.
9. Confirm that the MM is operating properly:
a) Click Configuration ➤ Sites ➤ Servers ➤ Media Managers.
b) In the Media Managers list, click the MM.
c) Within the Media Manager Maintenance tab, confirm that the Media Manager Status is In
Traffic.
10. If it is necessary to install an OS patch, perform the procedure Install an OS patch in a single zone
from the UMS - manual install on page 134.

11.8 Configure Media Gateway warm standby

Media Gateway warm standby allows for Media Gateway redundancy. In the event the primary Media
Gateway fails, a standby Media Gateway can be brought online quickly.
The standby Media Gateway must have exactly the same number and type of modules plugged in the
same order as the primary Media Gateway, must use the same Media Gateway Web Account username
and password, and must be racked and stacked with the correct IP address and network information.
It must be installed and configured in the same way, following the procedures from the Media Gateway
Hardware Installation Manual. Also, if CAS files are being used, the files must be listed in the same
order on both Media Gateway.

Note
Do not add both primary and standby Media Gateways to the UMS as separate devices; only one device
should be listed in the UMS.

IPC Confidential Unigy 4.3

Enterprise Guide
354 11.8: Configure Media Gateway warm standby

1. In the UMS, in Tools ➤ Deployment ➤ Hardware Deployment, locate the primary Media Gateway
that the standby is being prepared for. Do not create a new Media Gateway in the UMS for the
standby machine.
2. Update the IP address of the primary device to the standby Media Gateways IP address.
3. In Tools ➤ Deployment ➤ Software Deployment, perform a software upgrade of the Media
Gateway; be sure to select Override Config.
4. In Configuration ➤ Sites ➤ Trunks ➤ Media Gateways, select the Media Gateway from the list.
5. Click the Properties button.
6. Click the CAS File Management tab.
7. In the To be Updated on MG column, select the check box for the CAS files. CAS files on the
standby MG must be listed in the same order as the primary MG.
Figure 46: Media Gateway Details - CAS File Management tab

8. Click Sync.
9. Perform the procedure Apply changes to a Media Gateway configuration on page 586.
Be sure to enable SSH remote access if it is not enabled.
10. Click the Media Gateway Maintenance tab.
11. Expand the Reset Configuration section then click Reboot.
12. Test that the standby Media Gateway is working properly.
a) Move the cables connected to the primary Media Gateway to the standby Media Gateway.
b) Reset the standby Media Gateway so that the connections are established. There should be a green
signal on all the Media Gateway trunks.
c) Make test calls from Unigy.
13. Once the verification and testing is complete, update the device IP address back to the primary Media
Gateway’s IP address.
14. If the cables were plugged into standby for testing purposes, plug them all back to the primary Media
Gateway, and reset the primary Media Gateway.

Note
If any configuration changes are made while the standby Media Gateway is in service, perform the
procedure Apply changes to a Media Gateway configuration on page 586 then click Reset when
switching back to the primary.

15. Test and verify calls from Unigy to verify the primary Media Gateway is good.
After completion of these steps, the standby Media Gateway has the same configuration as the primary
Media Gateway but the lines and network ports are not connected. Remember that any future

December 3, 2019 IPC Confidential

 11.9: Move CDIs to a different zone 355

configuration changes made to the primary Media Gateway also need to be made to the warm standby
Media Gateway. A best practice would be to swap the Media Gateways whenever you make changes.
This ensures both are working and have the same configuration.
The standby Media Gateway can be brought into service by swapping the lines with the primary Media
Gateway and bringing the network ports on line.

Note
This is considered N+N redundancy. A warm standby Media Gateway cannot be used for more than one
primary Media Gateway.

11.8.1 Put the warm standby Media Gateway into service

To put a warm standby Media Gateway into service, perform the following steps.
1. Plug in the cables to the standby Media Gateway. Be sure to match the cable positions as they were
on the main Media Gateway.
2. In Tools ➤ Deployment ➤ Hardware Deployment, change the IP address of the primary Media
Gateway to the standby Media Gateway’s IP.
3. If there are configured hoot lines, reset the Media Gateway from the Media Gateway Maintenance
panel.
The System Installation and Deployment Guide contains information on performing these tasks.

11.9 Move CDIs to a different zone

11.9.1 Move an IQ/MAX or IQ/MAX Edge turret to a different zone
Use this procedure to move an IQ/MAX or IQ/MAX Edge turret to a different home zone.
Prerequisites:
During this procedure, when you remove the turret from the Unigy database, the system deletes the
device and all associated data from the database. After you remove the turret, you reassign the
personality and speaker licenses; therefore, record these values before you move the turret so you can
reassign the same values after the move. Also record the turret hostname and MAC address so you can
identify the device in the UMS.
When the turret registers with the new zone, the system assigns the default values specified in the
prototype device.
1. Do one of the following from the turret you are moving:
• If you are not logged in to the turret, press the Admin button.
• If you are logged in as an end user, press the Shortcuts button then press More ➤ Admin.
2. Type the Admin user account password then press Next.
3. Press Configure Network ➤ Servers ➤ Set Values Manually ➤ CCM.
4. In the CCM Address field, change the value to the VIP of the new home zone.
5. Press Save ➤ Save ➤ Save ➤ Commit ➤ OK.
6. Remove the turret from the Unigy database:
a) Log in to the UMS: https://vip.
b) Click Tools ➤ Deployment ➤ Hardware Deployment.

IPC Confidential Unigy 4.3

Enterprise Guide
356 11.9: Move CDIs to a different zone

c) In the Deployment Zones panel, click the current turret home zone.
d) Within the IQ/MAX & Edge tab, click the turret then click Remove Device.
e) In the Delete Confirmation message box, click Yes.
The system removes the turret and all associated data from the database. After approximately three
minutes, the turret reboots and registers with the new home zone.
7. When the turret is available, confirm that it registered with the new zone:
a) Within the UMS, click Tools ➤ Deployment ➤ Hardware Deployment.
b) In the Deployment Zones panel, click the new turret home zone.
c) Within the IQ/MAX & Edge tab, locate the turret in the list.
8. Assign the turret personality if the system does not assign it automatically:
a) Click Configuration ➤ Enterprise ➤ License Manager.
b) Click the Active license.
c) Within the License Detail panel, click one of the following personality licenses for the turret, based
on the type of turret, then click View Assigned:
• IQ/MAX Edge100 TSL
• IQ/MAX Edge200 TSL
• IQ/MAX SU4 only TSL
• IQ/MAX TSL
d) Click +Assign.
e) In the Available to Assign panel, select the check box for the turret you are moving then click <
Assign.
f) Click Save.
9. If applicable, assign the appropriate number of additional speaker licenses that apply to the turret. Use
the legacy (Flash) UMS (https://<your_VIP>/ums/UMSClient.html) or Mass Edit Client
to accomplish this task. This is necessary because the Communication Devices menu is not available
in the HTML5 interface. This step describes the legacy procedure.
a) Click Configuration ➤ Sites ➤ Communication Devices ➤ IQ/MAX & Edge.
b) In the Turrets list on the left, click the turret to which you are assigning the license.
c) In the Speaker License field, select the number of speaker licenses to assign then click Save.

11.9.2 Move a Pulse to a different zone

Use this procedure to move a Pulse to a different home zone.
Prerequisites:
Determine whether an additional speaker license is assigned to the Pulse. Also record the Pulse MAC
address so you can identify the device in the UMS.
During this procedure, you change the VIP on the Pulse then remove the device from the database. The
Pulse automatically registers with the new home zone. When you remove the Pulse, the system deletes
the device and all associated data from the database. When the Pulse registers with the new zone, the
system assigns the default values specified in the prototype device.

December 3, 2019 IPC Confidential

 11.9: Move CDIs to a different zone 357

1. Log in to the Pulse.

2. Tap the Settings icon.
3. Tap the Admin icon.
4. Type the Admin user account password, then tap done.
5. Tap the Network icon.
6. Turn off Enable DHCP if it is on by tapping the On button to the right of the field.
If the field displays the Off button, leave it in its current state.
7. Tap the CCM Ip Address field, use the key pad to change the VIP to the value for the new home
zone, then tap done.
8. If Enable DHCP was on in step 6, turn it back on by tapping the Off button.
The button changes to On.
9. Scroll to the bottom of the panel then tap Save Changes.
10. After the changes are saved, tap Close.
11. Remove the Pulse from the database:
a) Log in to the UMS.
b) Click Tools ➤ Deployment ➤ Hardware Deployment.
c) Within the Deployment Zones panel, click the current Pulse home zone.
d) Within the Pulse tab, click the Pulse then click Remove Device.
e) In the Delete Confirmation message box, click Yes.
The system removes the Pulse and associated data from the database. After approximately three
minutes, the Pulse reboots and registers with the new home zone.
12. When the Pulse is available, confirm that it registered with the new zone:
a) Within the UMS, click Tools ➤ Deployment ➤ Hardware Deployment.
b) In the Deployment Zones panel, click the new Pulse home zone.
c) Within the Pulse tab, locate the Pulse in the list.
13. If the system does not automatically assign the Pulse personality, assign the Pulse hardware license:
a) Click Configuration ➤ Enterprise ➤ License Manager.
b) Click the Active license.
c) Within the License Detail panel, click Pulse (Hardware) TSL then click View Assigned:
d) Click +Assign.
e) In the Available to Assign panel, select the check box for the Pulse you are moving then click <
Assign.
f) Click Save.
14. If applicable, assign an additional speaker license. Use the legacy (Flash) UMS (https://
<your_VIP>/ums/UMSClient.html) or Mass Edit Client to accomplish this task. This is
necessary because the Communication Devices menu is not available in the HTML5 interface. This
step describes the legacy procedure.
a) Click Configuration ➤ Sites ➤ Communication Devices ➤ Pulse.
b) In the Pulse list, click the Pulse to which you are assigning the license.

IPC Confidential Unigy 4.3

Enterprise Guide
358 11.9: Move CDIs to a different zone

c) In the Speaker License field, select the speaker license then click Save.

11.9.3 Move a Unigy Soft Client to a different zone

Use this procedure to change a Soft Client's home zone.
Prerequisites:
Determine whether additional speaker licenses are assigned to the Soft Client. Also record the name of
the computer that is running the Soft Client so you can identify the client in the UMS.
During this procedure, you change the VIP for the Soft Client then remove it from the database. The
Soft Client automatically registers with the new home zone when the end user logs in. When you
remove the Soft Client, the system removes the client and all associated data from the database. When
the Soft Client registers with the new zone, the system assigns the default values specified in the
prototype device.
1. Log off of the Soft Client.
2. Change the home zone VIP:
a) On the client computer, click Start ➤ All Programs ➤ IPC Systems Inc ➤ Unigy Client
Configuration Tool.
b) In the Primary field, type the new home zone IP address (single appliance zone), VIP (HA zone),
or FQDN then click Save.
The IP address, VIP, or FQDN must be specified as the Common Name or Alternate Name in the
client certificate.
c) In the Save message box, click OK.
d) In the Unigy Config Tool panel, click Close.
3. Remove the Soft Client from the database:
a) Log in to the UMS: https://vip.
b) Click Tools ➤ Deployment ➤ Hardware Deployment.
c) Within the Deployment Zones panel, click the current Soft Client home zone.
d) Within the Soft Clients tab, locate the Soft Client in the list.
e) Click the Soft Client then click Remove Device.
f) In the Delete Confirmation box, click Yes.
The system removes the Soft Client and associated data from the database.
4. Log in to the Soft Client.
The Soft Client registers with the new home zone.
If the zone to which you moved the Soft Client is a lower version than the version currently installed,
the system displays the message Unexpected error occurred while startup. Click OK
then roll back the software by performing the procedure Roll back the Unigy Soft Client software –
Microsoft Windows 64-bit on page 631.
5. Confirm that the Soft Client registered with the new zone:
a) Within the UMS, click Tools ➤ Deployment ➤ Hardware Deployment.
b) In the Deployment Zones panel, click the new Soft Client home zone.
c) Within the Soft Client tab, locate the Soft Client in the list.
6. If applicable, assign additional speaker licenses:

December 3, 2019 IPC Confidential

 11.10: Remove hardware from the database 359

a) Click Configuration ➤ Sites ➤ Communication Devices ➤ Soft Clients.

b) In the Soft Clients list, click the Soft Client to which you are assigning the licenses.
c) In the Speaker License field, select the number of additional speaker licenses then click Save.

11.9.4 Move an IQ/MAX TOUCH turret to a different zone

Use this procedure to move an IQ/MAX TOUCH turret to a different home zone.
During this procedure, when you remove the turret from the Unigy database, the system deletes the
device and all associated data from the database. When the turret registers with the new zone, the system
assigns the default values specified in the prototype device.
1. Log in to the IQ/MAX TOUCH turret with the admin user account credentials.
2. Tap Configure Network.
3. At the top of the panel, tap Edit.
4. Scroll to the CCM Address field then change the value to the VIP of the new home zone.
5. Tap Save.
6. Remove the turret from the Unigy database:
a) Log in to the UMS.
b) Click Tools ➤ Deployment ➤ Hardware Deployment.
c) In the Deployment Zones panel, click the current turret home zone.
d) Within the IQ/MAX TOUCH tab, click the turret then click Remove Device.
e) In the Delete Confirmation message box, click Yes.
The system removes the turret and all associated data from the database. After approximately three
minutes, the turret reboots and registers with the new home zone.
7. When the turret is available, confirm that it registered with the new zone:
a) Within the UMS, click Tools ➤ Deployment ➤ Hardware Deployment.
b) In the Deployment Zones panel, click the new turret home zone.
c) Within the IQ/MAX TOUCH tab, locate the turret in the list.

11.10 Remove hardware from the database

When you replace, move, or remove hardware, perform certain rollback procedures, or restore a
database that contains data for devices that are not available to the associated zones within an enterprise,
remove the device data from the database.
Prerequisites:

Note
If you are removing a device from service, remove the device from the network to prevent it from re-
registering after you remove it from the database. If you are moving a device to a different zone, be sure
that the zone assignment on the device specifies the correct zone so the device re-registers with that
zone.

Removing the data is necessary to ensure that the system does not attempt to support devices that are no
longer associated with the enterprise and to eliminate hardware conflicts. If you are replacing a device,

IPC Confidential Unigy 4.3

Enterprise Guide
360 11.10: Remove hardware from the database

you must remove the hardware that is being replaced from the database because the replacement
hardware generally has the same network configuration, but a different MAC address.
When you remove a device, the system deletes the device and all associated data from the database.
New and moved devices register with the associated zone when device registration is enabled for the
zone. When the device registers with the zone, the system assigns the default values specified in the
prototype device.
You can remove the following types of devices from the database through the UMS:
• Converged Communications Manager (CCM) appliances
• Aggregated Converged Communications Manager (ACCM) appliances
• Media Manager (MM) appliances
• Media Gateways (MGs)
• CDIs (turrets, Pulse devices, and Unigy Soft Clients)
Remove device records from the database when you do the following:
• Replace a device.
• Remove a device from service.
• Move a device to a different home zone.
• Move the appliances in a zone to a different instance.
• Deploy a replica system with a customer database.
• Roll back a Unigy upgrade to Unigy v2.0 (applies only to MMs and MGs).
• Restore a database that includes devices that are different from the devices in the current enterprise.

Note
During a pre-v3.0 upgrade, remove only the devices that will not be used in the upgraded Unigy
enterprise.

Note
When possible, perform this procedure during non-business hours.

When you remove CCM or ACCM appliances that will re-register with a zone, after the appliances
register, the Role and State displayed within the Members tab (Configuration ➤ Sites ➤ Servers ➤
Clusters) will not match the Server Role and Server State displayed in the Cluster Operation Output
Details section or the output from Check the state of a zone from a browser on page 499. To correct this
mismatch, restart the zone by performing the procedure Refresh (restart) a zone in a single zone
enterprise on page 318 or Refresh (restart) zones in a multizone enterprise on page 319. If the UMS for
the zone is not accessible, log in to both appliances through SSH and reboot them at the same time.
1. Click Tools ➤ Deployment ➤ Hardware Deployment.
2. In the Deployment Zones panel, click the zone from which you are removing the device.
3. Click the appropriate tab for the device you are removing: Servers (for CCMs, ACCMs, and MMs),
Media Gateways, IQ/MAX & Edge, Soft Clients, Pulse, or IQ/MAX Touch.
4. Click the device you are removing then click Remove Device.
5. In the Delete Confirmation message box, click Yes.

December 3, 2019 IPC Confidential

 11.11: Remove an appliance from the database 361

The system deletes the device and all associated data from the database. If you did not remove the
device from the network before removing it from the database, within approximately three minutes
the device will attempt to register with the zone assigned to it.

11.11 Remove an appliance from the database

This topic describes how to remove a CCM, ACCM, or MM appliance from the Unigy enterprise
database.
When you remove the appliance, the system deletes the device and all associated data from the database.
If the device remains on the network, after several minutes it will attempt to re-register with the zone.
When possible, perform this procedure during non-business hours.
If you are removing CCM or ACCM appliances that will re-register with a zone, after the appliances
register, the Role and State displayed within the Members tab (Configuration ➤ Sites ➤ Servers ➤
Clusters) will not match the Server Role and Server State displayed in the Cluster Operation Output
Details section of the tab after you click Check Status or the output of the Check the state of a zone
from a browser on page 499 operation. To correct this mismatch, restart the zone by performing the
procedure Refresh (restart) a zone in a single zone enterprise on page 318 or Refresh (restart) zones in a
multizone enterprise on page 319, or if the UMS for the zone is not accessible, reboot both appliances at
the same time.
1. Click Tools ➤ Deployment ➤ Hardware Deployment.
2. In the Deployment Zones list, click the appropriate zone.
3. Within the Servers tab, click the appliance you are removing then click Remove Device.
4. In the Delete Confirmation message box, click Yes.
The system deletes the appliance and associated data from the database.

11.12 Remove a CDI from the database

Use this procedure to remove a turret, Pulse, or Unigy Soft Client from the Unigy enterprise database.
Prerequisite:
To prevent the CDI from re-registering with the zone after it is removed, disconnect it from the network
before you perform this procedure.
When you remove a CDI, the system deletes the CDI and all associated data from the database.
For information on moving a CDI to a different zone, refer to:
• Move an IQ/MAX or IQ/MAX Edge turret to a different zone on page 355
• Move a Pulse to a different zone on page 356
• Move a Unigy Soft Client to a different zone on page 358
• Move an IQ/MAX TOUCH turret to a different zone on page 359
1. Log in to the UMS.
2. Click Tools ➤ Deployment ➤ Hardware Deployment.
3. Within the Deployment Zones panel, click the zone from which you are removing the CDI.
4. Within the IQ/MAX & Edge, Soft Clients, Pulse, or IQ/MAX TOUCH tab, click the device then click
Remove Device.
5. In the Delete Confirmation message box, click Yes.

IPC Confidential Unigy 4.3

Enterprise Guide
362 11.13: Confirm that a device registered with a zone

The system deletes the CDI and associated data from the database. If you did not disconnect the CDI
as suggested in the Prerequisite section, within approximately three minutes it will re-register with the
zone configured on the CDI.

11.13 Confirm that a device registered with a zone

This topic describes how to determine whether a Converged Communications Manager (CCM),
Aggregated Converged Communications Manager (ACCM), or Media Manager (MM) appliance, or a
Media Gateway, turret, Pulse, or Unigy Soft Client registered with a zone.
To perform this procedure, your user account must have the IPC Project Manager or IPC Certified Tech
role assigned.
1. Within the UMS, click Tools ➤ Deployment ➤ Hardware Deployment.
2. In the Deployment Zones panel, click the zone with which the devices should be registered.
3. Click the appropriate tab for the type of device you are confirming: Servers (for CCMs, ACCMs, and
MMs), Media Gateways, IQ/MAX & Edge, Soft Clients, Pulse, or IQ/MAX TOUCH.
4. Within the tab you selected, confirm that the device is registered by locating it in the list.
A green check mark at the right side of the device entry indicates the device registration was
successful.

December 3, 2019 IPC Confidential

 363

12Database backup and restore

workflows
12.1 Create or schedule a new backup
Complete this procedure to create a backup job that runs immediately or to schedule a backup for a
future date.
Prerequisite:
If you are adding a scheduled backup job that will run at a specific date and time, review the current
scheduled jobs within the Schedule tab. You cannot schedule a job to run within 30 minutes of another
scheduled job.
If you are performing an Enterprise backup and Multi-tier Replication is enabled for the enterprise, it
should be enabled for all data centers in the enterprise before you perform the backup. To ensure that all
data is backed up, the backup should be performed from a portal zone.
Unigy supports backups to local and remote locations. Local backup jobs are stored in
the /var/opt/ipc/service_backup_restore directory of the controlling zone’s CCMs or
ACCMs. Remote backup jobs transfer the backup .tar file to a remote server after the backup completes.
Remote backup jobs ensure that backup files are available if the CCMs or ACCMs fail. For more
information on remote backup locations, see Remote storage of backup files on page 604 and Add or
edit a remote backup server on page 605.
The backup retention policy is enforced on local and remote backups when they are created. Each zone
should have a policy before creating backups.
An account that has one of the following roles is required to complete this procedure: Basic
Administrator, Advanced Administrator, IPC Project Manager, or IPC Certified Tech.
Consider the following:
• See Back up and restore considerations on page 601 for important information related to creating a
backup job.
• See Backup types on page 369 for information about what is included in the different types of backup
jobs.
• See Recommended backup types on page 371 for a table listing scenarios for creating a specific
backup.
• Restoring an Enterprise backup is a manual, command-line procedure that is required only if all zones
in an enterprise are being upgraded at the same time after the COP software was upgraded, if the
Unigy database is corrupted, or if data is lost following the loading of a database dump from an
earlier version that does not include data that was in the later version schema.
• See Back up and restore considerations on page 601 for an explanation of how Unigy recovers if one
zone is available and functioning.
• See the procedure, Restore an Enterprise backup file in a multizone enterprise on page 377 to better
understand what backups are necessary in the event of a catastrophic failure.

IPC Confidential Unigy 4.3

Enterprise Guide
364 12.1: Create or schedule a new backup

Caution
Run backup jobs during off-peak or non-business hours.

1. Log in to the UMS in the zone for which you are creating the backup.
If you are performing an Enterprise backup and Multi-tier Replication is enabled for the enterprise,
log in to the appropriate portal zone.
2. In the menu bar, click Tools ➤ Backup & Restore.
3. Click the Schedule tab.
The Schedule panel is displayed and lists the scheduled jobs.
4. Click Schedule Backup to create a new backup.
The Schedule New Backup Job panel is displayed. The fields that are shown depend on the values that
you select.
Figure 47: Schedule New Backup Job panel

5. In the Type list, select the type of backup job.

6. In Execute Backup on Zone, select the zone in which the backup job will run.
If partial replication is enabled, Archive all Zone backup jobs can run only in collector zones.
7. Select a Storage Type:
• Local saves the assembled backup data set in the default backup directory, /var/opt/ipc/
service_backup_restore, on the CCMs or ACCMs in the zone you selected in Execute
Backup on Zone.
• Remote saves the assembled backup data set in a directory on another server. Configured servers
are in the list. Click Edit to configure remote servers. For information on adding, changing, or
deleting remote servers, refer to Add or edit a remote backup server on page 605. In Remote
Server, select the server to which you want the backup file to be transferred.

December 3, 2019 IPC Confidential

 12.1: Create or schedule a new backup 365

8. Do one of the following for the User-Specific or Archive all Zone backup type:
• For User-Specific backups, click the Users button and select one or more users from the User
pop-up. Then click Assign.
• Click the sort arrow in the User pop-up to change the list’s order, or type a user’s name in the
Login Name text box at the top of this panel to dynamically filter the users displayed in this
panel.
• Click the blue icon next to a user in the User List box to remove that user from the list of those
to be backed up.
• For Archive all Zone backups, type a number in the Archive Scope field to specify how many
days of historical data to leave in each zone. All historical data prior to the number of days
specified is archived then removed from the database. For example, if the scope is 5, all historical
data that is older than five days is archived and removed from the database. The data that remains
in the database is available for reports and diagnostics. Due to potential performance issues that
can occur when certain default configuration data values are changed, do not retain more than
fourteen days of data.
9. Select one of the following in the Perform Backup list.
• Immediately: starts the process of assembling the backup data sets and begins the back up when
you click Save.
• At a Specific Time: delays the backup until a later date. Selecting this option enables the
Scheduled Date & Time field.
10. If you selected At a Specific Time in the previous step, complete the following to set a date and time.
This can be the specific date at which to run the backup job, or it can be the start date of a recurring
backup job.
a) Click the calendar icon next to the Scheduled Date & Time text box. The calendar popup opens
with the current date selected.
b) Edit the time by clicking the up and down arrows. The values are based on a 24 hour clock.
c) When the time is correct, select the date. Change the month, if necessary, before selecting the day.
Clicking a day closes the calendar popup and enters the selected date and time in the Scheduled
Date & Time text box.

Note
Cancel closes the calendar popup and clears the value in the Scheduled Date & Time text box.

11. Complete the following to schedule a recurring backup job:

a) Select the Recurring check box.
b) Select an interval for the scheduled backup job in the Interval list. The options are Daily, Weekly,
and Monthly. The date and time in the Scheduled Date & Time text box determines the time a
backup job is run for daily jobs; the day of the week and time for weekly jobs, and the numeric day
of the month and time for monthly jobs.
12. Optionally, type an informational note in the Note field.
13. Click Save.

One of the following occurs:

• If you selected Immediately for the Perform Backup/Restore field, click OK to close the message
box. Then click the Event History tab and click Refresh as necessary to track the status of the
backup or restore job.

IPC Confidential Unigy 4.3

Enterprise Guide
366 12.1: Create or schedule a new backup

• If you selected At A Specific Time for the Perform Backup/Restore field, the system displays the
job within the Schedule tab.
• If the job is scheduled to run within 30 minutes of another scheduled job, the system displays the
following error message:
Figure 48: Error when scheduled backup or restore jobs are scheduled too closely

Click OK, change the Scheduled Date & Time, and repeat this step.

12.1.1 Edit a scheduled backup or restore job

Complete this procedure to edit a scheduled backup job or a scheduled restore job.
Prerequisite:
To change the date or time that a scheduled backup will run, review the current scheduled jobs within
the Schedule tab. You cannot schedule a job to run within 30 minutes of another scheduled job.
Unigy supports both local and remote backups. Local backup jobs are stored in the /var/opt/ipc/
service_backup_restore directory of a zone’s CCM or ACCM. Remote backup jobs transfer the
backup .tar file to a remote server on completion. Remote backups ensure that backups are available
if the CCM or ACCM appliances fail. For more information about remote backup jobs, see Remote
storage of backup files on page 604 and Add or edit a remote backup server on page 605.
The backup retention policy is enforced on local and remote backups when they are created, and each
zone should have a policy before creating backups.
For important information related to backup and restore jobs, refer to Back up and restore
considerations on page 601.
An account that has one of the following roles is required to complete this procedure: Basic
Administrator, Advanced Administrator, IPC Project Manager, or IPC Certified Tech.

Note
Run backup and restore jobs during off-peak or non-business hours.

1. In the menu bar, click Tools ➤ Backup & Restore.

2. Click the Schedule tab.
The Schedule panel is displayed and lists the scheduled jobs.
3. Select the job you want to change and click Edit.
The Edit Scheduled Backup or Scheduled Restore Job panel is displayed. The current configuration of
the selected backup job is displayed. The following is an example of the page to edit a scheduled
user-specific backup job:

December 3, 2019 IPC Confidential

 12.1: Create or schedule a new backup 367

Figure 49: Edit Scheduled Backup or Scheduled Restore Job panel

Note
The Type, Storage Type, Remote Server, Enterprise, Instance, Zone, and Archive Scope(no. of days)
fields are read-only when editing a scheduled restore job. Remember too that only user and archive
backups can be scheduled restore jobs. Typically, scheduling restore jobs is not done on live systems.

4. For a scheduled backup job, select the backup type in the Type list. See Backup types on page 369
for information about what is included in the different types of backup jobs. See Recommended
backup types on page 371 for a table listing scenarios for using a specific backup.
5. In Execute Backup on Zone, select the zone in which the backup or restore job will run.
If partial replication is enabled, Archive all Zone backup or restore jobs can run only in collector
zones.
6. For scheduled backup jobs, select a Storage Type to change where the scheduled backup .tar file
will be stored:
• Local: saves the assembled backup data set in the default backup directory, /var/opt/ipc/
service_backup_restore, on the CCMs or ACCMs in the zone specified in Execute
Backup on Zone.
• Remote: saves the assembled backup data set in a directory on another server. Configured servers
are in the list. Click Edit to configure remote servers. See the procedure, Add or edit a remote
backup server on page 605 to work with the Remote Backup page.
7. Do one of the following for the User-Specific or Archive all Zone backup types:
• For User-Specific backups, click the Users button and select users from the User pop-up.
• Click the sort arrow in the User pop-up to change the list’s order, or type a user’s name in the
Login Name text box at the top of this panel to dynamically filter the zones displayed in this
panel.
• Click the blue icon next to a user in the User List box to remove that user from the list of those
selected for the scheduled job.

IPC Confidential Unigy 4.3

Enterprise Guide
368 12.1: Create or schedule a new backup

Note
For scheduled restore jobs, all users in the User List box will be restored unless you click the red
icon next to a user in the User List box to remove that user from the list of those scheduled to be
restored.

• For Archive all Zone backups, type a number in the Archive Scope field to specify how many
days of historical data to leave in each zone. All historical data prior to the number of days
specified is archived then removed from every zone. For example, if the scope is 5, all historical
data in every zone that is older than five days is archived and removed from the database. The data
that remains in the database is available for reports and diagnostics.
8. Select one of the following in the Perform Backup/Restore list.
• Immediately: runs the backup or restore job when you click OK.
• At a Specific Time: delays the backup or restore until a later date. Selecting this option enables the
Scheduled Date & Time field.
9. If you selected At a Specific Time in the previous step, complete the following to select a date and
time. This can be the specific date at which to run the job, or for a backup job, it can be the start date
of a recurring job.
a) Click the calendar icon next to the Scheduled Date & Time text box. The calendar popup opens
with the current date selected.
b) Edit the time by clicking the up and down arrows. The values are based on a 24 hour clock.
c) When the time is correct, select the date. Change the month, if necessary, before selecting the day.
Clicking a day closes the calendar popup and enters the selected date and time in the Scheduled
Date & Time text box.

Note
Cancel closes the calendar popup and clears the value in the Scheduled Date & Time text box.

10. Complete the following to schedule a recurring backup job:

a) Select the Recurring check box.
b) Select an interval for the scheduled backup job in the Interval list. The options are Daily, Weekly,
and Monthly. The date and time in the Scheduled Date & Time text box determines the time a
backup job is created for daily jobs; the day of the week and time for weekly jobs, and the numeric
day of the month and time for monthly jobs.

Note
Scheduled restore jobs cannot be recurring.

11. Optionally, type an informational or descriptive note in the Note field.

12. Click Save.

One of the following occurs:

• If you selected Immediately for the Perform Backup/Restore field, click OK to close the message
box. Then click the Event History tab and click Refresh as necessary to track the status of the
backup or restore job.
• If you selected At A Specific Time for the Perform Backup/Restore field, the system displays the
job within the Schedule tab.

December 3, 2019 IPC Confidential

 12.1: Create or schedule a new backup 369

• If the job is scheduled to run within 30 minutes of another scheduled job, the system displays the
following error message:
Figure 50: Error when scheduled backup or restore jobs are scheduled too closely

Click OK, change the Scheduled Date & Time, and repeat this step.

12.1.2 Backup types

The backup and restore features create complete or partial backups of the data stored in the Unigy
databases. Depending on the type of backup, it is possible to restore the data in the same zone or a
different zone as the one in which the backup was created.
The following are the supported backup types:
• User-All
• User-Specific
• Archive all Zone
• Enterprise

Note
Beginning with Unigy v2.0.1.5, Full and Local All Zones backups are no longer supported. Beginning with
Unigy v3.0, Local Zone backups are no longer supported. Recurring Full, Local Zone, and Local All
Zones backups that were scheduled in previous versions should be removed.

User backup
A user backup contains the configuration data of users in the Unigy database. This includes user account
details (role, license, codec, location), and end user feature settings (buttons, speakers, recording,
directory, contacts, reports, and other features). Restoring a user backup replaces or updates the current
data of the users being restored with data from the backup data set.
There are two types of user backups: User-Specific and User-All. A User-Specific backup contains the
data of one or more users selected for the backup. A User-All backup contains the data of every user in
the Unigy database that is replicated to every zone.

Archive all Zone backup

An Archive all Zone backup archives the data from the following tables:
• AccountChangeHistory
• AlertHistory
• AuthorizationFailureHistory
• BackupRestoreEvent
• CallRouteQuality
• CommunicationHistory

IPC Confidential Unigy 4.3

Enterprise Guide
370 12.1: Create or schedule a new backup

• CommunicationHistoryNote
• Job
• JobDetail
• JobParamValue
• LicensedFeatureAnonymousCheckoutHistory
• LicensedFeatureAssignedDeviceHistory
• LicensedFeatureAssignedUserHistory
• LoginHistory
• LogOffEventHistory
• LogOffEventLogOffEventHistoryLogOffEventHistoryMap
• MMCapacityHistory
• MMCapacityHistoryInterval
• PasswordChangeHistory
• ReportHistory
• VoiceQualityReport
When you set up an Archive all Zone backup, you specify the number of days of data to leave in the
database. The system backs up all data prior to this date then deletes the archived data from all
applicable zones. The backup runs only in the zone specified when you schedule the backup job. If the
enterprise consists of multiple realms and partial replication is enabled, the Archive all Zone backup
archives and purges only the data for the zones within the realm with which the specified zone is
associated. If the enterprise has a single realm, the backup purges the archived data from all of the zones
in the enterprise. When there are multiple realms, there should be an Archive all Zone backup
configured in a zone within each realm to ensure that archive data is backed up and cleared to prevent
memory overload issues.
When an Archive all Zone backup job is executed, the event history is cleared, therefore, there might be
more backups in the system than are displayed in event history. The archived data will not be available
for reporting unless you restore the data.

Important
Beginning with Unigy v2.0.1.5, archive backups use a different format to reduce the size of the
backup .tar file and the time required to back up and restore a file. This format is not backward
compatible, therefore, you cannot restore an Archive all Zone backup that was created prior to Unigy
v2.0.1.5 in a v2.0.1.5 or higher zone.

Enterprise backups
An Enterprise backup includes the Unigy database. If partial replication is not enabled, you can run the
backup from any zone, but to ensure that all data is backed up, always run the backup from a zone that
has the highest software version deployed. If partial replication is enabled, always run the backup from a
collector zone, which has the latest software version deployed. This ensures that history data for the
associated realm is backed up and minimizes the risk of losing data, which could happen if the backup
was of a lower database schema.
Restoring a backup of a lower version schema populates zones at higher schemas with default values for
the higher version tables and columns. This might require reentering the data configured previously for
the higher version zones.

December 3, 2019 IPC Confidential

 12.1: Create or schedule a new backup 371

An enterprise backup should be made after deploying an update in any zone of the Unigy enterprise to
be sure that there is a current backup of the latest database.

12.1.3 Recommended backup types

This topic describes when to use the different backup types in new or edited scheduled backup jobs.
This table is referenced in the following procedures:
• Create or schedule a new backup on page 363
• Edit a scheduled backup or restore job on page 366

Table 43: Recommendations for backups required in specific scenarios

Backup type Description

Enterprise backup This is a backup of the referenced Unigy database. This backup is required
only to recover from the failure of all appliances in an enterprise, to replace a
corrupt database, to restore the database after deploying an update that
requires new COP software for a single zone enterprise or when upgrading all
zones in the enterprise at the same time, or to recover data that is lost when a
zone with a higher version schema loads a database dump from a zone with a
lower version schema it does not include tables or columns that are in the
higher version schema.
Schedule an enterprise backup on a recurring basis, and store the
backup .tar file on a remote server, because backup files stored on failed
CCMs or ACCMs will not be available to restore.
Create an Enterprise backup after deploying an update so the data is not lost if
it is necessary to restore the Unigy database.
User-All This is a backup of the information for every user in the Unigy database of the
controlling zone that creates the backup. Replication ensures that every zone
has the same user information. Restoring this type of backup does not allow
the selection of some users to be restored, and is not recommended in most
scenarios. Use the Enterprise backup type instead.
User-Specific A User-Specific backup allows some users to be backed up and restored. In
most instances creating a User-Specific backup, not a User-All backup, is
recommended if the configuration of some users, especially their button
sheets, changes significantly.
Archive all Zone This is a backup of the communication history data from every zone, which
includes call history, users logging in and out, reporting history, system job
history, changes to user accounts, and backup and restore events. An archive
backup requires a scope, which is the number of days of historical data to
leave in the Unigy database. Historical data before the number of days entered
in the scope is backed up in an archive backup, then deleted from the
database.
This backup is useful for troubleshooting something that happened before the
data was archived and deleted from the database. The historical data for a
single zone or multizone Unigy enterprise must be restored before it can be
used for troubleshooting.

Note
Archived data is not available for reporting purposes.

IPC Confidential Unigy 4.3

Enterprise Guide
372 12.2: Restore data from a user or archive backup file

12.2 Restore data from a user or archive backup file

Only user and archive backup files can be restored from the UMS. Enterprise backups are restored by
running a command line script.
Prerequisite:
User and archive backup files can be restored from the local backup directory or a remote storage
location. If a remotely stored backup file is not listed within the Backup tab, upload the file to the
appliances in the zone for which you are restoring the backup by performing the procedure Upload a
backup file on page 611.
For important information related to restoring data, refer to Back up and restore considerations on page
601.
To restore enterprise backups, see the procedure Restore an Enterprise backup file in a multizone
enterprise on page 377 or Restore an Enterprise backup in a single zone on page 374.
When you restore user or archive data, the recommended procedure is to restore the data to a zone that
has the highest software version deployed to ensure that no data is lost due to schema differences.
However, in a mixed zone enterprise that includes Unigy v2.0.1 zones, data that was backed up in a
v2.0.1 zone must only be restored to a v2.0.1 zone. Data that was backed up in a higher version zone
must be restored in a higher version zone. This is required because different MySQL versions are
deployed.

Note
Perform restore operations during off-peak or non-business hours.

If you are restoring an Archive all Zone backup, the enterprise includes multiple realms, and partial
replication is enabled, restore the backup in a collector zone in the realm in which the backup was
created. The data will be restored only to the zone in which you run the restore. If other zones restart and
load the database from the zone in which you restored the archive data, the database dump will include
the restored data.
A user account that has one of the following roles is required to perform this procedure: Advanced
Administrator, IPC Project Manager, or IPC Certified Tech.
1. For an Archive all Zone restore, log in to the UMS in the zone in which you are restoring the archived
data.
For a user data restore, you can log in to any zone.
2. Click Tools ➤ Backup & Restore.
The Backup & Restore panel opens with the Backup tab selected. The Backup panel displays the
backup files currently stored by the system. For more information on the fields in this panel,
including filtering the list, see Backup & Restore: Backup on page 608.
3. Click a USER_DATA_SINGLE, USER_DATA_ALL or ALL_HISTORY_ALL_ZONES backup file in
the list.
4. Click Restore.
The Schedule New Restore Job panel opens.

December 3, 2019 IPC Confidential

 12.2: Restore data from a user or archive backup file 373

Figure 51: Backup & Restore - Schedule New Restore Job panel

5. If you are restoring user data, you can specify the users for whom you want to restore the data. To
remove users from the User List list, click the blue icon next to a user's name.
6. Select one of the following in Perform Restore.
• Immediately: starts the restore when you click OK.
• At a Specific Time: delays the restore until a later date. Selecting this option enables the
Scheduled Date and Time field.
7. If you selected At a Specific Time for Perform Restore, complete the following to select a date and
time to restore the backup:
a) Click the calendar icon next to the Scheduled Date & Time text box. The calendar popup opens
with the current date selected.
b) Edit the time by clicking the up and down arrows. The values are based on a 24 hour clock.
c) When the time is correct, select the date. Change the month, if necessary, before selecting the day.
Clicking a day closes the calendar popup and enters the selected date and time in the Scheduled
Date & Time text box.

Note
Cancel closes the calendar popup and clears the value in the Scheduled Date and Time text box.

8. Click OK.
• If the selected backup file has a different database schema from the current database schema the
Schema Version Upgrade dialog box opens:

IPC Confidential Unigy 4.3

Enterprise Guide
374 12.3: Restore an Enterprise backup in a single zone

Figure 52: Schema Version Upgrade dialog box

Click OK to continue; the system will migrate the data to the new schema. Click Cancel to close
the dialog box without restoring the backup file.
• If the Perform Restore selection is Immediately, the system displays a clock when it begins to
restore the backup file, then displays, Restore has been initiated successfully.
Click OK to continue. Click the Event History tab to track the status of the restore job. The Status
in the Event History panel changes to STARTED when the system begins restoring the data then
changes to COMPLETED when the restore is complete or FAILED if the restore is unsuccessful.
• If the Perform Restore selection is At a Specific Time, the system closes the Schedule New
Restore Job panel and returns to the Backup tab. Click the Schedule tab to view the restore job.

12.3 Restore an Enterprise backup in a single zone

This topic describes the procedure for restoring Enterprise backups in a single standalone zone or single
or peer HA zone to recover from corrupt data, to restore data that was lost when a higher version zone
loaded the database from a lower version zone in a mixed zone enterprise, or to restore data after
replacing the CCM or ACCM appliances following a zone hardware failure.
Restoring an Enterprise backup cannot be done from the UMS because services that the UMS requires
have to be stopped.
Prerequisites:
See Back up and restore considerations on page 601 for a description of what is backed up when a
backup file is created and when to use the restore feature.
The following are required to perform this procedure:
• A user account that has the IPC Certified Tech role assigned.
• The ability to log in to an appliance through SSH with root user account privileges to perform
restore and reboot procedures.
• A recent Enterprise database backup file. Check all backups stored locally, and if applicable, on all
remote servers to locate the most recent file.

December 3, 2019 IPC Confidential

 12.3: Restore an Enterprise backup in a single zone 375

• If necessary, obtain a new enterprise license file. A new license is required if you are restoring the
database after replacing CCM or ACCM appliances or if appliances were added or removed after the
backup you are restoring was created. If an appropriate license is not available, send a license request
to Westbrook Orders or the Project Manager in your region who is responsible for providing licenses.
• If possible, record the configuration for any scheduled recurring backup jobs. This is recommended
because after restoring an Enterprise backup, if the date for the currently scheduled job is prior to the
date the backup is restored, the scheduled backup job will not run because the date is in the past. For
recurring jobs, this prevents the next occurrence from being scheduled. This is especially important
for recurring Archive All Zone backups that help to prevent memory overload issues.
• If you are restoring an Enterprise backup in an enterprise where Blue Wave zones were deployed at
the time the backup was created then these zones were redeployed (reCOPed) and new Blue Wave
software was deployed, obtain the Blue Wave Director software DVD or access to the software ISO
file on an external data storage device. You must redeploy this software after the database is restored.
• If you are performing this procedure remotely, you must have the ability to power up an appliance
that was powered down.
• If you will be redeploying the Blue Wave Director software, be sure you have access to the Enterprise
Guide.
If you restore an Enterprise backup after redeploying the COP software, there will be no historical data
for software deployments prior to the reCOP within the Install, Rollback, or History tabs at Tools ➤
Deployment ➤ Software Deployment. This is because the local ISO files are no longer available on
the appliances in the zone.

Important
This is a service impacting procedure that requires disabling important services and multiple reboots. It
should not be performed during business hours.

1. Log in to the UMS.

2. Disable data replication for the zone by performing the procedure Disable data replication on page
498.

Important
Do not perform this step if you are restoring the database as part of the procedure Redeploy (reCOP)
a zone that must load the database from a lower version zone on page 333.

3. Click Tools ➤ Backup & Restore.

The Backup & Restore panel opens with the Backup tab selected. The Backup tab displays the backup
files currently stored by the system.
4. If the backup file you need to restore is not listed within the Backup tab, complete the procedure,
Upload a backup file on page 611.
5. Record the name and location of the backup file. This is generally /var/opt/ipc/
service_backup_restore.
6. For an HA zone, determine the IP addresses of the Active and Standby appliances by performing the
procedure Check the state of an HA zone from the UMS on page 500.
7. For an HA zone, do the following:
a) Access the command line on the Standby appliance.
b) Run the command su -lp then enter the appropriate password.

IPC Confidential Unigy 4.3

Enterprise Guide
376 12.3: Restore an Enterprise backup in a single zone

c) Power off the Standby appliance by running the init 0 command.

8. Access the command line on the Active appliance.
9. Run the command su -lp then enter the appropriate password.
10. Run the restore_unigy.sh script to restore the database.
The script is in /opt/ipc/service_backup_restore/scripts. Use one of the following
forms of the script. The first option writes the script output to the command line. The second option
writes the output to a text file.
• ./restore_unigy.sh -i BackupFileSpecification -t BackupType
• ./restore_unigy.sh -i BackupFileSpecification -t BackupType >
Filename.txt 2>&1
where:
• BackupFileSpecification is the fully-qualified path to the backup file recorded in step 5.
Using the default directory this is /var/opt/ipc/service_backup_restore/
backupFilename. .
• BackupType is the type of backup being restored (enterprise).
• Filename is the name of a text file to which the system sends the restore process output. This is
an optional parameter.
This is an example of the command to restore an Enterprise backup and write the output to a text
file: ./restore_unigy.sh -i /var/opt/ipc/service_backup_restore/
enterprise_wide_data_backup_2014-11-2_15-12-6.tar -t enterprise >
EnterpriseRestore.txt 2>&1.
11. After the restore completes, reboot the appliance by running the reboot command.
12. Monitor the state of the appliance until all of the services are running by performing the procedure
Check the state of a zone from a browser on page 499.
13. In an HA zone, do the following:
a) Power on the Standby appliance by pressing the power button on the front panel of the CCM or
ACCM. If you are working remotely, use iDRAC or ION.
b) Monitor the state of the Active and Standby appliances until all of the services are running by
performing the procedure Check the state of a zone from a browser on page 499.
14. Enable data replication for the zone by performing the procedure Enable data replication on page
497.
15. If a new enterprise license is required, install the license by performing the procedure Install an
enterprise license file on page 481.
16. Perform the procedure Validate a zone after a deployment, rollback, or other operations on page 638.
17. Make any adjustments that are required to accommodate changes that were made in the enterprise
after the backup you restored was created, for example, new, modified, or removed zones, CDIs,
Media Gateways, or other devices, users, lines, SMTP configuration, scheduled backups, and so
forth.
Be sure that there is a recurring Archive All Zone backup job scheduled for the zone to help prevent
memory overload issues. The date of the next event must be after the date you restored the database.
If it is not, reconfigure the backup job.
18. If you are redeploying the Blue Wave Director software, perform the procedure Deploy a Blue Wave
software update in an HA zone on both appliances simultaneously as described in the Enterprise

December 3, 2019 IPC Confidential

 12.4: Restore an Enterprise backup file in a multizone enterprise 377

Guide. See Deploy a Blue Wave software update in an HA zone on both appliances simultaneously on
page 116.

12.4 Restore an Enterprise backup file in a multizone enterprise

This topic describes how to restore an Enterprise database backup file when the database becomes
corrupted, is not available in at least one zone in a multizone enterprise, or is required for an upgrade
where the COP software is redeployed and all zones are being upgraded at the same time.
In most cases, as long as one zone is available and functioning, it is not necessary to restore an
enterprise backup file in a multizone enterprise because other zones can load the database from the
functioning zone.
Restoring an Enterprise backup cannot be done from the UMS because services that the UMS requires
have to be stopped.

Note
Because of MySQL differences, if you are restoring a Unigy v2.0.1 backup file, restore the backup in a
v2.0.1 zone. If you are restoring a higher version backup file, restore it in a higher version zone.

Prerequisites:
See Back up and restore considerations on page 601 for a description of what is backed up and when
restore should be used.
The following are required to perform this procedure:
• An enterprise that has at least one zone that is healthy and available.
• In a failed enterprise that did not have a functioning zone, this is the first zone to have a new
replacement CCM or ACCM installed and deployed. When possible, restore the database in the
same zone where the backup was created, or if this zone is not available, in a zone with the highest
software version.
• A user account that has the IPC Certified Tech role assigned.
• The ability to log in to an appliance through SSH with root user account privileges to perform
restore and reboot procedures.
• An Enterprise backup file of the functioning zone. A backup created by another zone can be used if
one for a specific zone does not exist or is not available. Restoring Enterprise backups created by
another zone is valid. In fact, if another zone has a more recent backup, it should be used to restore
the Unigy database. Be sure to check all backups stored on remote servers to locate the most current
backup.
• Restoring an Enterprise backup restores a copy of the Unigy database (ent.tar) as it existed when
the backup was created
• Licenses generated for a failed zone are in a backup of the Unigy database and are restored from
the Enterprise backup. Licenses generated for replacement hardware are installed after restoring a
backup of the Unigy database. Be sure to create a new Enterprise backup that includes the new
license files after the replacement system is fully functional.
• Record the enterprise name so you can compare it to the name after the database is restored. If the
name is not the same in all zones, data will not be replicated.
• If you are restoring an Enterprise backup and CCM or ACCM appliances were added or removed
after the backup was created, obtain the latest enterprise license file or request a new license by

IPC Confidential Unigy 4.3

Enterprise Guide
378 12.4: Restore an Enterprise backup file in a multizone enterprise

contacting Westbrook Orders or the Project Manager in your region who is responsible for providing
licenses.
• If possible, record the configuration for any scheduled recurring backup jobs. This is recommended
because after restoring an Enterprise backup, if the date for the currently scheduled job is prior to the
date the backup is restored, the scheduled backup job will not run because the date is in the past. For
recurring jobs, this prevents the next occurrence from being scheduled. This is especially important
for recurring Archive All Zone backups that help to prevent memory overload issues.
• If you are restoring an Enterprise backup in an enterprise where Blue Wave zones were deployed at
the time the backup was created then these zones were redeployed (reCOPed) and new Blue Wave
software was deployed, obtain the Blue Wave Director software DVD or access to the software ISO
file on an external data storage device. You must redeploy this software after the database is restored.
• If you will be redeploying the Blue Wave Director software, you have access to the Enterprise Guide.
If Multi-tier Replication is enabled, it must be enabled for all data centers in the enterprise, or the data
centers must be members of the default data center, before you perform the Enterprise restore and the
backup must be restored in a portal zone to ensure that the data is replicated properly.
If you restore an Enterprise backup after redeploying the COP software, there will be no historical data
for software deployments for the zone, prior to the reCOP, within the Install, Rollback, or History tabs
at Tools ➤ Deployment ➤ Software Deployment. This is because the local ISO files are no longer
available on the appliances in the zone. Version data for other zones might still be visible.

Important
This is a service impacting procedure that requires disabling important services and data replication
between the zones and multiple reboots. It should not be performed during business hours.

1. Log in to the UMS for the zone in which you are restoring the backup.
2. Click Tools ➤ Backup & Restore.
The Backup & Restore panel opens with the Backup tab selected. The Backup tab displays the backup
files currently stored by the system, including those on configured remote servers. Download or copy
remotely stored backups to a location that is accessible to the computer you are using to perform the
restore. See the procedure, Download a backup file on page 607 for the steps to do this.
3. If the backup file you need to restore is not listed within the Backup tab, complete the procedure,
Upload a backup file on page 611.
4. Record the location of the backup file. This is generally /var/opt/ipc/
service_backup_restore.
5. Perform the procedure Disable data replication on page 498 to disable replication.

Note
Perform the procedure for every zone in the enterprise. The last zone for which you disable replication
must be the zone where you are restoring the data.

6. Perform the procedure Check the state of a zone from a browser on page 499 for the zone in which
you are restoring the data. Determine which appliance is the Active appliance and which is the
Standby appliance and record their IP addresses.
If Multi-tier Replication is enabled for the enterprise, restore the backup in a portal zone.
7. Log in to the Standby appliance through SSH.
8. Run the command su -lp then enter the root user account password.

December 3, 2019 IPC Confidential

 12.4: Restore an Enterprise backup file in a multizone enterprise 379

9. Run the command init 0.

This powers off the Standby appliance.
10. Log in to the Active appliance through SSH.
11. Run the command su -lp then enter the root user account password.
12. Run the command cd /opt/ipc/service_backup_restore/scripts to change the
current directory.
13. Run the restore_unigy.sh script to restore the database.
The script is in /opt/ipc/service_backup_restore/scripts. Use one of the following
forms of the script. The first option writes the script output to the command line. The second option
writes the output to a text file.
• ./restore_unigy.sh -i BackupFileSpecification -t BackupType
• ./restore_unigy.sh -i BackupFileSpecification -t BackupType >
Filename.txt 2>&1
where:
• BackupFileSpecification is the fully-qualified path to the backup file recorded in step 4.
Using the default directory this is /var/opt/ipc/service_backup_restore/
backupFilename. The .tar extension applies to Unigy v2.0.1 or higher backup files and the .iso
extension applies to Unigy v2.0 files.
• BackupType is the type of backup being restored (enterprise).
• Filename is the name of a text file to which the system sends the restore process output. This is
an optional parameter.
This is an example of the command to restore an enterprise backup and write the output to a text
file: ./restore_unigy.sh -i /var/opt/ipc/service_backup_restore/
enterprise_wide_data_backup_2014-11-2_15-12-6.tar -t enterprise >
EnterpriseRestore.txt 2>&1.
14. After the restore completes, reboot the Active appliance by running the reboot command.
15. Monitor the state of the Active appliance until all of the services are running by performing the
procedure Check the state of a zone from a browser on page 499.
16. Power on the Standby appliance by pressing the power button on the front panel of the CCM or
ACCM. If you are working remotely, use iDRAC or ION.
17. Monitor the state of the Active and Standby appliances until all of the services are running by
performing the procedure Check the state of a zone from a browser on page 499.
18. Enable data replication for the zone in which you restored the database by performing the procedure
Enable data replication on page 497.
19. Repeat step 18 for each of the other zones in the enterprise. Wait for replication in one zone to
complete before you enable replication in the next zone.
20. Disable replication in all of the zones in the enterprise by performing the procedure Disable data
replication on page 498.
21. Perform the procedure Run the post_restore.sh script on page 614.
22. Enable replication in all of the zones in the enterprise, one zone at a time, by performing the
procedure Enable data replication on page 497.
In a mixed zone enterprise that includes Unigy v2.0.1 zones, enable replication in the v2.0.1 zones
before you enable replication in the higher version zones. In a non-mixed zone enterprise, enable

IPC Confidential Unigy 4.3

Enterprise Guide
380 12.5: Recover from a corrupt enterprise database in a multizone enterprise

replication first in the zone where you restored the database, then in the preferred zones, then in all
other zones.
23. Determine whether the enterprise name is the same in all zones at Configuration ➤ Enterprise ➤
System ➤ Enterprise. If it is not, perform the procedure Change the enterprise name on page 301.
The name must be the same in all zones to enable data replication.
24. If you are restoring a pre-Unigy v3.0 backup, run the
updateToneCadenceFreqForExistingInstances.sh script by performing the procedure
Run the updateToneCadenceFreqForExistingInstances.sh script on page 567.
25. If a new enterprise license is required, install the license by performing the procedure Install an
enterprise license file on page 481.
26. Perform the procedure Validate a zone after a deployment, rollback, or other operations on page 638.
27. Make any adjustments that are required to accommodate changes that were made in the enterprise
after the backup you restored was created, for example, new, modified, or removed zones, CDIs,
Media Managers, Media Gateways, NTP servers or other devices, users, lines, SMTP configuration,
scheduled backups, and so forth.
Be sure that there is a recurring Archive All Zone backup job scheduled for a zone within each realm
in the enterprise to help prevent memory overload issues. The date of the next event must be after the
date you restored the database. If it is not, reconfigure the backup job.
28. If you are redeploying the Blue Wave Director software, perform the procedure Deploy a Blue Wave
software update on both appliances in an HA zone simultaneously: .
• If you are using this procedure from the Enterprise Guide, refer to this topic: Deploy a Blue Wave
software update in an HA zone on both appliances simultaneously on page 116.
• If you are using this procedure from the Back Up and Restore Guide, refer to this topic in the
Enterprise Guide.

12.5 Recover from a corrupt enterprise database in a multizone enterprise

Although it is highly unlikely that the Unigy enterprise data that is replicated throughout a multizone
enterprise would become corrupt, it is possible that this could happen. This topic describes how to
recover from this situation by restoring an enterprise database backup to one zone and replicating it to
all other zones.
Prior to performing this procedure, the following must be true:
• All active zones are functional.
• You selected a zone to which you will restore the database. The data will be replicated from this zone
to all other zones. Ideally, this zone should have the most recent version of theUnigy software
deployed.
• A recent, valid enterprise database backup file is available on a remote data store and you have the
file name and path. Ideally, this should be a backup of a database that includes the latest version of
theUnigy database schema. If the database backup was not created in the zone to which you are
restoring the data, copy the file to the /var/opt/ipc/service_backup_restore/ directory
on the primary appliance in the zone.
• If you are restoring an enterprise backup and CCM or ACCM appliances were added or removed
after the backup was created, obtain the latest enterprise license file or request a new license by
contacting Westbrook Orders or the Project Manager in your region who is responsible for providing
licenses.

December 3, 2019 IPC Confidential

 12.5: Recover from a corrupt enterprise database in a multizone enterprise 381

• If you are restoring an enterprise backup in an enterprise where Blue Wave zones were deployed at
the time the backup was created then these zones were redeployed (reCOPed) and new Blue Wave
software was deployed, obtain the Blue Wave Director software DVD or access to the software ISO
file on an external data storage device. You must redeploy this software after the database is restored.
• If you will be redeploying the Blue Wave Director software, you have access to the Enterprise Guide.

Important
This is a service impacting procedure that requires disabling important services and data replication
between the zones and multiple reboots. It should not be performed during business hours.

1. Perform the procedure Disable data replication on page 498 to disable replication.

Note
Perform the procedure for every zone in the enterprise. The last zone for which you disable replication
must be the zone where you are restoring the data.

2. Log out of the UMS in all zones except the zone in which you are restoring the backup database.
3. Perform the procedure Check the state of a zone from a browser on page 499 for the zone in which
you are restoring the data. Determine which appliance is the Active appliance and which is the
Standby appliance and record their IP addresses.
4. Log in to the Standby appliance through SSH.
5. Run the command su -lp then enter the root user account password.
6. Run the command init 0.
This powers off the Standby appliance.
7. Log in to the Active appliance through SSH.
8. Run the command su -lp then enter the root user account password.
9. Run the command cd /opt/ipc/service_backup_restore/scripts to change the
current directory.
10. Run the restore_unigy.sh script to restore the database.
The script is in /opt/ipc/service_backup_restore/scripts. Use one of the following
forms of the script. The first option writes the script output to the command line. The second option
writes the output to a text file.
• ./restore_unigy.sh -i BackupFileSpecification -t BackupType
• ./restore_unigy.sh -i BackupFileSpecification -t BackupType >
Filename.txt 2>&1
where:
• BackupFileSpecification is the fully-qualified path to the backup file you identified in
the prerequisites. Using the default directory this is /var/opt/ipc/
service_backup_restore/backupFilename. The .tar extension applies to Unigy v2.0.1
or higher backup files and the .iso extension applies to Unigy v2.0 files.
• BackupType is the type of backup being restored (enterprise).
• Filename is the name of a text file to which the system sends the restore process output. This is
an optional parameter.
This is an example of the command to restore an enterprise backup and write the output to a text
file: ./restore_unigy.sh -i /var/opt/ipc/service_backup_restore/

IPC Confidential Unigy 4.3

Enterprise Guide
382 12.5: Recover from a corrupt enterprise database in a multizone enterprise

enterprise_wide_data_backup_2014-11-2_15-12-6.tar -t enterprise >

EnterpriseRestore.txt 2>&1.
11. After the restore completes, reboot the Active appliance by running the reboot command.
12. Monitor the state of the Active appliance until all of the services are running by performing the
procedure Check the state of a zone from a browser on page 499.
13. Power on the Standby appliance by pressing the power button on the front panel of the CCM or
ACCM. If you are working remotely, use iDRAC or ION.
14. Monitor the state of the Active and Standby appliances until all of the services are running by
performing the procedure Check the state of a zone from a browser on page 499.
15. Monitor the state of the appliances until all of the services are running by performing the procedure
Check the state of a zone from a browser on page 499.
16. Enable data replication for the zone in which you restored the database by performing the procedure
Enable data replication on page 497.
17. Repeat step 16 for each of the other zones in the enterprise. Wait for replication in one zone to
complete before you enable replication in the next zone.
18. Disable replication in all of the zones in the enterprise by performing the procedure Disable data
replication on page 498.
19. Perform the procedure Run the post_restore.sh script on page 614.
20. Enable replication in all of the zones in the enterprise, one zone at a time, by performing the
procedure Enable data replication on page 497.
In a mixed zone enterprise that includes Unigy v2.0.1 zones, enable replication in the v2.0.1 zones
before you enable replication in the higher version zones. In a non-mixed zone enterprise, enable
replication first in the zone where you restored the database, then in the preferred zones, then in all
other zones.
21. If a new enterprise license is required, install the license by performing the procedure Install an
enterprise license file on page 481.
22. Perform the procedure Validate a zone after a deployment, rollback, or other operations on page 638.
23. Make any adjustments that are required to accommodate changes that were made in the enterprise
after the backup you restored was created, for example, new, modified, or removed zones, CDIs,
Media Managers, Media Gateways, or other devices, users, lines, and so forth.
24. If you are redeploying the Blue Wave Director software, perform the procedure Deploy a Blue Wave
software update on both appliances in an HA zone simultaneously: .
• If you are using this procedure from the Enterprise Guide, refer to this topic Deploy a Blue Wave
software update in an HA zone on both appliances simultaneously on page 116.
• If you are using this procedure from the Back Up and Restore Guide, refer to this topic in the
Enterprise Guide.

December 3, 2019 IPC Confidential

 383

13Image backup and restore workflows

13.1 Image backup and restore (rollback) overview
An image backup, also known as a rollback point, disk image, or restore point, is a backup of an entire
drive that is saved in Unix dump format. It is a complete backup of the software and database, including
configuration, role, and state data, for an appliance at a specific point in time.
The purpose of an image backup is to provide the ability to restore an appliance to a previous condition
if it becomes corrupted, unstable, inaccessible, or for any other reason is in an undesirable state.

Important
Because different COP software is supported in pre-Unigy v3.0 and v3.0 or higher versions, you cannot
restore a v2.x image in a v3.0 or higher zone. To restore a v2.x image on a v3.0 appliance, you must
reCOP the appliance with the v2.0 COP software (02.00.00.00.1888) then restore the v2.x image. For
additional information, refer to Restore a CCM, ACCM, or MM disk image from the command line on
page 393.

An image backup can be created manually at an appropriate time, such as before making major
configuration changes, or automatically by the system prior to or after deploying the personality
software or during deployment of an update. The system creates a rollback point before and after
deployment of the personality software if the Back-up check box is selected in Personality Deployer. It
creates a rollback point before an upgrade if the Create Server Backup Image check box is selected.
Enabling the system to create the rollback points before and after Personality Deployer is run makes it
possible for you to remotely restore the appliances to the software state that existed prior to running
Personality Deployer or prior to running Zone Deployer. If these rollback points are not available, it
might be necessary to return to the customer site to redeploy (reCOP) the appliances.
If you selected the wrong personality, HA specification, zone VIP, or country base for an appliance, you
can roll back to the rollback point that was created before Personality Deployer was run. If you need to
rerun Zone Deployer to correct the zone type or zone ID, you can roll back to the rollback point created
after Personality Deployer was run.
The state of an appliance after a rollback is based on the state of the appliance at the time the image
backup was created. The system is not aware that a rollback occurred, so it is important to carefully
analyze the enterprise to determine whether remediation procedures are required. For example, changes
made to the zone after the rollback point was created, such as adding users or devices, might have to be
reapplied. Also, the role and state of the appliance might be different from what they were prior to the
rollback and a different license might be required. It might also be necessary to perform a failover, rearm
the appliance, or reboot one or both appliances to bring the zone to a healthy state. It might be necessary
to reboot multiple times to bring the appliance to the correct state. In a multizone enterprise, the
database that is restored during the rollback will be replaced by the enterprise database.
Before you begin a rollback, check the Tech Portal articles, Unigy Product Compatibility Matrix, and if
applicable, patch release notes to determine whether there are any rollback limitations or issues that you
need to be aware of before rolling back. Also, determine the rollback point to which you need to roll
back.

IPC Confidential Unigy 4.3

Enterprise Guide
384 13.1: Image backup and restore (rollback) overview

Important
Unless you are planning to redeploy one or both appliances in the zone, do not roll back to the rollback
point that was created prior to or after the personality software deployment because at these points you
cannot access the UMS.

If you are rolling back the appliances in an HA zone from the UMS, you always perform the procedure
on the Standby appliance. If the Standby appliance is not the appliance you need to roll back, perform a
manual HA failover to make the Active appliance the Standby appliance then perform the rollback.
However, if you are rolling back both appliances in an HA zone to a previous software version, you
must perform the rollback on both appliances from the command line. Unigy does not support rollback
of both appliances to a different software version from the UMS.
The image backup files are stored in /var/spool/backup/system-backup on each appliance.
This partition is not affected by a rollback, so the rollback points are always preserved. Within the
Software Deployment Rollback tab, the UMS displays the rollback points for the Standby appliance. To
display the rollback points, do one of the following:
• From the UMS, access the Rollback tab at Tools ➤ Deployment ➤ Software Deployment. To
display the rollback points for the Active appliance, perform a manual HA failover to make the
Active appliance the Standby appliance then click the Rollback tab.
• Locate the rollback points from the command line:
1. Access the command line on the appliance you are rolling back.
2. Change the directory to /var/spool/backup/system-backup.
3. List the directory contents.
The rollback point directories are named based on the date and time the rollback point was created; for
example, 2014-02-19-10-10-23. To view the contents of a rollback point, do one of the following:
• From the UMS:
1. Click Tools ➤ Deployment ➤ Software Deployment.
2. Within the Rollback tab, click the rollback point. The contents are displayed in the Description
panel.
• If you cannot access the UMS:
1. Access the appliance command line.
2. Change the directory to /var/spool/backup/system-backup.
3. Run the command /opt/ipc/cop/tools/deployment_rollback.sh –l
restorePoint, where restorePoint is the name of the image backup directory; for
example: /opt/ipc/cop/tools/deployment_rollback.sh –l
2014-02-19-10-10-23. If you use the Tab key to enter the rollback point directory, back
space to remove the slash at the end of the command.

Important
If you store an image backup file on an external storage device, create an archive (.tar) file that includes
the image backup directory and the /var/spool/backup/rollback_points.lst file. Both
files are required to restore an image backup.

December 3, 2019 IPC Confidential

 13.2: Create an image backup (restore point) from the UMS 385

After a rollback is complete, always check the zone status and confirm that the correct software version
is deployed. If Media Gateways are involved, check the CAS files and INI file and other configuration
properties.

13.2 Create an image backup (restore point) from the UMS

A disk image, also know as a rollback point or restore point, is a backup of an entire drive that is saved
in Unix dump format. The image and the rollback_points.lst file include everything required to
restore the system to its state at the time the image was created. This topic describes how to create a
rollback point for a CCM or ACCM appliance from the UMS, and if you are saving the rollback point to
a remote storage device, how to compress and copy the image file.
An image backup is typically performed automatically as part of the personality deployment and update
deployment processes. Although this is an optional procedure, IPC recommends that you create the
backup to ensure that you can restore the appliance software if the deployment fails.

Important
If you are manually creating the image to enable you to restore the system if a patch that requires a new
COP is unsuccessful, copy the required files to an external data storage device because all data on the
appliance will be lost when you deploy the COP.

In an HA zone, perform this procedure on both the primary and secondary CCMs or ACCMs in the
zone.

Caution
This is a service impacting procedure that should be performed when the zone is not being used to
process configuration and call requests.

1. Disable device registration by performing the procedure Disable device registration on page 497.
2. Disable data replication in the zone for which you are creating the image backup by performing the
procedure Disable data replication on page 498.
3. Place the cluster into maintenance mode by performing the procedure Place a cluster into
maintenance mode to enable control of HA failovers on page 598.
4. Place the Standby appliance into maintenance mode by performing the procedure Place an appliance
or Media Gateway into maintenance mode to indicate it is unavailable on page 599.
5. Click Tools ➤ Deployment ➤ Software Deployment.
6. On the Rollback tab, click Create an Image Backup.
7. Click Continue then in the Information box, click OK.
The appliance reboots and performs the backup. The backup takes approximately 45 minutes to
complete.
8. If applicable, compress the image backup directory and copy it to a remote storage device. Perform
this step for each appliance for which you are creating an image.
a) Access the appliance command line and enter the dynamic password from Password Manager.
b) Run the command su -lp and enter the dynamic password.
c) Run the command cd /var/spool/backup/system-backup.
d) Run the command ls -l.

IPC Confidential Unigy 4.3

Enterprise Guide
386 13.3: Roll back a personality or zone deployment

e) Within the list of displayed backup image directories, confirm that a directory for the image you
just created is in the list and that the image files are in the directory.
The directories are in date-time-stamp format, for example, 2017-02-14-12-59-30. Record
this directory name. You will substitute this name for date-time-stamp in the tar command
in the next step and in the directory path in step 8g.
f) Run the following commands to create the compressed archive of the image directory you
recorded in the previous step. The tar command captures the correct hostname and all files
required for rollback, including the rollback_points.lst file that includes a list of all
available rollback points.
1. cd /var/spool/backup.
2. tar cvjf ${HOSTNAME}_date-time-stamp.tar.bz2 rollback_points.lst
system-backup/date-time-stamp, where date-time-stamp is the name
of the image backup directory you are compressing.
This process can take 30 minutes or more to complete.
g) Use an FTP utility such as WinSCP or SFTP/SCP to copy the compressed image file you created
in the previous step, /var/spool/backup/hostname_date-time-stamp.tar.bz2 to
a secure destination on a remote storage device.
9. Take the Standby appliance out of maintenance mode by performing the procedure Take an appliance
or Media Gateway out of maintenance mode on page 600.
10. Indicate that the Standby appliance maintenance is complete by performing the procedure Indicate
that maintenance on the Standby appliance is complete on page 601.
11. If you are creating a rollback point for the second appliance in the zone, do the following:
a) Perform an HA failover to make the Active appliance the Standby appliance by performing the
procedure Force an HA failover on page 546.
b) Repeat steps 4 through 10 for the second appliance.
12. Take the cluster out of maintenance mode by performing the procedure Take a cluster out of
maintenance mode to resume normal HA operation on page 599.
13. Enable data replication by performing the procedure Enable data replication on page 497.
14. Enable device registration by performing the procedure Enable device registration on page 496.

13.3 Roll back a personality or zone deployment

If the Back-up check box within Personality Deployer is selected during deployment of the appliance
personality software, the system creates two restore points: one before the personality software
deployment and one after the deployment. If you discover an issue with the personality or zone
deployment, you can roll back to the appropriate restore point.
For overview information on restore points and the rollback procedures, refer to Image backup and
restore (rollback) overview on page 383.
The ability to roll back eliminates the need to redeploy the COP software and reconfigure the network
settings, and possibly deploy the personality software. If a problem occurs, such as deploying the wrong
personality for an appliance, assigning the wrong country base, or not indicating that the zone is part of
an HA pair, roll back to the point just before Personality Deployer was run. If you specified the wrong
the zone ID and only have to rerun Zone Deployer, you can roll back to the point after the personality
software was deployed.

December 3, 2019 IPC Confidential

 13.4: Roll back the software on the appliance in a Unigy or Blue Wave standalone zone 387

If you need to change the appliance network configuration, you can rerun Network Configurator after
rolling back to the restore point that was created before Personality Deployer ran, but you will not have
access to all of the Network Configurator screens. To ensure that you can make all required changes,
consider redeploying the COP software, which provides access to all of the screens.
Prerequisite:
Determine whether you need to roll back to the point before Personality Deployer was run or after it
completed. To rerun Personality Deployer, rollback to the first restore point. To rerun Zone Deployer,
roll back to the second restore point.

Note
You can perform this procedure only if Personality Deployer created the restore points. To determine
whether the restore points images were created, review the contents of the /var/spool/backup/
system-backup directory. The restore point directories are named based on the date and time the
image was created; for example, 2014-02-19-10-10-23.

1. Perform the procedure Restore a CCM, ACCM, or MM disk image from the command line on page
393.
2. After the rollback completes, reboot the appliance by running the command reboot.
3. Confirm that the rollback restored to the correct point by accessing the URL https://
appliance_ip in a browser. appliance_ip is the IP address of the appliance you rolled back:
You should see either Personality Deployer or Zone Deployer depending on the restore point you
selected. If Personality Deployer opened, you should see the following attribute values when you
click the Host Info button; these indicate that only the COP software is deployed:
• Personality not an Application Server
• Personality is not ACCM
• Personality is not CCM
• Personality is not MM
• COP Software Version: appropriate version; for example, 02.00.00.00.1888 (for v2.x zones) or
03.00.00.00.1272 (for v3.x zones)
• Unigy Software Version:
• Personality Type: COP

13.4 Roll back the software on the appliance in a Unigy or Blue Wave
standalone zone
This procedure describes how to roll back the software on the appliance in a standalone zone if problems
are encountered.
Within this topic, the terms current version and current software version refer to the Unigy software
version specified on the cover of this document. References to previous Unigy versions apply to the
versions, patches, service packs, and hotfixes for these versions that the current version supports.
For overview information on restore points and the rollback procedures, refer to Image backup and
restore (rollback) overview on page 383.
To use this procedure, there must a restore point to which you can roll back. This can be a manual image
backup or the restore point the system creates prior to deploying an update. This restore point is created
when you select the Create Server Backup Image check box during the update deployment.

IPC Confidential Unigy 4.3

Enterprise Guide
388 13.4: Roll back the software on the appliance in a Unigy or Blue Wave standalone zone

For information on rolling back an upgrade in an HA zone, refer to Roll back the software on the
appliances in a Unigy or Blue Wave HA zone from the UMS on page 389.

Caution
This is a service impacting procedure that should be performed when the zone is not being used to
process configuration and call requests.

1. Log in to the UMS.

2. Place the appliance into maintenance mode by performing the procedure Place an appliance or
Media Gateway into maintenance mode to indicate it is unavailable on page 599.
3. Click Tools ➤ Deployment ➤ Software Deployment.
4. Within the Rollback tab, click the restore point that was created just before the upgrade then click
Rollback.

Important
Do not attempt to roll back to a restore point that Personality Deployer created, because this returns to
a point before the UMS was available and requires redeployment of the zone.

5. In the Confirmation box, click Execute.

6. In the Information box, click OK.
During the rollback, the appliance reboots and the connection to the CCM or ACCM is unavailable.
The restore takes approximately 60 minutes.
7. Determine the state of the zone:
a) Check the state of the zone by performing the procedure Check the state of a zone from a browser
on page 499.
b) Determine whether the appliance is in maintenance mode by clicking Tools ➤ Deployment ➤
Hardware Deployment, select the appropriate zone then within the Servers tab, click the
appliance. If the Switch to Maintenance Mode button is visible, the appliance is not in
maintenance mode. If the Switch to Active Mode button is visible, click the button to return the
appliance to active mode.
c) Confirm that device registration is enabled by performing the procedure Enable device registration
on page 496.
This step does not apply to dedicated Blue Wave zones. Device registration should not be enabled
for these zones.
d) Determine whether the zone is in maintenance mode. If it is, take it out of maintenance mode by
performing the following procedures:
• Reenable SNMP forwarding for a zone on page 596.
• Take a zone out of maintenance mode to reenable BCP plan activation on page 598.
e) Perform the procedure Validate a zone after a deployment, rollback, or other operations on page
638.
8. Do one of the following:
• If you are not retrying the upgrade, do the following as applicable—this does not apply to
dedicated Blue Wave zones:
• If you rolled back from the current software version update, perform the procedure Downgrade
(roll back) the CDI software on page 562.

December 3, 2019 IPC Confidential

 13.5: Roll back the software on the appliances in a Unigy or Blue Wave HA zone from the UMS 389

• If you rolled back from the current software version to Unigy v2.0, perform the procedures
Downgrade the Media Gateway software on page 572 and Downgrade (roll back) the CDI
software on page 562.
• If you rolled back from the current software version to Unigy v2.0 and there are custom reports,
delete then re-upload the reports by performing the procedures Delete a custom report on page
696 and Edit and upload report on page 695.
• If you are retrying the upgrade, rerun the applicable software update deployment procedure.

13.5 Roll back the software on the appliances in a Unigy or Blue Wave HA
zone from the UMS
This procedure describes how to roll back the software on the appliances in an HA zone from the UMS
if problems are encountered.
Within this topic, the terms current version and current software version refer to the Unigy software
version specified on the cover of this document. References to previous Unigy versions apply to the
versions, patches, service packs, and hotfixes for these versions that the current version supports.
For overview information on restore points and the rollback procedures, refer to Image backup and
restore (rollback) overview on page 383.
This procedure applies to the following scenarios:
• When a configuration issue, problem with a Media Gateway, other non-fatal issues, or completion of
a test plan makes it desirable to roll back one or both appliances in the zone to a restore point that is
at the same software version as the current version.
• When the upgrade of one appliance in the zone produces undesirable results that require a roll back to
the previous software version. This is supported if only one appliance in the zone was upgraded. You
cannot use the UMS to roll back both appliances in a zone to a previous software version because
after you roll back the first appliance there is a version mismatch that prevents failover and rollback
of the second appliance.
For information on rolling back the software in HA zones that are not included in these scenarios or if
the rollback fails or cannot be performed due to the state of the appliance(s) you are rolling back, refer to
the procedure Restore a CCM, ACCM, or MM disk image from the command line on page 393. For
information on rolling back the software in a standalone zone, refer to Roll back the software on the
appliance in a Unigy or Blue Wave standalone zone on page 387.
Prerequisite:
Before you begin a rollback, determine the restore point to which you need to roll back.

Important
Unless you are planning to redeploy one or both appliances in the zone, do not roll back to the restore
points created by Personality Deployer because at these points you cannot access the UMS.

Within the Software Deployment Rollback tab, the UMS displays the restore points for the Standby
appliance. To display the restore point for the Active appliance either failover to make the Active
appliance the Standby appliance or do the following:
1. Log in to the Active appliance through SSH.
2. Change the directory to /var/spool/backup/system-backup.

IPC Confidential Unigy 4.3

Enterprise Guide
390 13.5: Roll back the software on the appliances in a Unigy or Blue Wave HA zone from the UMS

3. List the directory contents. The restore point image directories are named based on the date and time
the image was created; for example, 2014-02-19-10-10-23.
This procedure applies to single HA zone and multizone enterprises.

Caution
This is a service impacting procedure that should be performed when the zone is not being used to
process configuration and call requests. If it is necessary to perform the procedure during business
hours, activate the BCP plan before you begin to redirect the lines and CDIs to backup zones.

If you are performing this procedure for a single appliance in the zone, be sure that the appliance is the
Standby appliance. If it is not, force an HA failover to make it the Standby appliance then perform steps
1 through 11 and steps 14 through 18.
1. Log in to the UMS with the zone VIP.
2. In a multizone enterprise, if a BCP plan that includes the zone is configured for automatic failover
and you want to prevent the zone from failing over, place the zone into maintenance mode by
performing the procedure Place a zone into maintenance mode to disable BCP plan activation on
page 597.
3. Place the cluster into maintenance mode by performing the procedure Place a cluster into
maintenance mode to enable control of HA failovers on page 598.
4. Place the Standby appliance into maintenance mode by performing the procedure Place an appliance
or Media Gateway into maintenance mode to indicate it is unavailable on page 599.
5. Click Tools ➤ Deployment ➤ Software Deployment.
6. Within the Rollback tab, click the restore point to which you want to roll back then click Rollback.
7. In the Confirmation box, click Execute.
8. In the Information box, click OK.
During the rollback, the Standby appliance reboots and the connection to the CCM or ACCM is
unavailable. The time required for the restore to complete varies based on the size of the database;
however, it usually requires at least 60 minutes.
9. When the rollback is complete, perform the procedure Check the state of a zone from a browser on
page 499.
Determine whether the following are true for the Standby appliance you rolled back:
• Server Role is STANDBY.
• Server State is Maintenance_Available or Maintenance_Unavailable.
• Service Status for all services is RUNNING.
• Remarks value for all services, except Replicator, is Change role completed.
If these conditions are not true, do the following to attempt to bring the appliance to the expected
state.
• If the Server Role is ACTIVE, reboot the Standby appliance. After the reboot, the Server Role
should be STANDBY.
• If the Server Role is UNKNOWN and the Server State is FAILED, perform the procedure Rearm
the Standby appliance on page 547. After the rearm, the Server Role should be STANDBY and the
Server State should be MAINTENANCE_AVAILABLE or MAINTENANCE_UNAVAILABLE.

December 3, 2019 IPC Confidential

 13.6: Create a disk image backup from the command line 391

• If the Server State is AVAILABLE, place the appliance into maintenance mode by performing the
procedure Place an appliance or Media Gateway into maintenance mode to indicate it is
unavailable on page 599. The Server State should become MAINTENANCE_UNAVAILABLE.
If you cannot bring the appliance to the correct state, reboot both appliances by performing the
procedure Reboot CCM on page 587. or if you cannot access the UMS, skip the remaining steps in
this procedure and use the procedure Restore a CCM, ACCM, or MM disk image from the command
line on page 393 to roll back the second appliance. If you are performing this step after rolling back
the second appliance,
10. If the Server State is MAINTENANCE_UNAVAILABLE, perform the procedure Take an appliance or
Media Gateway out of maintenance mode on page 600.
11. Perform the procedure Indicate that maintenance on the Standby appliance is complete on page 601.
If you are rolling back the software for only one appliance, proceed to step 14.
12. Perform an HA failover to make the Active appliance the Standby appliance by performing the
procedure Force an HA failover on page 546.
13. Repeat steps 4 through 11 for the Standby appliance.
14. Perform the procedure Take a cluster out of maintenance mode to resume normal HA operation on
page 599.
15. Determine whether the zone is in maintenance mode. If it is, take it out of maintenance mode by
performing the following procedures:
• Reenable SNMP forwarding for a zone on page 596.
• Take a zone out of maintenance mode to reenable BCP plan activation on page 598.
16. Confirm that device registration is enabled by performing the procedure Enable device registration
on page 496.
17. Confirm that data replication is enabled by performing the procedure Enable data replication on page
497.
18. Perform the procedure Validate a zone after a deployment, rollback, or other operations on page 638.
19. Do one of the following:
• If you are not retrying the upgrade, do the following as applicable—this does not apply to
dedicated Blue Wave zones:
• If you rolled back from the current software version update, perform the procedure Downgrade
(roll back) the CDI software on page 562.
• If you rolled back from the current software version to Unigy v2.0, perform the procedures
Downgrade the Media Gateway software on page 572 andDowngrade (roll back) the CDI
software on page 562.
• If you rolled back from the current software version to Unigy v2.0 and there are custom reports,
delete then re-upload the reports by performing the procedures Delete a custom report on page
696 and Edit and upload report on page 695.
• If you are retrying the upgrade, rerun the applicable software update deployment procedure.

13.6 Create a disk image backup from the command line

A disk image, also know as a rollback point or restore point, is a backup of an entire drive that is saved
in Unix dump format. The image and the rollback_points.lst file include everything required to
restore the system to its state at the time the image was created. This topic describes how to manually

IPC Confidential Unigy 4.3

Enterprise Guide
392 13.6: Create a disk image backup from the command line

create a rollback point for a CCM or ACCM appliance from the appliance command line, and if you are
saving the rollback point to a remote storage device, how to compress and copy the image file.
Typically, an image backup is created during initial deployment by selecting the Back-up option within
the Personality Deployer application, during upgrade by selecting Create a server backup image, or
manually from the UMS with the procedure Create an image backup (restore point) from the UMS on
page 385. Perform this procedure only if you cannot create an image backup from the UMS.
To perform this procedure, you must be able to obtain dynamic passwords with Password Manager.
For overview information on image backups and the backup and restore procedures, refer to Image
backup and restore (rollback) overview on page 383.
For information on restoring an image backup from the command line, refer to Restore a CCM, ACCM,
or MM disk image from the command line on page 393.

Important
If you are creating the image to enable you to restore the system if a patch that requires a new COP is
unsuccessful, copy the required files to an external data storage device because all data on the appliance
will be lost when you deploy the COP.

Caution
This is a service impacting procedure that should be performed when the zone is not being used to
process configuration and call requests.

1. Access the command line on the appliance for which you are creating the image backup.
2. Run the command su -lp and enter the dynamic password.
3. Run the command /opt/ipc/cop/tools/deployment_backup.sh.
The image backup for the current appliance is created. This operation takes approximately 45
minutes.
Image backup files are stored on the CCM or ACCM in the directory /var/spool/backup/
system-backup/. Sub-directories are named using the date and time, such as:
2017-03-06-14-12-18, indicating March 6, 2017 at 2:12:18 PM. Do not rename the directory or
any of the associated files.
4. To view the properties of an image backup, run the command /opt/ipc/cop/tools/
deployment_rollback.sh -p backup-directory –l, where backup-directory is
the name of the image backup directory.
Note that it is a lowercase letter L after the dash. You can also type --list.
The system displays output similar to the following:

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

<dir:rollbackLists xmlns:dir="http://www.ipc.com/
SoftwarePackage.xsd"
xmlns: xsi="http://
www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://
www.ipc.com/SoftwarePackage.xsd SoftwarePackage.xsd ">
<rollbackList>
<rollbackPoint>2011-06-06-14-12-18</rollbackPoint>
<userComment>Initial ISO deploy</userComment>
<iSOName>Prior to Minimal Deployment of
dunkin_00.00.00.10.0136.iso</iSOName>

December 3, 2019 IPC Confidential

 13.7: Restore a CCM, ACCM, or MM disk image from the command line 393

<description> Partial RPM list at image time, will rollback

to this..
srvadmin-smcommon-6.3.0-233.1.el5
ipc-cop-harden-00.00.00.10.0136-1
srvadmin-cm-6.3.0-2075
...
net-snmp-5.3.2.2-7.el5
dbus-1.1.2-12.el5
</description>
</rollbackList>
</dir:rollbackLists>

You are looking for the data in the rollbackPoint element(s).

5. To store the image backup directory, and the rollback_points.lst file that is required to
restore the image backup, to an external data storage device, perform this step to compress the files
and copy the resulting .tar file to the remote device.
a) Run the command cd /var/spool/backup/system-backup.
b) Run the command ls -l.
c) Within the list of displayed backup image directories, confirm that a directory for the image you
just created is in the list and that the image files are in the directory.
Record the directory name. You will substitute this name for date-time-stamp in the tar
command in the next step and in the directory path in step 5e.
d) Run the following commands to create the compressed archive of the image directory you
recorded in the previous step. The tar command captures the correct hostname and all files
required for rollback, including the rollback_points.lst file that contains a list of all
available rollback points.
1. cd /var/spool/backup.
2. tar -cvjf ${HOSTNAME}_date-time-stamp.tar.bz2
rollback_points.lst system-backup/date-time-stamp, where date-
time-stamp is the name of the image backup directory you are
compressing.
This process can take 30 minutes or more to complete.
e) Use an FTP utility such as WinSCP or SFTP/SCP to copy the compressed image file you created
in the previous step, /var/spool/backup/hostname_date-time-stamp.tar.bz2 to
a secure destination on a remote storage device.

13.7 Restore a CCM, ACCM, or MM disk image from the command line
This topic describes how to restore a disk image backup (rollback point, restore point) from the
command line when it is not possible to perform the rollback from the UMS.
Within this topic, the terms current version and current software version refer to the Unigy software
version specified on the cover of this document. References to previous Unigy versions apply to the
versions, patches, service packs, and hotfixes for these versions that the current version supports.
For overview information on image backups and the backup and restore procedures, refer to Image
backup and restore (rollback) overview on page 383.
Use this procedure for the following scenarios:

IPC Confidential Unigy 4.3

Enterprise Guide
394 13.7: Restore a CCM, ACCM, or MM disk image from the command line

• You want to roll back to the restore point where only the COP or COP and Personality software are
deployed.
• You cannot access the UMS.
• You are rolling back the CCM or ACCM appliances in an HA zone to the restore point that was
created prior to an upgrade where both appliances were upgraded and both need to be rolled back. If
you upgraded only one of the appliances in the zone, you can use this procedure or the procedure Roll
back the software on the appliances in a Unigy or Blue Wave HA zone from the UMS on page 389.
• You are downgrading the Media Manager software to a previous version.

Note
If you deployed the MM software and upgrades with Single Click Deployment, no images will be
available to restore. In this situation, redeploy the MM.

Prerequisites
Use one of the following methods to locate and record the name of the image backup you are restoring
—the image directories are named based on the date and time the image was created; for example,
2017-02-19-10-10-23:
• For CCM or ACCM images, if you can access the UMS, click Tools ➤ Deployment ➤ Software
Deployment then within the Rollback tab, locate the appropriate Rollback Point. In an HA zone, the
system displays only the Standby appliance restore points.
• If you cannot access the UMS, or in an HA zone, need to view the Active appliance restore points, or
need to view MM restore points, locate the image backup from the command line:
1. Access the command line on the appliance you are rolling back.
2. Change the directory to /var/spool/backup/system-backup.
3. List the directory contents.
• If the image backup file is in a compressed archive (.tar) file stored on an external data storage
device, locate the file on that device. The name should be in one of the following formats based on
the method you used to create the archive file–date-time-stamp is the name of the image
backup directory and host-name is the host name of the appliance that was backed up.
• date-time-stamp.tar: Includes the entire /var/spool/backup directory, which
includes all image backup files in the /var/spool/backup/system-backup directory and
the /var/spool/backup/rollback_points.lst file that contains a list of all available
restore points.
• host-name_date-time-stamp.tar.bz2: Includes either the entire /var/spool/
backup directory or a specific image backup directory from /var/spool/backup/
system-backup and the /var/spool/backup/rollback_points.lst file.
To display the archive file contents to obtain the image backup file name, run the command tar -
tvf file-name, where file-name is the name of the archive file.
The full /var/spool/backup directory or the specific image backup directory and the
rollback_points.lst file are required to restore the image.
If you are restoring a pre-Unigy v3.0 image on a v3.0 or higher appliance, obtain a Unigy v2.x COP
(02.00.00.00.1888) software DVD. This is required because the Unigy v2.0 and Unigy v3.0 COP
software are not compatible, so you must reCOP the appliance(s) with the v2.0 COP software before
restoring the v2.x image backup. Locate the v2.x image archive file you want to restore. This should be

December 3, 2019 IPC Confidential

 13.7: Restore a CCM, ACCM, or MM disk image from the command line 395

stored on an external data storage device. If the image backup archive file was not saved to an external
location prior to upgrading to Unigy v3.0 or higher you will not be able to restore the 2.x appliance
image.

Note
This is a service impacting procedure that should be performed when the zone is not being used to
process configuration and call requests. If it is necessary to perform the procedure during business
hours, activate the BCP plan before you begin to redirect the lines and CDIs to backup zones.

It is not necessary to disable replication or place the zone or appliance into maintenance mode. If you
are rolling back both appliances in an HA zone, you can restore them at the same time; it is not
necessary to wait for the restore of one appliance to complete before you start the restore on the other
appliance.

Note
The system does not display a confirmation prompt before running the rollback script, so be certain that
you are ready to roll back before you run the script.

1. In a multizone enterprise, if a BCP plan that includes the zone in which you are restoring the image is
configured for automatic failover and you want to prevent the zone from failing over, place the zone
into maintenance mode by performing the procedure Place a zone into maintenance mode to disable
BCP plan activation on page 597.
2. Save or print the output from the following command to help you identify the Unigy version and
event associated with each of the rollback image files listed in the rollback_points.lst file.
cat /var/spool/backup/rollback_points.lst
3. Do one of the following according to whether you are restoring an image for an appliance at the same
COP software version as the current version or an image that was created with a previous COP
version:
• If you are restoring an image for an appliance at the same version as the current COP software (for
example, a v3.0 image on an appliance with the v3.0 COP), do the following:
1. Log in through the command line to the appliance on which you are restoring the image. Obtain
the dynamic password with Password Manager.
2. Run the command su -lp then enter the dynamic password.
• If you are restoring a Unigy v2.x image on a v3.0 or higher appliance, do the following:
1. Deploy the Unigy v2.0 COP software on the appliance by performing the procedure Deploy the
COP (Common Operating Platform) software on page 448.
2. Configure the appliance network settings by performing the procedure Configure the appliance
network settings with Network Configurator on page 450.
3. Log in through the command line to the appliance on which you are restoring the image.
4. Run the command su -lp then enter the root user account password.
4. If you copied a compressed image archive (.tar) file for the image backup to an external data
storage device, do the following to copy and extract the archive:
a) Use an FTP utility, such as WinSCP or SFTP/SCP, to copy the .tar file to the /tmp directory on
the appliance you are rolling back. This is necessary because of the system file permissions. The

IPC Confidential Unigy 4.3

Enterprise Guide
396 13.7: Restore a CCM, ACCM, or MM disk image from the command line

file will be one of the following based on whether you archived the entire /var/spool/
backup directory or a specific image backup directory:
• The entire image backup directory /var/spool/backup with the file naming convention
date_time_stamp.tar or host_name_date_time_stamp.tar.bz2.
• The specific image directory from /var/spool/backup/system-backup and the
rollback_points.lst file with the file naming convention hostname_date-time-
stamp.tar.bz2.
b) Move the .tar file from the /tmp directory to one of the following directories:
• If you are moving the archive for the entire /var/spool/backup directory, move the file to
the /var/spool directory.
• If you are moving the archive for the specific image directory, move the file to the /var/
spool/backup/ directory.
c) Extract the image files by running the following commands:
1. Change the current directory:
• If you are restoring the full backup directory, /var/spool/backup/, run the command
cd /var/spool.
• If you are restoring the specific image directory, run the command cd /var/spool/
backup/.
2. Extract the files by running one of the following commands, depending on the compression
option used, where file-name is the name of the .tar file.
• tar xvjf file-name.tar
• tar xvjf file-name.tar.bz2
5. Change the current directory to /var/spool/backup/system-backup.
6. If you want to review the contents of the image backup before you perform the restore, run the
command /opt/ipc/cop/tools/deployment_rollback.sh –l restorePoint.
restorePoint is the name of the image backup directory you recorded in the prerequisites. For
example: /opt/ipc/cop/tools/deployment_rollback.sh –l
2017-02-19-10-10-23. If you use Tab to enter the restore point directory, back space to remove
the slash at the end of the command.
7. Perform the rollback by running the rollback script with the command /opt/ipc/cop/tools/
deployment_rollback.sh –p restorePoint.
restorePoint is the name of the image backup directory you recorded in the prerequisites. For
example: /opt/ipc/cop/tools/deployment_rollback.sh –p
2017-02-19-10-10-23. If you use Tab to enter the restore point directory, back space to remove
the slash at the end of the command.
The restore takes approximately 30 minutes.
8. In an HA zone, if you are rolling back the software on the second CCM or ACCM appliance in the
zone, repeat the previous steps for the second appliance.
9. If you rolled the appliance back to the restore point that was created prior to running Personality
Deployer, rerun Personality Deployer. If you rolled back to the restore point that was created after
Personality Deployer completed, run Zone Deployer. If you rolled back a software update or rolled
back to a manually created restore point, determine the state of the zone:

December 3, 2019 IPC Confidential

 13.7: Restore a CCM, ACCM, or MM disk image from the command line 397

a) Check the state of the zone by performing the procedure Check the state of a zone from a browser
on page 499.
• If the Server Role for both appliances in an HA zone is UNKNOWN, the Server State is
FAILED, and the Replicator service is in the Failed state, reboot both appliances then
recheck the state of the zone.
• If the zone is an HA zone and the appliance Server State is Maintenance_Available or
Maintenance_Unavailable, the cluster is in maintenance mode. If the cluster is in
maintenance mode, check the Server Role to determine which appliance is the Standby
appliance.
b) Determine whether the appliance in a single appliance zone, or the Standby appliance in an HA
zone is in maintenance mode by clicking Tools ➤ Deployment ➤ Hardware Deployment, select
the appropriate zone then within the Servers tab, click the appliance. If the Switch to Maintenance
Mode button is visible, the appliance is not in maintenance mode. If the Switch to Active Mode
button is visible, click the button to return the appliance to active mode.
c) If the Standby appliance Server Role is UNKNOWN and the Server State is FAILED, perform the
procedure Rearm the Standby appliance on page 547.

Note
It might be necessary to reboot the appliances multiple times to bring the zone into the correct
state, especially in a multizone enterprise, for example, to make the Standby appliance the Active
appliance to match the state in the restored database.

d) If the HA cluster is in maintenance mode, perform the following procedures to take it out of
maintenance mode:
1. Indicate that maintenance on the Standby appliance is complete on page 601.
2. Take a cluster out of maintenance mode to resume normal HA operation on page 599.
e) Confirm that device registration is enabled by performing the procedure Enable device registration
on page 496.
This step does not apply to dedicated Blue Wave zones. Device registration should not be enabled
for these zones.
f) Confirm that data replication is enabled by performing the procedure Enable data replication on
page 497.
g) Determine whether the zone is in maintenance mode, and if it is, take it out of maintenance mode
by performing the following procedures:
• Reenable SNMP forwarding for a zone on page 596.
• Take a zone out of maintenance mode to reenable BCP plan activation on page 598.
h) Perform the procedure Validate a zone after a deployment, rollback, or other operations on page
638.
10. Do one of the following:
• If you are not retrying the upgrade, do the following as applicable—this does not apply to
dedicated Blue Wave zones:
• If you rolled back from the current software version update, perform the procedure Downgrade
(roll back) the CDI software on page 562.

IPC Confidential Unigy 4.3

Enterprise Guide
398 13.7: Restore a CCM, ACCM, or MM disk image from the command line

• If you rolled back from the current software version to Unigy v2.0, perform the procedures
Downgrade the Media Gateway software on page 572 and Downgrade (roll back) the CDI
software on page 562.
• If you rolled back from the current software version to Unigy v2.0 and there are custom reports,
delete then re-upload the reports by performing the procedures Delete a custom report on page
696 and Edit and upload report on page 695.
• If you are retrying the upgrade, rerun the applicable software update deployment procedure.

December 3, 2019 IPC Confidential

 399

14Network change workflows

14.1 Change a zone VIP
If it is necessary to change the Virtual IP Address (VIP) for an HA zone, complete this procedure, which
changes the VIP and the connections to the VIP from Media Managers (MMs), Media Gateways (MGs),
and CDIs (turrets, Pulse devices, and Soft Clients)

Important
If you are also making other network-related changes, such as changing an appliance IP address,
perform those procedures after you change the VIP.

After you change the VIP, do the following as applicable:

• For a zone with Media Managers, change the value in the Network Configurator PeerReg.Host field
to point to the new VIP.
• Change the VIP references on the DHCP server for dynamically programmed turrets and Pulse
devices that are registered with the zone.
• Change the VIP reference on each statically programmed turret and Pulse, and all Soft Clients that are
registered with the zone.
For standalone zones, the turrets, Pulse devices, and Soft Clients refer to the appliance IP address rather
than the VIP. For information on updating CDI devices that are associated with a standalone zone, refer
to Change the IP address for a CCM or ACCM in a single appliance zone on page 412.
The VIP change you make on the Primary appliance is replicated to the Secondary appliance and to all
other zones in the enterprise. Do not disable data replication during this procedure.

Caution
This is a service impacting procedure. IPC recommends that you perform this procedure after business
hours.

1. Log in to the zone for which you are changing the VIP: https://vip.
2. If Multi-tier Replication is enabled and the zone for which you are changing the VIP is a portal zone,
disable Multi-tier Replication for the associated data center by performing the procedure Disable
Multi-tier Replication on page 246.
3. If the Primary appliance (the appliance in the cluster with the lower IP address) is not the Active
appliance, force a failover to make it the Active appliance by performing the procedure Force an HA
failover on page 546.
4. Change the VIP:
a) Place the cluster into maintenance mode by performing the procedure Place a cluster into
maintenance mode to enable control of HA failovers on page 598.
b) Place the Standby appliance into maintenance mode by performing the procedure Place an
appliance or Media Gateway into maintenance mode to indicate it is unavailable on page 599.

IPC Confidential Unigy 4.3

Enterprise Guide
400 14.1: Change a zone VIP

c) Log in to the UMS on the Primary appliance in the zone for which you are changing the VIP. Use
the Primary appliance IP address: https://appliance_ip.
d) Click Configuration ➤ Enterprise ➤ System ➤ Zones.
e) In the Zones list, click the zone for which you are changing the VIP.
f) In the VIP Address and Certificate Authority IP fields, type the new VIP then click Save.
g) Log in to Primary (Active) appliance from the command line.
h) Run the command su -lp then enter the appropriate password.
i) Run Network Configurator on the Primary appliance by running the script /opt/ipc/cop/
network_configurator/scripts/network_configurator.sh.
j) Advance through each screen, without making any changes, then on the last screen, click Finish to
save the changes. .
The system displays the prompt, Do you want to execute CCM IP change scripts
k) Type y then press Enter.
The system runs a series of scripts that update the database. This might take several minutes.
l) When the Primary appliance is up, reboot the (Secondary (Standby) appliance.
m) When the Secondary appliance is up, display the contents of the /etc/hosts file and monitor
the value of the wlsv-host attribute until it changes to the new VIP.
n) Run Network Configurator on the Secondary appliance by running the script /opt/ipc/cop/
network_configurator/scripts/network_configurator.sh.
o) Advance through each screen, without making any changes. Within the last screen, click Finish.
The system displays the prompt, Do you want to execute CCM IP change scripts
p) Type y then press Enter.
The system runs a series of scripts that update the database. This might take several minutes.
q) Log in to the UMS with the new zone VIP: https://vip.
r) Take the Standby appliance out of maintenance mode by performing the procedure Take an
appliance or Media Gateway out of maintenance mode on page 600.
s) Indicate that the maintenance is complete by performing the procedure Indicate that maintenance
on the Standby appliance is complete on page 601.
t) Take the cluster out of maintenance mode by performing the procedure Take a cluster out of
maintenance mode to resume normal HA operation on page 599.
u) Monitor the state of the appliances in the zone by performing the procedure Check the state of a
zone from a browser on page 499.
If the zone's Active appliance Server Role is UNKNOWN, the Server State is FAILED, and the
Replicator service fails, reboot the Active appliance.
v) When the checkHAStatus Server State for both appliances is AVAILABLE, reboot the Standby
appliance.
w) Monitor the state of the appliances in the zone by performing the procedure Check the state of a
zone from a browser on page 499.
x) Confirm that both appliances are in Active Mode by accessing them in Hardware Deployment as
described in the procedure Take an appliance or Media Gateway out of maintenance mode on page
600. If one or both appliances are in Maintenance Mode, complete the procedure to place the
appliance(s) into Active Mode.

December 3, 2019 IPC Confidential

 14.1: Change a zone VIP 401

5. Change the VIP reference for each Media Manager (MM) in the zone:
a) Place the MM appliance into maintenance mode by performing the procedure Place an appliance
or Media Gateway into maintenance mode to indicate it is unavailable on page 599 .
b) Log in to the MM from the command line.
c) Run the command su -lp then enter the appropriate password.
d) Run Network Configurator by running the script /opt/ipc/cop/
network_configurator/scripts/network_configurator.sh.
e) Update the PeerReg.Host field with the new VIP. Do not change any of the other values.
f) Press Tab until the Next button is selected then press Enter.
g) Proceed through the remaining screens, without making changes, then on the last screen, click
Finish to save the changes.
The system displays the prompt Do you want to execute CCM IP change scripts.
h) Type y then press Enter.
The system runs a series of scripts that update the database. This might take several minutes.
i) Reboot the MM.
j) Return the MM to normal operation by performing the procedure Take an appliance or Media
Gateway out of maintenance mode on page 600.
k) If the MM you rebooted is in a Virtual Machine (VM), refer to Reapply the license for an MM in a
VM after a reboot on page 590.
6. Update DHCP servers, if necessary.
a) If the zone uses DHCP server option 66 to assign IP addresses to turrets and Pulse devices, change
the appliance VIP address specified for option 66 (tftp-server-name) on the DHCP server.
b) If the zone uses DHCP server option 112 to assign IP addresses to turrets and Pulse devices and
this zone is a registration coordinator, update the DHCP server configuration with the new VIP
address and update the Subnet in Mass Edit Client, if necessary.
c) If option 42 for the NTP server is configured with the CCM or ACCM IP address, change that
value as well.
d) Reboot each turret and Pulse to update the IP address. For information on rebooting multiple
devices, refer to Reboot communication devices on page 591.
For information on configuring a DHCP server, refer to the IQ/MAX Turret Hardware Installation
Manual, IQ/MAX Edge Turret Hardware Installation Manual, or Pulse Hardware Installation Manual.
7. Change the VIP reference on each statically programmed turret that is registered with the zone.
a) Log in to the turret.
b) Press the Shortcuts button.
c) Press More.
d) Press Admin.
e) Enter the Admin password then press Next.
f) Press Configure Network.
g) Press Servers.
h) Press Set Values Manually.

IPC Confidential Unigy 4.3

Enterprise Guide
402 14.2: Move the appliances in an HA zone to a different network

i) Press CCM.
j) Replace the existing VIP with the new VIP.
k) Press Save.
l) Press Save.
m) Press Save.
n) Press Commit.
o) Press OK.
p) Reboot the turret to update the VIP value by pressing Previous ➤ Restart Station ➤ Restart.
As an alternative method, you can reboot all of the turrets simultaneously, after you have changed
the VIP on all of them, by performing the procedure Reboot communication devices on page 591.
8. Change the VIP reference on each statically programmed Pulse that is registered with the zone.
a) Log in to the Pulse.
b) From the Application Launch Pad, tap Settings.
c) In the toolbar, tap Admin, enter the administrator password, then tap done.
d) In the toolbar, tap Network.
e) If Enable DHCP is ON, turn it OFF to enable the CCM Ip Address field.
f) In the CCM Ip Address field, tap within the text box, type the new VIP then tap done.
g) If Enable DHCP was enabled, turn it back ON.
h) Scroll to the bottom of the screen then tap Save Changes.
If you changed the Enable DHCP setting, the system prompts you to restart the Pulse.
i) Tap Restart. If you are not prompted to restart the Pulse, scroll to the bottom of the screen and tap
Restart Station.
9. Change the VIP reference on each Unigy Soft Client that is registered with the zone.
a) On the Microsoft Windows desktop, click Start ➤ All Programs ➤ IPC Systems Inc ➤ Unigy
Client Configuration Tool.
b) In the Primary field, type the new VIP then click Save.
c) If you were logged in to the Soft Client when you made this change, log out then log in to
implement the change.
10. If you disabled Multi-tier Replication in step 2, reenable it by performing the procedure Enable
Multi-tier Replication on page 243.

14.2 Move the appliances in an HA zone to a different network

Perform this procedure when it is necessary to move the Converged Communications Manager (CCM)
or Aggregated Converged Communications Manager (ACCM) appliances in an HA zone to a different
network. The procedure applies to network changes within the same backroom location and changes that
involve moving the appliances to a new location.
To change an appliance network configuration, you rerun Network Configurator. Network Configurator
is an application that enables you to configure appliance network settings and store them in the Unigy
database. It is run during initial appliance deployment and can be rerun as needed to make changes to
the initial configuration.

December 3, 2019 IPC Confidential

 14.2: Move the appliances in an HA zone to a different network 403

During the reconfiguration process, change only the IP Address, Subnet Mask, Default Gateway, or
PeerReg.Host fields. For information on navigating through the Network Configurator screens, refer to
Configure the appliance network settings with Network Configurator on page 450. When you rerun
Network Configurator, the system does not display all of the screens that were displayed during the
initial deployment.
After you change the VIP and IP addresses, do the following, as applicable, to enable other devices to
access the zone:
• Change the value of the Network Configurator PeerReg.Host field on all Media Manager (MM)
appliances in the zone to point to the new zone VIP.
• Change the VIP references on the DHCP Servers to update dynamically programmed turrets and
Pulse devices that are registered with the zone.
• Change the VIP reference on each statically programmed turret and Pulse, and all Soft Clients that are
registered with the zone.

Caution
This is a service impacting procedure that should be performed only when the zone is not involved in
processing calls or other requests.

1. Log in to the UMS in the zone for which you are changing the network configuration.
2. If Multi-tier Replication is enabled and the zone you are moving is a portal zone, disable Multi-tier
Replication for the associated data center by performing the procedure Disable Multi-tier Replication
on page 246.
3. Confirm that data replication is enabled for the zone by performing the procedure Enable data
replication on page 497. If replication is not enabled, enable it.
4. Place the zone you are configuring into maintenance mode and disable alert forwarding to the GSOC
and customer NMSs.
• Place a zone into maintenance mode to disable BCP plan activation on page 597
• Disable SNMP forwarding for a zone on page 596
5. Change the zone VIP and IP addresses in the UMS.
a) If the Primary appliance (the appliance in the cluster with the lower IP address) is not the Active
appliance, force a failover to make it the Active appliance by performing the procedure Force an
HA failover on page 546.
b) Place the cluster into maintenance mode by performing the procedure Place a cluster into
maintenance mode to enable control of HA failovers on page 598.
c) Place the Standby appliance into maintenance mode by performing the procedure Place an
appliance or Media Gateway into maintenance mode to indicate it is unavailable on page 599.
d) Log in to the UMS on the Primary appliance in the zone you are reconfiguring. Use the Primary
appliance IP address: https://appliance_ip.
e) Click Configuration ➤ Enterprise ➤ System ➤ Zones.
f) In the Zones list, click the zone you are configuring.
g) If you are moving the appliances to a different location, change the Backroom Location to the
new location.

IPC Confidential Unigy 4.3

Enterprise Guide
404 14.2: Move the appliances in an HA zone to a different network

h) In the VIP Address and Certificate Authority IP fields, type the new VIP.
i) In the ACCM/CCM1 Server IP Address and ACCM/CCM2 Server IP Address fields, type the new
IP addresses for the Primary and Secondary appliances then click Save.
6. If you are moving the appliances to a different location, shut down both appliances and move them to
the new location. If you are not moving the appliances, proceed to the next step.
After you move the appliances, continue with the remaining steps in this procedure. For information
on removing the hardware from the current backroom and installing it in the new backroom, refer to
the Common Appliance Platform Onsite Installation Manual.
7. Change the network configuration on both CCM or ACCM appliances.
Perform this procedure on both appliances at the same time.
a) Log in to each appliance from the command line.
b) Run the command su -lp then enter the appropriate password.
c) Start Network Configurator by running the script /opt/ipc/cop/
network_configurator/scripts/network_configurator.sh.
d) Within the Backroom Network Interface-1 Configuration screen, change the IP Address,
PeerReg.Host, Subnet Mask, and Dflt Gateway fields, as necessary.
e) Press Tab until the Next button is selected then press Enter.
f) Proceed through the remaining screens, without making any changes, then within the last screen,
click Finish to save the changes.
The system displays the prompt Do you want to execute CCM IP change
scripts?
g) Type y then press Enter.
The system runs a series of scripts that update the database. This takes several minutes.
h) Monitor the state of the appliances in the zone by performing the procedure Check the state of a
zone from a browser on page 499.
If the Server Role or Server State of either appliance are not correct or any of the services fail,
rerun Network Configurator on both appliances at the same time and instruct it to run the CCM IP
change scripts. Network Configurator can be run as many times as necessary.
i) Log in to the UMS with the zone VIP.
j) Take the Standby appliance out of maintenance mode by performing the procedure Take an
appliance or Media Gateway out of maintenance mode on page 600.
k) Indicate that the maintenance is complete by performing the procedure Indicate that maintenance
on the Standby appliance is complete on page 601.
l) Take the cluster out of maintenance mode by performing the procedure Take a cluster out of
maintenance mode to resume normal HA operation on page 599.
m) Monitor the state of the appliances in the zone by performing the procedure Check the state of a
zone from a browser on page 499.
If the zone's Active appliance Server Role is UNKNOWN, the Server State is FAILED, and the
Replicator service fails, reboot the Active appliance.
n) When the checkHAStatus Server State for both appliances is AVAILABLE, reboot the Standby
appliance.

December 3, 2019 IPC Confidential

 14.2: Move the appliances in an HA zone to a different network 405

o) Monitor the state of the appliances in the zone by performing the procedure Check the state of a
zone from a browser on page 499.
p) Confirm that both appliances are in Active Mode by accessing them in Hardware Deployment as
described in the procedure Take an appliance or Media Gateway out of maintenance mode on page
600. If one or both appliances are in Maintenance Mode, complete the procedure to place the
appliance(s) into Active Mode.
8. If the zone includes Media Managers, change the PeerReg.Host value on all MMs in the zone:
a) Place each MM appliance in the zone into maintenance mode by performing the procedure Place
an appliance or Media Gateway into maintenance mode to indicate it is unavailable on page 599.
b) Log in to the MM appliance through SSH.
c) Run the command su -lp and enter the root user account password to obtain root user
privileges.
d) Start Network Configurator by running the script /opt/ipc/cop/
network_configurator/scripts/network_configurator.sh.
e) Within the Backroom Network Interface-1 Configuration screen, type the new zone VIP in the
PeerReg.Host field, and if the MM also has new network settings, change the IP Address,
Subnet Mask, and Dflt Gateway.
f) Press Tab until the Next button is selected then press Enter.
g) Proceed through the remaining screens, without making changes, then within the last screen, click
Finish to save the changes.
The system displays the prompt Do you want to execute CCM IP change
scripts?
h) Type y then press Enter.
The system runs a series of scripts that update the database. This takes several minutes.
i) Reboot the appliance.
j) Return the MM appliance to normal operation by performing the procedure Take an appliance or
Media Gateway out of maintenance mode on page 600.
9. Update DHCP servers, if necessary.
a) If the zone uses DHCP server option 66 to assign IP addresses to turrets and Pulse devices, change
the appliance VIP address specified for option 66 (tftp-server-name) on the DHCP server.
b) If the zone uses DHCP server option 112 to assign IP addresses to turrets and Pulse devices and
this zone is a registration coordinator, update the DHCP server configuration with the new VIP
address and update the Subnet in Mass Edit Client, if necessary.
c) If option 42 for the NTP server is configured with the CCM or ACCM IP address, change that
value as well.
d) Reboot each turret and Pulse to update the IP address. For information on rebooting multiple
devices, refer to Reboot communication devices on page 591.
For information on configuring a DHCP server, refer to the IQ/MAX Turret Hardware Installation
Manual, IQ/MAX Edge Turret Hardware Installation Manual, or Pulse Hardware Installation Manual.
10. If statically programmed turrets are registered with the zone, change the zone VIP on each turret:
a) If you are logged on to the turret, press the Shortcuts button then press More.
b) Press Admin.
c) Enter the Admin password then press Next.

IPC Confidential Unigy 4.3

Enterprise Guide
406 14.2: Move the appliances in an HA zone to a different network

d) Press Configure Network.

e) Press Servers.
f) Press Set Values Manually.
g) Press CCM.
h) Replace the existing VIP with the new VIP.
i) Press Save.
j) Press Save.
k) Press Save.
l) Press Commit.
m) Press OK.
n) Reboot the turret to update the VIP value by pressing Previous ➤ Restart Station ➤ Restart.
As an alternative method, you can reboot all of the turrets simultaneously, after you have changed
the VIP on all of them, by performing the procedure Reboot communication devices on page 591.
11. If statically programmed Pulse devices are registered with the zone, change the zone VIP on each
Pulse:
a) Log in to the Pulse.
b) From the Application Launch Pad, tap Settings.
c) In the toolbar, tap Admin, enter the administrator password, then tap done.
d) In the toolbar, tap Network.
e) If Enable DHCP is ON, turn it OFF to enable the CCM Ip Address field.
f) In the CCM Ip Address field, tap within the text box, type the new VIP then tap done.
g) If Enable DHCP was enabled, turn it back ON.
h) Scroll to the bottom of the screen then tap Save Changes.
If you changed the Enable DHCP setting, the system prompts you to restart the Pulse.
i) Tap Restart. If you are not prompted to restart the Pulse, scroll to the bottom of the screen and tap
Restart Station.
12. If Unigy Soft Clients are registered with the zone, change the zone VIP for each Soft Client:
a) On the Microsoft Windows desktop, click Start ➤ All Programs ➤ IPC Systems Inc ➤ Unigy
Client Configuration Tool.
b) In the Primary field, type the new zone IP address (single appliance zone), VIP (HA zone), or
FQDN then click Save.
The IP address, VIP, or FQDN must be specified as the Common Name or Alternate Name in the
client certificate.
c) If you were logged in to the Soft Client when you made this change, log out then log in to
implement the change.
13. Take the zone out of maintenance mode and enable SNMP forwarding.
• Take a zone out of maintenance mode to reenable BCP plan activation on page 598
• Reenable SNMP forwarding for a zone on page 596
14. If you disabled Multi-tier Replication in step 2, reenable it by performing the procedure Enable
Multi-tier Replication on page 243.

December 3, 2019 IPC Confidential

 14.3: Change the IP address or other network settings for both appliances in an HA zone 407

If you moved the appliances to a different address, assign a new portal zone for the data center.

Note
After you complete the IP address change, other zones in the enterprise continue to make discovery
pings to the old IP addresses, which remain cached as residual JGroups data. You can see this if you run
a packet capture. This has minimal impact on the enterprise, so it is not necessary to take any remedial
action. However, if you want to clear the cached data, perform a full enterprise refresh of all zones in the
enterprise with the procedure Refresh (restart) zones in a multizone enterprise on page 319. You are not
required to restart all zones at the same time, they can be refreshed as time permits when the zones are
not processing calls or configuration requests.

14.3 Change the IP address or other network settings for both appliances in
an HA zone
If the wrong network settings were entered for both appliances in an HA zone during initial zone
deployment or if changes are made to the network, update the appliance configuration.

Note
This procedure assumes that it is not necessary to change the zone VIP. If you also have to change the
VIP, change it before you change the appliance IP addresses by performing the procedure Change a
zone VIP on page 399.

This procedure applies to making network configuration changes to both appliances in an HA zone.
• For information on moving the appliances in a zone to a different network, refer to Move the
appliances in an HA zone to a different network on page 402.
• For information on changing the IP address for one appliance in an HA zone, refer to Change the IP
address or other network settings for one CCM or ACCM appliance in an HA zone on page 409.
• For information on changing the IP address for an appliance in a single appliance zone, refer to
Change the IP address for a CCM or ACCM in a single appliance zone on page 412.
To change an appliance network configuration, you rerun Network Configurator. Network Configurator
is an application that enables you to configure appliance network settings and store them in the Unigy
database. It is run during initial appliance deployment and can be rerun as needed to make changes to
the initial configuration.
During the reconfiguration process, change only the IP Address, Subnet Mask, Default Gateway, or
PeerReg.Host fields. For information on navigating through the Network Configurator screens, refer to
Configure the appliance network settings with Network Configurator on page 450. When you rerun
Network Configurator, the system does not display all of the screens that were displayed during the
initial deployment.

Caution
This is a service impacting procedure that should be performed only when the zone is not involved in
processing calls or other requests.

1. Log in to the UMS in the zone for which you are changing the network configuration.
2. If Multi-tier Replication is enabled and the zone for which you are changing the configuration is a
portal zone, disable Multi-tier Replication for the associated data center by performing the procedure
Disable Multi-tier Replication on page 246.

IPC Confidential Unigy 4.3

Enterprise Guide
408 14.3: Change the IP address or other network settings for both appliances in an HA zone

3. In a multizone enterprise, confirm that data replication is enabled for the zone you are configuring by
performing the procedure Enable data replication on page 497. If replication is not enabled, enable
it.
4. Place the zone you are configuring into maintenance mode and disable alert forwarding to the GSOC
and customer NMSs by performing the following procedures:
• Place a zone into maintenance mode to disable BCP plan activation on page 597.
• Disable SNMP forwarding for a zone on page 596.
5. If you are changing the appliance IP addresses, change the values in the UMS:
a) Place the cluster into maintenance mode by performing the procedure Place a cluster into
maintenance mode to enable control of HA failovers on page 598.
b) If the Primary appliance (the appliance in the cluster with the lower IP address) is not the Active
appliance, force a failover to make it the Active appliance by performing the procedure Force an
HA failover on page 546.
c) Place the Standby appliance into maintenance mode by performing the procedure Place an
appliance or Media Gateway into maintenance mode to indicate it is unavailable on page 599.
d) Log in to the UMS on the Primary appliance in the zone you are reconfiguring. Use the Primary
appliance IP address: https://appliance_ip.
e) Click Configuration ➤ Enterprise ➤ System ➤ Zones.
f) In the Zones list, click the zone you are configuring.
g) In the ACCM/CCM1 Server IP Address and ACCM/CCM2 Server IP Address fields, type the new
IP addresses for the Primary and Secondary appliances then click Save.
6. Change the network configuration on both CCM or ACCM appliances.
Perform this step on both appliances at the same time.
a) Access the command line on each appliance.
b) Run the command su -lp then enter the root user account password.
c) Start Network Configurator by running the script /opt/ipc/cop/
network_configurator/scripts/network_configurator.sh.
d) Within the Backroom Network Interface-1 Configuration screen, change the IP Address,
PeerReg.Host, Subnet Mask, or Dflt Gateway fields, as necessary.
e) Press Tab until the Next button is selected then press Enter.
f) Proceed through the remaining screens, without making any changes, then within the last screen,
click Finish to save the changes.
The system displays the prompt Do you want to execute CCM IP change
scripts?
g) Type y then press Enter.
The system runs a series of scripts that update the database. This takes several minutes.
h) Monitor the state of the appliances in the zone by performing the procedure Check the state of a
zone from a browser on page 499.
If the Server Role or Server State of either appliance are not correct or any of the services fail,
rerun Network Configurator on both appliances at the same time and instruct it to run the CCM IP
change scripts. Network Configurator can be run as many times as necessary.
7. Take the Standby appliance and cluster out of maintenance mode:

December 3, 2019 IPC Confidential

 14.4: Change the IP address or other network settings for one CCM or ACCM appliance in an HA
zone 409

a) Log in to the UMS with the zone VIP.

b) Take the Standby appliance out of maintenance mode by performing the procedure Take an
appliance or Media Gateway out of maintenance mode on page 600.
c) Indicate that the maintenance is complete by performing the procedure Indicate that maintenance
on the Standby appliance is complete on page 601.
d) Take the cluster out of maintenance mode by performing the procedure Take a cluster out of
maintenance mode to resume normal HA operation on page 599.
e) Monitor the state of the appliances in the zone by performing the procedure Check the state of a
zone from a browser on page 499.
If the zone's Active appliance Server Role is UNKNOWN, the Server State is FAILED, and the
Replicator service fails, reboot the Active appliance.
f) When the checkHAStatus Server State for both appliances is AVAILABLE, reboot the Standby
appliance.
g) Monitor the state of the appliances in the zone by performing the procedure Check the state of a
zone from a browser on page 499.
h) Confirm that both appliances are in Active Mode by accessing them in Hardware Deployment as
described in the procedure Take an appliance or Media Gateway out of maintenance mode on page
600. If one or both appliances are in Maintenance Mode, complete the procedure to place the
appliance(s) into Active Mode.
8. Take the zone out of maintenance mode and enable SNMP forwarding by performing the following
procedures:
• Take a zone out of maintenance mode to reenable BCP plan activation on page 598.
• Reenable SNMP forwarding for a zone on page 596.
9. If you disabled Multi-tier Replication in step 2, reenable it by performing the procedure Enable
Multi-tier Replication on page 243.

Note
After you complete the IP address change, other zones in the enterprise continue to make discovery
pings to the old IP addresses, which remain cached as residual JGroups data. You can see this if you run
a packet capture. This has minimal impact on the enterprise, so it is not necessary to take any remedial
action. However, if you want to clear the cached data, perform a full enterprise refresh of all zones in the
enterprise with the procedure Refresh (restart) zones in a multizone enterprise on page 319. You are not
required to restart all zones at the same time, they can be refreshed as time permits when the zones are
not processing calls or configuration requests.

14.4 Change the IP address or other network settings for one CCM or ACCM
appliance in an HA zone
Use this procedure when it is necessary to change the network configuration for one Converged
Communications Manager (CCM) or Aggregated Converged Communications Manager (ACCM)
appliance in an HA pair, for example, if the wrong IP address was specified during initial deployment.

Note
This procedure assumes that it is not necessary to change the zone VIP. If it is necessary to change the
VIP, change it before you change the appliance IP address by performing the procedure Change a zone
VIP on page 399.

IPC Confidential Unigy 4.3

Enterprise Guide
410 14.4: Change the IP address or other network settings for one CCM or ACCM appliance in an HA
zone

This procedure applies to changing the network settings for one appliance in an HA zone.
• For information on moving the appliances in a zone to a different network, refer to Move the
appliances in an HA zone to a different network on page 402.
• For information on changing the IP address or other network settings for both appliances in an HA
zone, refer to Move the appliances in an HA zone to a different network on page 402. Use this
procedure if you are changing the IP address for one appliance in an HA zone and also have to
change the PeerReg.Host value on the second appliance in the zone to match the new IP address on
the peer appliance.
• For information on changing the IP address or other network settings for an appliance in a single
appliance zone, refer to Change the IP address for a CCM or ACCM in a single appliance zone on
page 412.
To change an appliance network configuration, you rerun Network Configurator. Network Configurator
is an application that enables you to configure appliance network settings and store them in the Unigy
database. It is run during initial appliance deployment and can be rerun as needed to make changes to
the initial configuration.
During the reconfiguration process, change only the IP Address, Subnet Mask, Default Gateway, or
PeerReg.Host fields. For information on navigating through the Network Configurator screens, refer to
Configure the appliance network settings with Network Configurator on page 450. When you rerun
Network Configurator, the system does not display all of the screens that were displayed during the
initial deployment.

Caution
This is a service impacting procedure that should be performed only when the zone is not involved in
processing calls or other requests.

1. Log in to the UMS with the zone VIP in the zone you are configuring.
2. If Multi-tier Replication is enabled and the zone for which you are changing the configuration is a
portal zone, disable Multi-tier Replication for the associated data center by performing the procedure
Disable Multi-tier Replication on page 246.
3. In a multizone enterprise, confirm that data replication is enabled for the zone you are configuring by
performing the procedure Enable data replication on page 497. If replication is not enabled, enable
it.
4. Place the zone into maintenance mode and disable alert forwarding to the GSOC and customer NMSs
by performing the following procedures:
• Place a zone into maintenance mode to disable BCP plan activation on page 597.
• Disable SNMP forwarding for a zone on page 596.
5. Place the cluster into maintenance mode by performing the procedure Place a cluster into
maintenance mode to enable control of HA failovers on page 598.
6. If the appliance for which you are changing the IP address is not the Standby appliance, force an HA
failover to make the Active appliance the Standby appliance by performing the procedure Force an
HA failover on page 546.
7. Place the Standby appliance into maintenance mode by performing the procedure Place an appliance
or Media Gateway into maintenance mode to indicate it is unavailable on page 599.
8. Change the IP address in the UMS:
a) Click Configuration ➤ Enterprise ➤ System ➤ Zones.

December 3, 2019 IPC Confidential

 14.4: Change the IP address or other network settings for one CCM or ACCM appliance in an HA
zone 411

b) In the Zones list, click the zone for which you are changing the IP address.
c) In the ACCM/CCM1 Server IP Address or ACCM/CCM2 Server IP Address field, type the new IP
address for the Primary or Secondary appliance you are changing then click Save.
9. Change the network configuration on the CCM or ACCM appliance that has the incorrect settings:
a) Access the appliance command line.
b) Run the command su -lp and enter the appropriate password.
c) Start Network Configurator by running the script /opt/ipc/cop/
network_configurator/scripts/network_configurator.sh.
d) Within the Backroom Network Interface-1 Configuration screen for the appliance, change the IP
Address, Subnet Mask, Dflt Gateway, or PeerReg.Host fields, as applicable.
e) Press Tab until the Next button is selected then press Enter.
f) Proceed through the remaining screens, without making any changes, then within the last screen,
click Finish to save the changes.
The system displays the prompt Do you want to execute CCM IP change
scripts?
g) Type y then press Enter.
The system runs a series of scripts that update the database. This takes several minutes.
h) Monitor the state of the appliances in the zone by performing the procedure Check the state of a
zone from a browser on page 499.
If the Server Role or Server State of either appliance are not correct or any of the services fail,
rerun Network Configurator on both appliances at the same time and instruct it to run the CCM IP
change scripts. Network Configurator can be run as many times as necessary.
10. Take the Standby appliance out of maintenance mode by performing the procedure Take an appliance
or Media Gateway out of maintenance mode on page 600.
11. Inform the system that maintenance on the Standby appliance is complete by performing the
procedure Indicate that maintenance on the Standby appliance is complete on page 601.
12. Take the cluster out of maintenance mode by performing the procedure Take a cluster out of
maintenance mode to resume normal HA operation on page 599.
13. Monitor the state of the appliances in the zone by performing the procedure Check the state of a zone
from a browser on page 499.
If the zone's Active appliance Server Role is UNKNOWN, the Server State is FAILED, and the
Replicator service fails, reboot the Active appliance.
14. When the checkHAStatus Server State for both appliances is AVAILABLE, reboot the Standby
appliance.
15. Monitor the state of the appliances in the zone by performing the procedure Check the state of a zone
from a browser on page 499.
16. Confirm that both appliances are in Active Mode by accessing them in Hardware Deployment as
described in the procedure Take an appliance or Media Gateway out of maintenance mode on page
600. If one or both appliances are in Maintenance Mode, complete the procedure to place the
appliance(s) into Active Mode.
17. Take the zone out of maintenance mode and enable SNMP forwarding by performing the following
procedures:
• Take a zone out of maintenance mode to reenable BCP plan activation on page 598.

IPC Confidential Unigy 4.3

Enterprise Guide
412 14.5: Change the IP address for a CCM or ACCM in a single appliance zone

• Reenable SNMP forwarding for a zone on page 596.

18. If you disabled Multi-tier Replication in step 2, reenable it by performing the procedure Enable
Multi-tier Replication on page 243.

Note
After you complete the IP address change, other zones in the enterprise continue to make discovery
pings to the old IP addresses, which remain cached as residual JGroups data. You can see this if you run
a packet capture. This has minimal impact on the enterprise, so it is not necessary to take any remedial
action. However, if you want to clear the cached data, perform a full enterprise refresh of all zones in the
enterprise with the procedure Refresh (restart) zones in a multizone enterprise on page 319. You are not
required to restart all zones at the same time, they can be refreshed as time permits when the zones are
not processing calls or configuration requests.

14.5 Change the IP address for a CCM or ACCM in a single appliance zone
This topic describes how to change the IP address for a single Converged Communications Manager
(CCM) or Aggregated Converged Communications Manager (ACCM) appliance in a single appliance
zone. This is required when moving the appliance in a single appliance zone to a different network or
when the wrong value was entered for the appliance during initial deployment.
For information on changing the IP addresses for both appliances in an HA zone, refer to Move the
appliances in an HA zone to a different network on page 402. For information on changing the IP
address for one appliance in an HA zone, refer to Change the IP address or other network settings for
one CCM or ACCM appliance in an HA zone on page 409.
To change an appliance IP address, you rerun Network Configurator. Network Configurator is an
application that enables you to configure appliance network settings and store them in the Unigy
database. It is run during initial appliance deployment and can be rerun as needed to make changes to
the initial configuration.
During the process of changing the IP address, change only the IP Address, and if applicable, the
Subnet Mask, Default Gateway and PeerReg.Host fields. For information on navigating through the
Network Configurator screens, refer to Configure the appliance network settings with Network
Configurator on page 450. When you rerun Network Configurator, the system does not display all of
the screens that were displayed during the initial configuration.
After you change the IP address, do the following as applicable:
• Change the IP address references on the DHCP Server to update dynamically programmed turrets and
Pulse devices that are registered with the zone.
• Change the IP address reference on each statically programmed turret and Pulse, and all Soft Clients
that are registered with the zone.

Caution
This is a service impacting procedure that should be performed only when the zone is not involved in
processing calls or other requests.

1. Log in to the UMS.

2. Place the zone into maintenance mode and disable alert forwarding to the GSOC and customer NMSs
by performing the following procedures:
• Place a zone into maintenance mode to disable BCP plan activation on page 597.

December 3, 2019 IPC Confidential

 14.5: Change the IP address for a CCM or ACCM in a single appliance zone 413

• Disable SNMP forwarding for a zone on page 596.

3. Place the appliance into maintenance mode by performing the procedure Place an appliance or
Media Gateway into maintenance mode to indicate it is unavailable on page 599.
4. Change the IP address specified for the zone in the UMS before you change the address through
Network Configurator:
a) Click Configuration ➤ Enterprise ➤ System ➤ Zones.
b) In the Zones list, click the appropriate zone.
c) In the VIP Address and ACCM/CCM1 Server IP Address fields, type the new appliance IP
address then click Save.
5. Change the CCM or ACCM IP address:
a) Access the appliance command line.
b) Run the command su -lp and enter the root user account password.
c) Start Network Configurator by running the script /opt/ipc/cop/
network_configurator/scripts/network_configurator.sh.
d) Within the Backroom Network Interface-1 Configuration screen, type the new IP Address, and if
applicable, change the Subnet Mask, Dflt Gateway and PeerReg.Host fields.
e) Press Tab until the Next button is selected then press Enter.
f) Proceed through the remaining screens, without making any changes, then on the last screen, click
Finish to save the changes.
The system displays the prompt Do you want to execute CCM IP change
scripts?
g) Type y then press Enter.
The system runs a series of scripts that update the database. This takes several minutes.
h) Monitor the state of the appliance by performing the procedure Check the state of a zone from a
browser on page 499.
If the Server Role and Server State of the appliance are not correct or any of the services fail,
rerun Network Configurator and instruct it to run the CCM IP change scripts. Network
Configurator can be run as many times as necessary.
6. Take the appliance out of maintenance mode by performing the procedure Take an appliance or
Media Gateway out of maintenance mode on page 600.
7. For a zone with Media Managers, change the appliance IP address reference on all MMs in the zone:
a) Place the MM appliance into maintenance mode by performing the procedure Place an appliance
or Media Gateway into maintenance mode to indicate it is unavailable on page 599.
b) Log in to the appliance through SSH.
c) Run the command su -lp and enter the root user account password to obtain root user
privileges.
d) Start Network Configurator by running the script /opt/ipc/cop/
network_configurator/scripts/network_configurator.sh.
e) Within the Backroom Network Interface-1 Configuration screen, type the new CCM IP address in
the PeerReg.Host field.
f) Press Tab until the Next button is selected then press Enter.
g) Proceed through the remaining screens, without making changes, then within the last screen, click
Finish to save the changes.

IPC Confidential Unigy 4.3

Enterprise Guide
414 14.5: Change the IP address for a CCM or ACCM in a single appliance zone

The system displays the prompt Do you want to execute CCM IP change
scripts?
h) Type y then press Enter.
The system runs a series of scripts that update the database. This takes several minutes.
i) Reboot the appliance.
j) Return the MM appliance to normal operation by performing the procedure Take a cluster out of
maintenance mode to resume normal HA operation on page 599.
8. Update DHCP servers, if necessary.
a) If the zone uses DHCP server option 66 to assign IP addresses to turrets and Pulse devices, change
the appliance VIP address specified for option 66 (tftp-server-name) on the DHCP server.
b) If the zone uses DHCP server option 112 to assign IP addresses to turrets and Pulse devices and
this zone is a registration coordinator, update the DHCP server configuration with the new VIP
address and update the Subnet in Mass Edit Client, if necessary.
c) If option 42 for the NTP server is configured with the CCM or ACCM IP address, change that
value as well.
d) Reboot each turret and Pulse to update the IP address. For information on rebooting multiple
devices, refer to Reboot communication devices on page 591.
For information on configuring a DHCP server, refer to the IQ/MAX Turret Hardware Installation
Manual, IQ/MAX Edge Turret Hardware Installation Manual, or Pulse Hardware Installation Manual.
9. If statically programmed turrets are registered with the zone, change the appliance IP address on each
turret:
a) If you are logged on to the turret, press the Shortcuts button then press More.
b) Press Admin.
c) Enter the Admin password then press Next.
d) Press Configure Network.
e) Press Servers.
f) Press Set Values Manually.
g) Press CCM.
h) Replace the existing IP address with the new CCM or ACCM IP address.
i) Press Save.
j) Press Save.
k) Press Save.
l) Press Commit.
m) Press OK.
n) Reboot the turret to update the IP address value by pressing Previous ➤ Restart Station ➤
Restart.
As an alternative method, you can reboot all of the turrets simultaneously after you have changed
the IP address on all of them by performing the procedure Reboot communication devices on page
591.
10. If statically programmed Pulse devices are registered with the zone, change the appliance IP address
on each Pulse:

December 3, 2019 IPC Confidential

 14.6: Change a CCM or ACCM hostname 415

a) Log in to the Pulse.

b) From the Application Launch Pad, tap Settings.
c) In the toolbar, tap Admin, enter the administrator password, then tap done.
d) In the toolbar, tap Network.
e) If Enable DHCP is ON, turn it OFF to enable the CCM Ip Address field.
f) In the CCM Ip Address field, tap within the text box, type the new CCM or ACCM IP address
then tap done.
g) If Enable DHCP was enabled, turn it back ON.
h) Scroll to the bottom of the screen then tap Save Changes.
If you changed the Enable DHCP setting, the system prompts you to restart the Pulse.
i) Tap Restart. If you are not prompted to restart the Pulse, scroll to the bottom of the screen and tap
Restart Station.
11. If Unigy Soft Clients are registered with the zone, change the appliance IP address for each Soft
Client:
a) On the Microsoft Windows desktop, click Start ➤ All Programs ➤ IPC Systems Inc ➤ Unigy
Client Configuration Tool.
b) In the Primary field, type the new CCM or ACCM IP address then click Save.
c) If you were logged in to the Soft Client when you made this change, log out then log in to
implement the change.
12. Take the zone out of maintenance mode and enable SNMP forwarding by performing the following
procedures:
• Take a zone out of maintenance mode to reenable BCP plan activation on page 598.
• Reenable SNMP forwarding for a zone on page 596.

14.6 Change a CCM or ACCM hostname

An appliance hostname is a label that identifies the appliance throughout the network. Perform this
procedure to change the hostname for a Converged Communications Manager (CCM) or Aggregated
Converged Communications Manager (ACCM) appliance.
To change the appliance hostname, rerun Network Configurator. Network Configurator is an application
that gathers network information for an appliance and stores it in the Unigy database. It is run during
initial appliance deployment, but can be rerun to make changes to the initial configuration.
During the process of changing the appliance hostname, do not change any other property values. For
information on navigating through the Network Configurator screens, refer to Configure the appliance
network settings with Network Configurator on page 450. When you rerun Network Configurator, you
do not see all of the screens that were displayed during the initial configuration.
1. For an appliance in an HA zone, do the following:
a) Place the cluster into maintenance mode by performing the procedure Place a cluster into
maintenance mode to enable control of HA failovers on page 598.
b) If the appliance you are changing is not the Standby appliance, force an HA failover to make it the
Standby appliance by performing the procedure Force an HA failover on page 546.
c) Place the Standby appliance into maintenance mode by performing the procedure Place an
appliance or Media Gateway into maintenance mode to indicate it is unavailable on page 599.

IPC Confidential Unigy 4.3

Enterprise Guide
416 14.7: Change a Media Manager IP address

2. Log in to the appliance from the command line.

3. Run the command su -lp and enter the appropriate password.
4. Rerun Network Configurator by running the script /opt/ipc/cop/network_configurator/
scripts/network_configurator.sh.
5. On the Host Information Configuration screen, type a new name in the Hostname field.
The hostname must be unique across the enterprise; for example, you cannot have the hostnames
CCM1.nyc.ipc.com and CCM1.boston.ipc.com in the same enterprise.
6. Press Tab until the Next button is selected then press Enter.
7. Proceed through the remaining screens, without making any changes, then on the last screen, click
Finish to save the change.
The system displays the prompt Do you want to execute CCM IP change scripts.
8. Type y then press Enter.
The system runs a series of scripts then reboots the appliance. This might take several minutes.
9. For an appliance in an HA zone, do the following:
a) Take the Standby appliance out of maintenance mode by performing the procedure Take a cluster
out of maintenance mode to resume normal HA operation on page 599.
b) Indicate that maintenance on the appliance is complete by performing the procedure Indicate that
maintenance on the Standby appliance is complete on page 601.
c) Take the cluster out of maintenance mode by performing the procedure Take a cluster out of
maintenance mode to resume normal HA operation on page 599.
The Active appliance Role changes to UNKNOWN, the State changes to FAILED,and the
Replicator service fails.
d) Reboot the zone's Active appliance to bring it back to a healthy state.
10. To change the host name on the second appliance in an HA zone, repeat steps 1 through 9, forcing an
HA failover as described in step 1b to make the Active appliance the Standby appliance.

14.7 Change a Media Manager IP address

This topic describes how to change the IP address for a Media Manager (MM) appliance. This might be
required when moving from a test environment to a production environment or to accommodate network
changes.
To change an MM IP address, rerun Network Configurator. Network Configurator is an application that
gathers network information for an appliance and stores it in the Unigy database. It is run during initial
appliance deployment, but can be rerun to make changes to the initial configuration. When you rerun
Network Configurator, the system does not display all of the screens that were displayed during the
initial configuration.
During the process of changing the IP address, change only the IP Address field. For information on
navigating through the Network Configurator screens, refer to Configure the appliance network settings
with Network Configurator on page 450.
After you change the IP address, re-register the MM with the associated zone.
1. Place the MM appliance into maintenance mode by performing the procedure Place an appliance or
Media Gateway into maintenance mode to indicate it is unavailable on page 599.
2. Change the MM IP address.

December 3, 2019 IPC Confidential

 14.8: Change a Media Manager hostname 417

a) Log in to the appliance through SSH.

b) Run the command su -lp then enter the root user account password.
c) Run Network Configurator by running the script /opt/ipc/cop/
network_configurator/scripts/network_configurator.sh.
d) Within the IP Address field in the Backroom Network Interface-1 Configuration screen, type the
new IP address.
e) Press Tab until the Next button is selected then press Enter.
f) Proceed through the remaining screens then on the last screen, click Finish to save the changes.
The system displays the prompt Do you want to execute CCM IP change
scripts?
g) Type y then press Enter.
The system runs a series of scripts that update the database. This might take several minutes.
h) Reboot the appliance.
3. Re-register the MM with the associated zone.
a) Log in to the UMS in the zone with which the MM is associated.
b) Click Tools ➤ Deployment ➤ Hardware Deployment. In the Deployment Zones panel, select the
zone with which the MM is associated then click Submit.
c) Within the Servers tab, click the MM then click Remove Device.
Within several minutes, the MM re-registers with the zone.
d) Confirm that the MM is monitored by the zone by clicking Configuration ➤ Sites ➤ Servers ➤
Media Managers, clicking the MM in the Media Managers list on the left, and determining
whether the Provisioned Service Mode is In-traffic.
4. Take the MM appliance out of maintenance mode by performing the procedure Take an appliance or
Media Gateway out of maintenance mode on page 600.

14.8 Change a Media Manager hostname

An appliance hostname is a label that identifies the appliance throughout the network. Perform this
procedure to change the hostname for a Media Manager (MM) appliance.
To change the appliance hostname, rerun Network Configurator. Network Configurator is an application
that gathers network information for an appliance and stores it in the Unigy database. It is run during
initial appliance deployment, but can be rerun to make changes to the initial configuration. When you
rerun Network Configurator, the system does not display all of the screens that were displayed during
the initial configuration.
During the process of changing the appliance hostname, do not change any other property values. For
information on navigating through the Network Configurator screens, refer to Configure the appliance
network settings with Network Configurator on page 450.
1. Place the MM appliance into maintenance mode by performing the procedure Place an appliance or
Media Gateway into maintenance mode to indicate it is unavailable on page 599.
2. Log in to the appliance through SSH.
3. Run the command su -lp then enter the root user account password.
4. Run Network Configurator by running the script /opt/ipc/cop/network_configurator/
scripts/network_configurator.sh.

IPC Confidential Unigy 4.3

Enterprise Guide
418 14.9: Change the NIC configuration for a Media Manager

5. Within the Hostname field in the Host Information Configuration screen, type the new hostname
The hostname must be unique across the enterprise; for example, you cannot have the hostnames
MM1.nyc.ipc.com and MM1.boston.ipc.com in the same enterprise.
6. Press Tab until the Next button is selected then press Enter.
7. Proceed through the remaining screens then on the last screen, click Finish to save the changes.
The system displays the prompt Do you want to execute CCM IP change scripts?
8. Type y then press Enter.
The system runs a series of scripts that update the database. This might take several minutes.
9. Reboot the appliance.
10. Take the MM appliance out of maintenance mode by performing the procedure Take an appliance or
Media Gateway out of maintenance mode on page 600.

14.9 Change the NIC configuration for a Media Manager

Perform this procedure when it is necessary to change the NIC configuration for a Media Manager
(MM) appliance.
If you are changing other appliance properties in addition to the NIC configuration, refer to the
appropriate topics in the Network change workflows chapter.
1. Change the Media Manager NIC settings with Network Configurator:
a) Access the appliance command line.
b) Run the command su -lp and enter the appropriate password.
c) Perform the procedure Configure the appliance network settings with Network Configurator on
page 450.
Change the NIC-related settings then when you are prompted to run the CCM IP change scripts,
type y and press Enter. Wait for the scripts to complete.
2. Change the SWMS configuration:
a) Login to SWMS with the URL https://mm_ip_address/swms/, where
mm_ip_address is the IP address of the MM you are changing.
b) Enter the swmsadmin user account credentials.
c) Click Configuration ➤ Network Management ➤ Show Network Configuration.
d) Click Execute.
e) Within Output Messages, determine the Device Name for Interface 1.
It should be the value that was set before you ran step 1.
f) Click Configuration ➤ Network Management ➤ Configure Network Interfaces.

December 3, 2019 IPC Confidential

 14.10: Change a Media Gateway IP address 419

Figure 53: Configure Network Interfaces

g) Set the Device Name for Intf 1 to the value you specified in Network Configurator in step 1, either
eth0 or bond0.
h) Click Save Settings.
3. Reboot the MM by performing the procedure Run Reboot Media Manager on page 588.

14.10 Change a Media Gateway IP address

A Media Gateway (MG) IP address is a numeric label, in dot decimal format, that identifies the MG and
its location in the network. Perform this procedure to change a Media Gateway IP address.
1. Change the IP address within the Media Gateway Administration Console:
a) Log in to the UMS.
b) Click Tools ➤ Deployment ➤ Hardware Deployment.
c) In the Deployment Zones panel, click the zone with which the MG is associated.
d) Within the Media Gateways tab, select the MG for which you are changing the IP address then
click the Admin Console link.
e) If the Windows Security dialog box is displayed, enter the Media Gateway User Name and
Password then click OK.
f) Click the Configuration button then click VoIP ➤ Network ➤ IP Interfaces Table.
g) In the Index column, select the Media Gateway you are configuring.
Edit and Delete buttons are displayed.
h) Click Edit.
i) In the IP Address field, type the new IP address then click Save.
After clicking Save, there is no confirmation window and the Save button is still enabled.
j) Click Cancel then Submit.
k) Click Burn to save the configuration to flash memory.

IPC Confidential Unigy 4.3

Enterprise Guide
420 14.11: Change a Media Gateway host name

2. Change the IP address within the UMS.

a) Click Configuration ➤ Sites ➤ Trunks ➤ Media Gateways.
b) In the Media Gateways list, click the Media Gateway for which you are changing the IP address.
c) Click the Properties button.
d) Within the Properties tab, type the new IP address in the IP Address field then click Save.
3. The new IP address is displayed for the IP Address parameter.

14.11 Change a Media Gateway host name

A Media Gateway (MG) host name (interface name) is an alphanumeric label that identifies the MG
throughout the network. Perform this procedure to change a Media Gateway host name.
1. Log in to the UMS.
2. Click Tools ➤ Deployment ➤ Hardware Deployment.
3. In the Deployment Zones panel, click the zone with which the MG is associated.
4. Within the Media Gateways tab, select the MG for which you are changing the host name then click
the Admin Console link.
5. If the Connect to dialog box is displayed, enter the Administration Console credentials then click OK.
6. Click the Configuration button then click VoIP ➤ Network ➤ IP Settings.
7. In the Index column, select the radio button for the Media Gateway you are configuring.
Edit and Delete buttons are displayed.
8. Click Edit.
9. In the Interface Name field, type the new host name then click Apply.
10. The new host name is displayed for the Host Name parameter.

14.12 Tune JGroups parameters to prevent network timeouts

This topic describes how to configure several JGroups parameters to help prevent network timeouts due
to latency issues that can impact interzone communication and the establishment of replication channels.
To perform this procedure, your use account must have the IPC Certified Tech role assigned.
1. Click Configuration ➤ Enterprise ➤ System Features ➤ Interzone Communication.
2. Adjust the following parameters as necessary:
• JGroups IZA Heartbeat Interval (sec)
• JGroups IZA Heartbeat Retry Count
• JGroups TCP Socket Connect Timeout (ms)
• JGroups Minimum Thread Pool Size
• JGroups Maximum thread Pool Size
• JGroups TCP Ping Timeout (sec)
• JGroups GMS Join Timeout (sec)

December 3, 2019 IPC Confidential

 14.13: Configure Unigy access to Domain Name System (DNS) servers 421

14.13 Configure Unigy access to Domain Name System (DNS) servers

Use this procedure to specify and verify one or more Domain Name System servers for resolving fully-
qualified domain names (FQDNs) in Unigy.
This procedure applies to external directory servers, SMTP servers for multi-factor authentication, and
voice recorder certificates that include an FQDN in their configuration. It involves updating the Domain
Name System resolver file, /etc/resolv.conf. Below is a sample of the default file. The search
line identifies the local domain name. The nameserver lines identify the DNS servers that can resolve
the FQDNs.
search ipc.com
nameserver 127.0.0.1

Perform this procedure on all CCM and ACCM appliances in the enterprise.
To perform this procedure, you must have SSH command line access and be authorized to use Password
Manager to obtain dynamic passwords.
1. From the appliance command line, log in with the shelldiag user account and enter the dynamic
password.
2. Run the command su -lp and enter the dynamic password.
3. Create a backup copy of the /etc/resolv.conf file by running the following command:
cp -p /etc/resolv.conf /etc/resolv.conf.orig

4. In the /etc/resolv.conf file, replace the default search value with the customer domain name
and replace the default nameserver value with the IP address for a DNS server. Add one nameserver
line for each DNS server. See the sample below.
search bankxyz.com
nameserver 10.20.30.30
nameserver 10.20.30.31

5. Save the file.

6. Reboot the appliance.
7. Verify the change by running the following command, where FQDN is a fully-qualified domain name
in the domain.
nslookup FQDN
Confirm that the name is resolved properly.
8. Repeat these steps for every CCM and ACCM in the enterprise.

IPC Confidential Unigy 4.3

Enterprise Guide
422 14.13: Configure Unigy access to Domain Name System (DNS) servers

December 3, 2019 IPC Confidential

 423

15Time-related workflows
15.1 Assign NTP servers to the devices in a zone
This topic describes how to add or change the NTP servers assigned to the CCM or ACCM appliances
and other devices in a zone.
This procedure is necessary only when the NTP servers assigned through Network Configurator during
initial deployment are not correct, when the NTP server IP addresses change, or when adding NTP
servers.
When you change the NTP servers through the UMS, the change applies only to the appliances in the
current zone. In an HA zone, the system updates the NTP servers on both appliances. The change is not
replicated to other zones in the enterprise, so perform this procedure for all applicable zones.
1. Within the UMS, click Configuration ➤ Enterprise ➤ System Features ➤ NTP Servers.
2. Enter the new NTP server IP address in the appropriate NTP Server Host field.
3. Click Save.
4. Synchronize the time on all Media Managers by performing the procedure Run Sync MM NTP Config
on page 698.
5. Reboot all Media Gateways.
6. For turrets and Pulse devices, do one or both of the following:
• If the devices obtain their time from NTP servers specified on a DHCP server, update the NTP
server(s) on the DHCP server(s) then reboot all of the turrets and Pulse devices by performing the
procedure Reboot communication devices on page 591.
• For Pulse devices that are statically configured, restart the devices:
1. Tap Settings ➤ Admin.
2. Enter the Admin user account password then tap done.
3. Scroll to the bottom of the page, tap Restart Station, then tap Restart.
• For turrets that are statically configured, do the following on each turret:
1. Press Settings ➤ More ➤ Admin.
2. Enter the Admin user account password then press Next.
3. Press Configure Network ➤ Servers ➤ Set Values Manually ➤ NTP Servers.
4. If necessary, scroll through the NTP servers to locate the server you are changing by pressing
NTP Server #, where # is the number of the currently displayed server. The system displays the
next NTP server.
5. Press Edit.
6. Press Enter IP Address.
7. Enter the IP address then press Save.
8. Press Previous ➤ Previous ➤ Previous.
9. Press Restart Station then press Restart.

IPC Confidential Unigy 4.3

Enterprise Guide
424 15.2: Change a location time zone in a standalone zone

15.2 Change a location time zone in a standalone zone

When you define a Unigy location, one of the properties you specify is the time zone. If you need to
change the time zone for a location, the CDI devices connected to the zone must also be updated.
Perform this procedure to change a time zone for a location and its hosted CDI devices.
To ensure consistent time information, the location time zone must match the time zone set for the
appliance hardware clock and system clock. For information on changing the hardware clock, refer to
the Linux help ( hwclock --help). For information on changing the system clock, refer to Change
the system time zone on page 426.
1. Log in to the UMS: https://appliance_ip.
2. Place the appliance into maintenance mode by performing the procedure Place an appliance or
Media Gateway into maintenance mode to indicate it is unavailable on page 599.
3. Click Configuration ➤ Enterprise ➤ System ➤ Locations.
4. In the Location Configuration list, click the location you are changing.
5. In the Locations panel, choose a time zone in the Time Zone list.
6. Click Save.
7. Reboot the appliance by performing the procedure Reboot CCM on page 587, for CCMs and
ACCMs, or Run Reboot Media Manager on page 588 for MMs.
8. After the reboot completes, take the appliance out of maintenance mode by performing the procedure
Take an appliance or Media Gateway out of maintenance mode on page 600.
9. Reboot all applicable turrets and Pulse devices by performing the procedure Reboot communication
devices on page 591.

15.3 Change the location time zone for an HA zone in a single or multizone
enterprise
When you define a Unigy location, one of the properties you specify is the time zone. If you need to
change the time zone for a location, the desktop devices (turrets and Pulse devices) connected to the
zone must also be updated. Perform this procedure to change a time zone for a location and its hosted
devices.
To ensure consistent time information, the location time zone must match the time zone set for the
appliance hardware clock and system clock. For information on changing the hardware clock, refer to
the Linux help ( hwclock --help). For information on changing the system clock, refer to Change
the system time zone on page 426.

Note
To change the time zone on desktop devices, change the time zone for the front room location associated
with the devices.

This procedure includes confirming that the correct location is assigned, confirming that the correct time
zone is assigned to the location, confirming that the correct address is assigned to the location, and
rebooting the devices hosted by the zone.
1. Log in to the UMS: https://vip.
2. Confirm or change the location assigned to the appliances to reflect the new time zone.
Perform these steps for each zone for which you are changing the time zone.

December 3, 2019 IPC Confidential

 15.3: Change the location time zone for an HA zone in a single or multizone enterprise 425

a) Click Configuration ➤ Enterprise ➤ System ➤ Zones.

b) In the Zones list, click the zone you are changing.
c) In the Backroom Location field, determine whether the current location is the location for which
you are changing the time zone. If it is not, select the appropriate location then click Save.
3. Place the zone cluster into maintenance mode by performing the procedure Place a cluster into
maintenance mode to enable control of HA failovers on page 598.
4. Place the standby appliance into maintenance mode by performing the procedure Place an appliance
or Media Gateway into maintenance mode to indicate it is unavailable on page 599.
5. Click Configuration ➤ Enterprise ➤ System ➤ Locations.
6. In the Location Configuration panel, click the appropriate location.
7. In the Locations panel, do one of the following:
• In the Time Zone field, if the time zone assigned to the location is not correct, choose the correct
time zone.
• In the Time Zone field, if the time zone assigned to the location is the correct time zone, ensure
that it is applied properly by selecting another time zone to enable the Save button then selecting
the correct time zone. When you click Save in step 9, the time zone script will run to ensure that
the time zone is applied correctly.
8. In the Address Detail section, confirm that the address for the location is correct. If it is not, select
the correct address.
9. Click Save.
10. Reboot the appliance by performing the procedure Reboot CCM on page 587, for CCMs and
ACCMs, or Run Reboot Media Manager on page 588 for MMs.
11. After the reboot completes, confirm that all of the services are running properly by performing the
procedure Check the state of a zone from a browser on page 499.
12. Take the Standby appliance out of maintenance mode by performing the procedure Take an appliance
or Media Gateway out of maintenance mode on page 600.
13. Indicate that the maintenance is complete for the appliance by performing the procedure Indicate that
maintenance on the Standby appliance is complete on page 601.
14. Force an HA failover to make the Standby appliance the Active appliance by performing the
procedure Force an HA failover on page 546.
This is a stateless failover, so active calls are dropped.
The database is updated with the new time zone.
15. Repeat steps 4 through 13 for the second appliance in the zone.
16. Take the cluster out of maintenance mode by performing the procedure Take a cluster out of
maintenance mode to resume normal HA operation on page 599.
17. Determine the state of the zone and whether the zones are communicating by performing the
procedure Check the state of an HA zone from the UMS on page 500.
18. If the system time zone is not the same as the new location time zone, perform the procedure Change
the system time zone on page 426.
19. Reboot all applicable turrets and Pulse devices by performing the procedure Reboot communication
devices on page 591.
20. Repeat steps 1 through 19 for each of the other zones that require the time zone change.
Perform the procedure one zone at a time.

IPC Confidential Unigy 4.3

Enterprise Guide
426 15.4: Change the system time zone

15.4 Change the system time zone

If you change an appliance hardware clock or the time zone of a Unigy location (for example, after
moving an appliance to a location in a different time zone), also change the appliance system clock. This
applies to CCMs, MMs, ACCMs, and voice recorders.
This procedure describes how to change the appliance system time zone. For information on changing
other time zone settings, refer to the following:
• Changing the hardware clock is done by running one or more of the functions of the hwclock
command. For information on this command, refer to the Linux help (hwclock --help).
• Changing the time zone of a Unigy location is done through the UMS. For information on this
procedure, refer to Change a location time zone in a standalone zone on page 424 or Change the
location time zone for an HA zone in a single or multizone enterprise on page 424.
For Unigy, the system time zone variable supports the Olson (tz) time zone format, for example:
• Asia/Tokyo
• Europe/London
• America/New_York
The available values are listed in /usr/share/zoneinfo/zone.tab.
After you change the time zone, reboot the turrets and Pulse devices to update the time zone data. If you
do not update the system clock, the offset from UTC time will not be correct.
1. To update the system time zone on a CCM, MM, or ACCM, change the ZONE value in the clock
file by doing the following:
a) At the Linux command line, delete the existing localtime file by typing rm -f /etc/
localtime and pressing Enter.
b) Make a symbolic link from the localtime file to the corresponding time zone directory by
typing the command ln -s /usr/share/zoneinfo/time_zone/etc/localtime,
where time_zone is the new time zone value in Olson (tz) time zone format; for example, ln -
s /usr/share/zoneinfo/Asia/Tokyo /etc/localtime.
c) Edit the clock file by typing vi /etc/sysconfig/clock and setting the ZONE variable
equal to the new time zone; for example Zone="Asia/Tokyo".
d) In an HA zone, restart the orchestrator and occasd services on the CCMs or ACCMs:
1. Open an SSH session on the Active and Standby CCMs or ACCMs, and each MM (if
applicable).
2. On the Standby CCM or ACCM, type service orchestrator stop then press Enter.
3. On the Standby CCM or ACCM, type service occasd stop then press Enter.
4. On the Active CCM or ACCM, type service orchestrator stop then press Enter.
5. On the Active CCM or ACCM, type service occasd stop then press Enter.
6. On the Active CCM or ACCM, type service orchestrator start then press Enter.
Wait until all of the services are running. To view the status, perform the procedure Check the
state of a zone from a browser on page 499. Starting orchestrator also starts occasd and
reboots the Media Gateways.
7. On the Standby CCM or ACCM, type service orchestrator start then press Enter.
2. If it is necessary to change the system time zone value on voice recording servers, do the following:

December 3, 2019 IPC Confidential

 15.5: Configure the server time source 427

a) On each server, perform one of the following procedures:

Recorder type Reference

• IPC Media Recorder (IMR) Configure the server time source on page 427

• NICE Trading Recording (NTR)

NICE Interaction Management (NIM) Configure the server time source – NIM on page
430

b) Reboot each server in the following sequence as applicable:

1. Core server
2. Satellite or Logger servers
3. Sentinel server
3. Reboot the turrets and Pulse devices from the UMS. For information on this procedure, refer to
Reboot communication devices on page 591.

15.5 Configure the server time source

To ensure that the system time is synchronized between all of the voice recording servers and the Unigy
Converged Communications Manager (CCM) or Aggregated Converged Communications Manager
(ACCM) appliance with which the servers communicate for recording purposes, configure the time
properties on each NTR server.
The time source must be a Network Time Protocol (NTP) server.

Note
To ensure consistent time synchronization, all of the servers and the CCM or ACCM should use the same
time source.

For additional details about NTP services, see the IPC Unigy / CTI Active IP Recording Integration
Manual.
1. Access the server and log in.
2. Stop all NTR services using the Monitor Tool or system configuration ➤ configuration
management in the NICE Recording Web GUI.
See the NICE Recording: Installation & Configuration Manual for details.
3. Click the time display in the bottom right corner of the Microsoft Windows desktop.
The date and time interface is displayed.

IPC Confidential Unigy 4.3

Enterprise Guide
428 15.5: Configure the server time source

Figure 54: Microsoft Windows date/time interface

4. Click Change date and time settings.

The Date and Time dialog box is displayed.
Figure 55: Date and Time dialog box

5. On the Date and Time tab, confirm that the time zone and Daylight Saving Time settings are correct.
If they are not:
a) Click Change time zone.
The Time Zone Settings dialog box is displayed.

December 3, 2019 IPC Confidential

 15.5: Configure the server time source 429

Figure 56: Time Zone Settings dialog box

b) In the Time zone field, select the correct time zone to match the backroom where the server is
located.
c) If the time zone observes Daylight Saving Time, select the Automatically adjust clock for
Daylight Saving Time check box. If it does not, clear the check box.
d) Click OK.
6. Click the Internet Time tab then click Change settings.
The Internet Time Settings dialog box is displayed.
Figure 57: Internet Time Settings dialog box

7. Select the Synchronize with an Internet time server check box.

IPC Confidential Unigy 4.3

Enterprise Guide
430 15.6: Configure the server time source – NIM

8. In the Server field, type the IP address of the NTP server that serves as the time source.
9. Click Update now.
The system updates the time source then displays a success message.

Note
If the success message is not displayed, click Update Now multiple times until the system displays the
message.

10. Click OK.

11. Start all NTR services using the Monitor Tool or system configuration ➤ configuration
management in the NICE Recording Web GUI.

15.6 Configure the server time source – NIM

To ensure that the system time is synchronized between all of the voice recording servers and the Unigy
Converged Communications Manager (CCM) or Aggregated Converged Communications Manager
(ACCM) with which the servers communicate, configure the time properties on each server.
The steps shown for this procedure are performed using Windows Server 2008 Standard R2.
The time source can be one of the following:
• The associated CCM or ACCM
• A Network Time Protocol (NTP) server

Note
To ensure consistent time synchronization, all of the servers and the CCM or ACCM should use the same
time source.

1. Open the NICE Interaction Management Services Configuration Manager by clicking Start ➤ All
Programs ➤ NICE Systems ➤ CTI Tools ➤ CTI Console Viewer ➤ NICE Services
Configuration Manager.
The NICE Services Configuration Manager window is displayed.

December 3, 2019 IPC Confidential

 15.6: Configure the server time source – NIM 431

Figure 58: NICE Services Configuration Manager window

2. In the toolbar, click the All Services icon.

3. On a Database and Application Server, stop the CLSRCMService service, or on the Logger Servers,
stop the IPCapture and VOIP Logger services by right-clicking the service then clicking Stop.
The service is placed in the Stopped state.
4. Click the time display in the bottom right corner of the Microsoft Windows desktop.
The date and time interface is displayed.

IPC Confidential Unigy 4.3

Enterprise Guide
432 15.6: Configure the server time source – NIM

Figure 59: Microsoft Windows date and time interface

5. Click Change date and time settings.

The Date and Time dialog box is displayed.
6. On the Date and Time tab, confirm that the time zone and Daylight Saving Time settings are correct.
If they are not, do the following:
a) Click Change time zone.
The Time Zone Settings dialog box is displayed.
Figure 60: Time Zone Settings dialog box

b) In the Time zone field, select the correct time zone.

c) Ensure that the Automatically adjust clock for Daylight Saving Time check box is cleared.
d) Click OK.
7. Click the Internet Time tab then click Change settings.
The Internet Time Settings dialog box is displayed.

December 3, 2019 IPC Confidential

 15.6: Configure the server time source – NIM 433

Figure 61: Internet Time Settings dialog box

8. Select the Synchronize with an Internet time server check box.

9. In the Server field, type the IP address of the CCM, ACCM, or NTP server that serves as the time
source.
10. Click Update now.
The system updates the time source then displays a success message.

Note
If you do not see the success message, click Update Now multiple times until the system displays the
message.

11. Click OK.

12. In the NICE Services Configuration Manager window, right-click each service you stopped in step 3,
then click Start.
The services are placed in the Running state.

Note
Synchronization of the time on all of the servers with the time source might require a considerable
amount of time. During this time, CDRs (Call Detail Records) might not be available.

IPC Confidential Unigy 4.3

Enterprise Guide
434 15.6: Configure the server time source – NIM

December 3, 2019 IPC Confidential

 435

16Enterprise to enterprise line sharing

Enterprise to enterprise line sharing allows two or more discrete Unigy enterprises to share lines and line
status. There is no limit on the number of enterprises that can share with each other. All zones in any
subscribing or publishing instances in the enterprises must be at Unigy v4.2 or higher.
Each enterprise can be a publishing enterprise, a subscribing enterprise, or both. The publishing
enterprise is the enterprise sharing the line, where the line physically resides. The subscribing enterprise
is the one gaining access to the shared line.
There is no explicit publishing, meaning that all lines are published; there are no unpublished lines. All
CDIs can access a line in any configured instance.
The following line types can be shared between Unigy enterprises:
• Unigy dial tone lines
• private lines (ARD, MRD, hoot)

16.1 Enterprise line sharing considerations

In some scenarios, the behavior under the enterprise to enterprise line sharing feature differs from the
typical or expected Unigy behavior.
• Shared lines cannot be shared further.
• Barge
• Barge information is exchanged between two Unigy enterprises only on the initial barge from
another side. Unigy does not display the barge name for subsequent subscribed users who barge on
a call.
• When a subscribed user uses a speaker to barge on a shared line that is in exclusive hold, a busy
tone is heard and the speaker channel turns off after about 30 seconds. When a subscribed user
uses a handset to barge on a shared line that is in exclusive hold, access is rejected as expected.
• Conference
• A subscribing site user who barges on a conference created by a publishing site user should not
remove lines added to this conference by a publishing site user and vice versa. This might cause a
line to drop for all users in a call or an inconsistent status display. Also, when barging on a
conference created by a user on the other side and then adding or removing lines, it is
recommended not to put the line on hold.
• Unsupervised conference not supported.
• Diversion
• When a user makes a call using a subscribed line to a publishing site user and that call is diverted
until the maximum number of diversion hops is reached, the call fails (as expected). Normally, this
call failure would be communicated from the publishing enterprise to the subscribing site user by a
centerline message. In enterprise to enterprise line sharing, the failure is not communicated.
• To divert a line from a subscribing enterprise turret, you must manually enter the extension or
number. End users will not be able to use the feature where they select a button from the button
sheet. Routing is done at the publishing enterprise so the number must be routable by the
publishing enterprise.

IPC Confidential Unigy 4.3

Enterprise Guide
436 16.1: Enterprise line sharing considerations

• Diversion settings for a line on the publishing enterprise are visible on devices on the subscribing
enterprise.
• Line status for speaker call
A shared line connected to a speaker channel on a remote site ignores the settings for speaker status
display. The line status for a shared line assigned to a speaker channel always shows Busy on the
user’s Button Sheet.
• Dial tone lines and transferring calls
When transferring lines between two Unigy enterprises, inaccuracies in the display of Calling Line
Identification (CLI) and Connected Party Identification (CPI) may be observed.
• Intercom and Open Connexion
Enterprise to enterprise line sharing does not support intercom, Open Connexion, OOPS, or Music On
Hold lines.
• Personal extension
Subscribed lines cannot be used as a personal extension.
• Forced line clear
Forced line clear is not supported on subscribed lines.
• Exclusive Hold is not supported.

Call History
Call history records generated at the publishing enterprise for the lines used by subscribing enterprises
will display a new system user, RemoteUser_CH. Unigy versions prior to v4.1 will continue to display
AllianceUser_CH for Alliance Interop users. Unigy v4.2 and above will display RemoteUser_CH
for both enterprise to enterprise line sharing and Alliance MX Interop.
Details of the call are displayed on the subscribing enterprise. The publishing enterprise indicates that
the line was used and the user who seized the line.
Figure 62: Communications History Report example

December 3, 2019 IPC Confidential

 16.2: Understanding PUIBs 437

Recording
Recording is configured by user and remains the same for line sharing. The isLineRecorded setting on
the publishing enterprise does not affect shared lines on the subscribing enterprise. Configure the
isLineRecorded setting for shared lines on the subscribing enterprise.

BCP
Following a BCP failover, or any time a line is moved to another zone in the publishing enterprise, the
line status of shared lines at the subscribing enterprise may be delayed for up to 30 minutes while the
line status subscription refresh occurs at the subscribing enterprise.

16.2 Understanding PUIBs

PUIB is an acronym for Published Userinfo Base. It is used to reference lines from publishing
enterprises by subscribing enterprises in enterprise to enterprise line sharing.
The PUIB is automatically generated by the system whenever a line is created. The PUIB is important
for enterprise to enterprise line sharing because subscribing enterprises use this number to reference
lines from publishing enterprises. The TrunkAOR value you enter when configuring lines in the
procedure Configure enterprise to enterprise line sharing on page 439 is the PUIB.
You can see this number by viewing a line’s details tab in the UMS. It is a read-only field.

IPC Confidential Unigy 4.3

Enterprise Guide
438 16.2: Understanding PUIBs

Figure 63: Published Userinfo Base in UMS

When the first line is created, the system assigns the number 200 as the base PUIB. The base PUIB
increments by 100 for subsequent lines. The 99 intermediate numbers are available for line appearances.
For example, if you create five extensions, the system creates five corresponding base PUIBs, 100 digits
apart:

Table 44: Extensions to Base PUIBs

Extension Base PUIB

1000 200
1001 300
1002 400
1003 500
1004 600

When you create appearances for the extension, the PUIB (not the base PUIB) is used as the TrunkAOR.
In this example, we’ve created three appearances for extension 1002:

December 3, 2019 IPC Confidential

 16.3: Configure enterprise to enterprise line sharing 439

Table 45: Extension Appearances to PUIBs

Extension-Appearance PUIB
1002-1 401
1002-2 402
1003-3 403

To have these appearances roll over on the subscribing enterprise, create a hunt group for them on the
subscribing enterprise.
1. From the UMS, click Configuration ➤ Enterprise ➤ Hunt Group.
2. Click the Plus sign to add a hunt group.
3. Drag the appropriate Resource AORs from the Available to Assign panel to the grid on the Details
tab.
4. Click Save.
5. Assign the end user by clicking the End User tab and dragging the name of the end user from the
Available to Assign panel to the grid on the End User tab.
Figure 64: Hunt Group Example

16.3 Configure enterprise to enterprise line sharing

use this procedure to configure shared lines in enterprise to enterprise line sharing.
All configuration is performed using the Mass Edit Client from the subscribing enterprise. The
publishing enterprise provides information only.
Technicians must have access to all the enterprises involved or must be able to obtain the information
from the publishing site (detailed below).
The ability to configure the enterprise to enterprise line sharing feature is restricted to IPC Project
Managers, and IPC Certified Technicians.

IPC Confidential Unigy 4.3

Enterprise Guide
440 16.3: Configure enterprise to enterprise line sharing

1. Plan the mapping in advance.

Plan the sites and site server lists to match the instances and zones in the publishing enterprise. A best
practice is to make a Site Server for all the zones in the published instances for BCP purposes. For
example:

Table 46: Example of mapping plan for enterprise to enterprise line sharing

Publishing Enterprise Subscribing Enterprise

(Region 1) (Region 2)
Instance Zone Zone VIP Site Site Server
Instance 1 Zone 1 192.168.10.12 Reg1Inst1 Reg1Inst1Z1
Instance 1 Zone 2 192.168.10.15 Reg1Inst1 Reg1Inst1Z2
Instance 1 Zone 3 192.168.10.18 Reg1Inst1 Reg1Inst1Z3
Instance 2 Zone 4 192.168.10.21 Reg1Inst2 Reg1Inst2Z4
Instance 2 Zone 5 192.168.10.24 Reg1Inst2 Reg1Inst2Z5

2. Collect information from the publishing enterprise:

• Zone VIPs. You can find this information at Configuration ➤ Sites ➤ Servers ➤ Cluster.
• SIP and SIPS ports. You can find this information at Configuration ➤ Sites ➤ Servers ➤
Cluster.
• Secure Communication settings for each instance (enabled/disabled). You can find this information
at Configuration ➤ Enterprise ➤ Security ➤ Security Communications ➤ Instance. Refer to
the table in the procedure Copy Certificates Between Enterprises on page 442 for Secure
Communication setting parameters.
• List of lines, appearances, and PUIBs. You can find this information at Configuration ➤
Enterprise ➤ Lines and Extensions then Private Lines or Extensions.

Table 47: Example of a table to create as a configuration aid

Line and Appearance PUIB Line to create

from Publishing Enterprise from Publishing Enterprise at Subscribing Enterprise
3001 300 301
3002 400 401
3003 501

3. Use Mass Edit Client to create the Sites.

Site is a subscribing-side alias for the publishing instance. Create one Site for each instance in the
publishing enterprise.
a) From the UMS in a zone in the subscribing enterprise, click Tools ➤ Mass Edit Client ➤
Enterprise Line Sharing ➤ Site.
b) Log in to the Mass Edit workbook by entering the VIP of the zone in the subscribing enterprise
and your credentials.
c) Perform a New Search leaving the search criteria blank to review the existing data, if any.
d) From the Changes tab, click Create Record and fill in the following fields:

December 3, 2019 IPC Confidential

 16.3: Configure enterprise to enterprise line sharing 441

1. Site Name: enter a name to reference the publishing site instance. The name must be unique
throughout all enterprises.

Tip
Use a site naming convention that will make it easy to determine the publishing instance in case
you need to troubleshoot issues.

2. Secure Comm: enter true or false to indicate if you are using secure communication.
e) Click Validate Changes.
f) Click Save Changes.
The Save Progress tab updates.
g) From the Search tab, click New Search to review your changes.
h) Click Logout and close the workbook without saving.
When the site is created, the system generates an ID, an Enterprise ID, and an Enterprise Type.

Note
Enterprise ID 1 is Alliance. Enterprise ID 2 is Unigy.

4. Use Mass Edit Client to configure the Site Servers

A Site Server is the subscribing-side alias for the publishing zone. Create one Site Server for each
zone in each publishing instance.
a) From the UMS in a zone in the subscribing enterprise, click Tools ➤ Mass Edit Client ➤
Enterprise Line Sharing ➤ Server.
b) Log in to the Mass Edit workbook by entering the VIP of the zone in the subscribing enterprise
and your credentials.
c) Perform a New Search leaving the search criteria blank to review the existing data, if any.
d) From the Changes tab, click Create Record and fill in the following fields:
1. Site ID: obtain this from the Associations tab. Click Load Site and use the Site ID
corresponding to the Site Name for this zone's instance.
2. Site Server Name: enter a name for the to reference the publishing site zone.

Tip
Use a site server naming convention that will make it easy to determine the publishing zone in
case you need to troubleshoot issues.

3. IP Address: enter the VIP of the publishing enterprise zone.

4. SIP Port: enter the SIP port used by the publishing enterprise.
5. Secure SIP Port: enter the port used for Secure SIP by the publishing enterprise. This field is
required even if you are not using secure communication.
e) Click Validate Changes.
f) Click Save Changes.
The Save Progress tab updates.
g) From the Search tab, click New Search to review your changes.
h) Click Logout and close the workbook without saving.

IPC Confidential Unigy 4.3

Enterprise Guide
442 16.4: Copy Certificates Between Enterprises

5. Use Mass Edit Client to create and configure the subscribing enterprise lines.
a) From the UMS in a zone in the subscribing enterprise, click Tools ➤ Mass Edit Client ➤ Lines
and Extensions then Private Lines or Lines and Extensions.
b) Log in to the Mass Edit workbook by entering the VIP of the zone in the subscribing enterprise
and your credentials.
c) Create lines for the subscribing side in the usual manner.
Refer to the online help for details on the fields in this Mass Edit workbook .
Complete these additional fields for subscribed lines:
1. TrunkAOR: enter the PUIB + the Line Appearance from the publishing enterprise.
2. Alliance/Remote Site: Obtain this value from the Enum Loader tab, click Load Dynamic
Enums. Under Alliance/Remote Site and Label, find the site you created and copy the Value
corresponding to the Label.
The trunk is created when you create the line.
d) Click Validate Changes.
e) Click Save Changes.
The Save Progress tab updates.
f) From the Search tab, click New Search to review your changes.
g) Click Logout and close the workbook without saving.
The system creates a trunk corresponding to the PUIB. This trunk is not visible in the UMS Trunks
menu but can be viewed through Mass Edit Client ➤ Trunk ➤ Remote workbook.
6. Exchange certificates between the publishing and subscribing enterprises to enable secure
communications by performing the procedure Copy Certificates Between Enterprises on page 442.

16.4 Copy Certificates Between Enterprises

Publishing and subscribing enterprise establish trust for secure communications by exchanging
certificates. This is a manual process.

All Unigy appliances (CCMs, ACCMs, and MMs) have certificates. All appliances in the same Unigy
enterprise have the same certificate with IPC as the CA.
Copying certificates between enterprises consists of copying the first certificate of the ca-bundle file in
each enterprise and appending it to the end of the ca-bundle file in the other enterprise. A ca-bundle
could contain more than one certificate; the first certificate in the bundle is the one we are sharing.
In order to use secure communication on a Site in the subscribing enterprise, secure communication
must be enabled on the publishing instance. Refer to the following table for combinations and outcomes
based on the secure communication settings.

December 3, 2019 IPC Confidential

 16.4: Copy Certificates Between Enterprises 443

Table 48: Secure Communication Settings

Secure Comm on Secure Comm on Certs copied? Type of Comm

Publishing Instance Subscribing Site
Disabled Disabled No Successfully establishes
non-secure
communication
Enabled Disabled No Successfully establishes
non-secure
communication
Enabled Enabled Yes Successfully establishes
secure communication

As a best practice, swap certificates on one server from each enterprise, test the connection, and if
successful, copy the ca-bundle file to all other servers in their respective enterprises.
1. Open an ssh connection with an appliance in the publishing enterprise and another ssh connection
with an appliance in the subscribing enterprise.
Open with shelldiag and su to root

su -lp

2. Prepare the ca-bundle file on one appliance in the publishing enterprise.

a) Find the ca-bundle in the /opt/ipc/security/keymgmt/certs/ directory.
b) Make a working copy and a safe copy of the file.

mkdir tmp
cp ca-bundle tmp/ca-bundle
cp -p ca-bundle tmp/ca-bundle.orig

We are using the p argument to preserve the original file timestamp.

c) Create a new file containing the top-most certificate extracted from the original bundle file:

cd tmp
awk '/BEGIN /{a=1};a;/END /{exit}' ca-bundle > ca-bundle.top_pub

3. Prepare the ca-bundle file on one appliance in the subscribing enterprise.

a) Find the ca-bundle in the /opt/ipc/security/keymgmt/certs/ directory.
b) Make a working copy and a safe copy of the file.

mkdir tmp
cp ca-bundle tmp/ca-bundle
cp -p ca-bundle tmp/ca-bundle.orig

c) Use this command to create a new file containing the top-most certificate extracted from the
original bundle file:

cd tmp
awk '/BEGIN /{a=1};a;/END /{exit}' ca-bundle > ca-bundle.top_sub

IPC Confidential Unigy 4.3

Enterprise Guide
444 16.4: Copy Certificates Between Enterprises

4. Concatenate the extracted publishing enterprise certificate TO the end of the subscribing enterprise
bundle for use in the subscribing enterprise.
a) Copy ca-bundle.top_pub from the publishing appliance to the /opt/ipc/security/
keymgmt/certs/tmp/ directory on the subscribing appliance.
From the certs/tmp directory on the subscribing appliance, type the following command:

scp shelldiag@ip_addr_publishing:/opt/ipc/security/keymgmt/
certs/tmp/ca-bundle.top_pub /opt/ipc/security/keymgmt/certs/tmp

b) Concatenate the two files using the command:

cat ca-bundle ca-bundle.top_pub > ca-bundle.full_sub

5. Concatenate the extracted subscribing certificate TO the end of the publishing enterprise bundle for
use in the publishing enterprise.
a) Copy ca-bundle.top_sub from the subscribing appliance to the /opt/ipc/security/
keymgmt/certs/tmp/ directory on the publishing appliance.
From the certs/tmp directory on the publishing appliance, type the following command:

scp shelldiag@ip_addr_subscribing:/opt/ipc/security/keymgmt/
certs/tmp/ca-bundle.top_sub /opt/ipc/security/keymgmt/certs/tmp

b) Concatenate the two files using the command:

cat ca-bundle ca-bundle.top_sub > ca-bundle.full_pub

6. Test the TLS connections.

a) Run these commands to test the connection:
• From an appliance on the publishing enterprise:
openssl s_client -connect ip_of_subscribing_enterprise:443 -
CAfile /opt/ipc/security/keymgmt/certs/tmp/ca-bundle.full_pub

• From an appliance on the subscribing enterprise:

openssl s_client -connect ip_of_publishing_enterprise:443 -
CAfile /opt/ipc/security/keymgmt/certs/tmp/ca-bundle.full_sub

b) The following return indicates a successful connection:

Verify return code: 0 (ok)

c) Close the connections by typing CTRL-C.

7. Upon success between the first two appliances, perform the certificate exchange for all the appliances
in both enterprises.
a) Copy the new publishing enterprise bundle (ca-bundle.full_pub) from the tmp directory to
the certs directory, as ca-bundle, overwriting the existing ca-bundle.

cp ca-bundle.full_pub ../ca-bundle

b) Copy the new ca-bundle to all the publishing appliances.

December 3, 2019 IPC Confidential

 16.4: Copy Certificates Between Enterprises 445

c) Copy the new subscribing enterprise bundle (ca-bundle.full_sub) from the tmp directory
to the certs directory, as ca-bundle, overwriting the existing ca-bundle.

cp ca-bundle.full_sub ../ca-bundle

d) Copy the new ca-bundle to all the subscribing appliances.

e) Change the permissions of all ca-bundle files.

chown keymgmt:admin ca-bundle

8. Restart the opensips service on both appliances to get the updated certificates to take effect.
Run the command: service opensips restart

Note
This command must be run whenever you update the certifications (ca_bundle) on a CCM, ACCM, or
MM.

IPC Confidential Unigy 4.3

Enterprise Guide
446 16.4: Copy Certificates Between Enterprises

December 3, 2019 IPC Confidential

 447

17Procedures referenced by the

workflows
The procedures in this chapter are referenced from the various workflows described in this document.
These procedures are not intended to be performed in the sequence in which they are listed in this
chapter. Refer to the workflows for this information.

17.1 Deployment and upgrade procedures

17.1.1 Common Operating Platform image
The Common Operating Platform (COP) is the base software platform for the Unigy Converged
Communications Manager, Media Manager, Aggregated Converged Communications Manager, and
Blue Wave appliances. It is a combination of base operating system and essential common and IPC
software components that is delivered as an ISO image file on a double-sided DVD.
For information on deploying the COP software, refer to Deploy the COP (Common Operating
Platform) software on page 448.
For information on determining whether the correct COP version is deployed, refer to Determine the
current COP version on page 450.
The image is hardened to IPC security specifications to minimize intrusion threats from external
sources.
The COP is installed by IPC Manufacturing prior to shipment of an appliance. There are also situations,
such as certain patches and corrective maintenance procedures, that require IPC technicians to deploy
the COP at a customer site.
The COP consists of the following major software components:
• Kickstart installer: Installs the operating system and IPC and third-party packages.
• Red Hat Enterprise Linux operating system (64-bit ): Minimized to include only the core components
required to operate and administer the system.
• MySQL Enterprise: Database.
• Oracle Communications Converged Application Server (OCCAS) – also known as WebLogic: The
system Application Server software.
• IPC packages: Network Configurator, security, fingerprint, and deployment RPMs that support host
and network configuration, prevention of unauthorized access, fingerprint generation, and Unigy and
third-party application deployment.
• Hardening script: Minimizes opportunities for unauthorized access.
• Snoopy: Provides a log of commands that are executed on a machine.
• syslog-ng: System logging.
• Additional security packages: Prevent unauthorized access.

IPC Confidential Unigy 4.3

Enterprise Guide
448 17.1: Deployment and upgrade procedures

17.1.2 Deploy the COP (Common Operating Platform) software

The Common Operating Platform (COP) is the customized Red Hat Linux operating system on which
the Unigy appliances run. It also includes supporting files and applications. These instructions apply to
deploying the COP on Converged Communications Manager (CCM), Media Manager (MM), and
Aggregated Converged Communications Manager (ACCM) appliances.

Important
The CCMs, MMs, and ACCMs are shipped with the COP software deployed; therefore, do not perform
this procedure (reCOP) unless you are deploying a software upgrade that requires new COP software or
encounter a major system failure that requires redeploying an appliance.

Note
Different Unigy software and hardware versions support different COP versions; for example:
• Unigy v2.x with R610 or R620 appliances requires COP version 02.00.00.00.1888.
• Unigy v3.x, v4.0.x, and v4.1.x with R620 or R630 appliances requires COP version 03.00.00.00.1272.
• Unigy v4.2 with R620 or R630 appliances supports COP version 03.00.00.00.1272.
• Unigy v4.2 with R640 appliances requires COP version 03.00.01.00.0018.
Future software updates might introduce new COP versions, therefore, when performing a procedure that
requires deploying the COP, be sure you are deploying the correct version. For information on the COP
version supported for each Unigy software version, refer to the UpgradePaths tab in the Unigy Product
Compatibility Matrix.

If you are deploying the COP on multiple appliances, you can save time by performing the deployments
synchronously or simultaneously. To perform the deployments synchronously, after the COP software is
installed on one appliance, insert the DVD in the next appliance as described in step 8. To perform the
COP simultaneously, obtain multiple DVDs.
Before you deploy the COP, remove any USB data storage devices that are connected to the appliance.
For overview information on the COP software, refer to Common Operating Platform image on page
447.
If a Single Click Deployment appliance is available, you can use it to deploy the COP software.
1. Power up the appliance.
If you see the prompt Do you want to generate fingerprint?, the COP software is
already deployed, proceed to step 9.
2. Insert the COP DVD in the appliance DVD drive.
3. Power cycle the appliance.
The appliance powers up and begins the boot process.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 449

Figure 65: System boot options

4. When the boot up screen displays the setup options, press F11.

Note
You have only a few seconds to do this, so it is important that you watch for this prompt. If you miss
the prompt, repeat step 3.

The F11 = BIOS Boot Manager prompt changes to Entering BIOS Boot Manager and
the system continues the boot process. If you are prompted for a password, type the BIOS password
then press Enter. Within approximately 30 seconds, the system displays the Boot Manager screen.
5. Select the BIOS Boot Menu option then press Enter.
The BIOS Boot Manager menu is displayed. It should be similar to the following screen:
Figure 66: BIOS Boot Manager Boot Sequence menu – Unigy – R620 hardware

6. Select the DVD optical drive option; for example, SATA Optical Drive, Optical Drive (SATA/ATA),
or Embedded SATA Port Optical Drive then press Enter.
The system boots from the DVD in the DVD drive and prepares to start the deployment.
7. At the prompt Press the <Enter> key to begin the Installation Process.,
press Enter.

IPC Confidential Unigy 4.3

Enterprise Guide
450 17.1: Deployment and upgrade procedures

The deployment process runs for approximately fifteen minutes then ejects the DVD and displays the
prompt Do you want to generate fingerprint?.
8. Remove the COP DVD from the DVD drive.

Note
If you are deploying the COP on another appliance, insert the DVD in the next appliance now and start
the deployment procedure for that appliance. Refer to steps 1 through 7.

9. Type n to skip fingerprint generation then press Enter.

The prompt Do you want to launch Network Configurator? is displayed.
10. Type y then press Enter.
The first Network Configurator screen is displayed. For information on configuring the appliance
network settings, refer to Configure the appliance network settings with Network Configurator on
page 450.

17.1.3 Determine the current COP version

Use this procedure to determine the current version of the COP software.
Do one of the following:
• If the zone is deployed, click the About tab within the UMS.
• If the zone is not deployed, but Network Configurator has been run:
1. Log in to the appliance from the console or command line.
2. Run the command su -lp and enter the appropriate password.
3. Run the hostinfo command.
• If the zone is not deployed and Network Configurator has not been run:
1. Power up the appliance.
2. When you are prompted to display the fingerprint information, type n then press Enter.
3. When you are prompted to run Network Configurator, type y then press Enter.
4. Configure the appliance network settings by performing the procedure Configure the appliance
network settings with Network Configurator on page 450.
5. Log in to the appliance from the console or command line.
6. Run the command su -lp and enter the appropriate password.
7. Run the hostinfo command.

17.1.4 Configure the appliance network settings with Network Configurator

Use Network Configurator to set the root user account password and the appliance network
configuration before deploying the personality software or to change the configuration values.

Important
Make all Network Configurator changes from the appliance console.

Within this topic, the terms current version and current software version refer to the Unigy software
version specified on the cover of this document. References to previous Unigy versions apply to the
versions, patches, service packs, and hotfixes for these versions that the current version supports.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 451

Prerequisites:
Before running Network Configurator, you should have the customer-provided network values for each
appliance. These are described in the customer's Unigy Data Collection document or Information to
collect prior to running Network Configurator or performing an upgrade on page 462.
You can access the appliance through a keyboard and video monitor attached to one of the appliance
USB ports and the VGA monitor port, an RS232 terminal emulator/VT100 connected through the
appliance serial port, or remotely with iDRAC or a KVM switch.

Note
Shell (ssh) access to the appliances might require completion of the first Network Configurator screen,
which defines the root account password. If it is necessary to access the shell before you complete
Network Configurator, specify the password, then use the Quit button to exit Network Configurator.

A Unigy Converged Communications Manager (CCM), Media Manager (MM), or Aggregated

Converged Communications Manager (ACCM) is delivered as a hardened appliance. IPC
Manufacturing installs the Common Operating Platform (COP) prior to shipping the appliance.
If Manufacturing did not fully deploy the appliance or if you are redeploying the appliance, when you
power it up for the first time, the system prompts you to generate the appliance finger print followed by
a prompt to run the Network Configurator utility, which is part of the COP. Network Configurator
provides the network data required for you to bring up the appliance and continue the deployment using
the Web-based Personality Deployer or Single Click Deployment.
If you are configuring multiple appliances, you can configure them simultaneously.
The Network Configurator options vary based on whether you configure the appliance with a single
network connection or connections to two separate switches for redundancy:
• Legacy: In a legacy configuration, one network interface connection (NIC) is active and is connected
to the Unigy network.
• Bonded: In a bonded pair configuration, two NICs are connected to the network: a primary and a
secondary. Both interfaces share the same IP address and reside on the same subnet and LAN; but
each NIC is connected to a different network switch.
A bonded pair configuration provides switch fault tolerance and failover functionality. The primary
NIC manages all network traffic under normal conditions. If the primary NIC or switch fails, the
secondary NIC becomes active and uses the other switch for network connectivity.
If you do not complete Network Configurator because of an unexpected interruption, it opens again to
enable you to complete the configuration after you power up or reboot the appliance. If the system does
not display Network Configurator when you power up the appliance, or changes are required after the
initial configuration, you can run Network Configurator by running the /opt/ipc/cop/
network_configurator/scripts/network_configurator.sh script from the Linux
command line. If you are rerunning Network Configurator after it was run for initial deployment, you
can access the command line through the console, ssh, iDRAC, or ION.

IPC Confidential Unigy 4.3

Enterprise Guide
452 17.1: Deployment and upgrade procedures

Important
After the initial deployment is complete, you can rerun Network Configurator as needed to modify the
network settings, however, only the following changes are permitted:
• Hostname
• IP Address
• Subnet Mask
• Dflt Gateway
• PeerReg.Host
• NIC Configuration Option (Media Managers only)
Changing any other values can have unpredictable results, including appliance failure. You can also rerun
Network Configurator without making any changes as part of the procedure to change a zone VIP.

1. If the appliance is not powered up, press the Power button.

On first boot, the system powers up then presents a prompt asking whether you want to generate a
fingerprint.
Figure 67: Prompt for generating fingerprints

Do you want to generate fingerprint <[y]es | [n]o]> ?

_

2. In most cases, you do not need the fingerprint value, so you can type n and press Enter. However, if
you need the fingerprint because you do not have an enterprise license file, type y then press Enter to
generate the fingerprint. Copy and paste the value into an e-mail message and send the message with
a request for an enterprise license to Westbrook Orders or to the Project Manager in your region who
is responsible for providing licenses. If the enterprise consists of multiple appliances, send the
fingerprint values for all of the CCM or ACCM appliances.
3. When prompted to launch Network Configurator, type y then press Enter.
Figure 68: Prompt for launching Network Configurator

Do you want to Launch Network Configurator <[y]es] | [n]o]> ?

_

Note
If the system does not prompt you to run Network Configurator, log in with root privileges and run the
script /opt/ipc/cop/network_configurator/scripts/
network_configurator.sh.

The appliance displays the Network Configurator – Configure Root Password screen, which prompts
you to enter and confirm the password you are assigning to the Linux root user account.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 453

Figure 69: Network Configurator – Configure Root Password screen

4. In the Enter Password field, type the password that you want to assign to the Linux root user
account then press the Tab key.
A valid password should be a mix of upper and lower case letters, numeric digits, and special
characters; use at least 7 characters in a password, with characters from all of these classes. An upper
case letter that begins the password and a digit that ends it do not count towards the number of
character classes used. The following special characters can be included:
@ $ # % & * ! ( ) + | _ -

(Spaces are included for readability; spaces are not valid characters.)
5. In the Re-Enter Password field, retype the root password then press Tab.
The Next button is highlighted.
6. Press Enter.
Network Configurator confirms that both passwords match and validates them against the system's
password policy, then displays the Host Information Configuration screen.
Figure 70: Network Configurator - Host Information Configuration screen

7. In the Hostname field, type a unique name that identifies the appliance, then press Tab.

IPC Confidential Unigy 4.3

Enterprise Guide
454 17.1: Deployment and upgrade procedures

Important
The first segment of the fully qualified host name must be unique throughout the entire Unigy
enterprise. For example, the names server1.ipc.com and
server1.development.ipc.com are not considered unique.
This requirement applies to any enterprise device managed by Unigy: CCMs, ACCMs, Media
Managers, Media Gateways, turrets, and Pulse devices.

8. In the Domain field, type the network domain name then press Tab.
9. In the NIC Configuration Option field, choose one of the following:
• Legacy: Configure each network interface independently.
• Bonded: Configure bonded network interface bond0 (bonding eth0 and eth2), and optionally
configure bond1 (bonding eth1 and eth3).
10. Press Tab until the Next button is highlighted then press Enter.
The remaining screens differ depending on whether you chose the Legacy or Bonded option.
11. Continue with Configure legacy connections on page 454 or Configure bonded connections on page
458.

17.1.4.1 Configure legacy connections

When you choose the Legacy option, Network Configurator displays the Backroom Network Interface-1
Configuration screen where you enter the network values for the eth0 NIC.
Figure 71: Network Configurator – Backroom Network Interface-1 Configuration screen (legacy)

1. Press Tab to leave the NIC Configuration field set to Auto:Auto:Auto.

The Identify eth0 button is highlighted.
2. To identify the port on the back of the appliance to which you should connect the Ethernet cable for
this NIC, press Enter.
The left LED on the Ethernet port flashes orange to identify the associated port.

Note
On some appliances, the eth0 NIC is not the first of the four ports; therefore, you should perform this
step to be sure you are connecting the cable to the correct port.

3. Connect the Ethernet cable to the port indicated then press Tab.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 455

4. In the IP Address field, type the eth0 NIC IP address designated for this appliance then press Tab.
5. In the Subnet Mask field, type the network subnet mask then press Tab.
6. In the Dflt Gateway field, type the IP address of the network default gateway then press Tab.
7. In the PeerReg.Host field, enter one of the following values:
• For an ACCM in a standalone enterprise, leave the field blank. A standalone enterprise has an
Express license that supports a single ACCM in a single zone.
• For an appliance in an HA pair, enter the IP address of the peer CCM or ACCM. This is the other
appliance in the HA pair.
• For a Media Manager, enter the zone VIP.
8. Press Tab until the Next button is highlighted then press Enter.
Network Configurator displays the Backroom Network Interface-2 Configuration screen.
Figure 72: Network Configurator – Backroom Network Interface-2 Configuration screen (legacy)

9. In the Skip eth2 Configuration field, press the right arrow on the keyboard to change the value to
Yes.
10. Press Tab until the Next button is highlighted then press Enter.
Network Configurator displays the Enterprise Network Interface-1 Configuration screen, where if
applicable, you configure the eth1 NIC.

IPC Confidential Unigy 4.3

Enterprise Guide
456 17.1: Deployment and upgrade procedures

Figure 73: Enterprise Network Interface-1 Configuration screen (legacy)

11. In the Skip eth1 Configuration field, press the right arrow on the keyboard to change the value to
Yes.
12. Press Tab until the Next button is highlighted then press Enter.
Network Configurator displays the Enterprise Network Interface-2 Configuration screen.
Figure 74: Enterprise Network Interface-2 Configuration screen (legacy)

13. In the Skip eth3 Configuration field, press the right arrow on the keyboard to change the value to
Yes.
14. Press Tab until the Next button is highlighted then press Enter.
Network Configurator displays the Network Static Route(s) Information Configuration screen. This
screen is reserved for future use.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 457

Figure 75: Network Static Route(s) Information Configuration screen (legacy)

15. Press Tab until the Next button is highlighted then press Enter.
Network Configurator displays the DNS & NTP Information Configuration screen. Enter the IP
addresses for up to three NTP servers for time synchronization.

Note
The DNS Configuration Option, Master Server, and Zone fields are not supported. Entering values for
these fields does not configure access to a Domain Name Server. To specify a DNS for external
directory servers, multi-factor authentication SMTP servers, voice recorder certificates that include an
FQDN, or any other feature that requires a DNS, refer to Configure Unigy access to Domain Name
System (DNS) servers on page 421.

Figure 76: DNS & NTP Information Configuration screen (legacy)

16. To enter one or more NTP server IP addresses, do the following:

a) Press Tab to select the first NTP Server field, then type the NTP server IP address.
b) If you are entering the IP address for another NTP server, press Tab to select the [2] field, then type
the IP address. If you are not adding another NTP server, proceed to the next step.

IPC Confidential Unigy 4.3

Enterprise Guide
458 17.1: Deployment and upgrade procedures

17. Press Tab until the Next button is highlighted, then press Enter.
Network Configurator displays the Configuration Successful screen.
Figure 77: Configuration Successful screen (legacy)

18. Press Enter.

Network Configurator closes and the appliance reboots.
Single Click Deployment appliance registration
If you are deploying the appliance personality software and the zone with Single Click Deployment
(SCD) instead of Personality Deployment and Zone Deployer, do the following to register the appliance
with the SCD appliance. If you are not using SCD, skip these steps.
1. Run the following command to stop iptables:
service iptables stop
2. Perform the procedure Register a Unigy appliance with a Single Click Deployment appliance on page
160.

17.1.4.2 Configure bonded connections

When you choose the Bonded option, Network Configurator displays the Backroom Network Interface
Configuration screen where you enter the network values for bond0 (two NICs on the same appliance).

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 459

Figure 78: Network Configurator – Backroom Network Interface Configuration screen (bonded)

1. Press Tab to leave the NIC Configuration field set to Auto:Auto:Auto.

The Identify eth0 button is highlighted.
2. To identify the port on the back of the appliance to which you should connect the Ethernet cable for
this NIC, press Enter.
The left LED on the Ethernet port flashes orange to identify the associated port.

Note
On some appliances, the eth0 NIC is not the first of the four ports; therefore, you should perform this
step and step 4 to be sure you are connecting the cables to the correct ports.

3. Connect the Ethernet cable to the port indicated, then press Tab.
The Identify eth2 button is highlighted.
4. To identify the port on the back of the appliance to which you should connect the Ethernet cable for
this NIC, press Enter.
The left LED on the Ethernet port flashes orange to identify the associated port.
5. Connect the Ethernet cable to the port indicated, then press Tab.
6. In the IP Address field, type the bond0 NIC IP address designated for this appliance, then press Tab.
7. In the Subnet Mask field, type the network subnet mask then press Tab.
8. In the Dflt Gateway field, type the IP address of the network default gateway then press Tab.
9. In the PeerReg.Host field, enter one of the following values:
• For an ACCM in a standalone enterprise, leave the field blank. A standalone enterprise has an
Express license that supports a single ACCM in a single zone.
• For an appliance in an HA pair, enter the IP address of the peer CCM or ACCM. This is the other
appliance in the HA pair.
• For a Media Manager, enter the zone VIP.
10. Press Tab until the Next button is highlighted then press Enter.
Network Configurator displays the Enterprise Network Configuration screen.

IPC Confidential Unigy 4.3

Enterprise Guide
460 17.1: Deployment and upgrade procedures

Figure 79: Network Configurator – Enterprise Network Configuration screen (bonded)

11. In the Skip bond1 Configuration field, press the right arrow on the keyboard to change the value to
Yes.
12. Press Tab until the Next button is highlighted, then press Enter.
Network Configurator displays the Network Static Route(s) Information Configuration screen. This
screen is reserved for future use.
Figure 80: Network Static Route(s) Information Configuration screen (bonded)

13. Press Tab until the Next button is highlighted, then press Enter.
Network Configurator displays the DNS & NTP Information Configuration screen. You can enter the
IP addresses for up to three NTP servers for time synchronization.

Note
The DNS Configuration Option, Master Server, and Zone fields are not supported. Entering values for
these fields does not configure access to a Domain Name Server. To specify a DNS for external
directory servers, multi-factor authentication SMTP servers, voice recorder certificates that include an
FQDN, or any other feature that requires a DNS, refer to Configure Unigy access to Domain Name
System (DNS) servers on page 421.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 461

Figure 81: DNS & NTP Information Configuration screen (bonded)

14. To enter one or more NTP server IP addresses, do the following:

a) Press Tab to select the first NTP Server field then type the NTP server IP address.
b) If you are entering the IP address for another NTP server, press Tab to select the [2] field, then type
the IP address. If you are not adding another NTP server, proceed to the next step.
15. Press Tab until the Next button is highlighted then press Enter.
Network Configurator displays the Configuration Successful screen.
Figure 82: Configuration Successful screen (bonded)

16. Press Enter.

Network Configurator closes and the appliance reboots.
Single Click Deployment appliance registration
If you are deploying the appliance personality software and the zone with Single Click Deployment
(SCD) instead of Personality Deployment and Zone Deployer, do the following to register the appliance
with the SCD appliance. If you are not using SCD, skip these steps.
1. Run the following command to stop iptables:
service iptables stop

IPC Confidential Unigy 4.3

Enterprise Guide
462 17.1: Deployment and upgrade procedures

2. Perform the procedure Register a Unigy appliance with a Single Click Deployment appliance on page
160.

17.1.4.3 Information to collect prior to running Network Configurator or performing an upgrade

This topic describes network properties that are required to deploy Unigy Converged Communications
Manager (CCM), Aggregated Converged Communications Manager (ACCM), and Media Manager
(MM) appliances. The network properties are used for configuring the appliance with Network
Configurator and for upgrades.
This table describes the network deployment properties. Refer to the customer's Unigy Data Collection
document to determine the values for these properties. Use the Network configuration properties
worksheet on page 464 to record the customer-specific values.
The properties in the table are grouped based on where they are configured or where they can be viewed.
The first group is configured in Network Configurator during initial deployment or when the values are
changed. The second group is configured at Configuration ➤ Enterprise ➤ System ➤ Zones when
the zones are initially configured or during upgrades. The third group is configured in Zone Deployer
and visible within the Install tab at Tools ➤ Deployment ➤ Software Deployment.

Table 49: Deployment properties

Properties Description Notes

Network Configurator properties
Password Password you want to assign to the If you are deploying the CCMs or ACCMs
appliance Linux root user account. in an HA cluster, the root password for the
primary and secondary appliances must
be the same.
A valid password should be a mix of upper
and lower case letters, digits, and special
characters; use at least 7 characters in a
password with characters from all of these
classes. An upper case letter that begins
the password and a digit that ends it do
not count towards the number of character
classes used.
Host name Name to assign to the appliance for The host name must be unique throughout
identification purposes. the entire Unigy enterprise. For example,
the fully qualified host names
server1.ipc.com and
server1.development.ipc.com
are not considered to be unique because
they both begin with the "server1." host
name.
This requirement applies to any enterprise
device managed by Unigy: CCMs,
ACCMs, Media Managers, Media
Gateways, turrets, and Pulse devices.
Domain Network domain within which the For example, companyname.com.
appliance resides.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 463

Table 49: Deployment properties (continued)

Properties Description Notes

NIC Type of ethernet NIC communication and Default: Legacy
configuration fault-tolerance support. The following
options are available:
• Legacy configuration uses a single NIC
for network communication: eth0.
• Bonded configuration uses bonded
NICs for fault-tolerance. If you are
providing failover support with a single
network, you specify the values for the
eth0 and eth2 NICs. If you are
providing failover support with two
networks, you also specify the values
for the eth1 and eth3 NICs.

Appliance IP IP address assigned to the appliance's Use dot-decimal format

address eth0 NIC or to the bond0 bonded NIC. nnn.nnn.nnn.nnn.

Subnet mask Network subnet mask. Use dot-decimal format

nnn.nnn.nnn.nnn.

Default IP address of the network default Use dot-decimal format

gateway gateway. nnn.nnn.nnn.nnn.

Peer or IP address for the zone's host or cluster. Use dot-decimal format
Registration Enter one of the following: nnn.nnn.nnn.nnn.
host
• For standalone system: blank
• For HA setup: IP address of peer
• For Media Manager: VIP address of
HA cluster or IP address of standalone
CCM

Static routes If you are configuring a two-network Use dot-decimal format

(multi-home) interface configuration, you nnn.nnn.nnn.nnn.
will define the static routes that establish
the routing table. You need the following
information for each static route:
• Network or host IP address
• Network subnet mask
• Network default gateway
NTP server IP addresses for up to three Network Use dot-decimal format
Time Protocol (NTP) servers that the nnn.nnn.nnn.nnn.
system uses for time synchronization on
the appliances and other system
hardware.
Network configuration properties for Zone Configuration
VIP Address Virtual IP address for the zone associated Use dot-decimal format
with the appliances you are deploying or nnn.nnn.nnn.nnn.
upgrading.

IPC Confidential Unigy 4.3

Enterprise Guide
464 17.1: Deployment and upgrade procedures

Table 49: Deployment properties (continued)

Properties Description Notes

ACCM/CCM1 IP address of the zone's primary Use dot-decimal format
Server IP appliance. nnn.nnn.nnn.nnn.
Address
ACCM/CCM2 IP address of the zone's secondary Use dot-decimal format
Server IP appliance. nnn.nnn.nnn.nnn.
Address
Backroom Backroom location in which the zone's
Location appliances reside.
Software Deployment
Zone ID ID assigned to a zone when the zone is
initially deployed with Zone Deployer or
when it is changed after initial
deployment.

17.1.4.4 Network configuration properties worksheet

This worksheet identifies network property values for each Unigy CCM, ACCM, or MM appliance you
are deploying.
Also refer to the customer's Unigy Data Collection document.
For a description of each of these properties, refer to Information to collect prior to running Network
Configurator or performing an upgrade on page 462.
The properties in the table are grouped based on where they are configured or where they can be viewed.
The first group is configured in Network Configurator during initial deployment or when the values are
changed. The second group is configured at Configuration ➤ Enterprise ➤ System ➤ Zones when
the zones are initially configured or during upgrades. The third group is configured in Zone Deployer
and visible within the Install tab at Tools ➤ Deployment ➤ Software Deployment.
Properties for multiple components can be recorded here. Use additional worksheets if necessary, or
collect properties in a spreadsheet based on this worksheet.

Note
Save this information in case it is needed for updates that require a new COP, rebuilding an appliance, or
redeploying a zone.

Table 50: Customer appliance values

Properties Appliance 1 Appliance 2 Appliance 3 Appliance 4 Appliance 5 Appliance 6

Network Configurator properties
Password
Host name
Domain
NIC
configuration

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 465

Table 50: Customer appliance values (continued)

Properties Appliance 1 Appliance 2 Appliance 3 Appliance 4 Appliance 5 Appliance 6

Appliance IP
address
Subnet mask
Default
gateway
Peer or
registration
host
Static routes
NTP server
Network configuration properties for Zone Configuration
VIP Address
ACCM/
CCM1
Server IP
Address
ACCM/
CCM2
Server IP
Address
Backroom
Location
Software Deployment
Zone ID

17.1.5 Deploy the appliance personality software with Personality Deployer

The Unigy personality (application) software is deployed on appliances using Personality Deployer. The
software is delivered in an ISO file that is added to the appliance during the Common Operating
Platform (COP) software deployment or is uploaded or transferred to the appliance from a DVD or
external data storage device.
The personality software is designed to be installed from a remote computer through a Web browser. In
the context of this procedure, a Unigy appliance is a Converged Communications Manager (CCM),
Aggregated Converged Communications Manager (ACCM), or Media Manager (MM). The application
software for other types of appliances, including Media Gateways, Channel Banks, and Session Border
Controllers, is installed by IPC Manufacturing.
Personality Deployer provides the option to create disk image backups that provide restore points to
which you can roll back the appliance if problems are encountered. If you select this option, the system
creates a backup before the personality deployment and one after the deployment. This helps to save
time if you discover a problem with the personality deployment or zone deployment, because you can
return to the appropriate restore point without having to redeploy the COP software. For information on
restoring a backup image, refer to Roll back a personality or zone deployment on page 386.
The appliance reboots multiple times during the deployment.

IPC Confidential Unigy 4.3

Enterprise Guide
466 17.1: Deployment and upgrade procedures

1. Launch Personality Deployer:

a) From a Web browser, access https://appliance_ip, where appliance_ip is the IP
address of the appliance on which you are deploying the software.
You are prompted for login credentials.
b) Type the user name and password for the install user account then click OK.
The Personality Deployer window opens.
2. Determine whether the ISO you are deploying is in the Select ISO to perform Operation list. If the
file is not in the list, upload or transfer the file as described below. If low band width is an issue, use
the transfer option.
• To upload the file:
1. Within Personality Deployer, in Upload an ISO, click Browse.
2. Locate and select the file then click Upload.
• To transfer the file from a corporate server or another Unigy appliance:
1. In Transfer an ISO, enter the URL for accessing the file. You must use the server or appliance
IP address, not the hostname.
2. Click Transfer.
The upload or transfer takes approximately fifteen minutes to complete on a local network, but can
take much longer over a VPN connection. The transfer generally takes less time than the upload. If
the upload or download fails due to low band width or slow transfer rates caused by corporate
security controls, refer to Download an ISO file when an upload or download fails on page 548.
When the upload or transfer process completes, the system displays the message ISO file
uploaded successfully or ISO file transferred successfully. Click Back to
return to Personality Deployer.
3. Enter the appropriate values for each field according to the type of appliance you are deploying.

Note
For screen, field, and button descriptions for this application, refer to Personality Deployer on page
467.

a) Select the appropriate personality type for the appliance you are deploying.
b) Select the appropriate Country Base.
c) If the appliance is part of an HA pair, select Appliance is part of an HA pair, confirm that the
Peer Host is correct, then type the Local Zone VIP for the zone you are deploying.
d) If the appliance is an MM, enter the Registration Host, which in an HA zone is the zone VIP.
4. To create the disk image backups, select the Back-up check box. This is the default setting.

Note
Even though a new installation has no data or working environment to preserve, creating a rollback
point is advised because it will allow remote recovery from any unforeseen adversities.
5. In the Select ISO to perform Operation list, select the ISO file to deploy.
6. Click Install, then click Start Installation.
If you selected Back-up, the system reboots and you temporarily lose access while the first image
backup file is created. This takes approximately 15 minutes. When the backup is complete, the
deployment begins. While the software deployment is in progress, you can access the appliance

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 467

through SSH or the console. After the deployment completes, the appliance reboots then the system
creates the second image backup.
7. To view the progress of the deployment, do the following:
a) After approximately 15 minutes, click Back to return to the Personality Deployer window.
b) Click Get Status to display the current deployment status and progress.
c) Refresh the page periodically by clicking Back then re-clicking Get Status until it displays
Deployment Progress = 100% and Deployment Status = Complete.
For CCMs and ACCMs, the deployment takes approximately 90 minutes to complete, if you
selected the backup option, and 60 minutes if you did not. For MMs, the process takes
approximately 15 minutes.
You can also monitor the deployment progress by clicking Back then clicking Get logs. At the end
of the log you should see output similar to the following, which indicates that the deployment is
complete and the post deployment image backup is starting:
Figure 83: Personality Deployer log showing the end of the deployment process prior to creating
the final image backup

8. Click Host Info and confirm that the values for the following attributes are correct:
• Personality is
• COP Software Version
• Unigy Software Version
• Personality Type
• The zone VIP
• Peer Host IP

17.1.5.1 Personality Deployer

This topic is a reference for the fields and options available in the Personality Deployer application.
Personality Deployer deploys personality (application) software on Unigy Converged Communications
Manager (CCM), Aggregated Converged Communications Manager (ACCM), and (MM) appliances.
Access Personality Deployer from a browser by navigating to https://appliance_IP/
deployment/PersonalityDeployment.html, where appliance_IP is the IP address of the
appliance on which you are deploying the software. Enter the install user account credentials then
click OK.
Personality Deployer options
Personality Deployer provides the following options:

IPC Confidential Unigy 4.3

Enterprise Guide
468 17.1: Deployment and upgrade procedures

• Install on page 471 – Installs the personality software from the selected ISO file.
• Delete on page 471 – Deletes the selected ISO file from the appliance.
• List Contents on page 472 – Lists the contents of the manifest for the selected ISO file.
• Validate ISO on page 472 – Validates the ISO file to ensure that it is viable before deployment.
• Get Logs on page 472 – Displays the logs from the last personality software deployment.
• Get Status on page 472 – Displays the progress of the software deployment.
• Roll Back on page 472 – Restores the system to a previous rollback point.
• Host Info on page 472 – Provides basic information about the current appliance including network
configuration, personality, software versions, HA pair, and zone VIP values.
• Upload an ISO on page 476 – Uploads an ISO file to the appliance from a remote data storage
device.
• Transfer an ISO on page 476 – Transfers a personality ISO file from another Unigy appliance.
• Change Password on page 476 – Changes the Personality Deployer password.
Figure 84: Personality Deployer application

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 469

Table 51: Personality Deployer

Name Description Values Notes

Select Personality Type of personality • ACCM – deploys the After deployment, to
software to deploy. appliance as an determine the
Aggregated personality that was
Converged deployed, click Host
Communications Info.
Manager by installing
the CCM and MM
software on the same
appliance.
• CCM – deploys the
appliance as a
Converged
Communications
Manager by installing
only the CCM
software on the
appliance.
• MM – deploys the
appliance as a Media
Manager by installing
only the MM software
on the appliance.

Select CountryBase Specifies tones, • Australia Customer provided.

cadences, and electrical For guidelines on the
and regulatory • China country base to assign,
requirements for devices • Pan-Euro refer to Country base
in a specific designations on page
geographical region. • South Africa
476.
• United Kingdom
• United States

Appliance is part of an Specifies whether the Select the check box to This option applies to
HA pair appliance will be a indicate that the CCMs and ACCMs.
member of a High appliance will be a
Availability (HA) cluster member of an HA pair.
that provides local
appliance resilience and
fault-tolerance.
Peer Host Identifies the peer IP address in dot- This field is visible only if
appliance in an HA pair decimal notation you select the Appliance
(the other appliance in nnn.nnn.nnn.nnn is part of an HA pair
the cluster). Default: IP address check box.
entered in Network
Configurator during
network configuration.
Local Zone VIP Virtual IP address (VIP) IP address in dot- This field is visible only if
of the zone HA cluster in decimal notation you select the Appliance
which the appliance is a nnn.nnn.nnn.nnn is part of an HA pair
member. check box.

IPC Confidential Unigy 4.3

Enterprise Guide
470 17.1: Deployment and upgrade procedures

Table 51: Personality Deployer (continued)

Name Description Values Notes

Registration Host • In a standalone (non- IP address in dot- This field is visible only if
HA) zone, identifies decimal notation you select MM in the
the IP address of the nnn.nnn.nnn.nnn Select Personality field.
CCM with which the
MM communicates.
• In an HA zone,
identifies the Virtual
IP address (VIP) of
the zone through
which the MM
communicates with
the active CCM.

Back-up Indicates whether Select the check box to A rollback point is a

Personality Deployer enable the backup. single file that contains
creates drive image Clear the check box to the complete contents
backups prior to and disable the backup. and structure of a drive
after deploying the Default: enabled or partition. In the event
personality software. of an unsuccessful
This feature can deployment, you can
eliminate the need to return to a working
reCOP an appliance if a deployment.
problem is discovered
with the personality or
Note
zone deployment.
Even though a new
installation has no data
or working environment
to preserve, creating a
rollback point is advised
because it will allow
remote recovery from
any unforeseen
adversities.

Select ISO to perform List of personality ISO ISO file names If the ISO file you want
Operation files available in all to deploy is not in the
zones that you can list, use Upload an ISO to
install, validate, upload the ISO file or
download, or delete. You Transfer an ISO to
can also display the transfer the file from
contents of the ISO another appliance or
manifest, display the corporate server.
logs and status of the
deployment, and restore
to a previous image.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 471

Table 51: Personality Deployer (continued)

Name Description Values Notes

Upload an ISO Enables you to upload a ISO file name returned Click Browse to locate
personality software ISO by the Browse operation and select an ISO file,
file to the appliance from which is then displayed
a laptop or remote data in the text field. Click
storage device. Upload to upload the file.
The file is uploaded
to /opt/ipc/
deployment/iso/.
Refresh the screen to
see the file in the Select
ISO to perform Operation
list.
Transfer an ISO Enables you to transfer URL that identifies theType the URL then click
a personality software location from which theTransfer.
ISO file from another system transfers the Transfer reduces the
Unigy appliance or a ISO file. For example, to
bandwidth cost of
corporate server to the download a file from uploading the ISO file to
current appliance. another appliance, use each appliance. Instead,
the URL format you upload the file to a
http:// single server or
appliance_ip/ appliance then
stage/iso/iso- download it from that
filename, as in source to each
http:// appliance.
The file is downloaded
10.20.30.40/
to /opt/ipc/
stage/iso/
deployment/iso/.
dunkin_02.00.00.
Refresh the screen to
00.1448.iso see the file in the Select
(assumes that the file ISO to perform Operation
was uploaded list.
to /opt/ipc/
deployment/iso/).
Change Password Enables you to change 8 to 20 alphanumeric For security reasons,
the Personality Deployer characters including the IPC recommends
password for the following special changing the default
install user account. characters: @$_. password. Type the new
password value then
click Change.

Install
Deploys the software from the ISO file selected in the Select ISO to perform Operation list. Select the
appropriate ISO file than click Install.
Delete
Enables you to delete the selected ISO file in the Select ISO to perform Operation list. Select the
appropriate ISO file than click Delete.

IPC Confidential Unigy 4.3

Enterprise Guide
472 17.1: Deployment and upgrade procedures

Note
The file is immediately deleted; there is no confirmation dialog box.

List Contents
Lists the contents of the manifest for the ISO file selected in the Select ISO to perform Operation list.
The manifest contains information such as the software version, release date, and the RPM packages
contained in the ISO file.
Validate ISO
Performs an ISO verification procedure to determine the integrity of the ISO file. If the ISO is valid, the
system displays the message ISO is good... verification passed.
Get logs
Displays the log contents from the last personality deployment. A successful software deployment ends
with output similar to the following:

[Mon Feb 14 13:22:10 EST 2011] : All packages installed Successfully

[Mon Feb 14 13:22:10 EST 2011] : === DONE =====
[Mon Feb 14 13:22:11 EST 2011] : Deployment Process exiting with
exit status 0
[Mon Feb 14 13:22:11 EST 2011] : !!! SYSTEM IS GOING TO REBOOT AFTER
INSTALL ... PLEASE WAIT... !!!!

Get Status
Displays information about the progress and status of an ISO file deployment in XML format.

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

- <jobProgress xmlns:ns2="http://www.ipc.com/JobProgress/">
<result>partial</result>
<count>1</count>
<progress>100</progress>
<complete>0</complete>
</jobProgress>

RollBack
Restores the system to the rollback point you select. Two rollback points are created when you select the
Back-up check box during the deployment of the personality software.

Host Info
Provides basic information about the current appliance, including network configuration, personality,
software versions, HA cluster, and zone VIP. Some of the properties are available only for certain
configuration scenarios. The output is a dump of responses to a set of questions, not a formatted report.
See the following sample report from the primary CCM in an HA cluster with bonded NICs:
Primary Interface MAC: 00:21:9B:8D:D9:14
Server Registration UUID: 09219B8DD914
Primary Interface name: bond0
Primary Interface IP: 20.30.40.50
Primary Interface IP MASK: 255.255.255.255
Primary Interface is Bonded
Primary Interface is Static
Personality is an Application Server
Personality is not ACCM

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 473

Personality is CCM
Personality is not MM
NTP sources list: 20.50.50.50
COP Software Version: 02.00.00.00.1436
Unigy Software Version: 02.00.00.00.1436
Setup as SFHA/SLHA pair
Server HA mode is enabled
Server has the OCCAS AdminServer
Server is the Primary Node mds_host
Personality Type: CCM1
Model: R620
My other data source IP: 20.30.40.51
The zone VIP: 20.30.40.52
Peer Host IP: 20.30.40.51
OCCAS AdminServer IP: 20.30.40.50

Table 52: Host Info output

Name Description Values Notes

Primary Interface MAC Appliance's primary NIC
MAC address.
Server Registration Appliance's Universal
UUID Unique Identifier (UUID).
Primary Interface name Appliance's first NIC • eth0 – bonding is not The output does not
adapter. The name enabled provide information on
varies based on whether the other interface
bonding is enabled. • bond0 – bonding is adapters.
enabled for NIC
redundancy

Primary Interface IP Appliance's primary NIC

IP address
Primary Interface IP Appliance's primary NIC
MASK network subnet mask.
Primary Interface is Indicates whether NIC • Legacy – bonding is
redundancy is supported not enabled
for bond 0.
• Bonded – bonding is
enabled

Primary Interface is Indicates how the • Static – administrator

appliance primary NIC assigned and does
IP address is assigned. not change
• Dynamic – a DHCP
server is used to
assign the IP address

Personality is Indicates whether the • Application Server

appliance is an
application server or a • Media Server
media server.

IPC Confidential Unigy 4.3

Enterprise Guide
474 17.1: Deployment and upgrade procedures

Table 52: Host Info output (continued)

Name Description Values Notes

Personality is or is not Indicates the type of • ACCM – Converged
appliance based on the Communications
personality software Manager and Media
installed. Manager software are
installed
• CCM – only the
Converged
Communications
Manager software is
installed
• MM – only the Media
Manager software is
installed

NTP sources list IP addresses of NTP

servers that provide time
synchronization for the
appliance.
COP Software Version Version of the Common
Operating Platform
(COP) software
installed.
Unigy Software Version Version of the Unigy This version can be
personality software different from the COP
installed. version.
Setup as Indicates whether the • Standalone Server – This property does not
appliance is configured HA is not supported indicate the type of High
to support HA. Availability supported.
• SFHA/SLHA pair – That information is
the appliance is a based on the enterprise
member of a stateful license.
or stateless HA pair

Server HA mode is Indicates whether HA is • enabled Displayed only for

enabled. appliances that are
• disabled members of an HA pair.
HA is disabled or a Indicates that HA is In an HA zone, this is
Standalone setup currently disabled or the displayed until you run
appliance is a Zone Deployer, which
standalone appliance. enables HA.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 475

Table 52: Host Info output (continued)

Name Description Values Notes

Server Indicates whether the • Server has the The AdminServer JVM
OCCAS AdminServer OCCAS AdminServer does not run on a
JVM is running on the – appliance is a secondary appliance.
appliance. standalone appliance
or the primary
appliance in an HA
pair
• Server is not the
OCCAS AdminServer
– appliance is the
secondary appliance
in an HA pair

Server Indicates whether the • is the Primary Node

appliance is a mds_host – primary
standalone appliance or appliance
the primary appliance in
an HA pair. • is not mds_host –
secondary appliance

Personality Type Indicates the appliance • ACCM – standalone Unigy 360 does not
personality and HA role. ACCM support ACCMs.

• ACCM1 – primary
ACCM in an HA pair
• ACCM2 – secondary
ACCM in an HA pair
• CCM – standalone
CCM
• CCM1 – primary
CCM in an HA pair
• CCM2 – secondary
CCM in an HA pair
• MM – Media Manager
Model Appliance model • R620
number.
• R630
My other data source IP IP address of the other If the appliance is a
member of the HA pair. standalone appliance,
the localhost IP address
(127.0.0.1) is displayed.
VIP not set yet Displayed for a Standalone appliances
standalone appliance or do not have a VIP.
when the VIP has not
been specified.
The zone VIP Virtual IP address of the The value is blank for a
zone cluster. standalone appliance.

IPC Confidential Unigy 4.3

Enterprise Guide
476 17.1: Deployment and upgrade procedures

Table 52: Host Info output (continued)

Name Description Values Notes

Peer is undefined for Indicates that the Displayed only on a
standalone server appliance is a standalone appliance.
standalone appliance.
Peer Host IP IP address of the other The value is blank for a
member of the HA pair. standalone appliance.
OCCAS AdminServer IP IP address of the This is the IP address of
appliance on which the a standalone appliance
OCCAS AdminServer or the primary appliance
JVM is running. in an HA pair. The
AdminServer JVM does
not run on a secondary
appliance.

Upload an ISO
If the ISO file you are deploying is not in the Select ISO to perform Operation list, you can use this
option to upload the file to the current appliance from a data source such as a laptop, desktop computer,
or external data storage device. If bandwidth is an issue at a customer site, refer to Transfer an ISO on
page 476.
• The Browse button opens the Choose File to Upload dialog box where you select a file to upload.
After you select a file, the file path and name populate the text box.
• The Upload button copies the selected file to the /opt/ipc/deployment/iso/ directory on the
appliance and displays the file name in the Select ISO to perform Operation list.
Transfer an ISO
If the ISO file you are deploying is not in the Select ISO to perform Operation list, you are deploying
one or more HA zones, and bandwidth is an issue, you can transfer the ISO to the current appliance from
a corporate server or another Unigy CCM or ACCM. This can reduce the bandwidth cost and time
required to load an ISO file on a Unigy appliance. To use this option, upload the ISO file to a server or
Unigy appliance then when you run Personality Deployer on each additional appliance, type the URL to
the ISO file then click Transfer. The URL must include the source server or appliance IP address, not
the hostname.
Change Password
Provides a text box for entering a new password for the Personality Deployer application install user
account. Type the new password then click Change.

Important
There is no password confirmation, so be sure the value you enter is correct.

17.1.5.1.1 Country base designations

This topic provides a list of IPC country base designations for different countries. These are guidelines
that you can use when you configure appliance network settings with Network Configurator. They are
based on current customer configurations.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 477

Country Country base

Argentina USA
Australia Australia
Austria Pan-Euro
Bahrain Pan-Euro
Belgium Pan-Euro
Brazil USA
Canada USA
Chile USA
China China
Colombia USA
Czech Republic Pan-Euro
Denmark Pan-Euro
France Pan-Euro
Germany Pan-Euro
Greece Pan-Euro
Hong Kong United Kingdom (some customers use USA)
Hungary Pan-Euro
India USA
Indonesia USA
Ireland Pan-Euro
Israel Pan Euro
Italy Pan-Euro
Japan USA
Luxembourg Pan-Euro
Malaysia United Kingdom
Mexico USA
Netherlands Pan-Euro
New Zealand Australia
Norway Pan-Euro
European Union Pan Euro
Peru USA
Philippines United Kingdom
Qatar Pan-Euro
Russia Pan-Euro

IPC Confidential Unigy 4.3

Enterprise Guide
478 17.1: Deployment and upgrade procedures

Country Country base

Saudi Arabia Pan-Euro
Singapore United Kingdom
South Africa South Africa
South Korea USA
Spain Pan-Euro
Sweden Pan-Euro
Switzerland Pan-Euro
Taiwan USA
Thailand United Kingdom
Turkey Pan-Euro
United Arab Emirates Pan-Euro
United Kingdom Unigy – United Kingdom, Alliance MX – Pan-Euro
United States USA
Vietnam USA

17.1.6 Transfer a personality ISO file

If the ISO file for a personality software deployment is not available in the Select ISO to perform
Operation list when you run Personality Deployer, you can upload the file from a DVD or external
storage device or transfer the file from another Unigy CCM or ACCM appliance. The ISO files are quite
large and can take a considerable amount of time to upload. The transfer feature requires less time, so it
is often a better choice when there are bandwidth issues at a customer site. This topic describes the
transfer procedure.
The ISO files reside in the /opt/ipc/deployment/iso directory.
1. Open Personality Deployer for the Unigy appliance that is serving as the source appliance for
transferring the personality ISO file to other appliances:
a) From a Web browser, navigate to https://appliance_ip/deployment/
PersonalityDeployment.html, where appliance_ip is the IP address of the appliance.
You are prompted for login credentials for the install user account.
b) Type the user name and password then click OK.
The Personality Deployer window opens.
2. At the Upload to ISO option, click Browse, locate and select the ISO file, then click Upload.
The ISO is uploaded to the appliance and the name is displayed in Select ISO to perform Operation.
3. Open Personality Deployer for a Unigy appliance to which you want to transfer the ISO file as
described in step 1.
4. At the Transfer an ISO option, type the URL for the ISO file on the appliance to which you uploaded
the file in step 1.
For example, type https://10.20.30.40/stage/iso/
dunkin_02.00.00.00.1416.iso, where 10.20.30.40 is the IP address of the appliance

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 479

from which you are transferring the file and dunkin_02.00.00.00.1416.iso is the name of
the ISO file.
5. Click Transfer.
6. Repeat steps 3 through 5 for each additional appliance.

17.1.7 License procedures

17.1.7.1 Obtain license fingerprints
IPC generates a unique license fingerprint for each CCM or ACCM during manufacturing. The
fingerprint can be obtained using Network Configurator during device deployment. After installation
and deployment, you can use the UMS to generate and download the fingerprints for all CCMs and
ACCMs in the enterprise.
In an enterprise with multiple CCMs or ACCMs, the fingerprint file contains fingerprints for all
connected CCMs and ACCMs.
The fingerprint file is a text file. The license fingerprint is used by the license generator to generate the
enterprise license file. License fingerprints are not required for emergency or certified administrator
license files. Any license file can be installed on any UMS client in the enterprise; licensing is then
propagated to all zones in the enterprise automatically.
A fingerprint file should always include the fingerprints for all appliances in all zones in the enterprise.
If one or more appliances are not available when you generate a fingerprint file, the license generated
from the file will not match the appliances in the enterprise when the appliances that were down come
back into operation. This will result in a fingerprint mismatch. The system will display an error message
once a day that instructs you to install a new license. If the issue is not corrected within seven days, by
generating a new fingerprint file, requesting a new license, and installing the license, the system will
archive the current license file and prevent users from logging in. To avoid this problem, generate a new
fingerprint file and request a license only when all appliances are accessible.
If you add, replace, or remove one or more appliances, or restore a database backup that has a different
appliance configuration than the current enterprise, generate a new fingerprint file that includes the
correct appliances, request a new license file, and install the license within seven days. When it is
possible, obtain the license file before you make any changes. To request a license, contact your regional
support team.
You must have one of the following roles to generate and download a license fingerprint: Basic
Administrator, Advanced Administrator, Security Administrator, IPC Project Manager, or IPC Certified
Tech.
1. Click Configuration ➤ Enterprise ➤ License Manager.
2. Click the Fingerprint tab in the License Manager panel.

IPC Confidential Unigy 4.3

Enterprise Guide
480 17.1: Deployment and upgrade procedures

Figure 85: License Manager: Fingerprint tab

3. Click Generate Fingerprint.

Unigy processes the request to generate the fingerprints for all connected CCMs or ACCMs in the
enterprise, then displays Success in the Status column when the process is complete.
4. Click Download.
5. Save the file to the desired location.

17.1.7.2 Obtain license files

IPC Manufacturing delivers an enterprise license with the appliances for new Unigy systems; however,
there are various deployment, upgrade, repair, and user-related procedures that require a new license.
When it is necessary to obtain a license, contact your regional support team.
Below is a list of the Unigy licenses that are available and the information that the person generating the
license requires.
• Enterprise license:
• License type: Enterprise
• System type: Enterprise, Standard, or Express (feature options vary depending on the system type)
• Fingerprints for all CCMs and ACCMs in the enterprise (see Obtain license fingerprints on page
479)
• List of the features that are licensed
• Usage limits for each selected feature
• Emergency license:
• License type: Emergency
• Password
• Expiration days
• Certified administrator license:
• License type: Certified Admin Customer or Certified Admin IPC Technician
• User name

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 481

• Password
• Expiration days
After the license file is generated, it is delivered to the requestor along with any required information.

17.1.7.3 Install an enterprise license file

This topic describes how to install an enterprise license from the UMS.
Consider the following guidelines when you install an enterprise license:
• You can install a new license at any time.
• Only one enterprise license file can be active in the enterprise. If you install a new file, the previously
installed license is deactivated and archived.
• If a new license file is installed, any feature assignments made after a previous license file installation
are retained; feature assignments are not affected by a license update of the same system type.
• If you add or replace one or both of a zone's CCM or ACCM appliances, you must install a new
license that reflects the new appliance MAC address(es).
• Assignments and configured soft limits (license usage limits) are preserved when you update a
license file.
• In a multizone enterprise, the license is replicated to all zones in the enterprise.
• If you are installing a new license in a multizone enterprise that has zones with different software and
schema versions, install the license within a zone with the highest version. The system applies the
correct license enforcement for each zone.
• If license installation fails or is canceled, all changes are canceled and the previously installed
enterprise license file remains in effect.
You must have one of the following roles to install license files: Security Administrator, Advanced
Administrator, IPC Project Manager, or IPC Certified Tech. For an initial deployment, only the
secadmin user account can install the license file because you cannot add active users to the enterprise
until the license is installed.
1. Click Configuration ➤ Enterprise ➤ License Manager.
2. Click the License tab in the License Manager panel.
Figure 86: License Manager: License tab

IPC Confidential Unigy 4.3

Enterprise Guide
482 17.1: Deployment and upgrade procedures

3. Select Enterprise License from the License Type list.

4. Click Install License.
5. Click Choose File.
6. Select the license file that you want to install, then click Open.
The UMS loads the license file.
7. Click Continue.
The UMS displays the licensed features contained in the file. Verify that the usage limits are correct
for each feature.
8. Click Install.
The UMS installs the license file.
9. Click Back to return to the License Manager panel.

17.1.7.4 Install a license file (all types)

Use the UMS to install a license file.
Within this topic, the terms current version and current software version refer to the Unigy software
version specified on the cover of this document. References to previous Unigy versions apply to the
versions, patches, service packs, and hotfixes for these versions that the current version supports.
Basic Administrators can install certified administrator and emergency license files. Security
Administrators can install enterprise and emergency license files. Advanced Administrators, IPC Project
Managers, and IPC Certified Techs can install any license files.
To install an emergency license file, you need the password that was entered for the file when it was
created.
To install a certified administrator license file, you need the user name and password that were entered
for the file when it was created.
The steps for updating (reinstalling) an existing enterprise or emergency license file are the same as
installing a new file. The following considerations apply when you are reinstalling a license file:
• You can have only one active enterprise or emergency license file for the enterprise. If you install a
new file of either type, the previously installed license file is deactivated and archived.
• A new enterprise license file can add, remove, or replace the set of CCM or ACCM fingerprints for
the enterprise to account for changes in the zone configuration of the system.
• Assignments and configured soft limits (license usage limit alerts) are preserved when you update a
license file.
1. Log in to the UMS.
If the enterprise is a mixed zone enterprise, you are installing the enterprise license, and the license
you are installing has changes that are specific to the current software version, log in to a current
version zone.
2. Click Configuration ➤ Enterprise ➤ License Manager.
3. Click the License tab in the License Manager panel. For an illustration, see Install an enterprise
license file on page 481.
4. Select one of the following in the License Type list:
• Enterprise License
• CertifiedAdmin License

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 483

• Emergency License
5. Click Install License.
6. Click Choose File.
7. Choose the license file that you want to install and click Open.
The UMS loads the license file.
8. Click Continue.
• For an enterprise license file, the UMS displays the licensed features contained in the file. Verify
that the usage limits are correct for each feature.
• For an emergency license file, type the password for the license in the License Password field.
• For a certified administrator license file, type the user name and password for the license in the
License User Name and License Password fields.
9. Click Install.
The UMS installs the license file.

17.1.7.5 Install a certified administrator license file

Use the UMS to install certified administrator license files.
Certified administrator license files assign the Advanced Administrator role (for certified customers) or
the IPC Certified Tech role (for certified IPC personnel) to the currently logged in user. To install a
certified administrator license file, you must have a user account that enables you to log in to the UMS
and a CertifiedTechnicianLicense file for your user account.
When you install the license, the UMS prompts you for a license user name and password. These are
specified when the license is generated. Before you install the license, obtain the user name and
password from IPC.
1. Log in to the UMS as the user to whom you are assigning the Advanced Administrator or IPC
Certified Tech role.
2. Click Configuration ➤ Enterprise ➤ License Manager.
3. In the License Type field within the License tab, select Certified Admin License.
4. Click Install License.
The Install New Certified Admin License panel is displayed.
5. Click Choose File then select the license file for the user.
6. Click Open.
The UMS loads the license file.
7. Click Continue.
8. In the License User Name and License Password fields, type the user name and password assigned
to the license.
9. Click Install.
The UMS installs the license and displays a message that shows the installation status and the
installed role. For a certified customer, the role shown is Advanced Administrator. For an IPC
technician, the role is IPC Certified Tech.
10. Click Back to return to the License Manager panel.

IPC Confidential Unigy 4.3

Enterprise Guide
484 17.1: Deployment and upgrade procedures

17.1.7.6 Downgrade an enterprise license

Use this procedure when it is necessary to downgrade the Unigy enterprise license file, for example after
rolling back the software to a lower version.
Within this topic, the terms current version and current software version refer to the Unigy software
version specified on the cover of this document. References to previous Unigy versions apply to the
versions, patches, service packs, and hotfixes for these versions that the current version supports.
The method for downgrading the enterprise license depends on the current software version and the
version to which you are downgrading.
Prerequisite:
Obtain the required license file:
• If you are downgrading from the current software version to Unigy v2.0.1, obtain the Unigy v2.0.1
enterprise license file and an emergency license file.
• For other downgrades, if you do not have the original enterprise license file, obtain a new file for the
applicable software version.
To obtain a license file, contact your regional support team. Include a copy of the fingerprint file that
includes all appliances in the enterprise.
1. If you are downgrading from the current software version to Unigy v2.0.1:
a) Revoke the Enterprise Trader License from all end users.
b) Install the emergency license file by performing the procedure Install a license file (all types) on
page 482.
2. Install the lower version enterprise license file, by performing the procedure Install an enterprise
license file on page 481.
3. If you are downgrading from the current software version to Unigy v2.0.1, reassign the Enterprise
Trader License to all applicable end users.

17.1.7.7 Assign feature licenses to users

Feature licenses control user access to Unigy features and devices. This topic describes how to assign
feature licenses to users.
Your user account must have one of the following roles to assign feature licenses to users: Advanced
Administrator, Security Administrator, IPC Project Manager, or IPC Certified Tech.
You can assign feature licenses if the license class for the feature is Assigned. The following licenses
can be assigned:
• Enterprise Trader License, Standard Trader License, or Express Trader License: Enables end
users to log in to IQ/MAX TOUCH, IQ/MAX, and IQ/MAX Edge turrets, IQ/MAX Sync, and
IQ/MAX Omni Soft Clients. The license name displayed depends on the type of system license
purchased; that is, Enterprise, Standard, or Express.
• Pulse User License: Enables end users to log in to a Pulse, Pulse Enterprise, or Pulse Mobile.
• Administrator-only User License: Enables administrative users to log in to the Unigy Management
System (UMS). The system assigns this license automatically when a user account that is assigned an
administrative role is added from Configuration ➤ Users. You cannot assign or revoke this license
from License Manager.
• Pulse Enterprise Intercom only software license: Provides Pulse, Pulse Enterprise, and Pulse
Mobile end users with access to the intercom feature, but not hoots.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 485

• Pulse Enterprise Intercom & Hoot software license: Provides Pulse, Pulse Enterprise, and Pulse
Mobile end users with access to the intercom and hoot features.
• IQ/MAX Sync for OCS: Enables turret end users to use the IQ/MAX Sync for OCS feature that
pairs the Microsoft Office Communications Server (OCS) integration feature with a user's IQ/MAX
or IQ/MAX Edge turret.
• FastFind license: Provides IQ/MAX Omni, IQ/MAX Sync, and Pulse Enterprise end users with
access to the FastFind search feature.
• QuickDial license: Provides IQ/MAX Omni and IQ/MAX Sync end users with access to the
QuickDial feature for making calls from Microsoft Office and other applications that support the
clipboard.
• Voice Recording API (per recording channel) license: Provides voice recording capabilities. Voice
Recording API licenses are automatically consumed when Recording Mix Profiles are assigned to
end users.
• Blue Wave API - CTI: Provides access to applications that use the Blue Wave API. The system
assigns this license automatically when a user account that is assigned the Blue Wave API - CTI role
is added from Configuration ➤ Users. You cannot assign or revoke this license from License
Manager.
• Blue Wave API - Management License: Enables a custom application to manage different types of
users in the Unigy database using the Blue Wave API - Management API. The system assigns this
license automatically when a user account that is assigned the Blue Wave API - CTI role is added
from Configuration ➤ Users. You cannot assign or revoke this license from License Manager.
• IQ/MAX TOUCH No Spkr User Application License: Provides access to an IQ/MAX TOUCH
with no speaker access.
• IQ/MAX TOUCH 4 Spkr User Application License: Provides access to an IQ/MAX TOUCH with
access to four speaker channels.
• IQ/MAX TOUCH 8 Spkr User Application License: Provides access to an IQ/MAX TOUCH with
access to eight speaker channels.
• IQ/MAX TOUCH 16 Spkr User Application License: Provides access to an IQ/MAX TOUCH
with access to sixteen speaker channels.
• IQ/MAX TOUCH 24 Spkr User Application License: Provides access to an IQ/MAX TOUCH
with access to twenty-four speaker channels.
• IQ/MAX TOUCH 32 Spkr User Application License: Provides access to an IQ/MAX TOUCH
with access to thirty-two speaker channels.
• DEVICE_APP1, DEVICE_APP2, DEVICE_APP3, DEVICE_APP4. DEVICE_APP_5: Provides access
to custom device applications that run on communication devices and Soft Clients.
• Spatial Audio License: Provides end user access to the IQ/MAX TOUCH spatial audio feature,
introduced in Unigy v4.0,. This feature enables users to assign the spatial audio position from which
speaker channel audio is played.
• Policy Engine Communication Barriers License: Assigned to all end users who are imported into
the Compliance Policy Engine for control of unauthorized line and party access.
The number of licenses that are available to assign is controlled by the license usage limit, although
more licenses can be assigned for licenses that are only consumed upon registration or login.
Unlimited licenses are generally available in the enterprise. Anonymous licenses are available on a
concurrent basis (first come, first served).

IPC Confidential Unigy 4.3

Enterprise Guide
486 17.1: Deployment and upgrade procedures

Note
When you assign licenses to users in a mixed zone enterprise and the licenses are being assigned from
a pre-Unigy v3.1 zone, data replication must be enabled in all higher version zones at the time of the
license assignments to ensure that the data is replicated to the zones. This is required because license
assignments are not stored in the database in Unigy v3.1 or higher, and therefore, are not updated when
a zone loads the database from another zone. To avoid this limitation, when possible, assign licenses
from a v3.1 or higher zone.

1. Click Configuration ➤ Enterprise ➤ License Manager.

Figure 87: License tab

2. In the License Type field, be sure that Enterprise License is selected.

3. Click the ACTIVE license in the License Files list.
A list of feature licenses for the currently installed enterprise license is displayed in the License
Detail page.
4. Click the license you want to assign, then click View Assigned.
The selected feature license detail with the Assigned Users list is displayed.
Figure 88: Assigned User page

5. Click +Assign.
An Available To Assign popup with a list of end users groups is displayed.
6. Select a User Group then click Next>.
The list of users belonging to the end users group is displayed.
7. Select the user(s) to whom you want to assign the feature license then click <Assign.
8. Click Save.
9. In the confirmation dialog box, click OK.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 487

17.1.7.8 Revoke feature licenses from users

To remove a user's ability to access a CDI or certain Unigy features, you revoke one or more feature
licenses.

Note
• When you revoke licenses, the system does not prompt you to confirm the action before revoking the
licenses.
• You cannot revoke the Enterprise Trader License from a Unigy Soft Client end user who is currently
logged in.
• You cannot revoke the Administrator-only User license.

You must have one of the following roles to revoke feature licenses from users: Advanced
Administrator, Security Administrator, IPC Project Manager, or IPC Certified Tech.

Tip
Before you revoke licenses for a specific user, use the View All Assigned Features button to display all
assigned licenses. To display the licenses assigned to multiple users, run the Assigned License report by
performing the procedure Generate assigned license report on page 689.

1. Click Configuration ➤ Enterprise ➤ License Manager.

2. In the License tab, select the Enterprise License with the ACTIVE status.
A list of feature licenses currently installed in the system is displayed in the License Detail panel.
3. Select a license you want to revoke.
4. Click View Assigned.
For an illustration, see Assign feature licenses to users on page 484.
5. Do one of the following:
• If you are revoking only the selected license from one or more users:
1. In the Assigned Users list, select the users for whom you want to revoke the selected license.
2. Click Remove.
3. Click Save. The User Revoke Confirmation message box is displayed.
4. Click OK.
• If you are revoking more than one license for an individual user (you cannot revoke multiple
licenses simultaneously for multiple users):
1. Click the user.
2. Click View All Assigned Features. The Assigned Features dialog box lists all assignable
licenses. The check box for each license assigned to the current user is selected.

IPC Confidential Unigy 4.3

Enterprise Guide
488 17.1: Deployment and upgrade procedures

Figure 89: Assigned Features dialog box

3. Clear the check box for all licenses you want to revoke then click Save.
4. In the Assigned Users list, click Save. The Feature Assign/Revoke Confirmation message box is
displayed.
5. Click OK.

17.1.8 Add an IPC Certified Technician user

To perform certain Unigy deployment, configuration, diagnostic, and monitoring procedures, your user
account must have the IPC Certified Tech role assigned to provide access to all Unigy menu options.
This role is assigned through an IPC Certified Technician license. The procedure applies only to IPC
employees.
Prerequisite:
You must have an IPC Certified Technician license file in your possession to complete this procedure.
Follow your department policy for obtaining a license file along with the credentials. IPC Certified
Technician licenses are available only to IPC employees.
A security administrator cannot assign the IPC Certified Tech role. You are assigned the role when you
log in to the UMS with your user account and install the IPC Certified Technician license.
1. Log in to the UMS with a security administrator account.
2. Determine whether an appropriate authentication policy is available:
a) Click Configuration ➤ Enterprise ➤ Security ➤ Security Policies ➤ User Authentication
Policies.
b) Review the available authentication policies.
If a policy appropriate for an IPC Certified Tech user is not available, create one by clicking+Add
New. Specify the policy attributes then click Save.
3. Add a new user account.
Use the legacy (Flash) UMS (https://<your_VIP>/ums/UMSClient.html) or Mass Edit
Client to accomplish this task. this is necessary because the Users menu is not available in the
HTML5 interface. For information on using Mass Edit Client, refer to the Features Configuration
Guide. To create a user account in the Legacy interface, do the following:

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 489

a) Click Configuration ➤ Users.

b) Click the Add New (+) button.
c) Complete the required fields and select the following roles. For details on the panel fields and
buttons, refer to the UMS online help or the UMS UI Guide.
• Basic Administrator
• IPC Project Manager

Note
Basic Administrator has read access to alarming and monitoring and can perform backups, but IPC
Project Manager does not have rights to these features. IPC Project Manager can configure
devices, install software, and administer the system security configurations, but Basic Administrator
cannot. Applying the IPC Certified Technician license provides more privileges than both roles;
however, the advantage to selecting both roles for the user account is that these roles will provide
access to most of the system if the IPC Certified Technician license expires or becomes corrupted.
They also enable you to log in to the UMS to install the license.

d) Click Save.
4. Install the IPC Certified Technician license:
a) Log in to the UMS using the account you created in the previous step (do not log in with the
security administrator account).
b) Click Configuration ➤ Enterprise ➤ License Manager.
c) In the License Type list, select Certified Admin License.
d) Click Install License.
e) Click Choose File, select your IPC Certified Technician license file, then click Open.
f) Click Continue.
g) Type the License User Name and License Password you were provided then click Install.
The UMS displays the Installation Complete panel.

17.1.9 Zones
17.1.9.1 Deploy the first or only zone with Zone Deployer
A Unigy enterprise requires at least one zone. In a multizone enterprise, the first zone deployed is the
peer zone from which subsequent zones are deployed.
The peer zone is the source for customer digital certificates and certificate keys that are synchronized
with each subsequent zone you add. It also provides the enterprise license and initial database for the
enterprise. This data is replicated to new zones when you enable replication for the zone. After initial
deployment of the enterprise, any zone can serve as the peer zone.
This procedure applies to standalone and High Availability (HA) zones, but not to dedicated Blue Wave
zones. Dedicated Blue Wave zones cannot serve as a peer zone. For information on deploying dedicated
Blue Wave zones and all subsequent zones in a multizone enterprise, refer to Deploy subsequent zones
on page 495.
In an HA zone, Zone Deployer deploys the zone and configures and enables HA.

IPC Confidential Unigy 4.3

Enterprise Guide
490 17.1: Deployment and upgrade procedures

Note
If Zone Deployer fails, resolve the source of the failure then rerun it. You cannot rerun Zone Deployer
after both appliances in the zone are successfully deployed.

References to the term Primary appliance apply to the ACCM in a standalone zone, and in an HA zone,
to the CCM or ACCM in the HA pair that has the lower IP address. The system assigns the Primary and
Secondary appliance designations during appliance deployment.

Important
Deploy the zone for the Primary appliance then deploy the zone for the Secondary appliance. Use the
same zone ID for both appliances.

1. Within a browser, open Zone Deployer by accessing https://ip_address, where

ip_address is the IP address of the appliance you are deploying.
The Connect to dialog box is displayed.
If you see Personality Deployer instead on Zone Deployer, Personality Deployer was not run for the
appliance.
2. Enter the credentials for the install user account then click OK.
Zone Deployer opens with the appliance personality displayed.

Note
For information on the Zone Deployer fields and buttons, refer to Zone Deployer on page 491.

3. In the Select Zone Type field, select First Zone.

4. Confirm the Zone VIP value, which is the address that was entered in the Local Zone VIP field in
Personality Deployer. If there is no value, enter one of the following:
• For a standalone zone, the IP address of the CCM or ACCM appliance in the zone.
• For an HA zone, the zone VIP (Virtual IP Address).
5. Click Fetch Zones.
All configured zones are displayed in the Configured Zones list. At this point there should be only
one.
6. In the Configured Zones list, click the zone you are deploying.
7. In the Enter Zone Id field, type the ID number assigned to the zone.
The ID can be any numeric value, it does not have to be 1. Confirm that the ID you enter is the
correct ID for the zone as specified in the Data Collection Document for the customer.
8. Click Submit.
9. Within the Zone Deployer Confirmation page, confirm the deployment properties then click
Continue.
The system begins the deployment process, and after a brief delay, displays the message System
has initiated Zone Deployer successfully.
10. Click Get Logs to determine the progress of the zone deployment. Refresh the page as necessary to
get the latest status. If you do not see the Get Logs button, reopen Zone Deployer by accessing
https://ip_address/deployment/ZoneDeployer.html from the browser, where
ip_address is the appliance IP address.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 491

The Zone Deployer Logs page is displayed. The system deploys the zone, enables HA (if applicable),
then reboots the appliance. The deployment is complete when you see information similar to the
following at the end of the log:

Wait for the reboot to complete before deploying the zone for the Secondary appliance.
11. Determine the status of the appliance by performing the procedure Check the state of a zone from a
browser on page 499.
For the Primary appliance, use the checkMyStatus option.
12. Repeat steps 1 through 11 for the Secondary appliance.
If you see the message Peer Server is not deployed or VIP is down, wait several
minutes to allow the VIP to become active then try again.
After you deploy the zone, if you discover a problem with the deployment, refer to the procedure Roll
back a personality or zone deployment on page 386.
17.1.9.1.1 Zone Deployer
Zone Deployer deploys zones within a Unigy enterprise. You can deploy a single zone for a Unigy
Express system or multiple zones for Standard and Enterprise systems.
A Unigy enterprise requires at least one zone. In a multizone enterprise, the first zone deployed serves as
the peer zone for deploying other zones. The peer zone is the source for customer digital certificates and
certificate keys that are synchronized with each subsequent zone you add. It also provides the license
and initial database for the enterprise. This data is replicated to new zones when you enable data
replication. After you deploy one or more subsequent zones, any zone can serve as the peer zone for
deploying other zones.
You configure each subsequent zone from the UMS before you deploy it.

IPC Confidential Unigy 4.3

Enterprise Guide
492 17.1: Deployment and upgrade procedures

Figure 90: Zone Deployer

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 493

Table 53: Zone Deployer

Name Description Values Notes

Personality Type of personality • ACCM – standalone System populated from
software deployed on ACCM the value specified in
the appliance. Also Personality Deployer
provides a link to system • ACCM1 – primary when the personality
information. ACCM in an HA pair software was deployed
• ACCM2 – secondary on the appliance.
ACCM in an HA pair Click the Personality link
to display system
• CCM – standalone
information including the
CCM
appliance network
• CCM1 – primary settings, personality,
CCM in an HA pair NTP server, software
versions, whether HA is
• CCM2 – secondary
configured and enabled,
CCM in an HA pair
zone VIP, peer
• MM – Media Manager appliance, and whether
the appliance is the
primary or secondary
appliance in the HA pair.
For a description of this
information, refer to the
Host Info section of
Personality Deployer on
page 467.
Select Zone Type Type of zone for • First Zone – peer The peer zone is the
deployment purposes. zone for the first zone deployed and
enterprise serves as the controlling
zone for a multizone
• Subsequent Zone – enterprise. There can be
additional zones that only one peer zone.
are deployed after the Deploy the peer zone
peer zone before you deploy all
other zones.
Zone VIP • In an HA zone, the IP address or VIP in dot
cluster VIP for the decimal notation
zone you are nnn.nnn.nnn.nnn
deploying.
• In a stand-alone
zone, the IP address
of the CCM or ACCM
in the zone you are
deploying.

IPC Confidential Unigy 4.3

Enterprise Guide
494 17.1: Deployment and upgrade procedures

Table 53: Zone Deployer (continued)

Name Description Values Notes

Peer Zone VIP In a multizone VIP in dot decimal This property is disabled
enterprise, the VIP of notation for the peer zone.
the peer zone. nnn.nnn.nnn.nnn It provides a connection
to the peer zone for
communication and
replication.
This property does not
apply to a standalone
zone, which has only
one zone.
Configured Zones List of zones configured Zones listed by ID and Click Fetch Zones to
from the UMS. name display the list of
configured zones.
The zones are
configured through
Configuration ➤
Enterprise ➤ System ➤
Zones or Tools ➤
Deployment ➤ Hardware
Deployment.

Enter Zone Id Unique identifier for the Numeric The ID for the first zone
zone. does not have to be 1.
Refer to the customer
Unigy Data Collection
document for the Zone
IDs assigned to each
zone.

Table 54: Buttons

Name Description
Check Connectivity Attempts to connect the zone you are deploying to
the peer zone. If the connection is successful, the
system displays the message DS-WS is
reachable.
Fetch Zones Retrieves a list of zones that are configured in the
UMS.
Submit Starts the zone deployment process.
Get Logs Displays the zone deployment log that indicates
the status of the deployment. Deployment is
successful if you see the message Zone with
id # is successfully deployed, where
# is the zone ID.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 495

17.1.9.2 Deploy subsequent zones

After you deploy the first zone in the enterprise, use that zone as the peer zone to add, configure, and
deploy one or more subsequent zones. A subsequent zone can be a Unigy zone or a Blue Wave zone. For
upgrades, this topic applies to all zones, including the first zone.
Prerequisites:
To deploy multiple zones, the Unigy Enterprise license must be a Standard or Enterprise license, or there
must be a Unigy Blue Wave Appliance license.
A peer zone must be deployed before you deploy subsequent zones. The peer zone serves as the source
for customer digital certificates and certificate keys that are synchronized with each subsequent zone
you add. It also provides the enterprise license and initial database data. The peer zone can be any active
Unigy zone. For a new enterprise, refer to Deploy the first or only zone with Zone Deployer on page 489
for information on deploying the first enterprise zone that serves as the initial peer zone for the
enterprise. Do not use a Blue Wave zone as the peer zone.
Obtain the IP address or VIP (Virtual IP address) of the peer zone before you begin this procedure.

Important
If Zone Deployer fails, resolve the source of the failure then rerun it. You cannot rerun Zone Deployer
after a successful zone deployment.

References to the term Primary appliance apply to the ACCM in a standalone zone, and in an HA zone,
to the CCM or ACCM in the HA pair that has the lower IP address. The system assigns the Primary and
Secondary appliance designations during appliance deployment.
This procedure applies to various deployment, upgrade, and hardware recovery scenarios. Perform the
procedure in one of the following ways:
• If you are deploying a zone with a single CCM or ACCM appliance, perform steps 1 through 14.
• If you are deploying the Primary and Secondary appliances in an HA zone, perform steps 1 through
14 for the Primary appliance and steps 3 through 14 for the Secondary appliance. Deploy the zone for
the Primary appliance then deploy the zone for the Secondary appliance. Use the same zone ID for
both appliances. When you deploy the Primary appliance, Zone Deployer configures and enables HA
after deploying the zone.
• If you are replacing one appliance in an HA zone due to a hardware failure or hardware upgrade,
perform steps 3 through 14 for the replacement appliance. This assumes that the COP and personality
software are deployed on the new appliance and you are adding the appliance to an existing zone that
was fully configured and deployed during the initial zone deployment.
1. Log in to the UMS in the peer zone.
2. If you have not already done so, configure the new zone and add it to the database by performing the
procedure Add or edit a zone on page 515.
Be sure to enter the VIP Address and appliance IP addresses in the ACCM/CCM1 IP Address, and in
an HA zone, the ACCM/CCM2 IP Address. These are required for running Zone Deployer for
subsequent zones. Also select a Backroom Location, and if applicable, a Preferred Zone.
3. Within a browser, open Zone Deployer by accessing https://IP_address, where
IP_address is the IP address of the CCM or ACCM appliance you are deploying.
The Connect to dialog box is displayed.
4. Enter the credentials for the install user account then click OK.
Zone Deployer opens with the appliance personality displayed.

IPC Confidential Unigy 4.3

Enterprise Guide
496 17.1: Deployment and upgrade procedures

Note
For information on the Zone Deployer fields and buttons, refer to Zone Deployer on page 491 .

5. In the Select Zone Type field, select Subsequent Zone.

6. The system populates the Zone VIP field from the value entered in Personality Deployer. This is the
VIP for the zone in which you are deploying the appliance. If the VIP is not correct, enter the correct
value.
7. In the Peer Zone field, type the peer zone VIP. This is the zone that provides the digital certificate,
certificate key, and database data.
8. Click Check Connectivity.
The system displays the message DS-WS is reachable indicating that the connection with the
peer zone was successful.
9. Click Fetch Zones.
All configured zones are displayed in the Configured Zones list.
10. In the Configured Zones list, click the zone you are deploying. This is the zone you configured in
step 2.
11. In the Enter Zone ID field, type the unique ID assigned to the zone.
Use the ID displayed to the left of the zone name. If you are deploying the secondary appliance in an
HA pair, specify the same ID as you specified for the primary appliance.

Note
If you are adding a zone to an enterprise in which one or more zones have been removed, the zone ID
might not be the next sequential number.

12. Click Submit.

13. Within the Zone Deployer Confirmation page, confirm that the deployment properties are correct then
click Continue.
The system deploys the zone, enables HA when applicable, then reboots the appliance.
14. To monitor the progress of the deployment, click Get Logs.
The deployment is complete when you see the message
!!! SYSTEM IS GOING TO REBOOT AFTER Zone Selection .... PLEASE WAIT.... !!!! Zone with id 2
is successfully deployed.
15. If you are deploying both appliances in the zone, repeat steps 3 through 14 for the second appliance in
the HA pair.
If you see the message Peer Server is not deployed or VIP is down when you
deploy the second appliance, wait several minutes to allow the VIP to become active then try again.
After you deploy the zone, if you discover a problem with the deployment, such as assigning the wrong
zone ID, refer to the procedure Roll back a personality or zone deployment on page 386.

17.1.9.3 Enable device registration

Enable device registration to allow Media Managers, Media Gateways, and CDI devices (turrets, Pulse
devices, and Soft Clients) to register with the zone.
1. Within the UMS, click Configuration ➤ Enterprise ➤ System ➤ Zones.
2. In the Zones list, click the zone for which you are enabling device registration.
The Zone Configuration panel is displayed.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 497

3. Confirm that the VIP Address is correct.

• For a standalone zone, it should be the IP address of the appliance.
• For an HA zone, it should be the zone VIP (virtual IP address ).
4. Within the Trading section, select the Device Registration Enabled check box then click Save.
Wait at least fifteen minutes for the devices to register.

17.1.9.4 Disable device registration

Disable device registration to prevent Media Managers, Media Gateways, turrets, Pulse devices, and
Soft Clients) from registering with the zone during certain maintenance procedures including image
backup.
1. Within the UMS, click Configuration ➤ Enterprise ➤ System ➤ Zones.
2. In the Zones list, click the zone for which you are disabling device registration.
The Zone Configuration panel is displayed.
3. Within the Trading section, clear the Device Registration Enabled check box then click Save.

17.1.9.5 Enable data replication

Data replication synchronizes Unigy data between zones to support an enterprise-wide distributed,
consistent, and concurrent data store. This procedure describes how to enable data replication.
Enabling data replication affects Local Area Data Replication, not the Wide Area Data Replication used
in Multi-tier Replication. It reboots the appliances in a zone then loads a copy of the Unigy database
from another zone, or if only one zone is available, the system loads the zone's local Unigy database.
The zone that provides the database dump is determined either from the Preferred Zone property
specified for the zone, or if a preferred zone is not specified or the zone is not available, through the
zone selection algorithm. For information on this algorithm, refer to Database source zone selection
algorithms for database dumps on page 615. If the zone for which data replication is being enabled is a
portal zone, the database will always be retrieved from another portal zone.
For initial system deployment, enable data replication in the peer zone before enabling it for subsequent
zones.
In a multizone enterprise, when replication must be reenabled for more than one zone, for example after
an upgrade or restoring a backup, the sequence in which you enable replication for each zone varies
based on the enterprise and the procedure in which you are enabling replication. The standard sequence
involves enabling replication in the preferred zones then enabling it in the remaining zones. Below is a
list of exceptions to this standard.
• If you are enabling replication after restoring an enterprise database backup file, the first zone for
which you enable replication should be the zone in which you restored the data.
• If Multi-tier Replication is enabled and you are enabling data replication to restart all zones in a data
center, reenable data replication for the portal zone before you enable it for the local zones.
The data replication option is not available for standalone enterprises that have the Unigy Express
license installed.
Wait for data replication in one zone to complete before you enable it in the next zone.
1. Log in to the UMS in the zone for which you are enabling data replication: https://vip.
2. Click Configuration ➤ Sites ➤ Servers ➤ Clusters.
3. In the Clusters list, click the zone cluster.

IPC Confidential Unigy 4.3

Enterprise Guide
498 17.1: Deployment and upgrade procedures

4. Within the Properties tab, select the Enable Replication check box then click Save.
Both appliances reboot. Initiation of the reboot might take several minutes. If the appliances do not
reboot automatically within three minutes, reboot them manually by performing the procedure Reboot
CCM on page 587.
5. Monitor the state of the appliances as they reboot by performing the procedure Check the state of a
zone from a browser on page 499.

17.1.9.6 Disable data replication

Data replication synchronizes Unigy data between zones to support an enterprise-wide distributed,
consistent, and concurrent data store. Certain maintenance procedures require disabling data replication
before performing the procedure.

Note
If Multi-tier Replication is enabled for the data center associated with the zone for which you are disabling
data replication and the zone is a portal zone, you must suspend or disable Multi-tier Replication for the
data center prior to disabling data replication. For information on these procedures, refer to Suspend or
resume Multi-tier Replication on page 247 or Disable Multi-tier Replication on page 246.
Disabling then reenabling data replication for a portal zone does not load the database from another
zone. If it is necessary to load the database for a portal zone, refer to Refresh (restart) a portal zone on
page 320.

When data replication is disabled for a zone, all types of replication that are enabled for the zone are
disabled, that is, when you disable data replication, the system also disables partial replication and
Multi-tier Replication for the zone if these features are enabled. If you restart the zone appliances, a
database dump will not be loaded from another zone while data replication is disabled. To perform
database refreshes for all zones except portal zones, enable data replication.
In a multizone enterprise when replication must be disabled for more than one zone, for example before
an upgrade or restoring a backup, the sequence in which you disable replication for each zone varies
based on the procedure in which you are disabling replication. For example, if you are disabling
replication prior to restoring an Enterprise backup file, the last zone for which you disable replication
should be the zone in which you are restoring the data.
Perform this procedure in each applicable zone.
1. Log in to the UMS in the zone for which you are disabling data replication: https://vip.
2. Click Configuration ➤ Sites ➤ Servers ➤ Clusters.
3. In the Clusters list, click the zone cluster.
4. Within the Properties tab, clear the Enable Replication check box then click Save.

17.1.9.7 Change a zone's BCP status to Active

When you deploy a zone, the default BCP Status for the zone is Maintenance. This state prevents
activation of a BCP plan in a multizone enterprise that supports BCP and also prevents Soft Client end
users from logging in. This status affects standalone and HA zones. After you deploy a zone, change this
status to Active to enable normal operation.
1. Log in to the UMS.
• For a standalone zone, use the appliance IP address: https://appliance_ip.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 499

• For an HA zone, use the zone VIP: https://vip.

2. Click Configuration ➤ Enterprise ➤ System ➤ Zones.
3. In the Zones list, click the zone for which you are activating the BCP status.
4. In the BCP Status field, select Active.
5. Click Save.

17.1.9.8 Check the state of a zone

17.1.9.8.1 Check the state of a zone from a browser
It is important to know the current state of the CCMs or ACCMs in a zone before and after various
deployment and HA-related procedures. You can determine this information from the UMS or from a
browser. This procedure describes how to display the information from a browser, which is the preferred
method.
The information that Check HA Status provides varies based on whether you are checking the status of a
standalone zone, single HA zone, or a zone in a multizone enterprise. It includes which appliance in an
HA zone is the Active appliance, the state of the appliances, when the main services for an appliance are
started and when initiation is complete, whether there were any service-related errors encountered, status
of the communication between each appliance and its peer and the gateway, TCP, JGroups Channel, and
Replication Server listen ports and connections, firewall fencing status, and in a multizone enterprise,
whether replication is enabled and the zones are communicating.
Perform this procedure at these times:
• After deploying a zone
• Prior to upgrading a zone
• After upgrading a zone
• After enabling data replication in a multizone enterprise
• If you cannot log in to the UMS
• After rebooting an appliance
• If a problem is encountered with a zone

Note
Check HA Status does not display information until the services on the Active appliance begin to start up.
If you are performing this procedure after taking a cluster out of maintenance mode, the data for the
Standby appliance will not be available until the appliance reboot is complete. If you are performing this
procedure after enabling data replication, the data will not be available for either appliance until the
reboots complete. The time required for this to occur depends on the size of the database; however, it
requires at least 15 minutes.

1. In a browser, do one of the following:

• For a standalone zone or the first appliance deployed in an HA zone, navigate to https://
appliance_ip/haservices/checkMyStatus.
appliance_ip is the appliance's IP address.
• In an HA zone, navigate to https://vip/haservices/checkHAStatus.
vip is the zone's virtual IP address (VIP).
2. Ensure that the following information is correct:

IPC Confidential Unigy 4.3

Enterprise Guide
500 17.1: Deployment and upgrade procedures

• Server displays the correct IP address, and if the appliance is the Active appliance in an HA pair,
VIP Owner is displayed to the right of the IP address.
• Server Role is ACTIVE for the Active appliance and STANDBY for the Standby appliance. While
the Standby appliance is coming up, the role is UNKNOWN.
• Server State is AVAILABLE. If the zone is an HA zone and the cluster is in maintenance mode,
the state of the Active appliance will be MAINTENANCE_AVAILABLE and the state of the
Standby appliance will be MAINTENANCE_UNAVAILABLE or MAINTENANCE_AVAILABLE
depending on whether the maintenance operation for the appliance is in progress or complete.
• Network State is GY_PY. This indicates that the appliance is connected to the gateway (GY) and
the peer appliance (PY). GN or PN indicate that the appliance cannot connect with the gateway or
peer appliance.
• Service Status is RUNNING for all services.
• Remarks is Change role completed in followed by the time required to start the service
in milliseconds for all services except the Replicator service, which displays Replication is
enabled or Replication is disabled based on whether the Enable Replication check
box within the cluster Properties tab is selected for the zone.
If the Rearm Server process was initiated manually or programmatically during a zone
deployment or restart, the message MySQL Rearm server action is in progress
followed by the elapsed time is displayed for the Standby appliance until the rearm completes. At
that time, the Change role completed in message is displayed.
If the Standby appliance Server Role is UNKNOWN and the Server State is FAILED, review the
status details then troubleshoot the issue. If you discover a problem, correct it then rearm the
appliance by performing the procedure Rearm the Standby appliance on page 547. If the role and
state are still not correct, reboot the Standby appliance. If this does not resolve the issue, reboot both
appliances.

Important
Unless it is necessary to rearm the appliance during business hours, perform the procedure after
business hours. Rearming an appliance can affect users and active calls.

For a complete description of the status attributes, refer to Cluster Operation Output Details on page
502.

Important
Correct all issues before upgrading or forcing an HA failover, unless the upgrade is required to correct the
issue.

17.1.9.8.2 Check the state of an HA zone from the UMS

In a Unigy HA zone, it is important to know the current state of the CCMs or ACCMs in the zone before
and after various deployment and HA-related procedures. You can determine this information from the
UMS or from a browser. This procedure describes how to display the status information from the UMS.
For information on displaying the state information for a single appliance or an HA zone from the
browser, refer to Check the state of a zone from a browser on page 499.
The information that Check HA Status provides enables you to determine which appliance is the Active
appliance, the state of the appliances, when the main services for a zone are started and when initiation
is complete, whether there were any service-related errors encountered, status of the communication

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 501

between each appliance and it's peer and the gateway, TCP, JGroups Channel, and Replication Server
listen ports and connections, firewall fencing status, and in a multizone enterprise, whether replication is
enabled and the zones are communicating.
Perform this procedure at these times:
• After deploying a zone
• Prior to upgrading a zone
• After upgrading a zone
• After enabling data replication in a multizone enterprise
• After rebooting an appliance
• If a problem is encountered with a zone

Note
Check HA Status does not display information until the services on the Active appliance begin to start up.
If you are performing this procedure after taking a cluster out of maintenance mode, the data for the
Standby appliance will not be available until the appliance reboot is complete.

1. Click Configuration ➤ Sites ➤ Servers ➤ Clusters.

2. In the Clusters list, click the zone cluster.
3. Within the Members tab, confirm the following:
• The Role is ACTIVE for the Active appliance and STANDBY for the Standby appliance.
• The State is AVAILABLE. If the zone is an HA zone and the cluster is in maintenance mode, the
state of the Active appliance will be MAINTENANCE_AVAILABLE and the state of the Standby
appliance will be MAINTENANCE_UNAVAILABLE or MAINTENANCE_AVAILABLE
depending on whether the maintenance operation for the appliance is in progress or complete.
4. Click Check Status.
5. Ensure that the following information is correct:
• Server displays the correct IP address, and if the appliance is the Active appliance, VIP Owner
is displayed to the right of the IP address.
• Server Role is ACTIVE for the Active appliance and STANDBY for the Standby appliance. While
the Standby appliance is coming up, the role is UNKNOWN.
• Server State is AVAILABLE. If the zone is an HA zone and the cluster is in maintenance mode,
the state of the Active appliance will be MAINTENANCE_AVAILABLE and the state of the
Standby appliance will be MAINTENANCE_UNAVAILABLE or MAINTENANCE_AVAILABLE
depending on whether the maintenance operation for the appliance is in progress or complete.
• Network State is GY_PY. This indicates that the appliance is connected to the gateway (GY) and
the peer appliance (PY). GN or PN indicate that the appliance cannot connect with the gateway or
peer appliance.
• Service Status is RUNNING for all services.
• Remarks is Change role completed in followed by the time required to start the service
in milliseconds for the appliance and all services except the Replicator service, which displays
Replication is enabled or Replication is disabled based on whether the
Enable Replication check box within the cluster Properties tab is selected for the zone.

IPC Confidential Unigy 4.3

Enterprise Guide
502 17.1: Deployment and upgrade procedures

If the Rearm Server process was initiated manually or programmatically during a zone
deployment or restart, the message MySQL Rearm server action is in progress
followed by the elapsed time is displayed for the Standby appliance until the rearm completes. At
that time, the Change role completed in message is displayed.
If the Standby appliance Server Role is UNKNOWN and the Server State is FAILED, review the
status details then troubleshoot the issue. If you discover a problem, correct it then rearm the
appliance by performing the procedure Rearm the Standby appliance on page 547. If the role and
state are still not correct, reboot the Standby appliance. If this does not resolve the issue, reboot both
appliances.

Important
Unless it is necessary to rearm the appliance during business hours, perform the procedure after
business hours. Rearming an appliance can affect users and active calls.

For a complete description of the Check Status output, refer to Cluster Operation Output Details on
page 502.

Important
Correct all issues before upgrading or forcing an HA failover, unless the upgrade is required to correct the
issue.

17.1.9.8.2.1 Cluster Operation Output Details

This panel provides status details for an HA cluster, including the role and state of each appliance, the
appliance IP addresses, the owner of the VIP, the status of the associated services, and the status of the
TCP port, firewall, JGroup Channel port, and replication port. Use this information to determine the
health of a zone and whether it is fully operational before and after various zone and cluster operations.
Introduction
To access this panel, do one of the following:
• Within the UMS, click Configuration ➤ Sites ➤ Servers ➤ Clusters. In the Clusters list, click the
zone cluster. Within the Members tab, click Check Status.
• For a single appliance, within a browser access https://appliance_ip/haservices/
checkMyStatus, where appliance_ip is the appliance IP address.
• For an HA zone, within a browser access https://vip/haservices/checkHAStatus,
where vip is the zone VIP.
The status output for stateful and stateless HA configurations is the same.
Within the UMS, the information for the Active appliance is displayed at the top of the output and the
information for the Standby appliance is displayed after the Active appliance Replication Status section.
In the browser display, the information for the Active appliance is displayed on the left and the
information for the Standby appliance is displayed on the right, unless the screen is not wide enough to
accommodate this display. In this situation, the display is the same as the UMS display. Errors are
displayed in red.
The following roles can access this information: IPC Project Manager and IPC Certified Tech.
Appliance information

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 503

Basic cluster or appliance information is displayed at the top of the output. This includes the appliance
IP address, role, state, network connection state, information about the appliance status, the date and
time the appliance was last rebooted, and the owner of the VIP.
Figure 91: Active appliance details

Figure 92: Standby appliance details - rearm and completed

The following information is displayed:

• Server: Appliance IP address and VIP ownership. The active appliance always owns the VIP.
• Server Role: Role of the appliance in the HA cluster. The values for a healthy cluster are ACTIVE
for the Active appliance and STANDBY for the Standby appliance. While the Standby appliance is
coming up, the role is UNKNOWN.
• Server State: Status of the appliance. The value for the Active and Standby appliances in a healthy
cluster is AVAILABLE. If the zone is an HA zone and the cluster is in maintenance mode, the state of
the Active appliance is MAINTENANCE_AVAILABLE and the state of the Standby appliance is
MAINTENANCE_UNAVAILABLE or MAINTENANCE_AVAILABLE depending on whether the
maintenance operation for the appliance is in progress or complete.
• Network State: GY_PY indicates that the appliance is connected to the gateway (GY) and the peer
appliance (PY). GN or PN indicate that the appliance cannot connect with the gateway or peer
appliance.
• Orchestrator State: Indicates the current status of the Orchestrator service. The value should be
INITIALIZED.
• Remarks: The value for a healthy appliance is Change role completed in followed by the
time required to start the appliance in milliseconds. If the Rearm Server process was initiated
manually or programmatically during a zone deployment or restart, the message MySQL Rearm
server action is in progress followed by the elapsed time is displayed for the Standby

IPC Confidential Unigy 4.3

Enterprise Guide
504 17.1: Deployment and upgrade procedures

appliance until the rearm completes. At that time, the Change role completed in message is
displayed.
• Started: Date and time the appliance was last restarted.
Service Status
The Service Status section indicates the current status of the services running on the appliance.
Figure 93: Service Status section - 1 of 2

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 505

Figure 94: Service Status section - 2 of 2

The following information is displayed:

• Service Name: Name of the service.
• Service Status: Current status of the service. The value for a healthy cluster is RUNNING for all of
the services. STARTING indicates that the service is still initializing. If the status remains at
STARTING for 30 minutes or more, refer to the Troubleshooting section.
• Remarks: The value for all of the services should be Change role completed in followed by
the time required to start the service in milliseconds, except for the Replicator service, which
indicates Replication is enabled or Replication is not enabled based on
whether the Enable Replication check box on the cluster Properties tab is selected. null indicates
that the service is still initiating.
If you stop the occasd service from the command line, the Service Status for the OCCASdEnginePID
service will be FAILED and the Remarks will be OCCASdEnginePID Service is failed.
The status and remarks for the IZChannel service, which runs within the occasd service, and other
OCCAS-related services might also indicate a failure based on the timing of the service interruption.
TCP port, firewall, JGroup Channel port, and replication port status
This section displays status information for the TCP port, firewall, JGroup Channel port, and replication
port. The JGroup Channel Status and Replication Status information does not apply to a Standby
appliance.

IPC Confidential Unigy 4.3

Enterprise Guide
506 17.1: Deployment and upgrade procedures

Figure 95: TCP port, firewall, JGroup port, and replication port status section

• TCP port: Displays the port on the Active appliance that listens for TCP traffic and the established
connection with the Standby appliance.
• Fire Wall Status: For a healthy cluster, the firewall should not be raised on the Active or Standby
appliance. In this situation, the firewall is up, but firewall fencing is not raised. If a critical issue is
detected on the Active appliance, firewall fencing is raised on both appliances and a failover occurs to
make the Standby appliance the Active appliance. For a critical failure on the Standby appliance,
firewall fencing is raised on both appliances, the Standby appliance is flagged as Failed, and the
Active appliance continues to act as the host for the zone.
If the cluster is in maintenance mode, a number of additional entries are displayed; for example,
IPCACCEPT tcp -- 0.0.0.0/0.0.0.0.0/0 tcp dpt:8001 and REJECT tcp --
0.0.0.0./0.0.0.0.0/0 tcp dpt:3306 reject-with icmp-port-unreachable.
• JGroup Channel Status: Displays the JGroup Channel listening port and its established connection
with the Standby appliance in the cluster and the Active appliance in each of the other zones in the
enterprise . This information is not displayed for Standby appliances.
• Replication Status: Displays the replication listening port on the Active appliance and its established
connection with the Standby appliance in the cluster and the Active appliance in each of the other
zones in the enterprise. This information is not displayed for Standby appliances.
Troubleshooting
This section provides solutions for several cluster issues.
• If the Standby appliance Server Role is UNKNOWN and the Server State is FAILED, review the
status details, logs, and any other available information to attempt to determine the source of the
issue. If you discover the source of the problem, correct it then rearm the appliance by performing the
procedure Rearm the Standby appliance on page 547. If the role and state are still not correct,
reboot the standby appliance.

Note
Unless it is necessary to rearm the appliance during business hours, IPC recommends that you
perform the procedure after business hours. Rearming an appliance can affect users and active calls.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 507

• If the Server Role for an appliance remains UNKNOWN and the Server State remains AVAILABLE
for more than 45 minutes after an appliance is rebooted, do the following:
1. Determine which component is in the STARTING state; for example, if the component is Mysql,
you see:
• Service Name:Mysql
• Service Status:STARTING
• Remarks:null
2. At the Linux command line, create a file named orchestrator_threads.txt by running
the command pid=$(cat /var/run/orchestrater.pid); jrcmd $pid
print_threads > orchestrator_threads.txt.
3. Reboot the appliance. If the problem persists, contact Technical Support with the debug
information collected in the file you created in step 2.
• When the Remarks value for a component remains Change role in Progress for more than
45 minutes, do the following:
1. Copy the contents of the Cluster Operation Output Details report and paste it into a document file
or e-mail message.
2. At the Linux command line, create a file named orchestrator_threads.txt by running
the command pid=$(cat /var/run/orchestrater.pid); jrcmd $pid
print_threads > orchestrator_threads.txt.
3. Copy the output generated by the URL, http://appliance_ip:8001/va-ha/ctrl?
action=exthastatus, where appliance_ip is the IP address of the appliance on which
the component is not starting properly. Paste the output into the document or e-mail message you
created in step 1.
4. Reboot the appliance. If the problem persists, contact Technical Support with the debug
information collected in the files you created in steps 1, 2, and 3.
17.1.9.8.3 Check a zone's replication status with checkReplication
The checkReplication tool displays the replication, partial replication, and database dump status
and data for a zone.
For information on checking the replication status for all zones in the enterprise simultaneously, refer to
Check the data replication status for all zones in the enterprise on page 513.
1. Within a browser, access the URL https://vip/haservices/checkReplication, where
vip is the zone's VIP.
2. Review the output details. For information on the output, refer to Check replication output details on
page 507.
17.1.9.8.3.1 Check replication output details
This topic describes the output presented by checkReplication.
To run checkReplication, refer to Check a zone's replication status with checkReplication on page
507.
The information displayed is for the zone from which you ran checkReplication. In this topic, this
zone is referred to as the current zone.

IPC Confidential Unigy 4.3

Enterprise Guide
508 17.1: Deployment and upgrade procedures

Below is sample checkReplication output followed by an explanation of each attribute.

Replication is enabled.

Partial Replication is enabled.

Jgroups view size: 4

Jgroups expected view size: 4
Jgroups view members:
AddressPayload [vip=100.200.120.11, physicalIp=100.200.120.13,
schemaVersion=0.405, instanceId=1140850691]
AddressPayload [vip=100.200.120.11, physicalIp=100.200.120.12,
schemaVersion=0.405, instanceId=1140850691]
AddressPayload [vip=100.200.120.4, physicalIp=100.200.120.5,
schemaVersion=0.405, instanceId=1140850690]
AddressPayload [vip=100.200.120.4, physicalIp=100.200.120.6,
schemaVersion=0.405, instanceId=1140850690]
AddressPayload [vip=100.200.120.4, physicalIp=100.200.120.5,
schemaVersion=0.405, instanceId=1140850690]

InitStatus:Initialized

ReplicatorFSM state: active

GlobalReplicationTier Status : ENABLED GlobalReplicationTier Role:APZA

ZookeeperState :ActiveActive channel Name:Enterprise0301000001721
GlobalReplicationTier Operation: No GlobalReplicationTier operation is
running.

Zone Availability Status: available

Delta-Sync Enabled?: [true]

Delta-Sync Activated?: false

Last database sync from "["100.200.120.11"]" at "["Wed Jan 20 15:23:14 EST

2016"]" with Delta Sync = false. Time Required for Delta Sync = [10327] ms

ReplicatorInfo.queueState: realtime

Data captured for the period Wed Jan 20 14:52:10 EST 2016 to Wed Jan 20
15:23:14 EST 2016
OUTGOING:
Messages (total): 1455
Messages(total)/second: 0.0
Bytes sent (total): 5077807
Bytes(total)/second: 2724.0
INCOMING:
Messages (from zone 1): 952
Messages (from zone 1)/second: 0.0
Bytes received (from zone 1): 476000
Bytes received (from zone 1)/second: 255.0
Messages (from zone 4): 566
Messages (from zone 4)/second: 0.0
Bytes received (from zone 4): 1469262
Bytes received (from zone 4)/second: 788.0
Messages (total): 1518
Messages(total)/second: 0.0
Bytes received (total): 1945262

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 509

Bytes(total)/second: 1043.0

JGROUPS STAT DUMP: {VERIFY_SUSPECT={id=13, bind_interface=, bind_addr=/

100.200.120.5, stats=true, name=VERIFY_SUSPECT, num_msgs=1,
ergonomics=true, use_mcast_rsps=false, use_icmp=false, timeout=10000},
FRAG2={id=5, num_frags_received=0, frag_size=60000, stats=true,
name=FRAG2, num_frags_sent=0, ergonomics=true}, BARRIER={id=0,
max_close_time=60000, opener_scheduled=false, stats=true, name=BARRIER,
closed=false, ergonomics=true, in_flight_threads_count=0}, MERGE3={id=54,
view_consistency_checker_running=false, max_participants_in_merge=100,
merge_task_running=false, is_coord=false, stats=true, views=1,
check_interval=320000, name=MERGE3, ergonomics=true, num_merge_events=0,
info_sender_running=true}, AUTH={id=33, stats=true, name=AUTH,
ergonomics=true}, FD_ALL={suspected_members=[], interval=60000,
local_address=z3ccm1-10637(100.200.120.4,1100.200.120.5,Schema_Version
0.405,1140850690), num_heartbeats_received=5759, stats=true,
has_suspected_mbrs=false, ergonomics=true, num_heartbeats_sent=1448,
running=true, timeout_check_interval=2000, id=29, name=FD_ALL,
num_suspect_events=6, msg_counts_as_heartbeat=false, timeout=600000,
members=[z4ccm2-20478(100.200.120.11,100.200.120.13,Schema_Version
0.405,1140850691),
z4ccm1-11449(100.200.120.11,100.200.120.12,Schema_Version
0.405,1140850691), z3ccm1-10637(100.200.120.4,100.200.120.5,Schema_Version
0.405,1140850690), z3ccm2-7999(100.200.120.4,100.200.120.6,Schema_Version
0.405,1140850690)]}, UNICAST3={num_xmits=0, num_unacked_msgs=0,
local_address=z3ccm1-10637(100.200.120.4,100.200.120.5,Schema_Version
0.405,1140850690), stats=true, xmit_table_max_compaction_time=600000,
num_msgs_in_recv_windows=0, xmit_table_num_resizes=0,
log_not_found_msgs=true, conn_close_timeout=60000, id=64,
conn_expiry_timeout=120000, xmit_rsps_sent=0, xmit_reqs_received=0,
xmit_task_running=true, xmit_reqs_sent=0, xmit_table_num_rows=100,
name=UNICAST3, num_acks_received=3, xmit_table_undelivered_messages=0,
members=[z4ccm2-20478(100.200.120.11,100.200.120.13,Schema_Version
0.405,1140850691),
z4ccm1-11449(100.200.120.11,100.200.120.12,Schema_Version
0.405,1140850691), z3ccm1-10637(100.200.120.4,100.200.120.5,Schema_Version
0.405,1140850690), z3ccm2-7999(100.200.120.4,100.200.120.6,Schema_Version
0.405,1140850690)], xmit_interval=1000, xmit_table_resize_factor=1.2,
num_messages_sent=5, max_msg_batch_size=500, num_acks_sent=1,
ack_batches_immediately=true, num_messages_received=1,
xmit_table_num_moves=0, age_out_cache_size=0, ergonomics=true,
xmit_table_missing_messages=0, xmit_table_msgs_per_row=1000,
num_connections=0, xmit_table_num_purges=0, ack_threshold=5,
num_send_connections=0, xmit_table_num_compactions=0,
num_unacked_messages=0, number_of_messages_in_receive_windows=0,
num_receive_connections=0}, ENCRYPT={sym_provider=null, alias=1,
stats=true, sym_init=128, key_password=ef675510092260c3,
asym_provider=null, sym_algorithm=Blowfish, asym_init=512,
ergonomics=true, id=25, name=ENCRYPT, asym_algorithm=RSA,
store_password=ef675510092260c3, encrypt_entire_message=false,
key_store_name=jgroupsksjceks}, TCP={bind_addr=/100.200.120.5,
num_bytes_received=297957008, external_port=0, regular_queue_size=0,
diagnostics_ttl=8, oob_queue_size=0, receive_interfaces=null,
physical_addr_max_fetch_attempts=10, internal_pool_size=50,
receive_on_all_interfaces=false, oob_thread_pool.queue_max_size=1000,
internal_thread_pool.keep_alive_time=30000, timer.queue_max_size=2000,
enable_diagnostics=true, internal_thread_pool.queue_enabled=true,
thread_pool.enabled=true, num_msgs_received=103017,

IPC Confidential Unigy 4.3

Enterprise Guide
510 17.1: Deployment and upgrade procedures

different_version_messages=0, timer.rejection_policy=Discard,
send_buf_size=640000, oob_thread_pool.enabled=true, conn_expire_time=0,
oob_pool_size=0, num_incoming_msgs_received=94414, enable_bundling=true,
internal_queue_size=0, num_msgs_sent=73560,
suppress_time_different_cluster_warnings=60000, diagnostics_port=7501,
client_bind_port=0, internal_thread_pool.max_threads=75,
external_addr=null, regular_pool_size=50,
logical_addr_cache_max_size=4000, reaper_interval=0,
sock_conn_timeout=3000, defer_client_bind_addr=false,
internal_thread_pool.min_threads=50, send_queue_size=10000,
client_bind_addr=null, logger_type=log4j,
logical_addr_cache_expiration=600000, num_bytes_sent=245669189,
thread_pool.queue_max_size=50000, bundler_buffer_size=0,
timer_queue_size=0, diagnostics_bind_interfaces=null,
suppress_time_different_version_warnings=60000, enable_batching=true,
who_has_cache_timeout=2000, port_range=0, stats=true,
peer_addr_read_timeout=3000, tcp_nodelay=true, timer_threads=2,
timer.tick_time=50, id=22, diagnostics_addr=/224.0.75.75,
internal_thread_pool.rejection_policy=discard,
internal_thread_pool.queue_max_size=500, bind_port=9802,
num_internal_msgs_received=7491, different_cluster_messages=0,
loopback=true, linger=-1, open_connections=5, name=TCP,
enable_unicast_bundling=true, oob_thread_pool.rejection_policy=Discard,
log_discard_msgs_version=true, thread_naming_pattern=pc1,
internal_thread_pool.enabled=true, channel_name=Enterprise0301000001721,
use_send_queues=true, num_oob_msgs_received=1110,
discard_incompatible_packets=true, thread_pool.rejection_policy=Discard,
timer_class=TimeScheduler3, diagnostics_passcode=null, ergonomics=true,
thread_pool.queue_enabled=true, bundler_capacity=20000,
singleton_name=null, num_threads=176, oob_thread_pool.queue_enabled=false,
log_discard_msgs=true, bundler_type=new, timer_type=new3,
recv_buf_size=20000000, timer_tasks=7, timer.wheel_size=200},
TCPPING={always_send_physical_addr_with_discovery_request=false,
num_initial_members=2, port_range=0,
initial_hosts_list=[100.200.120.12:9802, 100.200.120.13:9802,
100.200.120.6:9802, 100.200.120.52:9802, 100.200.120.58:9802,
100.200.120.5:9802],
current_coord=z4ccm2-20478(100.200.120.11,100.200.120.13,Schema_Version
0.405,1140850691), force_sending_discovery_rsps=true, stats=true,
ergonomics=true, max_found_members=0, num_initial_srv_members=0, id=10,
max_dynamic_hosts=100, num_discovery_requests=1, is_coord=false,
initial_hosts=[100.200.120.12:9802, 100.200.120.13:9802,
100.200.120.6:9802, 100.200.120.52:9802, 100.200.120.58:9802,
100.200.120.5:9802], return_entire_cache=false, break_on_coord_rsp=true,
use_disk_cache=false, stagger_timeout=0, name=TCPPING,
view=[z4ccm2-20478(100.200.120.11,100.200.120.13,Schema_Version
0.405,1140850691)|21], dynamic_host_list=[100.200.120.5:9802],
timeout=200000}, GMS={merge_task_running=false,
local_address=z3ccm1-10637(100.200.120.4,100.200.120.5,Schema_Version
0.405,1140850690), stats=true, log_collect_msgs=true,
resume_task_timeout=20000, number_of_views=3, num_prev_views=20,
log_view_warnings=true, flush_invoker_class=null,
print_physical_addrs=true, merge_timeout=60000, num_members=4, id=14,
num_prev_mbrs=50, leave_timeout=1000, view_bundling=true,
view_handler_suspended=false, name=GMS, join_timeout=60000,
view_handler_size=0, max_join_attempts=0, merge_killer_running=false,
members=[z4ccm2-20478(100.200.120.11,100.200.120.13,Schema_Version
0.405,1140850691),
z4ccm1-11449(100.200.120.11,100.200.120.12,Schema_Version

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 511

0.405,1140850691), z3ccm1-10637(100.200.120.4,100.200.120.5,Schema_Version
0.405,1140850690), z3ccm2-7999(100.200.120.4,100.200.120.6,Schema_Version
0.405,1140850690)], merge_in_progress=false, print_local_addr=true,
max_bundling_time=50, merge_id=null, ergonomics=true,
use_flush_if_present=true, handle_concurrent_startup=true,
view_ack_collection_timeout=10000,
view=[z4ccm2-20478(100.200.120.11,100.200.120.13,Schema_Version
0.405,1140850691)|21]}, STATE_TRANSFER={id=17, average_state_size=0.0,
stats=true, barrier_closed=false, name=STATE_TRANSFER,
number_of_state_bytes_sent=0, ergonomics=true,
number_of_state_requests=0}, NAKACK2={use_mcast_xmit_req=false,
suppress_time_non_member_warnings=60000, current_seqno=67864, stats=true,
xmit_table_max_compaction_time=10000, size_of_all_messages_incl_headers=0,
xmit_table_num_resizes=0, log_not_found_msgs=true,
discard_delivered_msgs=true, print_stability_history_on_failed_xmit=false,
xmit_table_num_current_rows=50, id=57, xmit_rsps_sent=0,
max_rebroadcast_timeout=2000,
msgs=z3ccm1-10637(100.200.120.4,100.200.120.5,Schema_Version
0.405,1140850690):
z3ccm1-10637(100.200.120.4,100.200.120.5,Schema_Version 0.405,1140850690):
[67791 | 67864 | 67864] (0 elements, 0 missing)
z4ccm1-11449(100.200.120.11,100.200.120.12,Schema_Version
0.405,1140850691): [0 | 0 | 0] (0 elements, 0 missing)
z4ccm2-20478(100.200.120.11,100.200.120.13,Schema_Version
0.405,1140850691): [41625 | 41625 | 41625] (0 elements, 0 missing)
z3ccm2-7999(100.200.120.4,100.200.120.6,Schema_Version 0.405,1140850690):
[0 | 0 | 0] (0 elements, 0 missing)
, xmit_reqs_received=0, xmit_task_running=true, xmit_table_num_rows=50,
xmit_reqs_sent=0, become_server_queue_size_actual=0, name=NAKACK2,
xmit_table_capacity=500000, xmit_table_resize_factor=1.2,
xmit_interval=1000, use_mcast_xmit=false, num_messages_sent=67864,
max_msg_batch_size=100, xmit_from_random_member=false,
num_messages_received=95517, xmit_table_num_moves=0,
non_member_messages=0, size_of_all_messages=0, ergonomics=true,
become_server_queue_size=50, xmit_table_missing_messages=0,
xmit_table_msgs_per_row=10000, log_discard_msgs=true,
xmit_table_num_purges=1110, xmit_table_num_compactions=0,
xmit_table_undelivered_msgs=0, xmit_rsps_received=0},
STABLE={stable_task_running=true, max_bytes=400000,
num_bytes_received=302488, stats=true, cap=0.1, bytes_received=302488,
stable_received=0, stability_received=1110, ergonomics=true,
suspended=false, id=16, desired_avg_gossip=60000, stable_sent=1667,
name=STABLE, stability_sent=0, send_stable_msgs_to_coord_only=true,
stability_delay=2000}, channel={sent_msgs=67864, sent_bytes=232008703,
received_bytes=297550065, received_msgs=94410}}

Not performing any Role currently.

Provider Zone info:

No valid Data to display at the Provider end.

Receiver Zone info:

No valid Data to display at the Receiver end.

The following information is presented by checkReplication:

• Replication is: Indicates whether replication is enabled or disabled for the current zone.
• Partial replication is: Indicates whether partial replication is enabled or disabled for the zone.

IPC Confidential Unigy 4.3

Enterprise Guide
512 17.1: Deployment and upgrade procedures

• Jgroups view size: Displays the number of CCM or ACCM appliances in the enterprise that are in a
zone that has replication enabled. If the number of appliances does not match the number of
appliances in the enterprise, this can indicate that replication for a zone is not enabled, the appliances
in the zone are rebooting, or the appliances in the zone are down.
• Jgroups expected view size: Indicates the JGroups view size you should expect to see in a data
center (whether or not Multi-tier Replication is enabled). For example, for a 10 zone enterprise (all
standalone zones) without Multi-tier Replication enabled, the JGroups expected view size would be
10. If you break down that enterprise into three data centers and enable Multi-tier Replication, then if
there are three zones in a particular data center each zone will indicate that the JGroups expected
view size is 3 since it should only display the JGroups view size of its data center zones.
• Jgroups view members: Displays the zone VIP, IP address, schema version, and associated instance
for each appliance included in the JGroups view. The number of appliances should match the number
specified in Jgroups view size plus one final entry for the active appliance in the current zone.
The first entry in the list is the coordinator for the JGroups cluster. If you run checkReplication
for each zone in the associated data center, the list should be the same for each zone.
• InitStatus: Indicates the Replicator Status. If the state is Initialized then the replicator is
initialized. If the state is Replicator is not Initialized then the replicator is in the
process of initializing.
• ReplicatorFSM state: Indicates the internal state of the Replicator component for database
replication. If the component is running properly, the state is active. This is equivalent to the
Status RUNNING and the Remarks value Replication is enabled for the Replicator service
in the checkHAStatus output.
• GlobalReplicationTier Status: Indicates whether Multi-tier Replication is enabled, disabled, or
suspended.
• Zone Availability Status: Indicates the status of the current zone in relation to its ability to provide a
database dump to other zones. The status available indicates that the zone is not providing a
database dump to any zones. The status partially available indicates that the zone is
providing a database dump to one zone, but is available to provide the database for another zone. The
status not available indicates that the zone is providing a database dump for two zones and is
not available to provide the database to another zone until the dump for one zone is complete.
• Delta-Sync Enabled?: Indicates whether the delta-sync database dump feature is enabled. Delta-sync
minimizes the time required to synchronize a database after an upgrade, zone refresh, or zone restart
by loading only the data changes that are different from what is in the current database. For
information on delta-sync, refer to the Databases topic in the System Installation and Deployment
Guide.
• Delta-Sync Activated?: Indicates whether the last database dump that was performed was a delta-
sync (true) or a full database dump (false).
• Last database sync from: Displays the VIP of the zone from which the current zone last loaded a
database dump and the date and time this occurred. It also indicates whether the dump was a delta-
sync (true) or a full database dump (false) and the time required to complete the process.
If a zone cannot load the database from another zone, it starts with its local database. In this situation,
the source zone and date and time stamp do not change. A change is seen only when the zone loads
the database from another zone.
• ReplicatorInfo.queueState: Indicates whether the Replicator is operating properly with data being
replicated in realtime. If the state is init, the replication data might be stuck.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 513

• Data captured for the period: Displays the data that was being replicated between the current zone
and other zones in the enterprise during the time period specified. The time period is approximately
10 minutes before you ran checkReplication. Unless there is no system activity, the totals
should not consistently be zero and the data should change each time you refresh the output. This
indicates that replication is occurring.
• OUTGOING: Data replicated from the current zone to the other zones in the enterprise. The data
includes the total number of messages sent, number of messages sent per second, total number of
bytes sent, and the number of bytes sent per second.
• INCOMING: Data replicated to the current zone from other zones. The data includes the following
information from each zone: total number of messages received, number of messages received per
second, total number of bytes received, and the number of bytes received per second.
• JGROUPS STAT DUMP: JGroups statistical data. The data included is from the time the zone was
placed into service to the present.
• Not performing any role currently: Role currently being performed by the zone in relation to its
participation in a database dump . The role receiver indicates that the zone is receiving a database
dump from another zone. The role provider indicates that the zone is providing a database dump
for another zone. The role Not performing any role currently indicates that the zone is
neither the provider nor the receiver of a database dump.
• Provider Zone info: Provides information related to the zones for which the current zone provided a
database dump. The information includes the target zone's VIP, physical IP address of each appliance
in the zone, schema version, and instance ID.
• Receiver Zone info: Provides information on the zones that provided a database dump for the current
zone. The information includes the source zone's VIP, physical IP address of each appliance in the
zone, schema version, and instance ID.
17.1.9.8.4 Check the data replication status for all zones in the enterprise
This topic describes how to display the current data replication status for all zones in an enterprise with
the getEnterpriseReplication.sh script.
Prerequisite:
Before you begin this procedure, determine whether the getEnterpriseReplication.sh script
is available in /etc/opt/ipc/ha/scripts. If it is not, obtain a copy of the script from the IPC
FTP site, FilesAnywhere.
This script runs the checkReplication.sh script in all zones specified in a text file then compiles
the output for each zone into the /var/spool/backup/EXP5/EntRepStatus.tar file to make
it easier to analyze the replication status for all zones in the enterprise. The .tar file includes a separate
file for each zone.
When you run the script, you include a single argument, the name of a text file that contains the IP
addresses for all appliances for which you are checking the replication status. The name of the text file
should be addresses.txt. Create this file by performing the procedure Generate address text files
with generateAddresses on page 567. Each entry in the file is delimited with an endofline (line break)
character.
For information on the script output, refer to Check replication output details on page 507.
1. Access the command line on a CCM or ACCM appliance.
Use the appliance where the addresses.txt file was created.
2. Run the command su -lp then enter the root user account password.

IPC Confidential Unigy 4.3

Enterprise Guide
514 17.1: Deployment and upgrade procedures

3. Change the current directory to /etc/opt/ipc/ha/scripts.

4. If the getEnterpriseReplication.sh script file is not in the /etc/opt/ipc/ha/
scripts directory, do the following:
a) Copy the file to the /etc/opt/ipc/ha/scripts directory.
b) Change the file permissions by running the following commands:
1. chown root:root getEnterpriseReplication.sh
2. chmod 755 getEnterpriseReplication.sh
5. Run the command ./getEnterpriseReplication.sh addresses.txt.
The output for each appliance is available in /var/spool/backup/EXP5/
EntRepStatus.tar.
6. Run the following command to extract the files in EntRepStatus.tar:
tar -xvf /var/spool/backup/EXP5/EntRepStatus.tar
7. Review the output for each appliance.
17.1.9.8.5 Check a zone's transient channel status with checkTransientChannels
Use this procedure to display the status of JGroups transient channel data for channels that communicate
transient entities including line status, presence, MWI, and custom topics.
The output includes the following entities:
• JGroups view size
• UNICAST
• NAKACK
• FD
• VERIFY_SUSPECT
• BARRIER
• FRAG
• MERGE
• TCP
• TCPPING
• GMS
• STATE_TRANSFER
• STABLE
• channel
1. Within a browser, access the URL https://ip/haservices/checkTransientChannel,
where ip is the IP address of the appliance you are validating.
2. Review the output.
17.1.9.8.6 Check the transient channel status for all zones in the enterprise
This topic describes how to display the current transient channel line status message queue size and
transient channel status information for all zones in an enterprise through the
getTransientChannelInfo.sh script.
Prerequisite:

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 515

Before you begin this procedure, be sure that the getTransientChannelInfo.sh script is
available in /etc/opt/ipc/ha/scripts. If it is not, obtain a copy of the script from the IPC FTP
site, FilesAnywhere, and copy it to this directory.
This script runs the checkTransientChannels.sh script in all zones then compiles the output
into the /var/spool/backup/EXP5/EntTransientChannelStatus_*.tar file to make it
easier to analyze the transient channel status for all zones in the enterprise. The .tar file includes two
files for each IP address: line status notification message queue size and transient channel information.
When you run the script, you include a single argument, the name of a text file that contains the IP
addresses for all appliances for which you are checking the transient channel status. The name of the text
file should be addresses.txt. You can create this file by performing the procedure Generate
address text files with generateAddresses on page 567. Entries in the file are delimited with an
endofline (line break) character.
The getTransientChannelInfo.sh script is applicable only for HA zones. If there is a
standalone appliance in the list of IP addresses in the addresses.txt file, the script does not fail, but
you will see errors for the appliance in the output generated.
1. Access the command line on a CCM or ACCM appliance.
Use the appliance where the addresses.txt file was created.
2. Change the current directory to /etc/opt/ipc/ha/scripts.
3. If the getTransientChannelInfo.sh script file is not in the /etc/opt/ipc/ha/
scripts directory, do the following:
a) Copy the file to the /etc/opt/ipc/ha/scripts directory.
b) Change the file permissions by running the following commands:
1. chown root:root getTransientChannelInfo.sh
2. chmod 755 getTransientChannelInfo.sh
4. Run the command ./getTransientChannelInfo.sh addresses.txt.
The output for each appliance is available in /var/spool/backup/EXP5/
EntTransientChannelStatus_*.tar.
5. Run the following command to extract the files in EntTransientChannelStatus_*.tar:
tar -xvf /var/spool/backup/EXP5/EntTransientChannelStatus_*.tar
6. Review the output for each appliance.

17.1.9.9 Add or edit a zone

This topic describes how to configure zone properties from the UMS when you add or edit a zone.
Prerequisite:
Before you add or edit a zone, collect the values required for each property you are configuring. These
should be available in the customer's Unigy Data Collection document.
When you deploy the first zone in a Unigy enterprise, the system configures the properties for this zone
(named Default Zone) based on a set of default values and the zone VIP specified during deployment of
the personality software. After you deploy the first zone, you can change the zone's properties, and in a
multizone enterprise, configure the properties for additional zones. Configure these subsequent zones as
part of the zone deployment procedure.
Refer to the UMS online help or UMS UI Guide for information on the values to enter for the zone
properties.

IPC Confidential Unigy 4.3

Enterprise Guide
516 17.1: Deployment and upgrade procedures

1. Click Configuration ➤ Enterprise ➤ System ➤ Zones.

2. In the Zones list, click +Add New to add a zone or click an existing zone to edit the zone.
3. Select the instance with which the zone is associated (applies only to new zones), provide a name for
the zone, enter the zone Backroom Location, Preferred Zone, VIP Address, IP address for the
primary, and in an HA zone, secondary CCM or ACCM appliances in the ACCM/CCM1 IP Address
and ACCM/CCM2 IP Address fields, Certificate Authority IP (enter the zone VIP), and the port and
timer values. Add or change any other values as needed.
Consider the following guidelines:
• To distinguish dedicated Blue Wave zones from Unigy zones, consider assigning a name that
makes this distinction clear.
• For dedicated Blue Wave zones:
• Pre-Unigy v3.1 zones must be associated with an instance that is separate from the Unigy
instances to avoid performance issues.
• Unigy v3.1 or higher zones can be associated with the same instance as Unigy zones without a
performance impact if the CDI Support and Line Support fields are set properly. These are
configured at Configuration ➤ Enterprise ➤ System ➤ Zones.
• If you are adding a Unigy zone, select the Device Registration Enabled check box. If you are
adding a Blue Wave zone, do not select this check box.
4. Click Save.

17.1.9.10 Add or edit a location

Locations identify the physical address and location of a Unigy backroom or front room at the address.
This topic describes how to add a new location or edit an existing location.
The location configuration specifies the location type, floor, time zone, associated instance, IPC site
code, and address. An address can be associated with multiple locations, including front rooms,
backrooms, or both location types; for example, first floor computer room, second floor trading center,
and third floor administrative center.
Prior to Unigy v3.0, addresses were configured during location configuration, however, beginning with
Unigy v3.0, addresses are configured at Configuration ➤ Enterprise ➤ System ➤ Addresses (refer
to Add, edit, or delete an address on page 242).
Configure the addresses before you configure the locations. Configure locations before you configure
the prototype devices and add Media Gateways, CDIs, or other devices to the system.
If you configure multiple backroom locations, assign them to the appropriate zones at Configuration ➤
Enterprise ➤ System ➤ Zones.

Note
If you are changing the address for an existing location and the address that is currently assigned to the
location is the default address for the enterprise (address ID 1 or 2), you might see an error message
when you attempt to save the change. This is because the default address is part of the enterprise seed
data and must be assigned to at least one location. If you are changing the address for all locations to
which this address is assigned, create a dummy location then assign the default address to that location
before you change the address for the existing location(s). Another option is to create new locations and
assign the appropriate address.

For details on the values you enter for the location fields, refer to the UMS online help or the UMS UI
Guide.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 517

1. Click Configuration ➤ Enterprise ➤ System ➤ Locations.

2. Do one of the following:
• To add a new location, click +Add New.
• To edit an existing location, click the location name in the locations list.
3. In the Name field, type a unique name that identifies the location throughout the enterprise.
4. In the Location Type field, select frontroom or backroom. A front room location is where CDIs
(turrets, Pulse devices, and Soft Clients) are located. A backroom location is where Unigy CCM,
MM, or ACCM appliances are located.
5. In the Floor field, type the location floor number.
6. In the Time Zone list, select the time zone for the location. You can select a time zone by GMT
offset, zone abbreviation, or region.
7. In the Instance field, select the Unigy instance associated with the location.
8. In the IPC Site Code (AFM) field, enter a unique code that identifies the Unigy location to a Critical
Alert, Advanced Fault Management (AFM), Network Operations Center (NOC), or Global Support
Operations Center (GSOC) facility that monitors system health.
9. In the Address Detail section, select an address.
The system populates the address fields.
Addresses are configured at Configuration ➤ Enterprise ➤ System ➤ Addresses.
10. Click Save.

17.1.9.11 Assign or change the backroom location for a zone's appliances

To identify the physical location of a device, you assign a location, which includes the address at which
the device resides and where it can be found at that address. This topic describes how to assign or
change the backroom location for the Converged Communications Manager (CCM), Aggregated
Converged Communications Manager (ACCM), or Media Manager (MM) appliances associated with a
zone.
You assign a location during initial deployment of the appliances in a zone and can change the location
as needed.
The locations are configured at Configuration ➤ Enterprise ➤ System ➤ Locations or Tools ➤
Deployment ➤ Configure Location.

CCM, ACCM, and MM appliances should always be assigned to a backroom location. If BCP is
enabled, home zones (Campus BCP) or active zones (Basic BCP) generally should be at a different
address from the backup zones (Campus BCP) or standby zones (Basic BCP) within the same instance
for disaster recovery purposes.
To perform this procedure, your user account must have the IPC Project Manager or IPC Certified Tech
role assigned.
1. If you are changing the backroom location and Multi-tier Replication is enabled for the data center
the zone is member of, disable Multi-tier Replication for the current zone and for the zone you are
assigning the zone to by performing the procedure Disable Multi-tier Replication on page 246.
Wait for the zones to join the default data center.
2. Click Configuration ➤ Enterprise ➤ System ➤ Zones.
3. In the Zones list, click the zone for which you are assigning or changing the location.

IPC Confidential Unigy 4.3

Enterprise Guide
518 17.1: Deployment and upgrade procedures

4. Within the Backroom Location field, select the appropriate backroom location.
5. Click Save.
6. If you disabled Multi-tier Replication in step 1, reenable it for both data centers by performing the
procedure Enable Multi-tier Replication on page 243.

17.1.9.12 Zone Configuration

Within this panel you can add a zone, view and configure the properties of a zone, re-establish failed or
stuck MRD and hoot lines associated with a zone, access the Blue Wave Administration console, and
change a previously specified country base.
Within this topic, the terms current version and current software version refer to the Unigy software
version specified on the cover of this document. References to previous Unigy versions apply to the
versions, patches, service packs, and hotfixes for these versions that the current version supports.
A zone generally represents a Unigy backroom. Each zone includes one or two Converged
Communications Manager (CCM) or Aggregated Converged Communications Manager (ACCM)
appliances, and zero, one, or multiple Media Managers (MMs), Media Gateways (MGs), Channel Banks
(CBs), or Session Border Controllers (SBCs). Turrets Pulse devices, and Unigy Soft Clients register with
the CCMs or ACCMs in the zone. Zones can also serve as backup zones for Business Continuity
Planning (BCP) failover purposes and as Blue Wave zones for routing application requests from custom
and third-party applications that use the Blue Wave APIs to Unigy zones for call processing.
To access this panel, click Configuration ➤ Enterprise ➤ System ➤ Zones.
From the Zones panel:
1. Click on a Zone name or an Instance name to view and configure the properties of a Zone.
2. Click +Add New to add a new Zone.
To access the panel, do one of the following:
• Click Configuration ➤ Enterprise ➤ System ➤ Zones. In the Zones list click a zone to modify it
or click the +Add New button to add a zone.
• Click Tools ➤ Deployment ➤ Hardware Deployment. Navigation to the panel through this means
is available only to users with the IPC Project Manager or IPC Certified Tech role. This option does
not provide access to all zone-related functions.

Note
Define the enterprise instances before adding new zones.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 519

Basic zone properties

Figure 96: Zone tab: basic zone properties

IPC Confidential Unigy 4.3

Enterprise Guide
520 17.1: Deployment and upgrade procedures

Table 55: Zone panel: basic zone properties

Name Description Values Notes

Instance Parent instance of the All instances in the Select a value from the list.
zone. enterprise defined Zones included in a BCP plan
Required through must all be associated with the
Configuration ➤ same instance.
Enterprise ➤ System ➤ Prior to Unigy v3.1, Unigy and
Instances. dedicated Blue Wave zones
could not be associated with the
same instance. With Unigy v3.1
or higher, dedicated Blue Wave
and Unigy zones can be
associated with the same
instance if the CDI Support and
Line Support properties in the
Trading section are disabled.
Customer provided.
Zone Name Unique name that 3 to 64 alphanumeric Special characters other than
identifies the zone characters, space, and underscore are not valid.
throughout the underscore. If you are configuring a
enterprise. Default: Default dedicated Blue Wave zone,
Required. Zone 1. Applies only consider assigning a name that
to the first zone. No distinguishes the zone from the
default for subsequent Unigy zones.
zones. Before you change the name of
a zone that has history and alert
data, perform an Archive all
Zone backup with a 14 day
scope to minimize the
performance impact caused by
update operations that create or
update entities to reflect the
name change.
Customer provided or system
generated (default).
Country Base Type Identifies tones, • Australia Customer provided.
cadences, electrical, For guidelines on the country
and regulatory • China base to assign, refer to Country
requirements for • Pan-Euro base designations on page 476.
devices in a specific After you save a country base,
geographical area. • South Africa
the system disables this field. To
Required • United Kingdom change the value, click Change
Countrybase.
• United States
If the system is licensed for
Alliance MX interoperability, end
users might experience
unexpected behavior if the
country base set in Unigy is
different from the country base
set in Alliance MX. For example,
they might hear different tones
for Unigy calls.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 521

Table 55: Zone panel: basic zone properties (continued)

Name Description Values Notes

Backroom Location Location that List of backroom Select a backroom location.
identifies where the locations associated Locations are configured at
zone appliances with the instance Configuration ➤ Enterprise ➤
reside. assigned to the zone. System ➤ Locations.
Default: For the first This identifies the data center the
zone deployed in the zone is associated with for Multi-
enterprise, the default tier Replication.
backroom location. To change the backroom location
when Multi-tier Replication is
enabled for the associated data
center, you must first disable
Multi-tier Replication for the
current data center and the data
center to which you are
assigning the zone, wait for the
zones to join the default data
center, change the location, then
reenable Multi-tier Replication for
both data centers.
You cannot remove a zone from
the enterprise if the backroom
location assigned to the zone is
associated with a data center
that has Multi-tier Replication
enabled. In this scenario, change
the backroom location to one
that is not associated with a
Multi-tier Replication enabled
data center before you remove
the zone.
Preferred Zone Zone from which the Blank plus all zones in To avoid latency issues, the zone
system loads a dump the enterprise except you select should be within
of the Unigy database the zone you are logged relatively close proximity to the
when the zone is in to. current zone. For example, if
initially deployed or is Default: blank – no there are zones in New York,
restarted. preferred zone. Boston, and Tokyo and you are
configuring a zone in New York,
the preferred zone generally
should be another zone in New
York or a zone in Boston, not a
zone in Tokyo.
If a zone is not specified or the
preferred zone is not available,
the system uses the source zone
selection algorithms described in
Database source zone selection
algorithms for database dumps
on page 615 to select the zone
from which to load the database.
If no zone is available, the zone
comes up with its own local
database.

IPC Confidential Unigy 4.3

Enterprise Guide
522 17.1: Deployment and upgrade procedures

Table 55: Zone panel: basic zone properties (continued)

Name Description Values Notes

The value for this field is not
stored in the database, therefore,
if the zone is upgraded with a
procedure that includes
redeploying the COP software,
Zone Deployer sets the value to
the peer zone that is specified
during the upgrade or to a blank
value for the first zone upgraded,
which does not have a peer
zone. It might be necessary to
change this value after the
upgrade if the value Zone
Deployer sets is not the
preferred value.
If Multi-tier Replication is or will
be activated, the preferred zone
for a portal zone should be a
portal zone in the nearest data
center and the database schema
version should be the same or
higher to ensure that no data is
lost.
Blue Wave zones can load the
database from any zone that
makes operational sense.
This field is visible only when you
are viewing the configuration for
the zone you are currently
logged in to.

Server Cluster
Figure 97: Zone tab: Server Cluster section

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 523

Table 56: Zone tab: Server Cluster section

Name Description Values Notes

VIP Address HA cluster Virtual IP Up to 24 characters in Customer provided.
address (VIP), or for a dot-decimal notation In an HA (High Availability)
standalone zone, the nnn.nnn.nnn.nnn configuration, the CCMs or
IP address of the CCM ACCMs in a zone work
or ACCM. together as a cluster and
Required present a single Virtual IP
address (VIP) to the outside
for all inbound
communication.
If there is no HA cluster,
populate this and the other
VIP fields with the
appliance-specific IP
address, subnet, gateway,
and FQDN information.
After you enter this value,
the system automatically
populates the Virtual IP
Address field within the
cluster Properties tab at
Configuration ➤ Sites ➤
Servers ➤ Clusters.

IPC Confidential Unigy 4.3

Enterprise Guide
524 17.1: Deployment and upgrade procedures

Table 56: Zone tab: Server Cluster section (continued)

Name Description Values Notes

ACCM/CCM1 Server IP IP address that IP address in dot- The system uses the value
Address identifies the appliance decimal format. you specify for ACCM/CCM1
in a single appliance ###.###.###.### Server IP Address, and
zone, or the primary where applicable, ACCM/
appliance in an HA CCM2 Server IP Address, to
zone. enable Zone Deployer to
Required deploy a zone during initial
deployment. It also uses
these values if it is
necessary to change the
appliance IP addresses.
Because of the security
hardening implemented to
protect a zone, the system
must ensure that the
appliances specified are
valid appliances for the VIP.
The appliances associated
with the VIP are identified
when Personality Deployer
is run on each appliance
during initial deployment. If
the IP addresses you specify
here do not match the
addresses of the appliances
specified in Personality
Deployer, the zone
deployment fails.
If you are changing the IP
addresses for the appliances
in a zone, change the IP
addresses here before you
change them with Network
Configurator. For information
on changing IP addresses,
refer to the Enterprise
Guide.
In an HA zone, enter the IP
address of the primary
appliance associated with
the VIP. The primary
appliance in an HA cluster is
the appliance with the lower
IP address.
ACCM/CCM2 Server IP IP address that IP address in dot- In an HA zone, enter the IP
address identifies the decimal format. address of the secondary
secondary appliance in ###.###.###.### appliance that is associated
HA zone. with the zone VIP. The
Required for an HA secondary appliance is the
zone. appliance in the cluster with
the higher IP address.
This field does not apply to
single appliance zones.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 525

Table 56: Zone tab: Server Cluster section (continued)

Name Description Values Notes

VIP Subnet Virtual IP subnet mask. Up to 24 characters in Customer provided.
dot-decimal notation Used to designate the
nnn.nnn.nnn.nnn subnetwork range of VIP
addresses.
VIP Gateway Virtual IP gateway. Up to 24 characters in Customer provided.
dot-decimal notation The point on the network
nnn.nnn.nnn.nnn that allows entry to another
network.
VIP FQDN Fully qualified VIP. Up to 256 characters Customer provided.
in the form The VIP identifies the zone
VIP.domain_name. and the domain name
For example, identifies the enterprise.
10.20.30.40.ipc.com.
SIP Port Port on which to listen Integer. IPC recommends using the
for SIP traffic. Range: 1025 to default port. If you change
Required 65535, excluding this port number, a zone
5059 refresh must be performed
Default: 5060 in order for the change to
take effect. To make a
change, follow the
procedure to Change the
SIP Port for a zone in the
Enterprise Guide.
HTTP Port Port on which to listen Range: 0 to 65535 IPC recommends using the
for HTTP traffic. Default: 80 default port.
Required
HTTPS Port Port on which to listen Range: 0 to 65535 IPC recommends using the
for secure HTTP traffic. Default: 443 default port.
Required
SysLog Port Port on which to listen Range: 0 to 65535 IPC recommends using the
for SysLog traffic. Default: 514 default port.
Required
SNMP Mgmt Port Port on which to listen Range: 0 to 65535 IPC recommends using the
for SNMP traffic. Default for general default port.
Required SNMP messages:
161
Default for SNMP trap
messages: 162

IPC Confidential Unigy 4.3

Enterprise Guide
526 17.1: Deployment and upgrade procedures

Table 56: Zone tab: Server Cluster section (continued)

Name Description Values Notes

Web Link Access Indicates the state of • Check box Enabling and disabling the
Web links access for selected: the Web Web links is controlled by
the WebLogic Admin links are enabled. the Enable Web links or
Console, SWMS Disable Web links buttons at
Admin Console, and • Check box the bottom of the panel.
Enterprise Watch. cleared: the Web Web links can be enabled or
Links are disabled. disabled only by user
accounts with the IPC
Certified Tech role.
Read-only

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 527

Table 56: Zone tab: Server Cluster section (continued)

Name Description Values Notes

SMTP Server Config Name of the SMTP Names of configured The list is populated from
server profile for this SMTP servers. Configuration ➤
zone to use when Enterprise ➤ SMTP.
Unigy sends an email. If multi-factor authentication
is enabled for one or more
users, you must assign an
SMTP server profile to each
zone to enable the system to
send the e-mail messages
that deliver the security
token that is required for
these users to log in to the
UMS and Mass Edit Client
spreadsheets.

BCP Role and Status

Figure 98: Zone tab: BCP Role and Status section

Table 57: Zone tab: BCP Role and Status section

Name Description Values Notes

Configure BCP Role Specifies the role of the • Active: Zone is able For Basic BCP, assign
zone in Business to process calls and the Active role to the
Continuity Planning configuration primary zone and
(BCP). requests. Standby to the
Required secondary zone.
• Standby. Zone is a
The system sets the
Basic BCP Standby
value to Active for
zone.
Campus BCP.
• LocalSurvivability. LocalSurvivabili
Zone is a ty is not supported.
LocalSurvivability Customer provided.
zone.
Default: Active

IPC Confidential Unigy 4.3

Enterprise Guide
528 17.1: Deployment and upgrade procedures

Table 57: Zone tab: BCP Role and Status section (continued)

Name Description Values Notes

BCP Status Specifies the current • Active: Zone is If automatic BCP plan
status of the zone. functioning normally.activation is enabled, set
Required this value to
• Inactive: BCP plan Maintenance before
was activated for the
performing maintenance
zone redirecting the
activities, such as
lines and CDIs to one
upgrades or hardware
or more backup
replacement, to prevent
zones.
the zone from failing
• Maintenance: Zone is over. However, if it is
in maintenance mode necessary to support
to prevent automatic call processing during
activation of the BCP the maintenance
plan during a operation, you can
maintenance manually activate the
operation. BCP plan for the zone
you are maintaining to
• Failed: Zone is redirect the lines and
unavailable due to a
CDIs to backup zones
component or
prior to performing the
network failure. The
maintenance.
BCP plan has not
The system sets the
been activated to
status to Inactive
redirect the lines and
CDIs. when a BCP plan is
activated. You cannot
Default: Maintenance manually set this value
nor can you change it
from Inactive to
Active. When the
BCP plan is deactivated,
the system changes the
status back to Active.
The system sets the
value to Failed when
a zone failure is
detected. You cannot
manually set this value
nor can you change the
value.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 529

Properties
Figure 99: Zone tab: Properties section

Table 58: Zone tab: Properties section

Name Description Values Notes

Certificate Authority IP IP address of the Up to 128 characters in Customer provided.
certification authority dot-decimal notation This is usually the zone
that issues Digital nnn.nnn.nnn.nnn. VIP.
Certificates.
Required.
Intrusion Tone Indicates whether the Select the check box to The tone frequency and
system plays an enable. cadence are defined by
intrusion tone when an Default: enabled the country base. You
end user barges in to a can adjust the tone level
handset line call, private and intrusion tone voice
line or dial tone call. attenuation from the
UMS.
When you enable this
feature at the zone level,
you can enable or
disable the feature for
individual end users and
end user groups.
Intrusion tones are
supported for turrets and
IQ/MAX Omni.
Customer provided.
Record Warning Tone Indicates whether the Select the check box to
system plays a tone enable.
when a call is being Default: disabled
recorded.
Call Control QOS Network Quality of Range: 0 to 255
Service for call control. Default: 26
Voice QOS Network Quality of Range: 0 to
Service for voice traffic. 99999999999
Required. Default: 46

IPC Confidential Unigy 4.3

Enterprise Guide
530 17.1: Deployment and upgrade procedures

Table 58: Zone tab: Properties section (continued)

Name Description Values Notes

Unsupervised Indicates whether lines Select the check box to Unsupervised
Conference in a conference can enable. conference is not
continue to be on the Default: disabled supported for Unigy and
call after one of the lines Alliance MX
places the conference interoperability.
on hold. This feature is In a multi-zone
set per zone. enterprise, IPC
recommends to
configure all zones the
same. If zones are
configured differently,
then the unsupervised
conference feature only
functions properly when
all lines and users
participating in the
conference are from
zones with the same
setting: either all
participating users and
lines must be from
zones with unsupervised
conference enabled, or
all participating users
and lines must be from
zones with unsupervised
conference disabled.
Max Diversion Hops Maximum number of Range: 1 to 26
times a call can be Default: 6
diverted.
Max Diversion Hops Indicates where to divert Up to 26 alphanumeric Typically set to the voice
Destination a call when a line is characters. mail pilot number, so the
programmed to divert calling party can leave a
and Max Diversion Hops message.
is exceeded.
System OOPS The Operator Overflow List of OOPS Resource OOPS lines can be set
Protection Service AORs. at the extension and
(OOPS) ResourceAOR zone levels. When an
used when an Instance OOPS line is required,
receives a call for an the system checks the
unknown number or the OOPS line defined for
OOPS line for an the extension. If this line
extension is not is not available, the
available. system uses the zone-
level OOPS line.
RNA Guard Timer Time period after which Range: 0 to 99999.
the system tears down a Default: 600 seconds.
call that is not
answered.
Required.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 531

Table 58: Zone tab: Properties section (continued)

Name Description Values Notes

Momentary Privacy Period of time during Range: 0 - 10 seconds This prevents a situation
Time which the system 1 to 2 seconds is where two or more end
invokes privacy on a line practical users who answer the
to prevent unintentional Default: 0 (disables the same ringing line
release of a call. feature) appearance at
Required. This feature is not approximately the same
applicable to MRD lines. time assume that they
barged in to an active
conversation and all
release the call. The
momentary privacy
helps to ensure that one
user stays on the line.
After the time period
expires, other end users
can barge in.
Enable Registration Indicates whether the • Select the check box For this zone to serve as
Coordination zone serves as a to enable the zone to a registration
registration coordinator serve as a coordinator:
for CDI load-balancing. registration
This enables you to
• The Enable
coordinator. The zone Registration
specify a subset of accepts registration Coordination check
zones that can accept requests. box must be selected
registration requests
• Clear the check box for the enterprise at
from turrets and Pulse
to disable registration Configuration ➤
devices.
coordination for the Enterprise ➤
zone. If a turret or System ➤ Enterprise.
Pulse sends a • Customer must
registration request, configure DHCP
the zone rejects it. option 112 with a list
Default: disabled of registration
coordinator zones.
• This zone must be in
the registration
coordinator zones list.
• This check box must
be selected for the
zone.
When registration
coordination is enabled
and a turret or Pulse
needs to register with a
zone, the system selects
an appropriate zone and
notifies the device,
which sends a
registration request to
the zone.
This feature applies only
to Unigy v4.2 or higher
devices. It does not

IPC Confidential Unigy 4.3

Enterprise Guide
532 17.1: Deployment and upgrade procedures

Table 58: Zone tab: Properties section (continued)

Name Description Values Notes

apply to Unigy Soft
Clients, which are
assigned a home zone
based on a static VIP.

Trading
Figure 100: Zone tab: Trading section

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 533

Table 59: Zone tab: Trading section

Name Description Values Notes

Trading Days Days during which Select the check box for The turrets and Pulse
trading occurs, or days each appropriate day. devices
during which business is Default: Monday through wake up from screen
conducted. Friday saver mode if a high
priority or intercom call
is received during
business hours on
trading days. After hours
or on non-trading days,
the devices do not wake
from screen saver mode
unless an end user
presses a button or
performs some other
action.
The system also uses
the trading days and
hours to determine
whether to run an
intrusive diagnostic test.
If you run an intrusive
test during business
hours, the system
displays a warning
message and provides
the option to run the test
despite its intrusive
impact. If an intrusive
test is scheduled to run
during business hours
on trading days, the test
will not run.
Start Time of Trading Time at which business Time in 24 hour time. This is the time of day
Day hours begin. Default: 9.0 (9:00 am) that turrets and Pulse
devices begin waking up
from screen saver mode
on incoming calls. It also
indicates the time at
which the system begins
to display a warning
message for attempts to
run intrusive diagnostic
tests.

IPC Confidential Unigy 4.3

Enterprise Guide
534 17.1: Deployment and upgrade procedures

Table 59: Zone tab: Trading section (continued)

Name Description Values Notes

End Time of Trading Time at which business Time in 24 hour time. This is the time of day
Day hours end. Default: 17.0 (5:00 pm) that turrets and Pulse
devices cease waking
up automatically on
incoming calls. It is also
the time at which the
system stops displaying
the warning message for
intrusive diagnostic
tests. Scheduled
intrusive tests can run
between this time and
the time specified in
Start Time for Trading
Day on the following day.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 535

Table 59: Zone tab: Trading section (continued)

Name Description Values Notes

Session Timer Expires Default call session Time in seconds from 90 If you change the value
(seconds) timer value for periodic to 604,800 (7 days). for this field, the change
keep-alive heartbeats. Default: 1800 seconds will not take effect until
Required. (30 minutes) the appliances in the
zone are rebooted.
Session Timer MinSE Minimum SIP Time in seconds from 90 If you change the value
(seconds) subscription session to 604,800 (7 days). for this field, the change
timer. Default: 180 seconds (3 will not take effect until
Required. minutes) the appliances in the
zone are rebooted.
Inter Zone Session Time during which a SIP Time in seconds from 90 A lower number results
Timer Expires (seconds) session remains open to 999999999. in a faster refresh, which
after a zone failure. Default: 600 enables quicker
Required. detection of a restarted
zone.
If you change the value
for this field, the change
will not take effect until
the appliances in the
zone are rebooted.
Publication Timer Default expiration time Time in seconds from 0 If you change the value
Expires (seconds) for SIP publication to 604,800 (7 days). for this field, the change
requests. Default: 600 seconds will not take effect until
Required. (10 minutes) the appliances in the
zone are rebooted.
Subscription Timer Default expiration time Time in seconds from 0
Expires (seconds) for SIP subscribe to 604,800 (7 days).
requests. Default: 3600 seconds
Required. (1 hour)
Registration Timer Default expiration time Time in seconds from 0
Expires (seconds) for SIP registration to 604,800 (7 days).
requests. Default: 600 seconds
Required. (10 minutes)

IPC Confidential Unigy 4.3

Enterprise Guide
536 17.1: Deployment and upgrade procedures

Table 59: Zone tab: Trading section (continued)

Name Description Values Notes

Device Registration Controls when the CCM Select the check box to When enabled, devices
Enabled or ACCM accepts enable. automatically attempt to
device registration Default: disabled register with the CCM or
requests. ACCM when they are up
and running.
When this field is
disabled, device
deployment registration
is rejected.
This field should be
enabled during system
deployment, or when
new devices are added,
then disabled to prevent
unauthorized device
registration.
If you disable CDI
Support, the system
disables this field to
prevent CDIs from
registering with the
zone.
CDI Support Indicates whether the • Selected: CDI Select the check box for
zone supports CDIs support is enabled. Unigy zones and co-
(turrets Pulse devices, located Blue Wave
or Unigy Soft Clients). • Cleared: CDI support zones.
is disabled. Clear the check box for
Default: enabled dedicated Blue Wave
zones.
This field is available for
Unigy v3.1 or higher.
Line Support Indicates whether the • Selected: Line Select the check box for
zone supports lines. support is enabled. Unigy zones and co-
located Blue Wave
• Cleared: Line support zones.
is disabled. Clear the check box for
Default: enabled dedicated Blue Wave
zones, which cannot be
associated with any
lines. Remove the zone
association from all
applicable lines before
disabling line support.
This field is available for
Unigy v3.1 or higher.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 537

Table 59: Zone tab: Trading section (continued)

Name Description Values Notes

Blue Wave Director Indicates whether the • Selected: Software is The system sets this
Support Blue Wave Director deployed. field when the Blue
software is deployed on Wave Director software
the zone's appliances. • Cleared: Software is is deployed on the
not deployed. appliances. It confirms
that the software is
deployed each time the
appliances are
rebooted.
Read-only.
This field is available for
Unigy v3.1 or higher.

IPC Confidential Unigy 4.3

Enterprise Guide
538 17.1: Deployment and upgrade procedures

Table 59: Zone tab: Trading section (continued)

Name Description Values Notes

Speaker Call CDR Specifies the time Integer. Range is 1 to 72 When the interval time is
Interval interval at which the hours. reached, the system
system creates a Call Default: 12 hours. creates a CDR that
Detail Record (CDR) for indicates the total time,
a speaker call that is rounded to seconds,
Note
open for an extended during which the end
period of time. The To avoid orphaned call user used the PTT or
record includes the time records for Call Match PTL button since the
during which the PTT or processing, set the end of the previous
PTL button was pressed value to 1 hour. interval.
during the interval. For example, if the
Required. interval is set to 3 hours,
the speaker call is open
for 16 hours, and the
user pressed and held
PTT for 60 seconds
from the time the line
was activated on the
speaker to the end of
the first interval, pressed
PTT for 240 seconds
from the end of the first
interval to the end of the
second interval, used
PTL for 180 seconds
between the end of the
second interval and the
end of the third interval,
did not use PTT or PTL
during the fourth
interval, and used PTT
for 20 seconds between
the end of the fourth
interval and the end of
the call, the system
creates the following
CDRs that indicate the
talk time for each
interval and the total talk
time for the call:
• CDR 1 for initiation of
the call
• CDR 2 for interval 1 =
60 seconds
• CDR 3 for interval 2 =
240 seconds
• CDR 4 for interval 3 =
180 seconds

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 539

Table 59: Zone tab: Trading section (continued)

Name Description Values Notes

• CDR 5 for interval 4 =

0 seconds
• CDR 6 for end of call
= total of 500
seconds

IPC Confidential Unigy 4.3

Enterprise Guide
540 17.1: Deployment and upgrade procedures

Table 59: Zone tab: Trading section (continued)

Name Description Values Notes

Enable Engine Overload This property • Enabled: Check box • If this property is
Monitoring determines whether the is selected. The enabled and the
voice applications system does not send WebLogic server
subsystem running on a OPTIONS messages Health is,
CCM or ACCM sends during an overload OVERLOAD,
SIP OPTIONS condition. WARNING,
messages to the Media CRITICAL, or
Managers (MMs) or • Disabled: Check box
is cleared. The FAILED, the system
Media Gateways (MGs)
system continues to does not send
when the Health status
send the OPTIONS OPTIONS messages
of the WebLogic
messages. to the MMs or MGs
AdminServer and
until the AdminServer
Engine (stateful HA Default: Enabled
and Engine server
only) servers is
Health is OK. The
OVERLOAD, WARNING,
MMs and MGs
CRITICAL, or
continue to function
FAILED. based on the last
successful OPTIONS
message.
• If you disable engine
overload monitoring,
the system continues
to send the OPTIONS
messages to the
{MMs every 10
seconds and to the
MGs every 60
seconds regardless
of the server state.
• If you do not enable
engine overload
monitoring, in an
overload condition,
the CCM or ACCM
might declare that
connectivity between
the MMs or MGs is
lost due to lack of
OPTIONS exchange.
As a result, calls
involving MMs or
MGs will fail.
• An overload condition
can be experienced
for various reasons
including when SIP
traffic reaches the
OCCAS SIP overload
protection threshold.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 541

Table 59: Zone tab: Trading section (continued)

Name Description Values Notes

Enable PMTUD Specify whether to use • Select the check box Disable to fragment
Path MTU Discovery to to enable. packets to avoid packets
determine the maximum being dropped.
transmission unit (MTU) • Clear the check box If you change this value,
size on the network path to disable. you must restart all
between two hosts to Default: enabled associated turrets and
avoid IP fragmentation. Pulse devices.
Ethernet MTU Maximum Transmission Integer in the range 576 Send packets smaller
Unit: the maximum size - 1500 bytes. than 1,500 bytes to
of each packet in any Default: 1500 accommodate
transmission. encryption overhead.
If you change this value,
you must restart all
associated turrets and
Pulse devices.
Send Billing Group Id to Indicates whether the • Select the check box Billing groups are
Recorder billing group ID to enable the system configured at System
associated with an end to send the billing Designer ➤ Billing
user whose CDI is group ID. Groups.
registered with the zone Billing groups are
is sent to the voice • Clear the check box assigned to end user
recorders in the call to disable this groups and end users in
detail records (CDRs). feature. the General section of
Default: disabled the Group Features or
Trader Features tab at
System Designer ➤ End
User Configuration.

IPC Confidential Unigy 4.3

Enterprise Guide
542 17.1: Deployment and upgrade procedures

Table 59: Zone tab: Trading section (continued)

Name Description Values Notes

Send Zone Id to Indicates whether Unigy • Select the check box When you select this
Recorder appends the zone ID to for zones that check box, if Call Match
the front room location communicate with a is not enabled for the
for CDIs registered with voice recording instance associated with
the zone in the data it system that Call the zone, the system
sends to the voice Match supports. displays the warning
recorders when an end message Call
user logs on. This data • Clear the check box Match feature
identifies call records for for zones that
communicate with a
must be enabled
Call Match. at the instance
voice recording
system that Call level. To enable Call
Match does not Match, select the Enable
support. Call Match check box at
Configuration ➤
Default: disabled Enterprise ➤ System ➤
Instances.
If Call Match is enabled
for the instance
associated with the
zone, the system
displays the message
Enabling this
option might
require
configuration of
the location ids
on the recorder.
Logged in users
must log off and
re-logon. If you
select the check box for
a zone associated with a
voice recording system
that Call Match does not
support, you will have to
change the location
value set in the
recording system to
location-
name@zoneID, where
location-name is the
name of the front room
location and zoneID is
the ID assigned to the
associated zone; for
example, London@1.
After you make this
change, all CDI end
users registered with the
zone will have to log off
then log on to implement
the change. To avoid the

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 543

Table 59: Zone tab: Trading section (continued)

Name Description Values Notes

need to configure the
voice recorders, do not
select this check box for
zones associated with
recorders that Call
Match does not support.
Prior to upgrading to
Unigy v4.2 or higher
from a pre-v4.2 version,
if @zoneID was
appended to the location
value on voice recorders
that Call Match does not
support and after the
upgrade the Send Zone
Id to Recorder check box
is not selected for the
zone the voice recorders
are connected to,
remove the @zoneID
value from the voice
recorder location
configuration as
described in the IPC
Media Recorder (IMR)
Voice Recording
Installation and
Configuration Manual.
Emergency Number The number that allows Typically 911 in North Prerequisites:
the caller to contact America and 112 in the a SIP trunk to the
local emergency EU. Emergency Gateway
services for assistance. Wikipedia maintains a exists and is properly
non-exhaustive list of configured for
numbers: https:// emergency calls to be
en.wikipedia.org/wiki/ routed to it.
List_of_emergency_tele Emergency Services is
phone_numbers enabled for the
enterprise.

Buttons

Table 60: Zone panel: buttons

Button Description
Delete Deletes the current zone.
Re-Establish Failed MRD Performs a force line clear on all failed or stuck MRD and hoot lines in the
Lines zone. This drops the connections, resets the CDI line status to idle, then
re-establishes the connections.
This action does not affect healthy lines.

IPC Confidential Unigy 4.3

Enterprise Guide
544 17.1: Deployment and upgrade procedures

Table 60: Zone panel: buttons (continued)

Button Description
Blue Wave Admin Opens the Blue Wave Administration console for managing the Blue Wave
Appliance. This button is enabled only when you access this panel on a
Blue Wave zone and the Blue Wave Appliance is running.
Change Countrybase Displays the Change Country Base panel from which you can change the
current country base. The system updates all country base references.
Enable Web links Enables or disables access to the following Web links:
Disable Web links
• Weblogic Admin Console
• SWMS Admin Console
• Enterprise Watch
This button is visible only to user accounts with the IPC Certified Tech
role.
When you click this button for a zone, the Web links are enabled or
disabled for all CCM, MM, or ACCM appliances in the zone.
The button label changes based on the current state. If the Web links are
disabled, the label is Enable Web links. If the Web links are enabled, the
label is Disable Web links. The state is also displayed in the Web Link
Access check box in the Server Cluster section of this panel.
The Web links are disabled by default. After you enable them, they remain
enabled until one of the following events occurs:
• Any IPC Certified Tech user disables the Web links for the zone.
• The person who enabled the Web links logs out of the UMS.
• The browser session of the user who enabled the Web links expires.
• Someone restarts (reboots) one of the appliances in the zone. This
disables the Web links only for the appliance that is restarted.
For additional Web links information, refer to the Enterprise Guide.
Revert Discards your changes.
Save Saves your changes.
Add New Create a new zone.

17.1.10 HA
17.1.10.1 Configure High Availability
In a Unigy enterprise, High Availability (HA), which provides appliance fault-tolerance, is achieved
through clustering. This topic describes the procedure for configuring HA.

Note
When a zone is deployed, Zone Deployer configures and enables HA; therefore, perform this procedure
only if HA is not enabled.

An HA cluster consists of a primary and secondary CCM or ACCM appliance sharing a virtual IP
address (VIP). The primary appliance is the appliance with the lower IP address. To determine the
primary appliance, run the IP_default report at Tools ➤ Reporting ➤ Reporting Configuration ➤
Device Report ➤ IP. The primary appliance hosts the WebLogic AdminServer server.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 545

For information on enabling HA, refer to Enable HA on page 545.

1. Log in to the UMS on the primary appliance of the HA pair: https://appliance_ip.
2. Click Configuration ➤ Sites ➤ Servers ➤ Clusters.
3. In the Clusters list, click the zone cluster.
4. Within the Properties tab, verify that the Virtual IP Address and all other properties are correct. If
you make any changes, click Save.
For details on the panel fields and buttons, refer to the UMS online help or the UMS UI Guide.
5. Within the Members tab, if the primary and secondary appliances for the zone are not in the list, do
the following:
a) Click +Assign.
b) Select the check box for the appliance(s).
c) Click < Assign.

17.1.10.2 Enable HA
This topic describes how to enable an HA cluster after the cluster is configured.

Note
When a zone is deployed, Zone Deployer configures and enables HA; therefore, perform this procedure
only if HA is not enabled.

Perform this procedure from the UMS on the primary appliance in the HA pair. The primary appliance is
the appliance with the lower IP address. To determine the primary appliance, run the IP_default report at
Tools ➤ Reporting ➤ Reporting Configuration ➤ Device Report ➤ IP. The primary appliance hosts
the WebLogic AdminServer server.
For information on configuring HA, refer to Configure High Availability on page 544.
1. Enable the cluster.
a) Log in to the UMS with the primary appliance IP address: https://appliance_ip.
b) Click Configuration ➤ Sites ➤ Servers ➤ Clusters.
c) In the Clusters list, click the zone cluster.
d) Within the Members tab, click EnableHA.
e) In the confirmation box, click OK.
This process takes approximately five minutes to complete.
f) Click OK in the message box that indicates successful completion and instructs you to reboot the
appliances.
2. Reboot the appliances, one at a time, beginning with the primary appliance. Use the following reboot
sequence:
a) Reboot the primary appliance by performing the procedure Reboot CCM on page 587.
b) Monitor the state of the appliance while it reboots by performing the procedure Check the state of
a zone from a browser on page 499.
c) When the primary appliance is completely up, reboot the secondary appliance.
d) Monitor the state of the appliance while it reboots by performing the procedure Check the state of
a zone from a browser on page 499.

IPC Confidential Unigy 4.3

Enterprise Guide
546 17.1: Deployment and upgrade procedures

17.1.10.3 Confirm that HA is enabled

When you deploy an HA zone, Zone Deployer configures and enables HA. If you encounter an HA-
related problem, confirm that HA is enabled.
1. Log in to the UMS with the zone VIP: https://vip, or if the VIP is not available, with the Active
appliance IP address: https://appliance_ip.
2. Click Configuration ➤ Sites ➤ Servers ➤ Clusters..
3. In the Clusters list, click the zone cluster.
4. Within the Members tab, confirm that the Enable HA button is disabled. If it is not, configure and
enable HA by performing the procedures Configure High Availability on page 544 and Enable HA on
page 545.

17.1.10.4 Force an HA failover

This procedure describes how to force an HA failover to make the Standby appliance in an HA pair the
Active appliance. Use this procedure when you want to transfer active ownership of the Virtual IP
address (VIP) in a controlled manner.
Prerequisites:
Before you force a failover, determine which appliance in the HA cluster is the Active appliance (the
owner of the VIP) and whether the Standby appliance is healthy. To display this information, perform
the procedure: Check the state of a zone from a browser on page 499.
Forcing an HA failover can be used for the following purposes:
• During deployment of updates when you are deploying one appliance at a time.
• When deploying a Blue Wave HA zone.
• When the system detects a pending failure of the Active appliance.
• Clearing logs.
During the HA failover, active UMS sessions might not be preserved.

Note
Unless it is necessary to perform this procedure during business hours, IPC recommends that you
perform the procedure after business hours. Rearming an appliance can affect users and active calls.

1. If you have not already done so, do the following:

a) Log in to the UMS with the zone VIP: https://vip.
b) Click Configuration ➤ Sites ➤ Servers ➤ Clusters.
c) In the Clusters list, click the zone cluster.
2. Within the Members tab, click FailOver.
The HA Warning message box is displayed.
3. Click OK.
During the failover, the following occurs:
• The Active appliance fails over, making the Standby appliance the Active appliance.
• The system reboots the appliance that was active and changes its Role to STANDBY. This takes
approximately 5 minutes.
4. Perform the procedure Check the state of a zone from a browser on page 499 to determine when the
appliances are up and fully operational.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 547

17.1.10.5 Rearm the Standby appliance

If the Role for a Standby appliance in an HA cluster is UNKNOWN and the State is FAILED, rearm the
appliance to reset it to the correct role and state.
To attempt to resolve the issue, run the rearm server script from the cluster Members tab. The rearm
server script is also run automatically when the Standby appliance is restarted manually or during a
deployment or upgrade.
If there is a network interruption during the rearm process, the zone will not be accessible. To correct
this issue, reboot both appliances in the zone.

Note
Unless it is necessary to rearm the appliance during business hours, perform this procedure after
business hours. Rearming an appliance can affect users and active calls.

1. If you have not already done so:

a) Log in to the UMS.
b) Click Configuration ➤ Sites ➤ Servers ➤ Clusters.
c) In the Clusters list, click the zone cluster.
2. Within the Members tab, click the Standby appliance then click Rearm Server.
The appliance reboots and the Remarks property in the Cluster Operation Output Details on page
502 for the Standby appliance displays the message MySQL Rearm server action is in
progress followed by the elapsed time until the rearm completes.
After the rearm, the Standby appliance Role should be STANDBY and the State should be one of the
following values:
• AVAILABLE: if the cluster is not in maintenance mode.
• MAINTENANCE_UNAVAILABLE: if the cluster is in maintenance mode and the maintenance
operation for the appliance is in progress.
• MAINTENANCE_AVAILABLE : if the cluster is in maintenance mode and the Service Done
button was clicked for the appliance.
You can refresh the page by clicking the Properties tab then clicking the Members tab.
If the role and state values are still not correct and you cannot determine the reason, restart both
appliances.

17.1.11 Upload or download an ISO file

This topic describes how to upload or download an ISO file to deploy or upgrade CCM or ACCM
appliances.
You can upload an ISO file from a DVD or external data storage device, or if bandwidth is an issue, you
can download the file from a corporate server or a Unigy appliance.
In an HA zone, when you access Impacted RPMs, the system copies the ISO file to the peer appliance
in the zone. In a multizone enterprise, after you upload the file to an appliance in one zone, the system
automatically downloads the file to the appliances in other zones when you access Impacted RPMs for
each zone.
An upload or download takes ten to fifteen minutes to complete on a local network, but can take several
hours over a VPN or other slow connection. The download generally takes less time than the upload.

IPC Confidential Unigy 4.3

Enterprise Guide
548 17.1: Deployment and upgrade procedures

ISO files are stored on a CCM or ACCM in the /opt/ipc/deployment/iso/ directory. Do not
add files to this directory or remove files from the directory from the command line. Use the UMS for
these tasks.

Note
Do not log out of the UMS while the upload is in progress because the upload will terminate. However,
you can lock your PC desktop without affecting the upload.

1. Click Tools ➤ Deployment ➤ Software Deployment.

2. Within the Install tab, click Upload Software Image.
3. Upload the file from the update DVD or another data storage device or download the file from a
corporate server or a Unigy appliance:
• To upload the file:
1. In Local File, click Choose File.
2. Locate and select the file then click Open.
• To download the file from a corporate server or a Unigy appliance:
1. Identify the location of the file.
2. In IPC URL, enter the URL for the file. The URL must contain the server or appliance IP
address, not the hostname.
4. Click Upload to upload the file or click Download from URL to download the file.
A progress bar is displayed.
If the upload or download fails due to low band width or slow transfer rates caused by other factors,
refer to one of the following procedures:
• If you are upgrading from Unigy v2.0, you can use the Upload or Transfer features in Personality
Deployer. For information on these features, refer to Deploy the appliance personality software
with Personality Deployer on page 465. Use Personality Deployer only to upload or transfer the
ISO file, do not rerun Personality Deployer to deploy the software. To access Personality Deployer
use the URL https://ip_address/deployment/PersonalityDeployment.html,
where ip_address is the IP address of the appliance onto which you are uploading the file. Due
to additional hardening changes, you cannot rerun Personality Deployer on a v2.0.1 or higher
appliance.
• If you are upgrading from Unigy v2.0.1 or higher or if uploading the file from Personality
Deployer failed, perform the procedure Download an ISO file when an upload or download fails
on page 548.
When the upload or download is complete, the system validates the ISO, displays the message File
Uploaded Successfully. ISO is good ... verification passed or File
Downloaded Successfully. ISO is good ... verification passed, and
displays the file in the Available Software Releases section. The value in the Status column should
be not_installed.

17.1.12 Download an ISO file when an upload or download fails

Use this procedure if an ISO file upload, download, or transfer fails due to low band width or slow
transfer rates caused by other factors.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 549

Unigy ISO files are over 2 GBs in size, which can present a problem when low band width or other
causes prevent an ISO upload, download, or transfer from completing successfully on a Unigy appliance
during an initial deployment, upgrade, or hardware replacement procedure. Use this workaround only if
the standard procedures fail.
Prerequisite:
Ensure that the ISO file is available on a server, laptop, or other external data storage device that you can
access from the Unigy appliance to which you are downloading the file.
During the upgrade of an HA zone, perform this procedure on the Active appliance.
1. Log in through SSH to the appliance on which you are downloading the ISO file.
2. Run the command su -lp then enter the root user account password.
3. Change the current directory by running the command cd /opt/ipc/deployment/iso and list
the directory contents (ls).
4. If the ISO file you are trying to upload is in the directory, delete the file.
5. Change the current directory to /tmp.
6. Copy the ISO file from the laptop, server, or other data storage device to the /tmp directory on the
appliance:
• If you are copying the file from your laptop, use a Secure Copy (SCP) tool such as scp, WinSCP,
or SFTP, to copy the file to the appliance.
• If you are copying the file from a server, run the command wget http://server_IP/
path/iso_file
• server_IP is the IP address of the server from which you are downloading the ISO file.
• path is the directory path to the ISO file.
• iso_file is the name of the ISO file you are downloading, including the .iso extension.
If wget is not available, use another tool that provides the ability to transfer the file to the
appliance.
7. Copy the ISO file from /tmp to the /var/www/html/ directory by running the command cp
iso_file /var/www/html/iso_file, where iso_file is the name of the ISO file you are
copying.
Do not change the file name.
8. Download the ISO file by entering the URL to the file in the appropriate field, described below, in the
format http://appliance_IP/iso_file
where:
• appliance_IP is the IP address of the current appliance. You must specify the IP address, not
the appliance host name.
• iso_file is the name of the ISO file you are downloading, including the .iso extension.
For example, http://10.20.30.40/dunkin_02.00.01.05.0077.iso.
• If you are downloading the ISO file from Personality Deployer, enter the URL in Transfer an ISO
then click Transfer. You should see the message ISO file transferred successfully
and the file should be visible in the Select ISO to perform Operation list.
• If you are downloading the ISO file for an upgrade from the UMS within the Install tab at
Tools ➤ Deployment ➤ Software Deployment, click Upload Software Image, in IPC URL,
enter the URL then click Download from URL. You should see the message ISO Download

IPC Confidential Unigy 4.3

Enterprise Guide
550 17.1: Deployment and upgrade procedures

Result ISO downloaded successfully and the file should be visible in the Available
Software Releases list.
9. After the download completes, delete the ISO file from the /tmp and /var/www/html directories
to free up this space:
a) Confirm that /tmp is the current directory by running the command pwd.
b) Run the command rm iso_file, where iso_file is the name of the ISO you downloaded,
for example, rm dunkin_02.00.01.05.0077.iso.
c) Change the current directory to /var/www/html.
d) Run the command rm iso_file.

17.1.13 Deploy an ISO file

This topic describes how to deploy an ISO file for a Unigy or Blue Wave upgrade or a Blue Wave initial
deployment after the file has been uploaded to an appliance.
For Unigy upgrades, deployed indicates that the software is deployed on the CCM or ACCM, and if
applicable, is staged for upgrading the remaining system devices.
1. If you are deploying a Blue Wave ISO file, create an image backup for each Blue Wave appliance you
are deploying by performing the procedure Create an image backup (restore point) from the UMS on
page 385.
If you are deploying a Unigy ISO, skip this step.
2. Click Tools ➤ Deployment ➤ Software Deployment.
3. Within the Install tab, click the ISO file you are deploying and ensure that the Status of the file is
not_installed and the Version is greater than the last installed ISO in the zone.
Refer to Unigy software version naming convention on page 29 for details on Unigy build naming
conventions.
4. Click Install Zone.
The Install panel is displayed.
5. Select the following check boxes as applicable:
• Create a server backup image: This option creates an image backup (restore point, rollback
point) prior to deploying the update. This option is selected by default.

Note
In a production environment, you should always create the backup image so you have a restore
point to roll back to if there is a problem with the deployment. However, if you are deploying a
Blue Wave ISO, clear this check box because you already created the image backup in step
1. Selecting this check box for a Blue Wave ISO will result in a failed deployment.

• Remove the archive logs prior to backup: This option deletes archived log files before running
the deployment to reduce the time required to create the image backup file. To preserve the
archived data without impacting the backup time, download the archive files to an external data
storage device before starting the deployment.
• Automatic Deployment: This option instructs the system to deploy the update on all selected
zones, except the peer zone, without the need for manual interaction, including pre-deployment
zone validation, placing the zone into maintenance mode, placing the cluster and Standby
appliance into maintenance mode, disabling data replication, deploying the update, taking the
Standby appliance out of maintenance mode, indicating that maintenance is complete, taking the
cluster out of maintenance mode, taking the zone out of maintenance mode, enabling replication,

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 551

and post deployment validation. Select this option when you deploy the peer zone while deploying
multiple Unigy v2.0.1 or higher zones with Enterprise Install.

Note
This option does not apply to Unigy v2.0 or Blue Wave zones.

• Install the update simultaneously on both servers in the zone: To reduce the time required to
upgrade Unigy and Blue Wave HA zones, this option instructs the system to automatically deploy
the software on both appliances in the zone simultaneously.
In a multizone enterprise, this option also supports parallel upgrade for Unigy zones. With parallel
upgrade, you deploy one zone to establish a stable zone and database then manually deploy all
other zones that need to be upgraded. It is not necessary to wait for the deployment of one zone to
complete (except the first zone) before you upgrade the next zone. Parallel upgrade is not
supported for Blue Wave zones, but deploying both appliances in the zone is.
The Install the update simultaneously on both servers in the zone check box is selected by
default. Use the option for Unigy parallel and Enterprise Install deployments and for upgrading
both appliances in a Blue Wave zone simultaneously. Clear the check box if you are upgrading one
appliance at a time.
• Install OS Patch(patch version): This option instructs the deployment process to install the latest
OS patch during the application software upgrade. To install the patch, you must have already
uploaded the OS patch ISO file.
6. Click Continue then click Install.
The system starts the upgrade job and displays the message Install ISO Job Created
Successfully.
7. Click OK.
The system reboots the appliance(s) then deploys the software. If you selected the Create Server
Backup Image check box, the system creates the image backup after it reboots the appliance(s). This
process takes approximately one hour.
8. After approximately 30 minutes, you can monitor the deployment by running the command tail -
f /opt/ipc/deployment/log/dunkin_deployment.log for patches and service packs
or tail -f /opt/ipc/deployment/log/hotfix_deployment.log for hotfixes.
Output similar to the following is displayed at the end of the file to indicate that the deployment is
complete and the final appliance reboot is in progress:
Unigy upgrades
[Mon Feb 25 03:36:36 EST 2013] : === DONE ===== switch on
orchestrator chkconfig
[Mon Feb 25 03:36:36 EST 2013] : START : update_about_xml
[Mon Feb 25 03:36:36 EST 2013] : END : update_about_xml
[Mon Feb 25 03:36:36 EST 2013] : Sending Deployment status update to
CCM
curl -X POST -uipccdi:2fc608f4887cf73a54d0729a4b92777b671b1df2 -H
"Content-Type:application/xml" --data @/tmp/job_status_req.xml
http://10.20.30.40/svc/deployment/deploymentmgr/updatejob/
33554604:33554605 adding index.html to apache for DMS Client switch
on orchestrator chkconfig

IPC Confidential Unigy 4.3

Enterprise Guide
552 17.1: Deployment and upgrade procedures

[Mon Feb 25 03:36:36 EST 2013] : Deployment Process exiting with

exit status 0
[Mon Feb 25 03:36:36 EST 2013] : !!! SYSTEM IS GOING TO REBOOT AFTER
INSTALL .... PLEASE WAIT... !!!!
Blue Wave upgrades
[root@ccm2 ~]# tail -f /opt/ipc/deployment/log/dunkin_deployment.log
[Thu Nov 29 15:58:50 EST 2018] : Unmounting ISO
[Thu Nov 29 15:58:50 EST 2018] : ISO unmounted successfully
[Thu Nov 29 15:58:50 EST 2018] : Deployment patch impact exiting
with exit statu s 0
[Thu Nov 29 15:58:50 EST 2018] : Deployment Test Process exiting
with exit statu s 0
[Thu Nov 29 16:00:47 EST 2018] : Calculating available disk space
for backup
[Thu Nov 29 16:00:47 EST 2018] : Calculating required disk space for
backup
[Thu Nov 29 16:01:18 EST 2018] : Available disk space is sufficient
for backup
[Thu Nov 29 16:01:48 EST 2018] : Estimated time to take system
backup - 22 Minut e(s)
modifying the clientaddr line with new IP to /etc/snmp/snmp.conf
modifying the clientaddr line with new IP to /etc/snmp/snmp.conf
For Unigy upgrades, the state of the update software is as follows:
• For appliances with the CCM personality, the update software is deployed on the appliance,
upgrading it to the new version. The update is staged for the remaining system devices: Media
Managers, Media Gateways, turrets, Pulse devices, and Soft Clients.
• For appliances with the ACCM personality, the update software is deployed on the appliance. All of
its components, including the Media Manager software, are upgraded to the new version. The update
is staged for the remaining system devices: Media Gateways, turrets, Pulse devices, and Soft Clients.

17.1.14 Confirm that an update was deployed

This topic describes how to confirm that a Unigy or Blue Wave application software update or an OS
patch was deployed during the upgrade process.
1. Log in to the UMS. If you upgraded an appliance in a standalone zone use the URL https://
appliance_ip. If you upgraded an appliance in an HA zone, use the URL https://vip.
2. Click Tools ➤ Deployment ➤ Software Deployment.
3. For an application software upgrade, click the Install tab. For an OS patch upgrade, click the OS
Patch tab.
4. Do one of the following based on the type of deployment that was performed:
• For an application software upgrade, in Available Software Releases, confirm that the status and
button state are correct:

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 553

• For a standalone zone, confirm that the Status of the ISO you deployed is installed and
when you click the ISO file, the Install Zone and Enterprise Install buttons are disabled.
• For a single HA zone, confirm that the Status of the ISO you deployed is installed and
when you click the ISO file, the Install Zone button is disabled. This change is not visible until
both appliances have been upgraded.
• For multiple Unigy zones deployed with Enterprise Install, confirm that the Status of the ISO
you deployed is installed for all zones you upgraded and when you click the ISO file, the
Install Zone button is disabled and the Enterprise Install button is enabled.
• For an OS patch upgrade, in Available OS Patch Releases, confirm that the status and button state
are correct:
• For a standalone zone, confirm that the Status of the ISO you deployed is installed and
when you click the ISO file, the OS Install Zone and OS Enterprise Install buttons are
disabled.
• For a single HA zone, confirm that the Status of the ISO you deployed is installed and
when you click the ISO file, the OS Install Zone button is disabled. This change is not visible
until all CCM and MM appliances or both ACCM appliances have been upgraded.
• For multiple Unigy zones deployed with OS Enterprise Install, confirm that the Status of the
ISO you deployed is installed for all zones you upgraded and when you click the ISO file
the OS Install Zone button is disabled and the OS Enterprise Install button is enabled.
Also, if a previous OS patch version was installed prior to the upgrade, that version should no
longer be displayed in the Available OS Patch Releases panel.
• For a Blue Wave zone, confirm that the Status of the ISO you deployed is installed and when
you click the ISO file, the Install Zone and Enterprise Install buttons are disabled. This change is
not visible until both appliances have been upgraded.
5. For Unigy application software upgrades, compare the build number for each device category within
the Deploy tab to the value in the Version column for each device type in Package Explorer, which
is accessed by clicking the view detail icon ( ) within the Install tab. The values should be the
same.
6. If applicable, confirm that the image backup file for each appliance was created by clicking the
Rollback tab.
You should see a backup with a Name that refers to the backup event; for example:
• Backup of ISO Installed With Unigy Version 04.00.01.00.0342
• Backup before OS patch ipc_os_patch_06.00.00.02.0002.iso
You should also see a Rollback Point with a date and time stamp in the format yyyy-mm-dd-hh-mm-
ss, for example, 2018-08-25-03-36-36.
7. Check the status of the history job associated with the deployment:
a) For a patch or service pack, click the History tab. For a hotfix, click the Hotfix History button.
b) Confirm that the value for the job in the Result column is success.
For an OS patch, if a previous OS patch version is installed and all appliances in the zone have not
been upgraded, the Result will be partial until all appliances are upgraded.
c) Click the job then in the Deployment Status Details panel, confirm that the value in the Result
column for the associated job(s) is Success.
d) Click each job.

IPC Confidential Unigy 4.3

Enterprise Guide
554 17.1: Deployment and upgrade procedures

In the Output Field panel, you should see information similar to the following, which is from the
upgrade of a single HA zone:
Application update output
Job Execution Event created successfully for Job Id3355445
Preconditions Executed for Job ID 3355445
Device Mode changed to maintenance
Zone.BCPStatus updated to maintenance
Zone.MaintenanceModeEnabled updated to true
Zone.MaintenanceModeProgress set to Started
Moving HA to maintenance mode and disabling replication

Platform Script Update : Deployment completed successfully on local

system
Post Install Status Update :
Updated BcpStatus->Active, MaintenanceModeEnabled->false,
MaintenanceModeProgress->started
Updated DeviceMode to Available
Replication Enabled

For an Enterprise Install, the message Platform Script Update : Deployment

completed successfully is displayed.
OS patch output
JobId:JobExecutionEventId = 1140850697:1140850697
isoName : ipc_os_patch_06.00.00.02.0011.iso
serverIds : 1140850690
backup : yes
purge Logs : no
isAutomatic : no
isEnterpriseInstall : false
Rebooting into maintenance boot for backup for around 24 Minute(s) ...
You will be losing connection for around 24 Minute(s), server is
rebooting into maintenance boot for backup ... SYSTEM WILL REBOOT
AGAIN AFTER DEPLOY ... View log for status and progress.
Scheduling reboot in 20 and certian death in 80 for from /opt/ipc/cop/
tools/osPatchManager.sh
crond (pid 3330) is running...
Stopping crond: [ OK ]
/tmp /home/diag
/home/diag

Execution Event completed successfully

Blue Wave output (does not include image backup)

Job Execution Event created successfully for Job Id1149239573
Checking for valid Blue Wave Event Executor....
Blue Wave ISO Install Validation Successful.

Checking for valid Event Executor....

Patch Install Validation Successful.

ipAddress = 10.204.192.9
JobId:JobExecutionEventId = 1149239573:1149239406
isoName : bluewave_03.01.00.00.0077.iso
backup ? no

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 555

cleanup logs ? no
parallel installation For HA ? yes
Automatic Deployment ? no
isEnterpriseInstall ? no
osPatchVersion ?
SoftwareISOType ? BLUEWAVE
iso Installation started... Installing/Upgrading RPMs in ISO
bluewave_03.01.00.00.0077.iso
verifying if occas is up and running properly....
Wait .occasd status:
replica2 (pid 8245) is running ...
engine2 (pid 11902) is running ...
ems2 (pid 25210) is running ...
[ OK ]
verifying if occas is up and running properly....
Wait .ISO installed successfully
Job's Details UpdatedScheduling reboot in 20 and certian death in 80
for from /opt/ipc/cop/tools/install_bw_iso.sh
crond is stopped
/tmp /tmp
/tmp

8. Check the deployment logs for any errors and for entries that indicate the upgrade was successful:
• For a Unigy application or Blue Wave deployment:
1. Click the Deployment Logs tab.
2. In the Server Name field, select the applicable appliance.
3. In the Number of Lines to Display field, type 20,000 then click Refresh.
4. Scroll through the log to determine whether there are any unresolved errors.
You can search the log file by copying and pasting the text into a text editor. You will see error
messages; however, they should either be identified in the file as being acceptable or they
should be resolved in a later command entry. If you find errors that do not fit into these
categories, analyze and resolve the issues.
Within the file, you should see the following information that indicates the deployment was
successful:
Unigy deployment
[Mon Feb 25 17:18:56 EST 2013] : Deployment Process exiting with
exit status 0
[Mon Feb 25 17:18:56 EST 2013] : !!! SYSTEM IS GOING TO REBOOT AFTER
INSTALL .... PLEASE WAIT
... !!!!

Blue Wave deployment – primary appliance

11:38:38 bw-utils.sh: Stat Deployed apps can be performed by this
CCM, currently the Cluster AdminServer 10.20.102.108
11:40:00 bw-utils.sh: APPLICATION bluewave DEPLOYED. WLST DEPLOYER
EXIT CODE is 0
modifying the clientaddr line with new IP to /etc/snmp/snmp.conf

IPC Confidential Unigy 4.3

Enterprise Guide
556 17.1: Deployment and upgrade procedures

Blue Wave deployment – secondary appliance

[Fri Nov 30 13:23:00 EST 2018] : /opt/ipc/cop/tools/rebootServer.sh:
calling plcm_monitor.sh to reboot with args:
modifying the clientaddr line with new IP to /etc/snmp/snmp.conf

• For an OS patch upgrade:

1. Access the command line on the appliance you upgraded.
2. Run the command su -lp and enter the appropriate dynamic password from Password
Manager.
3. Review the following logs.
• /opt/ipc/deployment/log/os_patch_deployment.log
• /opt/ipc/cop/patch/log/install.log
For upgrades run from the UMS, if the message /opt/ipc/sbin/os_patch.sh
install result 0 shown below is displayed near the end of the
os_patch_deployment.log file, it is not necessary to review the install.log file,
because this indicates that the upgrade was successful. However, if you find errors in
os_patch_deployment.log or ran the upgrade from the command line, review the more
detailed information in install.log.
[Thu Jun 1 16:06:22 EDT 2017] : Proceed to install
ipc_os_patch_06.00.00.02.0002.iso
[Thu Jun 1 16:08:08 EDT 2017] : /opt/ipc/sbin/os_patch.sh install
result 0
[Thu Jun 1 16:08:08 EDT 2017] : all good reboot now

9. For a Blue Wave update, access the Web Application Description Language (WADL) link for the
Blue Wave Appliance:
a) If your browser is Microsoft Internet Explorer 8.0, enable the Compatibility Mode before viewing
the WADL page to ensure proper formatting of the website.
b) Within the browser, access http://ip_or_vip/svc/bw/api/wadl, where ip_or_vip is
the IP address of the appliance in a standalone zone or VIP of the HA zone in which you deployed
the Blue Wave Director update.
c) Confirm that the WADL page displays Summary, Grammars, and Resources sections for the Blue
Wave APIs. These sections include resource URIs, supported methods, and a brief description of
each API.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 557

Figure 101: Blue Wave WADL output Summary section

Figure 102: Blue Wave WADL output Grammars and Resources sections

IPC Confidential Unigy 4.3

Enterprise Guide
558 17.1: Deployment and upgrade procedures

17.1.15 Upgrade the software on system devices

After you deploy the Unigy software on a new CCM or ACCM or deploy a software update, deploy the
software on applicable system devices, including Media Managers, Media Gateways, turrets, Pulse
devices, and Unigy Soft Clients.
Prerequisites
Before you perform this procedure, if you are deploying software on a Media Gateway, back up the
Media Gateway INI file (as a precaution). Refer to Download a Media Gateway INI file on page 585.
If the turrets and Pulse devices you are upgrading used DHCP option 66 or static IP addressing in the
previous version to assign home zones, but in the new version the enterprise will use DHCP option 112
to assign the home zones through load balancing, the enterprise, registration coordinator zones, and
subnet addresses must be configured to support this feature. For information on these procedures, refer
to the Network Requirements Guide.
Updates can provide changes for some or all device types. Compare the Current Version to the
Assigned Version for each device to determine whether an upgrade is required. You cannot select
devices for upgrade when the Current Version and the Assigned Version are the same. This indicates
that the software on the devices is already upgraded.
If the software is being deployed on Media Managers or Media Gateways, place these devices into
maintenance mode before deploying the software. If the background color of a device entry is yellow,
the device is not in maintenance mode. CCM and ACCM appliances will have a yellow background, but
do not have to be placed into maintenance mode because their software is already upgraded.
1. Log in to the UMS.
2. If you are upgrading Media Gateways or Media Managers, place them into maintenance mode by
performing the procedure Place an appliance or Media Gateway into maintenance mode to indicate it
is unavailable on page 599.
This step is not required for ACCMs.
3. Click Tools ➤ Deployment ➤ Software Deployment.
4. Click the Deploy tab.
The Software Deployment Wizard is displayed.
5. Within the 1 Software tab, select the devices on which you are deploying the software update:
a) Expand one of the following device type sections.
• Media Gateways
• IQ/MAX & Edge
• Soft Clients
• Servers (select only Media Managers)
• Pulse
• IQ/MAX TOUCH
b) Click +Assign.
c) Select the check box for each device you are upgrading.
Select the check box in the column heading for the first column to select all devices of the device
type you selected.
d) Click < Assign.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 559

e) Repeat steps a - d for each applicable device type.

f) Do the following if applicable:
• For Media Gateways, in the Override Config column, indicate whether the system should
overwrite the Media Gateway configuration, firmware, CAS files, and tone files.
• For Media Managers, if new OS patch software is available to be installed, select the check box
in the Install OS Patch column for each MM you want to upgrade.
6. Click 2 Deploy.
Review the selected devices. If devices are selected that should not be, return to the applicable device
type within 1 Software and remove the devices from the Selected for update table by clicking the
device then clicking Remove.
7. Click the Deploy button.
The Deployment Status panel displays the deployment progress. The time required to complete the
deployment is based on the number of devices. Click Refresh to refresh the information displayed.
After the deployment completes successfully, the Status icon turn green and the following occurs:
• The CCM or ACCM informs the Media Managers selected for upgrade that new software is
available and automatically upgrades them.
• The CCM or ACCM informs the Media Gateways selected for upgrade that new software is
available. The Media Gateways retrieve and install the software. After the software is installed, the
Media Gateways reboot. Rebooting takes approximately four minutes.
• The CCM or ACCM informs the turrets and Pulse devices selected for upgrade to retrieve and
install the new software. If a device is available and not actively processing calls, the system
automatically deploys the software and reboots the device. Devices that were not selected for
upgrade, that were active during the upgrade, or that were not available at the time of the upgrade,
retrieve the new software and deploy it when an end user logs in to the device or when the device
reboots. To ensure that all devices are upgraded, consider rebooting all of the devices at a time
when they are not in use. You can reboot multiple devices by performing the procedure Reboot
communication devices on page 591.
• Soft Client updates are staged on the CCM or ACCM. When end users log in to the Soft Client, the
Unigy Application icon in the Microsoft Windows System Tray displays a different icon that
indicates an update is available. When an end user right-clicks the icon to open the Unigy
Application menu, the system displays the Upgrade option. To install the new software, the user
clicks Upgrade, which uninstalls the current software and installs the new version.

Note
After you deploy the software on system devices, it can take up to 30 minutes for all of the devices to
reboot and re-register with the zone. The system does not update the current version value within the
1 Software tab until the devices are completely operational.
To refresh the tab, click Tools ➤ Deployment ➤ Software Deployment then click the Deploy tab. Do not
refresh the panel until the software deployment displayed within the Status panel is complete.

8. For Media Gateways, perform the procedure to Upload default portion of Media Gateway INI file on
page 583 or, if your MG contains default settings not configurable through the UMS and these
settings need to be retained, perform the procedure to Upload incremental changes to default portion
of MG INI file on page 585 then continue.
9. For Media Gateway upgrades from Unigy v2.0.1.x to Unigy v3.0 or higher, update the Media
Gateway user account password.
This is required because Unigy v3.0 and higher versions use a different password encryption
algorithm than previous releases.

IPC Confidential Unigy 4.3

Enterprise Guide
560 17.1: Deployment and upgrade procedures

a) Click Configuration ➤ Sites ➤ Trunks ➤ Media Gateways.

b) In the Media Gateways list, click the Media Gateway you are upgrading.
c) Within the Properties tab, enter a password for the Media Gateway user account specified in
userName.
d) Click Save.
The password is saved with the correct encryption algorithm.
10. For Media Gateways, resynchronize CAS files from the UMS to the Media Gateway. Perform the
procedure to Resynchronize CAS files on page 582 then continue.
11. For Media Gateway 7.00A.132 firmware upgrades, do the following:
a) Access the Media Gateway administration page at https://mg-ip/AdminPage, where mg-
ip is the Media Gateway IP address.
b) Click ini Parameters.
c) In Parameter Name, enter CasSpecialActionAfterInitBoard then click Apply New
Value.
The following information is displayed in the Output Window:
Parameter Name: CASSPECIALACTIONAFTERINITBOARD
Parameter New Value: 0
Parameter Description:Defines special action to run after board init
(0=No_Action, 1=Raise_And_Clear_Alarm, 2=Stop_And_Apply_Trunk)

d) In Enter Value, type 2 then click Apply New Value.

The following information is displayed in the Output Window:
Parameter Name: CASSPECIALACTIONAFTERINITBOARD
Parameter New Value: 2
Parameter Description:Defines special action to run after board init
(0=No_Action, 1=Raise_And_Clear_Alarm, 2=Stop_And_Apply_Trunk)

e) Click Back to Main to access the main console.

f) Click Device Actions ➤ Reset.
g) In the Reset Configuration section, confirm that Burn to FLASH is set to Yes then click Reset.
The Media Gateway saves the new value then reboots.
h) To confirm that the value was saved, repeat substeps a through c.
Parameter New Value in substep c should now be 2.
12. Ensure that the software changes are applied properly for all devices by doing the following:
• For turrets and Pulse devices, do one of the following based on the applicable upgrade scenario:

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 561

Scenario Procedure(s) to perform

The upgrade you performed was from Reboot all of the turrets and Pulse devices you upgraded
a pre-Unigy v4.2 version to Unigy by performing the procedure Reboot communication
v4.2 or higher, in the new version the devices on page 591 then immediately remove the
enterprise is configured to use DHCP devices from the Unigy database by performing the
option 112 to assign home zones and procedure Remove a CDI from the database on page 361.
the registration coordinator zones
and subnet addresses are
Note
configured.
You must remove the devices before the reboots complete
to enable them to use the load balancing feature to
register with an appropriate zone.

The devices being upgraded are Reboot all of the turrets and Pulse devices you upgraded
using DHCP option 66 to assign a by performing the procedure Reboot communication
home zone. devices on page 591.
The devices are using static IP Reboot all of the turrets and Pulse devices you upgraded
addressing to assign a home zone. by performing the procedure Reboot communication
devices on page 591.
The upgrade you performed was from Reboot all of the turrets and Pulse devices you upgraded
a Unigy v4.2 or higher version, in the by performing the procedure Reboot communication
previous version the devices were devices on page 591 then immediately remove the
configured to use DHCP option 66 to devices from the Unigy database by performing the
assign a home zone, but in the new procedure Remove a CDI from the database on page 361.
version the enterprise is configured to
use option 112 and the registration
Note
coordinator zones and subnet
addresses are configured. You must remove the devices before the reboots complete
to enable them to use the load balancing feature to
register with an appropriate zone.

The upgrade you performed was from Reboot all of the turrets and Pulse devices you upgraded
a Unigy v4.2 or higher version and in by performing the procedure Reboot communication
the previous version the enterprise devices on page 591.
was configured to use DHCP option
112 to assign home zones.

• Reboot the Media Managers, by performing the procedure Run Reboot Media Manager on page
588.
• If you have not done so already, reboot the Media Gateways by performing the procedure Reboot a
Media Gateway on page 591.
13. If you deployed the software on Media Managers or Media Gateways, take them out of maintenance
mode by performing the procedure Take an appliance or Media Gateway out of maintenance mode on
page 600.
14. Confirm that the devices were upgraded by running the Turret & Pulse Display Software Versions,
Media Gateway Software Version, CCM CCM Software Version, and Media Manager MM Software
Version diagnostic tests, as applicable at Tools ➤ Diagnostic.
The results should show the correct version and that the version matches the version in the database.

IPC Confidential Unigy 4.3

Enterprise Guide
562 17.1: Deployment and upgrade procedures

17.1.16 Downgrade (roll back) the CDI software

After you roll back the Unigy software on the CCM or ACCM appliances in a zone to a previous
software version, downgrade the software on the turrets, Pulse devices, and Unigy Soft Clients that are
registered with the zone to the same version.

Note
If you are downgrading the software for a Media Manager, refer to the procedure Restore a CCM, ACCM,
or MM disk image from the command line on page 393. If you are downgrading the software for a Media
Gateway, refer to the procedure Downgrade the Media Gateway software on page 572.

In a multizone enterprise, perform this procedure in each applicable zone after you roll back the
software on the CCM or ACCM appliance(s).

Note
This procedure is service impacting. Perform it only during non-trading hours.

1. Log in to the UMS.

2. Click Tools ➤ Deployment ➤ Software Deployment.
3. Click the Deploy tab.
The Software Deployment Wizard is displayed.
4. Within the 1 Software tab, select the CDI devices for which you are downgrading the software:
a) Expand an applicable CDI device type section for devices to be downgraded.
Downgrades can affect some or all device types. Compare the Current Version to the Assigned
Version for each device to determine whether a downgrade is required. You cannot select devices
for downgrade when the Current Version and the Assigned Version are the same because this
indicates that the software on the devices is already at the correct version.
b) Click +Assign.
c) Select the check box for each device you are downgrading.
Select the check box in the column heading for the first column to select all devices of the device
type you selected.
d) Click < Assign.
e) Repeat steps a - d for each applicable device type.
5. Click 2 Deploy.
Review the selected devices. If devices are selected that should not be, return to the applicable device
type within 1 Software and remove the devices from the Selected for update table by clicking the
device then clicking Remove.
6. Click the Deploy button.
The Deployment Status panel displays the deployment progress. The time required to complete the
deployment is based on the number of devices. Click Refresh to refresh the information displayed.
After the deployment completes successfully, the Status icon turn green and the following occurs:
• The zone informs the turrets and Pulse devices selected for downgrade to retrieve and install the
downgraded software. If an end user is not logged in to a device, the system automatically deploys
the software and reboots the device. If an end user is logged in to a device, the system does not
automatically deploy the software. Devices that are not selected for downgrade, that have an end
user logged in at the time of the downgrade, or that were not active at the time of the downgrade,

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 563

retrieve the downgraded software and deploy it when an end user logs in to the device or when the
device reboots.
• Soft Client downgrade software is staged on the zone appliances. When end users log in to the Soft
Client, the Unigy Application icon in the Microsoft Windows System Tray displays a different
icon that indicates a software change is available. When an end user right-clicks the icon to open
the Unigy Application menu, the system displays the Upgrade option. To downgrade the software,
refer to step 9.

Note
After you downgrade the software on CDIs, it can take up to 30 minutes for all of the devices to reboot
and re-register with the zone. The system does not update the current version value within the Deploy
tab until the devices are completely operational.
To refresh the Deploy panel, click Tools ➤ Deployment ➤ Software Deployment then click the Deploy
tab. Do not refresh the panel until the software deployment displayed within the Status panel is
complete.

7. Reboot the downgraded turrets and Pulse devices to ensure that the software changes are applied by
performing the procedure Reboot communication devices on page 591.
8. Confirm that the devices were downgraded by running the Turret & Pulse Display Software
Versions diagnostic job, at Tools ➤ Diagnostic.
The results should show the correct version for each device and that the version matches the version
in the database.
9. Roll back the software on the Unigy Soft Client client computers by performing the procedure Roll
back the Unigy Soft Client software – Microsoft Windows 64-bit on page 631 or Remote Soft Client
installation on page 625.

17.1.17 Configure an SMTP server

Configure the Simple Mail Transfer Protocol (SMTP) server to send an e-mail message whenever the
APP-DS-ds_ha-140025-standbyUnavailable-S alert is generated.
An SMTP server is required for multi-factor authentication to send security tokens to secured UMS and
Mass Edit Client users.
1. Click Configuration ➤ Enterprise ➤ SMTP.
2. In the SMTP list, click an existing server or click +Add New to configure a new server.
3. Enter SMTP configuration details as applicable. Not all fields are required.
• In Name, enter a unique name to identify the SMTP server.
• In SMTP Host, enter the hostname or IP address of the remote SMTP server. If you enter a fully-
qualified domain name (FQDN), identify the Domain Name Server (DNS) that provides name
resolution to Unigy. For information on this procedure, refer to Configure Unigy access to Domain
Name System (DNS) servers on page 421.
• In Port, enter the port for authenticating SMTP connections. The default is 25.
• In TLS Authentication, enable the Transport Layer Security Certification-band authentication if
TLS connections for SMTP are required.
If TLS Authentication is enabled, the Username, Password, and Confirm Password fields are
also required.
• In Username, enter the login username for a user account that is authorized to access the SMTP
server.

IPC Confidential Unigy 4.3

Enterprise Guide
564 17.1: Deployment and upgrade procedures

• In Password, enter the password for the login username.

• In Confirm Password, re-enter the password for the login username.
• In From Address, enter a valid e-mail address that is listed as the sender of alert e-mail messages.
Each e-mail address requires a from address because, for anti-spam reasons, some outgoing servers
refuse to forward e-mail without a valid from address.
• In To Address, enter a valid e-mail address that is listed as the receiver of alert e-mail messages.
Each e-mail address requires a to address because, for anti-spam reasons, some outgoing servers
refuse to forward e-mail without a valid to address.
4. Click Save.

17.1.17.1 SMTP configuration properties

Use this table to record the SMTP configuration properties for the enterprise. These will be required
after performing an upgrade or other maintenance procedure that involves redeploying the COP
software.

Property Value
Name
SMTP Host
Port
TLS Authentication
Username
Password
From Address
To Address

17.1.18 Send SNMP recovery alerts prior to an upgrade

Send all SNMP recovery alerts prior to upgrading from Unigy v2.x to Unigy v3.0 or higher.
This procedure sends all Unigy v2.x SNMP recovery alerts to an NMS before an upgrade. This is
recommended because Unigy v2.x alerts cannot be cleared from the UMS after an upgrade. Performing
these steps eliminates the need to run scripts to clear these alerts after the upgrade.
1. Click Configuration ➤ Sites ➤ SNMP Forwarding ➤ Alert Filtering.
2. Select a Zone then select a Trap Destination.
3. In the Show Alerts list, select Do Not Send Alerts.
If there are no alerts in the list, it is not necessary to complete the remainder of this procedure. If there
are alerts, proceed to step 4.
4. In Alert Name, type _R to show all recovery alerts.
5. Select the check box for all recovery alerts.
These alerts end in _R; for example, Turret-IQ/MAX-101001-Availability60Secs-P_R.
6. Click the Send Alerts button.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 565

7. In Show Alerts, select Do Not Send Alerts again and confirm that there are no recovery alerts by
searching again for alerts that end in _R.
8. Repeat these steps for all zones and trap destinations.

17.1.19 Clear Unigy v2.0 and v2.0.1 alerts

Use this procedure to clear Unigy v2.0 and v2.0.1 alerts after upgrading.
Clearing the alerts with this procedure is required after upgrading from Unigy v2.0 or v2.0.1 because
some v2.0 and v2.0.1 alerts are no longer supported, and therefore, cannot be cleared from the UMS.
1. Log in to the zone's Active CCM or ACCM appliance through SSH.
2. Run the command su -lp and enter the root user account password.
3. Run the command mysql -hVIP -udbuseraccount -pdbpassword dunkin -e
'delete from dunkin.AlertStatus';
where:
• VIP is the appliance IP address (standalone zone) or the zone VIP (HA zone).
• dbuseraccount is the database user account.
• dbpassword is the database user account password.
The system clears all alerts from the AlertStatus table.
4. If you did not send the v2.x SNMP recovery alerts prior to the upgrade, as described in Send SNMP
recovery alerts prior to an upgrade on page 564, do the following:
a) Run the following script to display the existing alerts:
listRecoveryFilters.sh
b) If the script returns recovery alerts, run the following script to remove them:
deleteRecoveryFilters.sh
c) Rerun the listRecoveryFilters.sh script to determine whether there are any remaining
alerts. If there are, rerun the deleteRecoveryFilters.sh script.

17.1.20 Convert the MySQL password hashing algorithm (fix_my_pass)

Unigy v2.0.1.5 or higher uses a different MySQL version from previous Unigy versions. Perform this
procedure to update the MySQL password hashing algorithm in v2.0 and v2.0.1 version zones to make
them compatible with higher version zones before you upgrade any of the zones.
This procedure applies to the following Unigy versions:
• v2.0 all supported patches
• v2.0.1 GA and all supported patches prior to v2.0.1.5
Perform this procedure on the ACCM in a standalone zone or on the Active CCM or ACCM appliance
in all HA zones in the enterprise.
1. Confirm that the zones in the enterprise are in a healthy state and no zones are in maintenance mode
by performing the procedure Check the state of a zone from a browser on page 499.
If you discover any issues, resolved them before proceeding to the next step.
2. Log in to the standalone ACCM or the Active and Standby CCM or ACCM appliances in the zone
through SSH.

IPC Confidential Unigy 4.3

Enterprise Guide
566 17.1: Deployment and upgrade procedures

3. Run the command su -lp and enter the root user account password.
4. Run the command cd /tmp to change the current directory.
5. Copy the fix_my_pass.sh file from your laptop or from Service Delivery's IPC FTP site to
the /tmp directory. .
6. Run the following scripts to convert the text file format and change ownership and permissions for
the fix_my_pass.sh script:
a) dos2unix fix_my_pass.sh
b) chmod 777 fix_my_pass.sh
c) chown root:root fix_my_pass.sh
7. Run the command ./fix_my_pass.sh to run the fix_my_pass.sh script.
8. Delete the fix_my_pass.sh file from the appliance.
This is important to prevent security issues.

17.1.21 Update prototype devices after an upgrade

Prior to Unigy v2.0.1.6, new CDIs obtained their default values from the prototype device configured
for the first zone, regardless of the zone the CDIs registered with. In the current software version, new
devices obtain their default values from the prototype device configured for their home zone. This
procedure describes how to update the prototype devices for pre-v2.0.1.6 zones that you upgrade to the
current software version.
This script copies a set of values from the prototype devices in the first zone to the prototype devices in
the zone in which you run it. The script does not overwrite properties that are set based on a zone's
countrybase.
1. Log in to each zone you upgraded.
2. Refresh the country base:
a) Click Configuration ➤ Enterprise ➤ System ➤ Zones.
b) In the Zones list on the left, click the zone you are updating.
c) Click Change Countrybase.
d) Reselect the Countrybase.
e) Click Save.
3. Run the following command in each zone: /opt/ipc/ha/scripts/
updateMyPrototype.sh zoneID vip username password
• zoneID is the ID (not the zone name) assigned to the zone during initial zone deployment. You
can determine the zone ID by accessing the Install tab at Tools ➤ Deployment ➤ Software
Deployment.
• vip is the VIP of the zone in which you are running the script.
• username is the login name of a Unigy user account that has the IPC Certified Tech role
assigned.
• password is the password for username.

December 3, 2019 IPC Confidential

 17.1: Deployment and upgrade procedures 567

17.1.22 Run the updateToneCadenceFreqForExistingInstances.sh script

After you upgrade from a pre-Unigy v3.0 version, roll back to a pre-Unigy v3.0 version, or restore a pre-
Unigy v3.0 Enterprise backup file, it might be necessary to perform this procedure to populate the tone
cadence-related fields for all zones in the enterprise.
The updateToneCadenceFreqForExistingInstances.sh script was first used in Unigy
v2.0.1.7. This procedure is required for the following situations if the enterprise includes more than one
instance and this script was not already run:
• When you upgrade from a pre-Unigy v3.0 version and the zone that provides the database dump
during the upgrade is a pre-Unigy v3.0 zone for which the
updateToneCadenceFreqForExistingInstances.sh script was not run prior to the
upgrade.
• When rolling back to a pre-Unigy v3.0 version in which the
updateToneCadenceFreqForExistingInstances.sh script was not run.
• When you restore an Enterprise backup file that was created for an enterprise in which the
updateToneCadenceFreqForExistingInstances.sh script was not run prior to the
backup.
It is not necessary to run the script for instances that were created in Unigy v3.0.
1. Access the command line on an appliance in a zone associated with an instance that is not the default
instance.
The default instance is the first instance in the Instances list at Configuration ➤ Enterprise ➤
System ➤ Instances.
2. Run the command su -lp and enter the root user account password.
3. Change the current directory to /opt/ipc/ha/scripts.
4. Run the command ./updateToneCadenceFreqForExistingInstances.sh.
5. Check the script output to be sure there are no errors or stack traces.
It should indicate Exiting with Code :0.
6. For each non-default instance, verify that the ToneCadenceFreq table was updated by running the
command mysql -udatabase_username -pdatabase_password dunkin -e
"select * from ToneCadenceFreq where parentInstanceId=instance_id";
where:
• database_username is the user name for accessing the Unigy database.
• database_password is the password for the database user account.
• instance_id is the ID assigned to the instance for which you are verifying the change.
The statement should return 144 entries for each instance.
7. Reboot all of the turrets in the non-default instances to fetch the updated tone cadence values.

17.1.23 Generate address text files with generateAddresses

This topic describes how to generate the addresses.txt and vipaddresses.txt files that are
used by various scripts including getEnterpriseReplication.sh and
getTransientChannelInfo.sh.
Prerequisite:

IPC Confidential Unigy 4.3

Enterprise Guide
568 17.2: Media Gateway procedures

Before you begin this procedure, be sure that you have access to the generateAddresses.sh file,
which should be available in the Unigy file system at /etc/opt/ipc/ha/scripts/. If the file is
not in this directory, download the generateAddresses.tar file from the IPC FTP site,
FilesAnywhere.

Important
You perform this procedure once on a single appliance to generate the text files that provide the VIP and
IP addresses that are used by the associated procedures. Separate files are created for Unigy, Blue
Wave Adapter, and Blue Wave Director procedures. These files are stored only on the appliance on
which you run this procedure, so it is important to run all procedures that require these files from the
same appliance. Use one of the following options:
• For procedures that apply only to Unigy zones, you can perform this procedure on any appliance.
• For procedures that apply to Unigy and Blue Wave zones, perform the procedure on an appliance in a
Blue Wave zone.
Record the IP address of the appliance so you can refer to it when you run the procedures that use the
files that are generated.

1. Access the command line for the appliance on which you are running the script.
Refer to the Important note above.
2. If the generateAddresses.sh file is not in the /etc/opt/ipc/ha/scripts directory, do
the following:
a) Copy the generateAddresses.tar file to the /etc/opt/ipc/ha/scripts directory.
b) Extract the script file by running the command tar -xvf generateAddresses.tar.
3. Run the script: ./generateAddresses.sh.
The following output indicates that the procedure was successful and the location of the text files that
were generated (you can ignore the Warning messages):
generating /etc/opt/ipc/ha/scripts/addresses.txt
Warning: Using a password on the command line interface can be insecure.

generating /etc/opt/ipc/ha/scripts/vipaddresses.txt
Warning: Using a password on the command line interface can be insecure.
Warning: Using a password on the command line interface can be insecure.

generating /etc/opt/ipc/bluewave/vipaddresses.txt
Warning: Using a password on the command line interface can be insecure.
Warning: Using a password on the command line interface can be insecure.

17.2 Media Gateway procedures

17.2.1 Add a Media Gateway
Add a Media Gateway to the system.
When you add a Media Gateway, you set only its base configuration properties, which include the
device name, location, and IP address.
1. Log in to the UMS with an account that has the role of IPC Project Manager or IPC Certified Tech.
2. Click Tools ➤ Deployment ➤ Hardware Deployment.

December 3, 2019 IPC Confidential

 17.2: Media Gateway procedures 569

3. In the Deployment Zones panel, click the name of the zone in which you are adding the Media
Gateway.
4. In the Deployment Plan Details panel, click the Media Gateways tab.
5. Click Add Device.
The Add New Device panel opens.
6. In the Select Location list, select a location of the Media Gateway.
This list contains all of the currently configured locations.
7. In the Device Name field, type a descriptive name for the Media Gateway.
8. In the Enter IP Address field, type the Media Gateway IP address.
9. Click Save.
A green check indicates that the Media Gateway is added successfully and now registered on the
network.
Figure 103: Deployment Plan Details panel - Media Gateways tab

At any time during or after the Media Gateway configuration process, you can select the Media Gateway
and click Admin Console to access the device’s web interface and verify the current configuration at the
device.

Note
Do not change configuration values at the device; only change configuration values for the Media
Gateway through the UMS and then Apply the changes to the device.

17.2.2 Add Media Gateways for BCP

Perform this procedure to add and configure Media Gateways (MGs) for BCP resiliency. This topic
applies primarily to Basic BCP.
This procedure ensures that when a BCP failover occurs, the MGs in the secondary zone can process
calls with lines that are common to both zones.

Note
Perform this procedure from the primary zone UMS.

IPC Confidential Unigy 4.3

Enterprise Guide
570 17.2: Media Gateway procedures

1. Add and configure all primary zone MGs. For information on this procedure, refer to the Media
Gateway Hardware Installation Manual.
2. Add and configure all secondary zone MGs. For information on this procedure, refer to the Media
Gateway Hardware Installation Manual.
3. For lines that use MG trunks, assign a trunk from the primary zone MG and a trunk from the
secondary zone MG in that order. For information on assigning trunks, refer to Associate trunks with
a private line on page 581 and Associate trunks with an extension on page 582.
4. Restart the secondary zone appliances to flush the JBOSS cache:
a) Within the secondary zone, power down the Standby CCM: shutdown -h now.
b) Reboot the Active CCM or ACCM.
c) After the reboot completes, determine the state of the appliance by performing the procedure
Check the state of a zone from a browser on page 499.
d) Log in to the UMS.
e) Check the Unigy alerts by viewing the UMS Monitoring Dashboard.
Resolve any Active CCM or ACCM issues before proceeding.
f) Reboot all Media Managers (MMs) by performing the procedure Run Reboot Media Manager on
page 588.
You can reboot the MMs simultaneously. Wait for all of them to finish rebooting.

Note
If you encounter problems with overloading the CCM or ACCM, reboot the MMs one at a time.

g) Power up the Standby CCM or ACCM.

Wait for it to be fully up.
h) After the appliance powers up, determine its state by performing the procedure Check the state of a
zone from a browser on page 499.

17.2.3 Update Media Gateway software

This procedure describes how to update Media Gateway software using the UMS.

This procedure is applicable when deploying a new Media Gateway or upgrading an existing Media
Gateway. Software deployment should be performed only during non-business hours. To be available
for update, the Media Gateway must be placed into Maintenance Mode.

Note
If updating the software on an existing Media Gateway the proxy IP is lost during the upgrade. To avoid
failures, retrieve the Media Gateway configuration prior to update (that is, download the Media Gateway
INI file), then re-apply the configuration (that is, upload the Media Gateway INI file) after software update
is complete.

1. Log in to the UMS with an account with the role of IPC Project Manager or IPC Certified Tech.
2. Put the device in maintenance mode.
a) Click Tools ➤ Deployment ➤ Hardware Deployment.
b) Click the zone associated with the Media Gateway.

December 3, 2019 IPC Confidential

 17.2: Media Gateway procedures 571

c) Within the Media Gateways tab, click the Media Gateway you are upgrading.
d) Click Switch to Maintenance Mode.
e) In the Confirmation dialog click Yes then in the Information message box click OK.

Note
When a Media Gateway is in Maintenance Mode, it is available for software updates. Maintenance
mode does not impact existing or new calls on the Media Gateway. An alert is generated when the
Media Gateway is put in maintenance mode.

3. Click Tools ➤ Deployment ➤ Software Deployment.

4. Click the Deploy tab.
The Software Deployment Wizard is displayed. The 1 Software tab displays each device personality
type.
5. Expand the Media Gateway device type section.
6. If the Media Gateways you are upgrading are deployed in a zone other than the current zone, select
the applicable zone from the Zone drop-down list.
7. Click +Assign
A list of available Media Gateways is displayed.
8. Select the check box for all Media Gateways you are upgrading.
Click the check box in the column heading of the first column to select all Media Gateways in the list.
9. Click < Assign to add the Media Gateways to the Selected for update table.
Verify that the New Version of the software is higher than the Current Version on the device.
An error message is displayed for any Media Gateways that are not in Maintenance Mode.
10. If this is a new Media Gateway, select the check box in the Override Config column to override the
software configuration. This overrides the firmware, tone files, and INI files.
To keep the existing configuration on a previously deployed Media Gateway, do not select this check
box.
11. Click the 2 Deploy tab.
A table summarizes the selected devices.
12. Click the Deploy button.
The Media Gateways are instructed by the zone that an update is available and to retrieve it. The
software upgrade takes approximately four minutes. Click Refresh to update the status. After the
upgrade is complete, the Media Gateways reboot. Allow an additional four minutes for the reboot.
13. For Media Gateways, perform the procedure to Upload default portion of Media Gateway INI file on
page 583 or, if your MG contains default settings not configurable through the UMS and these
settings need to be retained, perform the procedure to Upload incremental changes to default portion
of MG INI file on page 585.
14. For Media Gateway upgrades from Unigy v2.0.1.x to Unigy v3.0 or higher, update the Media
Gateway user account password.
This is required because Unigy v3.0 and higher versions use a different password encryption
algorithm than previous releases.
a) Click Configuration ➤ Sites ➤ Trunks ➤ Media Gateways.
b) In the Media Gateways list, click the Media Gateway you are upgrading.
c) Click the Properties button.

IPC Confidential Unigy 4.3

Enterprise Guide
572 17.2: Media Gateway procedures

d) Enter the password for the Media Gateway user account specified in userName.
e) Click Save.
The password is saved with the correct encryption algorithm.
15. Resynchronize CAS files from the UMS to the Media Gateway by performing the procedure to
Resynchronize CAS files on page 582.
16. For Media Gateway 7.00A.132 firmware upgrades, do the following:
a) Access the Media Gateway administration page at https://mg-ip/AdminPage, where mg-
ip is the Media Gateway IP address.
b) Click ini Parameters.
c) In Parameter Name, enter CasSpecialActionAfterInitBoard then click Apply New
Value.
The following information is displayed in the Output Window:
Parameter Name: CASSPECIALACTIONAFTERINITBOARD
Parameter New Value: 0
Parameter Description:Defines special action to run after board init
(0=No_Action, 1=Raise_And_Clear_Alarm, 2=Stop_And_Apply_Trunk)

d) In Enter Value, type 2 then click Apply New Value.

The following information is displayed in the Output Window:
Parameter Name: CASSPECIALACTIONAFTERINITBOARD
Parameter New Value: 2
Parameter Description:Defines special action to run after board init
(0=No_Action, 1=Raise_And_Clear_Alarm, 2=Stop_And_Apply_Trunk)

e) Click Back to Main to access the main console.

f) Click Device Actions ➤ Reset.
g) In the Reset Configuration section, confirm that Burn to FLASH is set to Yes then click Reset.
The Media Gateway saves the new value then reboots.
h) To confirm that the value was saved, repeat substeps a through c.
Parameter New Value in substep c should now be 2.
17. Switch the device back to Active Mode:
a) Click Tools ➤ Deployment ➤ Hardware Deployment.
b) Within the Media Gateways tab, click the Media Gateway you are placing in Active Mode then
click Switch to Active Mode.
c) In the Confirmation dialog click Yes then in the Information message box click OK.

17.2.4 Downgrade the Media Gateway software

Perform this procedure to downgrade Media Gateway (MG) software to V2.0.
Prerequisite: Prior to performing the MG downgrade, first roll back the Unigy software update. For
instructions on rolling back a Unigy deployment, refer to Roll back the software on the appliance in a
Unigy or Blue Wave standalone zone on page 387 or Roll back the software on the appliances in a Unigy
or Blue Wave HA zone from the UMS on page 389, depending upon the deployment scenario.
1. From the Media Gateway web interface (not the UMS), check the current firmware version (6.40A.
075.005) as indicated in the following figure.

December 3, 2019 IPC Confidential

 17.2: Media Gateway procedures 573

Figure 104: Media Gateway Home Page

2. Copy the downgraded Media Gateway firmware, for example, 6.40A.073.004, to the local machine.
The downgraded firmware will be located on the CCM under the directory: /opt/ipc/
deployment/stage/mediagateway/audiocodes and will have a .cmp extension.
3. From the Media Gateway web interface, access Maintenance ➤ Software Update ➤ Software
Upgrade Wizard as illustrated in the following figure.
Figure 105: Media Gateway Software Upgrade Wizard panel

4. Click Start Software Upgrade

5. Browse for the firmware (.cmp) file on the local machine, then click Load File.

IPC Confidential Unigy 4.3

Enterprise Guide
574 17.2: Media Gateway procedures

Figure 106: Media Gateway Software Upgrade Wizard

6. The file is loaded into the Media Gateway as illustrated below.

Figure 107: Media Gateway Software Upgrade Wizard panel

December 3, 2019 IPC Confidential

 17.2: Media Gateway procedures 575

7. After loading is complete, click Next for all options until Finish displays.
8. Click Finish, then Reset.
The panel indicates burn and reset in progress.
Figure 108: Media Gateway Software Upgrade Wizard panel

9. When finished, the CMP Version ID displays as indicated in the following figure.

IPC Confidential Unigy 4.3

Enterprise Guide
576 17.2: Media Gateway procedures

Figure 109: End of Process panel

10. Click End Process.

The MG Home page displays and you can verify this is the correct downgraded version.
Figure 110: Media Gateway Home Page

Once it is running the older firmware, the MG can then be added to the Unigy V2.0 system following
the standard process as described in the Unigy V2.0 documentation.

December 3, 2019 IPC Confidential

 17.2: Media Gateway procedures 577

17.2.5 Retrieve the Media Gateway configuration

Complete this procedure to retrieve device settings from the Media Gateway and import them into the
system.
You can retrieve the entire device configuration, or only the hardware profile settings. The hardware
profile includes the number and type of modules installed in the system.
You can perform this task only once after adding a new Media Gateway. If you manually add any
module to the Media Gateway configuration using the UMS before retrieving the configuration values,
the Retrieve button is disabled.
1. In the UMS, click Configuration ➤ Sites.
2. Optionally, filter the list of Media Gateways that will be displayed by Instance, Location, or Zone.
3. Click Trunks ➤ Media Gateways.
4. In the Media Gateways list, click the device whose settings you want to retrieve.
5. Click Retrieve to retrieve the settings from the device.
6. Do one of the following in the dialog box that opens:
• Click Yes to retrieve the entire device configuration. Select this if the Media Gateway was
previously configured and you want to retain that configuration.
• Click No to retrieve only the hardware plugged in to the Media Gateway (for example, the number
and types of ports).
A Job Progress window displays. When complete, the window indicates progress is 100 percent.
7. Click Close in the Job Progress window.
The system imports the retrieved device settings into the Unigy database, and displays them in the
UMS In the Module, Port, ISDN, AllianceICM, and Channel tabs based on the type of modules.

17.2.6 Media Gateway module population standard

This topic describes the standards for population of Media Gateway modules at the factory and in the
field.

Background
Media Gateway modules must be programmed during configuration in the same order as they are
physically installed in the device. Media Gateway modules are generally installed at the factory by the
team in Westbrook, while the configuration data is programmed offline by the Central Support Team.
This standard serves to coordinate the workflows of both teams to ensure that the system data matches
the physical device.

Physical population of modules in a new Media Gateway

Module population is left to right, top to bottom.

Note
A Media Gateway is configured for either T1 or E1, but not both. A combination of T1 and E1 protocols
can be implemented across multiple Media Gateways in a Unigy system.

Install the modules in this order:

1. 2-port TDM T1 or E1 modules

IPC Confidential Unigy 4.3

Enterprise Guide
578 17.2: Media Gateway procedures

2. 1-port TDM T1 or E1 modules

3. 4-port analog FXO/FXS modules
Once a Media Gateway is installed and running in the field, new modules can simply be added to the
next available slot.

Note
Some customers add extra hardware for future provisioning.

Programming guidelines
Whenever possible, split service connections to a PBX, CO and private provider among multiple
modules to limit exposure. Also mix CAS and ISDN across multiple modules and multiple Media
Gateways, if possible.
For example, if you have a multi-port T1 or E1 module, try and split the connections from the PBX
among multiple ports. If you have multiple modules, mix CAS and ISDN across them.
The only restriction in salt and peppering circuits across a Media Gateway is that there cannot be a
combination of E1 and T1 on the same MG.

Note
Trunk groups, configured through the UMS, can also be spread across multiple modules and multiple
media gateways.

17.2.7 Configure a Media Gateway

Complete this procedure to configure a Media Gateway after adding it to the system.
You must have one of the following roles to set the properties in this panel: Advanced Administrator,
IPC Project Manager, or IPC Certified Tech. Users with the Basic Administrator, Auditor, or System
Auditor role can view, but not modify, properties in this panel.
The first time you configure the Media Gateway, you must specify whether the device terminates T1 or
E1 TDM lines. (If the device terminates analog lines only, specify T1.)

Note
The TDM line type cannot be changed after saving the trunk and port configuration.

For information on the properties in this panel, refer to the UMS online help or UMS UI Guide.
1. In the UMS, click Configuration ➤ Sites .
2. Optionally, filter the list of Media Gateways that will be displayed by Instance, Location, or Zone.
3. Click Trunks ➤ Media Gateways.
4. In the Media Gateways list, click the name of the device you are configuring.
The Media Gateway panel opens.
5. Set the gateway TDM type.
You can set the value of this property only the first time you configure and save the Media Gateway
definition in the database.
a) Click the Properties button.
b) In the Gateway TDM Type list within the Properties tab, select T1 or E1 then click Save.

December 3, 2019 IPC Confidential

 17.2: Media Gateway procedures 579

c) Click the Modules/Port/Channels button to return to the Media Gateway panel.

6. Configure the Media Gateway properties.
a) In the Module list within the Module tab, select the module you are configuring.
b) In the Port list within the Port tab, select the port you are configuring.
The other tabs in the panel might change based on the module and port you select. Make any
changes that are necessary for the port you selected then click Save.
c) Configure the properties within the Port, ISDN, AllianceICM, or Channel tabs according to the
type of module you are configuring.
Click Show Advanced to display additional properties.
Click Save to save the changes for each tab.
7. Click the Properties button.
8. If necessary, edit the properties within the Properties, SNMP, Tone Levels, and VoIP Quality
Metrics tabs.
Click Save for each tab to save your changes.

17.2.8 Synchronize CAS files

Synchronize CAS files currently staged on the Converged Communications Manager (CCM) with a
Media Gateway (MG).
A CAS file provides channel-associated signaling used for CAS-terminated trunks. IPC uses proprietary
CAS files for generating CAS bits on the (E1 and T1) TDM side for MRD, ARD, and HOOT lines. Dial
tone CAS files are also provided.
IPC offers two versions of ARD signaling:
• E1_ARD and T1_ARD - If either end of the ARD line releases, the other end is also automatically
released. This is considered standard Unigy behavior.
• E1_ARD_CLASSIC and T1_ARD_CLASSIC - If one end releases, the other end still stays up. This
is legacy Alliance MX behavior. For example:
• If both sides are on-hook and one side goes off-hook the other side rings.
• If both sides are off-hook and one side goes on-hook the other side will NOT drop.
• If one side is off-hook and the other side in on-hook, when the on-hook user goes off-hook, that
user will be immediately connected to the other off-hook user.

Note
If you are using E1_ARD_Classic or T1_ARD_Classic CAS in an IPC Network Services network, ensure
that these channels are configured on the network side as Connection PLAR Tied mode.

Perform the synchronize CAS files task when you need to add a new MG with CAS modules (T1 or E1
CAS protocols) to the Unigy system. Service is temporarily interrupted so synchronize CAS files during
off-peak business hours or when the system is offline.

Note
If the Media Gateway was preconfigured, and was not overridden during the software upgrade, you
should synchronize the CAS files before you retrieve the Media Gateway configuration.

IPC Confidential Unigy 4.3

Enterprise Guide
580 17.2: Media Gateway procedures

1. In the UMS, click Configuration ➤ Sites.

2. Optionally, filter the list of Media Gateways that will be displayed by Instance, Location, or Zone.
3. Click Trunks ➤ Media Gateways.
4. In the Media Gateways list, click the MG for which you are synchronizing the CAS files.
The Media Gateway panel opens.
5. Click the Properties button.
6. If you have not already done so, enter the current user name and password for the Media Gateway
Web User Account.
a) Within the Properties tab, enter the userName and password.
b) Click Save.
7. Click the CAS File Management tab.
8. In the To be Updated on MG column, select the check box for the CAS files to synchronize.
Click the check box in the column heading to select all of the files.
9. Click Sync.
Unigy synchronizes the CAS files that are on the CCM server to the MG.
10. Click Yes to confirm.
When complete, the Job Progress window indicates 100 percent.
11. Click Close.

Note
If you are syncing CAS files as part of setting up a new Media Gateway, the Apply button is not
available until after you perform a Retrieve. If you are syncing CAS files and CAS trunks are already
configured on the UMS, then the Apply occurs automatically after the Sync.

12. If the Apply button is available, perform the procedure Apply changes to a Media Gateway
configuration on page 586.
Be sure to enable SSH remote access if it is not enabled. For information on this procedure, refer to
Enable or disable Media Gateway SSH remote access on page 587.

Suggestion
Keep a record of the order of the CAS files on the MG because if CAS file updates are made available in
the future, the updated CAS files will need to be resynchronized from the UMS to the MG in the order that
they were originally synchronized to the MG.

17.2.9 Configure a Media Gateway module

Configure the definition for a Media Gateway module in the Unigy database.
You cannot change the definition for a module that is already configured.
1. In the UMS, click Configuration ➤ Sites ➤ Trunks ➤ Media Gateways.
2. In the Media Gateways list, click the Media Gateway for which you are configuring the module.
The Media Gateway panel is displayed.
3. In the Module list within the Module tab, select the module you are configuring.
4. In the Type list, select a module type .
The options are 2 Port TDM, 1 Port TDM, 4 Port Analog - FXO, and 4 Port Analog - FXS.

December 3, 2019 IPC Confidential

 17.2: Media Gateway procedures 581

5. Click Save.
6. Click Apply to apply the changes to the device.

17.2.10 Associate trunks with a private line

Create a static association between a private line and one or more trunks.
When a call is established for the private line, Unigy traverses the list of trunks in the order that they are
defined in the UMS. The first trunk that makes a successful connection to the external party is used for
the call.
You can statically associate the following types of trunks with a private line:
• Media Gateway analog trunks
• Media Gateway TDM trunks (CAS channels only)
• SIP private line trunks
Use the legacy (Flash) UMS (https://<your_VIP>/ums/UMSClient.html) or Mass Edit
Client to accomplish this task. This topic describes the legacy procedure.
1. In the UMS, click Configuration ➤ Enterprise ➤ Lines and Extensions ➤ Private Lines.
The Private Lines List is displayed.
2. Click a private line to which you are associating one or more trunks.
Configuration properties for the line are displayed in the panel below the list.
3. Click the Trunk List tab.
Figure 111: Private Lines - Trunk List tab

IPC Confidential Unigy 4.3

Enterprise Guide
582 17.2: Media Gateway procedures

4. Drag one or more trunks or channels from the Available to Assign list to the Trunks list.
5. Click Save.

17.2.11 Associate trunks with an extension

Create a static association between an extension and one or more trunks.
When a call is initiated using the extension, Unigy traverses the list of trunks in the order that they are
defined in the UMS. The first trunk that makes a successful connection to the external party is used for
the call.
You can statically associate the following types of trunks with an extension:
• Media Gateway analog trunks
• Media Gateway TDM trunks (CAS channels only)
Use the legacy (Flash) UMS (https://<your_VIP>/ums/UMSClient.html) or Mass Edit
Client to accomplish this task. This topic describes the legacy procedure.
1. In the UMS, click Configuration ➤ Enterprise ➤ Lines and Extensions ➤ Extensions.
The Extensions list is displayed.
2. Click an extension to which you are associating one or more trunks.
Configuration properties for the line are displayed in the panel below the list.
3. Click the Trunk List tab.
Figure 112: Extensions Panel - Trunk List tab

4. Drag one or more trunks or channels from the Available to Assign list to the Trunks list.
5. Click Save.

17.2.12 Resynchronize CAS files

If your MG uses CAS files and new or updated CAS files are made available in the UMS (that is, they
are staged on the CCM), you need to resynchronize CAS files from the UMS to your Media Gateway.

Note
Service is temporarily interrupted, so resynchronize CAS files during off-peak business hours or when the
system is offline.

December 3, 2019 IPC Confidential

 17.2: Media Gateway procedures 583

1. In the UMS, click Configuration ➤ Sites.

2. Optionally, filter the list of Media Gateways that will be displayed by Instance, Location, or Zone.
3. Click Trunks ➤ Media Gateways.
The Media Gateways list is displayed.
4. Click the Media Gateway for which you are resynchronizing the CAS files.
The Media Gateway panel is displayed.
5. Click the Properties button.
6. If you have not already done so, enter the current user name and password for the Media Gateway
Web User Account.
a) Within the Properties tab, enter the userName and password.
b) Click Save.
7. Click the CAS File Management tab.
A green check mark is displayed in the Supposed to be on MG column for previously synced CAS
files.
8. In the To be Updated on MG column, select the check box for the CAS files to resynchronize.
Click the check box in the column heading to select all of the files.
9. Click Sync.
A Confirmation Dialogue is displayed.
10. Click Yes to confirm.
A Job Progress dialog box is displayed. When the percentage indicates 100, the sync is complete.

Note
If CAS is configured in the UMS for this MG, then the system automatically performs the Apply
operation right after it performs the Sync operation. A message in the Job Progress panel provides
information regarding the operations, such as: Verification Successful and going for
Apply, then Apply Successful from Unigy to Hardware. If the Apply could not be
performed, the message reads: Reboot required to Apply Configuration to MG.

11. Click Close.

12. If the system did not automatically apply the changes, perform the procedure Apply changes to a
Media Gateway configuration on page 586.
Be sure to enable SSH remote access if it is not enabled. For information on this procedure, refer to
Enable or disable Media Gateway SSH remote access on page 587.
13. Within the Media Gateway Maintenance tab, expand the Reset Configuration section then click
Reboot to reboot the device.
The CAS files are now in sync between the UMS and the MG.

17.2.13 Upload default portion of Media Gateway INI file

A portion of the Media Gateway (MG) INI file contains a set of default parameters configured by IPC to
optimize operation of the MG in the Unigy environment. Occasionally, IPC updates or adds parameters
to this set of MG INI defaults. As a best practice, follow this procedure right after upgrading MG
software to update the default portion of the MG INI file. Do this for new MGs as well as those being
upgraded to the latest Unigy version. The customer's MG configuration is retained and unaffected by
this procedure.

IPC Confidential Unigy 4.3

Enterprise Guide
584 17.2: Media Gateway procedures

Note
If you check the override config option during the MG software deployment, it is not necessary to also
upload the default portion of the MG INI file because the override config option takes care of this.

Prerequisite: Before you begin, for systems being upgraded, record the MG’s Remote Syslog Server
IP Address and Debug Level (located on the Media Gateway Maintenance tab) so that the values can
be reapplied at the end of this procedure.

Note
If a currently deployed MG contains settings not configurable through the UMS and these settings need
to be retained, instead of uploading the (entire) default portion of the INI file, you should upload just the
incremental differences between the default portion of the new INI and the currently deployed INI file. For
more information, refer to Upload incremental changes to default portion of MG INI file on page 585.

Software deployment should be performed only during non-business hours.

1. From the UMS, click Configuration ➤ Sites ➤ Trunks ➤ Media Gateways.
2. Click the Media Gateway for which you are uploading the default portion of the INI file.
3. Click the Properties button.
4. Click the Media Gateway Maintenance tab.
5. Expand the File Management section then click Upload Default INI.
A Job Progress window opens and displays the Operation Status. When the status indicates
Success, the configuration is updated on the Media Gateway.
6. If you plan to configure and associate new resource AORs to this MG, after doing so you must access
the Media Gateway web interface (not the UMS) and manually update the Tel Profile Name
parameter of each new channel in the Trunk Group Table to match the CAS Pattern configured for
the new channel in the UMS.
a) From the Media Gateway web interface, click Configuration ➤ VoIP ➤ Gateway ➤ Trunk
Group.
The Trunk Group Table panel is displayed.
b) Locate the channels that were configured after uploading the default INI and change the Tel Profile
Name of each from None to the appropriate value (for example, FXO IPC 1Stage TeIP, FXO IPC
2Stage TeIP, or CAS IPC Private TeIP).
c) When done, click Submit, then Burn.
d) Reboot the MG.
7. If you need to reapply a previously configured Syslog IP address or debug level, go to the Sys Log
section of the UMS Media Gateway Maintenance tab, re-enter the following values, then click
Update on MG:
a) Remote Syslog Server IP
b) Debug Level
c) Click Reboot.

Suggestion
Download the INI file, open it and ensure that the correct configuration was retained and that the new
default INI parameters were applied as well.

December 3, 2019 IPC Confidential

 17.2: Media Gateway procedures 585

17.2.14 Download a Media Gateway INI file

Download an INI file from the Media Gateway (MG) to the local file system to retain a backup copy.
The INI file is a text-based file that contains MG parameter settings.
Download an INI file to retain a backup copy of the parameter settings. This ensures that if a problem is
encountered in the future, you can safely restore the device back to a working configuration.
HTTPS access must be enabled in order to download a Media Gateway INI file.
1. In the UMS, click Configuration ➤ Sites .
2. Optionally, filter the list of Media Gateways that will be displayed by Instance, Location, or Zone.
3. Click Trunks ➤ Media Gateways.
4. In the Media Gateways list, click the MG for which you are downloading the INI file.
The Media Gateway panel is displayed.
5. Click the Properties button.
6. If you have not already done so, enter the current user name and password for the Media Gateway
Web User Account:
a) Within the Properties tab, enter the userName and password.
b) Click Save.
7. Click the Media Gateway Maintenance tab.
8. If HTTPS access it is not already enabled, expand the HTTPS Access section, select Enable, then
click Submit.

Tip
If you are not sure if it is enabled, click Get Current Values to display the HTTPS status.

9. Expand the File Management section then click Download INI.

The web browser prompts you to open or save the file to the local file system.
10. Click the Save down arrow then click Save As, navigate to the location on your local file share
where you want to store the file, optionally enter a file name (default file name is BOARD.ini), then
click Save.
A message indicates that The BOARD.ini download has completed.

17.2.15 Upload incremental changes to default portion of MG INI file

A portion of the Media Gateway (MG) INI file contains a set of default parameters configured by IPC to
optimize operation of the MG in the Unigy environment. Occasionally, IPC updates or adds parameters
to this set of MG INI defaults. As a best practice, you should always upload the default portion of the
MG INI file just after deploying MG software. If a currently deployed MG contains default settings not
configurable through the UMS and these settings need to be retained, follow this procedure to upload
just the incremental differences between the default portion of the new INI and the currently deployed
INI file. The customer's other MG configuration is retained and unaffected by this procedure.
Prerequisite: Before you begin, for systems being upgraded, record the MG’s Remote Syslog Server
IP Address and Debug Level (located on the Media Gateway Maintenance tab) so that the values can
be reapplied at the end of this procedure.
Software deployment should be performed only during non-business hours.

IPC Confidential Unigy 4.3

Enterprise Guide
586 17.2: Media Gateway procedures

1. In the UMS, click Configuration ➤ Sites ➤ Trunks ➤ Media Gateways.

2. In the Media Gateways list, click the Media Gateway for which you uploading the INI file.
3. Click the Properties button.
4. Within the Media Gateway Maintenance tab, expand the File Management section.
5. Click Upload Default Incremental INI.
A Job Progress panel opens and displays the operation status. When the Job Result is Complete,
the default portion of the INI file is incrementally updated on the Media Gateway.

Note
This step does not reapply the MG’s Syslog IP address or the Debug Level if they were previously
configured.

6. If you need to reapply a previously configured Syslog IP address or debug level, expand the Sys Log
section of the Media Gateway Maintenance tab, re-enter the following values, then click Update on
MG:
a) Remote Syslog Server IP
b) Debug Level
7. Perform the procedure Apply changes to a Media Gateway configuration on page 586.
Be sure to enable SSH remote access if it is not enabled. For information on this procedure, refer to
Enable or disable Media Gateway SSH remote access on page 587.
8. Perform the procedure Reboot a Media Gateway on page 591.

Suggestion
Download the INI file, open it, and ensure that the correct configuration was retained and that the new
default INI parameters were applied as well.

17.2.16 Apply changes to a Media Gateway configuration

Apply changes made in the UMS to a Media Gateway.
Perform this step after you make changes to a Media Gateway module or port settings.
1. In the UMS, click Configuration ➤ Sites .
2. Optionally, filter the list of Media Gateways that will be displayed by Instance, Location, or Zone.
3. Click Trunks ➤ Media Gateways.
4. In the Media Gateways list, click the MG for which you are applying the settings.
5. Click the Properties button.
6. Within the Media Gateway Maintenance tab, expand the Remote Access section.
7. Determine whether SSH remote access is enabled, and if it is not, enable it:
a) Click Get Current Values.
The Job Progress panel is displayed.
b) If the value in the Operation Status column is false, click Close then enable SSH access by
clicking the Enable option and clicking Submit.
8. Click Apply.
The system applies the changes. If a Media Gateway reboot is required, the system displays a
message indicating this; for example, a reboot is required for the following changes:

December 3, 2019 IPC Confidential

 17.3: Reboot procedures 587

• Configuring the board line type from the Unigy default configuration to T1 by changing the trunk
protocol type from NONE to T1.
• Configuring the board line type from the Unigy default configuration to E1 by changing the trunk
protocol type from NONE to E1.
• Changing the line type from T1 to E1 or from E1 to T1.
• Changing the Protocol Type.
9. To disable SSH remote access, do the following:
a) Within the Remote Access section, click Disable.
b) Click Submit.

17.2.17 Enable or disable Media Gateway SSH remote access

Certain Media Gateway operations require enabling SSH access.
For security reasons, you should disable SSH access when it is not needed.
1. Within the UMS, click Configuration ➤ Sites ➤ Trunks ➤ Media Gateways.
2. Click the Media Gateway for which you are enabling or disabling SSH remote access.
3. Click the Properties button.
4. Within the Media Gateway Maintenance tab, expand the Remote Access section.
To determine the current SSH remote access status, click Get Current Status and wait until the Job
Status is Completed. The current status is available in the Operation Status column; true
indicates that access is enabled and false indicates that it is disabled.
5. Select Enable to enable remote access or select Disable to disable access.
6. Click Submit.

17.2.18 Configure the NTP Server for a Media Gateway

It is necessary to set the NTP Server when you deploy, replace, or move a Media Gateway (MG).

1. Click Tools ➤ Deployment ➤ Hardware Deployment.

2. In the Deployment Zones list, click the zone that the MG is connected to.
3. Within the Media Gateways tab, click the MG then click the Admin Console link.
4. Enter the console user name and password then click Login.
5. Click Configuration ➤ System ➤ Time and Date.
6. In the Primary NTP Server Address (IP or FQDN) field, enter the VIP of the Unigy zone that the
MG is connected to.
7. Click Submit.
8. Click Burn.

17.3 Reboot procedures

17.3.1 Reboot CCM
Follow this procedure to reboot a Converged Communications Manager (CCM) or Aggregated
Converged Communications Manager (ACCM) from the Unigy Management System (UMS).

IPC Confidential Unigy 4.3

Enterprise Guide
588 17.3: Reboot procedures

If Multi-tier Replication is enabled, do not use this procedure; instead, refer to Refresh (restart) zones in
a multizone enterprise on page 319.
You must be logged in to the UMS and be authorized to generate and view the Reboot CCM Diagnostic
test.
Rebooting the appliances and loading the database requires approximately twenty minutes to complete.

Note
If the reboot does not complete, refer to Reboot an appliance if the reboot command gets stuck on page
590.

Warning
IPC does not recommend rebooting a CCM or ACCM during trading hours. Perform this command after
the trading day or during routine maintenance periods.

1. Click Tools ➤ Diagnostic.

2. Click Create New Test.
3. Expand CCM in the Available Tests tab.
4. Select the Reboot CCM tool and click Select.
5. If necessary, select the Zone associated with the CCM or ACCM that you want to reboot.
6. Click +Assign to select devices. Then do any of the following:
• From the Devices for Zone tab, select one or more devices, then click <Assign.
• From the Device List tab, select a device list (group of devices), then click <Assign.
7. Click Perform Test.

Note
This test is intrusive. IPC does not advise performing this test during business/trading hours.

8. Select the test from the grid, then click View Detail.
9. When the reboot is complete, the value in the Progress column in the Diagnostics Status Details panel
is 100.

17.3.2 Run Reboot Media Manager

This topic describes the procedure for rebooting a Media Manager from the UMS.

Note
This test is intrusive. IPC does not advise performing this test during business/trading hours.

You must be logged in to the Unigy Management System and be authorized to generate and view this
test.
1. Click Tools ➤ Diagnostic.
2. Click Create New Test.
3. Expand Media Manager in the Available Tests tab.

December 3, 2019 IPC Confidential

 17.3: Reboot procedures 589

4. Select the Reboot MM tool and click Select.

5. If necessary, select the Zone of the MM you want to reboot.
6. Click +Assign to select devices. Then do any of the following:
• From the Devices for Zone tab, select one or more devices, then click <Assign.
• From the Device List tab, select a device list (group of devices), then click <Assign.
7. Click Perform Test.

Note
Since this test is intrusive, the following confirmation dialog displays.
Figure 113: Confirmation for intrusive test

If you still want to run this intrusive test, check Execute test during working hours, then click OK.

8. To view the status of the test, select the test from the grid then click View Detail.
9. When the reboot is complete, the value in the Progress column in the Diagnostics Status Details
panel is 100.
10. Click click to view in the Output column to see the results.
Figure 114: Reboot Media Manager Output Panel

11. If the MM(s) you rebooted are in a Virtual Machine (VM), refer to Reapply the license for an MM in
a VM after a reboot on page 590.

IPC Confidential Unigy 4.3

Enterprise Guide
590 17.3: Reboot procedures

17.3.3 Reapply the license for an MM in a VM after a reboot

When a Media Manager in a VM (virtual machine) is rebooted, the SWMS license can become invalid.
Perform this procedure to regenerate and apply an MM license.
1. Determine whether the MM license is valid:
a) Within the UMS, click Configuration ➤ Sites ➤ Servers ➤ Media Managers.
b) In the Media Managers list, click the Media Manager you rebooted.
c) Within the Media Manager Maintenance tab, determine the MM status.
If the status is In Traffic, the license is valid, so it is not necessary to perform the rest of this
procedure. If the status is not In Traffic, complete the remaining steps.
2. Log in to the MM appliance command line with the shelldiag user account.
3. Run the command su -lp and enter the dynamic password.
4. Determine whether a valid license is present by running the following command:
snmpwalk -v2c -O n -c imm01Admin $(hostname -i) .
1.3.6.1.4.1.7569.1.2.1.81.1
If you copy and paste the command, copy one line at a time (include the period at the end of the first
line) to ensure that the full command is on the command line before you run it.
The command returns .1.3.6.1.4.1.7569.1.2.1.81.1.0 = INTEGER: 1 if the license
is valid or .1.3.6.1.4.1.7569.1.2.1.81.1.0 = INTEGER: 0 if it is invalid. If the
license is invalid, complete the remaining steps in this procedure.
5. Run the following command to determine the MM node id:
/opt/swms/bin/swmsconsole -n
A node ID similar to the following is returned:
1047f481-2c033e26-533e23a6-6b21dd7d-4fcbd3b5
6. Generate the license and key by running the following command, where node-id is the node ID
returned in step 4:
/opt/ipc/thrdParty/bin/swmskeygen.sh node-id
The system returns a license key similar to the following:
20c6b453-1b3e6bf9-3e468458-bd22af19-07051c17-fdf7fdc1
7. Apply the license by running the following command, where license-key is the license key
generated in step 5:
/opt/swms/bin/swmsconsole -l license-key
The command should not return any output.
8. Confirm that the applied license is valid by running the following command:
snmpwalk -v2c -O n -c imm01Admin $(hostname -i) .
1.3.6.1.4.1.7569.1.2.1.81.1
If you copy and paste the command, copy one line at a time (include the period at the end of the first
line) to ensure that the full command is on the command line before you run it.
The command should return .1.3.6.1.4.1.7569.1.2.1.81.1.0 = INTEGER: 1.

17.3.4 Reboot an appliance if the reboot command gets stuck

Occasionally one or more services prevent the reboot command from shutting down an appliance,
which results in the appliance being stuck in the reboot state.

December 3, 2019 IPC Confidential

 17.3: Reboot procedures 591

The following options are available to recover from this situation:

• Press the appliance Power button and hold it for 5 seconds until the platform powers off then press
the button again to power the appliance back on.
• Access iDRAC and perform a power cycle operation.
• Use the plcm_monitor.sh script, which monitors the appliance for sixty seconds then runs the
reboot -if command to perform a hard boot. Do the following to run this script:
1. Access the appliance command line.
2. Run the command su -lp then enter the appropriate password.
3. Run the command /opt/ipc/cop/tools/plcm_monitor.sh reboot.

17.3.5 Reboot a Media Gateway

During certain procedures, such as software upgrades, or port, trunk, or channel configuration, it is
necessary to reboot a Media Gateway. This topic describes how to perform this procedure.
Prerequisite:
If you have not placed the Media Gateway into maintenance mode, perform the procedure Place an
appliance or Media Gateway into maintenance mode to indicate it is unavailable on page 599.
1. Within the UMS, click Configuration ➤ Sites ➤ Trunks ➤ Media Gateways.
2. In the Media Gateways list, click the Media Gateway you are rebooting.
3. In the Media Gateway panel, click the Properties button.
4. Within the Media Gateway Maintenance tab, expand the Reset Configuration section.
5. Select the Graceful Option and Burn to Flash check boxes if they are not selected.
6. Click Reboot.
7. In the Confirmation Dialogue, click Yes.
A Job Progress panel is displayed. The reboot operation is complete when the Job Status is
Completed.

17.3.6 Reboot communication devices

This topic describes the procedure for rebooting communication devices from the UMS.
This test is intrusive.

Note
This test is intrusive. IPC does not advise performing this test during business/trading hours.

You must be logged in to the Unigy Management System and be authorized to generate and view this
test.
1. Click Tools ➤ Diagnostic.
2. Click Create New Test.
3. Expand Turret & Pulse in the Available Tests tab.
4. Select the Reboot Device tool and click Select.
5. If necessary, select the Zone of the device you want to reboot.

IPC Confidential Unigy 4.3

Enterprise Guide
592 17.3: Reboot procedures

6. Click +Assign to select devices. Then do any of the following:

• From the Devices for Zone tab, select one or more devices, then click <Assign.
• From the Device List tab, select a device list (group of devices), then click <Assign.
7. Click Perform Test.

Note
Since this test is intrusive, the following confirmation dialog displays.
Figure 115: Confirmation for intrusive test

If you still want to run this intrusive test, check Execute test during working hours, then click OK.

8. Select the test from the grid, then click View Detail.
When the reboot is complete, the value in the Progress column in the Diagnostics Status Details panel
is 100.
9. Click click to view in the Output column.
Figure 116: Reboot Communication Device Output panel

The reboot action fails if it cannot connect to the communication device or it times out. If this occurs,
check the device's network connectivity.
For information about the Reboot Device panel, see Reboot Device on page 592.

17.3.6.1 Reboot Device

Use this panel to reboot a communication device from the Unigy Management System.
Only users with the IPC Certified Tech role can access, create, schedule, and run this diagnostic test.
To access this panel, click Tools ➤ Diagnostic. Click Create New Test. Expand Turret & Pulse, then
select the Reboot Device check box and click Select.

December 3, 2019 IPC Confidential

 17.3: Reboot procedures 593

For information about duration, usage, sample output, next steps, and reasons for failure, see Reboot
communication devices on page 591.

Table 61: Selected Devices

Name Descriptions Values Notes

Device Name Names of Selected communication
communication devices devices to run this test
selected from the on.
Available Devices or
Device List panels.

Table 62: Available Devices

Name Description Values Notes

Name Unigy communication List of registered To filter the list, enter
device names. communication devices device search criteria.
for the selected zone. To remove the filter, click
the x icon in the search
field.
Login Name Name of the user logged List of users. To filter the list, enter
in to the communication login name search
device. criteria. To remove the
filter, click the x icon in
the search field.

Table 63: Device List

Name Description Values Notes

Device List Name Names of String. Up to 255 To filter the list, enter
communication device alphanumeric device list name search
lists. characters. criteria. To remove the
filter, click the x icon in
the search field. To
delete a device list, click
the minus icon next to
the device list name.

Table 64: Available Tests

Name Description Values Notes

Zone Filter field for specifying List of available zones. Test can only be
the devices to display Select the zone that executed in one zone at
based on the zone you contains the devices you a time.
select. want to create the
diagnostic test for.
Search Topic... Text field for entering
search criteria to locate
a test.

IPC Confidential Unigy 4.3

Enterprise Guide
594 17.3: Reboot procedures

Table 65: Available Templates

Name Description Values Notes

Name Names of available Up to 64 alphanumeric Long names do not
diagnostic templates. characters. wrap and may require
resizing the panel to
view them.
To filter the list, enter
template name search
criteria. To remove the
filter, click the x icon in
the search field. To
select a template, drag it
to the New Diagnostic
Test tab. To delete a
template, click the minus
icon next to the template
name.
VoIP Quality Preconfigured provided
for IPC Certified Techs
that contains all tests
and commands related
to VoIP Quality.
IP Recording Preconfigured provided
for IPC Certified Techs
that contains all tests
and commands related
to IP recording.
Patch Upgrade Preconfigured template
provided for IPC Note
Certified Techs that
contains all tests and Informational
commands used to diagnostics cannot be
verify all Unigy added to this template.
components are However, it is possible
operational after a patch to create a custom
upgrade. template containing any
combination of individual
walk the floor tests and
informational tests.

Table 66: Buttons

Name Description
Search Search the available tests for the text entered in the Search
Topic... field. Filters the list on the basis of this text.

Reset Reset the available tests tree to its original state.

Expand All ( + ) Expand all nodes of the available tests tree.
Collapse All ( - ) Collapse all nodes of the available tests tree.

December 3, 2019 IPC Confidential

 17.3: Reboot procedures 595

Table 66: Buttons (continued)

Name Description
Save as Template Save the selected tests and values as a diagnostic template
for future use.
Save Device List Save the list of devices for future use.
Schedule Test Schedule selected diagnostic test to be run on selected
devices.
Cancel Cancel diagnostic test(s) currently being configured.
Perform Test Perform diagnostic test(s) on selected device(s).
Remove Remove the selected device.

17.3.7 Restart an IQ/MAX or IQ/MAX Edge turret

Restart a turret to apply software updates or network configuration changes or to resolve an issue.
For most software upgrades that require a turret restart, either the system restarts the turrets or you
reboot them from the UMS; however, after an upgrade from Unigy v1.0, you must restart each turret
from the device itself.

Note
When you restart a turret that is in an active call, the call is maintained in the system until the call session
times out. The timeout duration is controlled by the Session Timer Expires zone attribute and is
configurable in the UMS; by default it is set to 30 minutes. If speaker channels were muted, they remain
muted until the call is terminated, which happens when a session timer expires.

1. Do one of the following to log in to the turret as an administrator:

• If an end user is not logged in to the turret, press Admin.
• If an end user is logged in to the turret:
1. In the Application Launch Pad, press Settings.
2. In the Shortcuts menu, press More ➤ Admin.
2. Enter the turret administrator password and press Next.
3. Press Restart Station.
4. Press Restart.

17.3.8 Restart an IQ/MAX TOUCH turret

Restart an IQ/MAX TOUCH to apply software updates or network configuration changes or to resolve
an issue.
For most software upgrades that require a turret restart, either the system restarts the turrets or you
reboot them from the UMS.
Manual reboot of the turret is only necessary if there is a problem with the device not being able to
connect to the backroom.
1. Log in as an administrator.
2. Tap General.

IPC Confidential Unigy 4.3

Enterprise Guide
596 17.4: Maintenance mode procedures

3. Tap Restart.

17.3.9 Restart a Pulse

Restart a Pulse to apply software updates or network configuration changes or to resolve an issue.
1. From the Application Launch Pad, tap Settings ➤ Admin.
The Administration menu opens.
2. Enter the Pulse administrator password then tap Done.
3. Scroll to the bottom of the View panel then tap Restart Station.
4. In the Confirm Restart dialog box, tap Restart.

17.4 Maintenance mode procedures

17.4.1 Disable SNMP forwarding for a zone
Disable SNMP forwarding for a zone. When a zone’s SNMP forwarding is disabled, alerts from that
zone are not forwarded to any of the SNMP trap destinations that the zone is associated with.

Note
When a zone or trap destination’s forwarding status is set to Disable, alerts continue to be sent to the
UMS Monitoring Dashboard, which allows technicians on site to continue to view alerts while SNMP
forwarding is disabled.

You must have the Advanced Administrator, IPC Project Manager, or IPC Certified Tech role to perform
this procedure.
1. Click Configuration ➤ Sites ➤ SNMP Forwarding ➤ Maintenance.
The Zone Maintenance Status panel is displayed.
2. Click the zone for which you are disabling SNMP forwarding.
The trap destinations associated zone are displayed in the Trap Destination grid.
3. Select the check box for the trap destinations you are disabling.
To disable SNMP forwarding for the zone, select all of the trap destinations.
4. Click Disable.
The Forwarding Status for the trap destinations changes to Disable and a red X is displayed to
indicate that forwarding is disabled. If you disabled forwarding for all of the trap destinations, the
Forwarding Status for the zone is Disable. If you disabled forwarding for a subset of destinations,
the status is Mixed.

17.4.2 Reenable SNMP forwarding for a zone

Reenable SNMP forwarding for a zone. When a zone’s SNMP forwarding is reenabled, forwarding from
Unigy is automatically resumed for the zone and alerts start to be sent again to all configured trap
destinations associated with the zone.

Note
When a zone or trap destination’s forwarding status is set to Disable, alerts continue to be sent to the
UMS Monitoring Dashboard, which allows technicians on site to continue to view alerts while SNMP
forwarding is disabled.

December 3, 2019 IPC Confidential

 17.4: Maintenance mode procedures 597

You must have the Advanced Administrator, IPC Project Manager, or IPC Certified Tech role to perform
this procedure.
1. Click Configuration ➤ Sites ➤ SNMP Forwarding ➤ Maintenance.
The Zone Maintenance Status panel is displayed.
2. Click the zone for which you are reenabling SNMP forwarding.
The trap destinations associated with the zone are displayed in the Trap Destination grid.
3. Select the check box for the trap destinations you are enabling.
To enable SNMP forwarding for the zone, select all of the trap destinations.
4. Click Enable.
The Forwarding Status for the trap destinations changes to Enable and a green check mark is
displayed to indicate that forwarding is enabled. If you enabled forwarding for all of the trap
destinations, the Forwarding Status for the zone is Enable. If you enabled forwarding for a subset
of destinations, the status is Mixed.

17.4.3 Disable SNMP forwarding to a trap destination

Disable forwarding of Unigy alerts to a trap destination (NOC) by disabling the forwarding for one or
more zone associations in the trap destination configuration. Other configured trap destinations will
continue to receive traps from those zones, if they are associated with them.

Note
When a zone is first associated with an SNMP forwarding trap destination configuration, the zone’s
forwarding status is set to Enable by default.

You can use the Zone Maintenance Status panel in one of two ways: to reveal (but not select) all the
destinations associated with a zone, click on the Zone Name or within the row. This action does not
check any of the check boxes and therefore does not select any zone or destination. Alternatively, you
can reveal and select all the destinations associated with zone by clicking the check box next to a Zone.
The following procedure uses the first method.
1. Click Configuration ➤ Sites ➤ SNMP Forwarding ➤ Maintenance.
The Zone Maintenance Status panel is displayed.
2. Click the zone associated with the trap destinations for which you are disabling SNMP forwarding.
The trap destinations associated with the zone are displayed in the Trap Destination grid.
3. Select the check box for the trap destinations you are disabling.
4. Click Disable.
The Forwarding Status for the trap destinations changes to Disable and a red X is displayed to
indicate that forwarding is disabled.
5. Repeat steps 2 - 4 to disable the forwarding for other zones associated with this trap destination.

Note
The SNMP Forwarding can be reenabled for a trap destination by following these steps and choosing
Enable in step 4.

17.4.4 Place a zone into maintenance mode to disable BCP plan activation
When you perform certain maintenance procedures, place a zone into maintenance mode to prevent
automatic BCP plan activation and the associated CDI redirection.

IPC Confidential Unigy 4.3

Enterprise Guide
598 17.4: Maintenance mode procedures

For information on preventing SNMP alert forwarding, refer to Disable SNMP forwarding for a zone on
page 596.
For information on taking a zone out of maintenance mode, refer to Take a zone out of maintenance
mode to reenable BCP plan activation on page 598.
1. Log in to the UMS: https://vip.
2. Click Configuration ➤ Enterprise ➤ System ➤ Zones.
3. In the Zones list, click the zone you are placing into BCP maintenance mode.
4. In the BCP Status field within the BCP Role and Status section, select Maintenance then click
Save.

17.4.5 Take a zone out of maintenance mode to reenable BCP plan activation
If you placed a zone into maintenance mode to disable automatic BCP plan activation during a
maintenance operation, after you complete the maintenance, take the zone out of maintenance mode to
reenable BCP plan activation.
For information on placing a zone into maintenance mode, refer to Place a zone into maintenance mode
to disable BCP plan activation on page 597.
1. Log in to the UMS with the zone VIP: https://vip.
2. Click Configuration ➤ Enterprise ➤ System ➤ Zones.
3. In the Zones list, click the zone you are taking out of BCP maintenance mode.
4. In the BCP Status field within the BCP Role and Status section, select Active then click Save.

17.4.6 Place a cluster into maintenance mode to enable control of HA failovers

When you perform a maintenance procedure on one or both appliances in an HA cluster, such as
deploying an update or replacing hardware, place the cluster into maintenance mode before performing
the maintenance to prevent an HA failover during the procedure due to hardware, software, or network
failure. This does not prevent manual failovers.
Prerequisites:
When you place a cluster into maintenance mode, the Standby appliance is available for maintenance. If
the appliance you want to maintain is not the Standby appliance, force an HA failover to make the
Active appliance the Standby appliance as described in Force an HA failover on page 546.
When a cluster is in maintenance mode, the firewall is raised to block communication between the
appliances in the cluster, data replication between the appliances is turned off, and monitoring between
the appliances is stopped to prevent failover. If the Active appliance fails while the cluster is in
maintenance mode, the Standby appliance cannot assume the role of Active appliance.
For most maintenance operations, after you place the cluster into maintenance mode you place the
Standby appliance into maintenance mode as described in Place an appliance or Media Gateway into
maintenance mode to indicate it is unavailable on page 599.
For information on taking the cluster out of maintenance mode, refer to Take a cluster out of
maintenance mode to resume normal HA operation on page 599.
1. Log in to the UMS: https://vip.
2. Click Configuration ➤ Sites ➤ Servers ➤ Clusters.
3. In the Clusters list, click the zone cluster.

December 3, 2019 IPC Confidential

 17.4: Maintenance mode procedures 599

4. Within the Members tab, click Start Maintenance.

The HA Warning dialog box is displayed.
5. Click OK.
Wait for the state of the appliances to change to maintenance mode. The state of the Active appliance
should be MAINTENANCE_AVAILABLE and the state of the Standby appliance should be
MAINTENANCE_UNAVAILABLE. Also, in the Cluster Operation Output Details panel, the
Orchestrator response should be HTTP 200 OK.

17.4.7 Take a cluster out of maintenance mode to resume normal HA operation

If you placed a cluster into maintenance mode to perform a maintenance procedure, when the procedure
is complete, take the cluster out of maintenance mode so it can resume normal operation.
Prerequisite
Before you perform this procedure, take the Standby appliance out of maintenance mode and indicate
that the maintenance operation is complete by performing the following procedures if you have not
already done so: Take an appliance or Media Gateway out of maintenance mode on page 600 and
Indicate that maintenance on the Standby appliance is complete on page 601.
1. Log in to the UMS in the zone for which you are taking the cluster out of maintenance mode:
https://vip.
2. Click Configuration ➤ Sites ➤ Servers ➤ Clusters.
3. In the Clusters list, click the zone cluster.
4. Within the Members tab, click Maintenance Done.
The HA Warning confirmation message box is displayed.
5. Click OK.
The State of both appliances changes to AVAILABLE and the system reboots the Standby appliance.
If the system does not reboot the Standby appliance, reboot it manually by performing the procedure
Reboot CCM on page 587.

17.4.8 Place an appliance or Media Gateway into maintenance mode to indicate it is

unavailable
When you perform a maintenance procedure on a Converged Communications Manager (CCM),
Aggregated Converged Communications Manager (ACCM), Media Gateway (MG), or Media Manager
(MM), such as deploying an update or replacing hardware, it might be necessary place the appliance into
maintenance mode before you perform the procedure to suppress alert notifications and inform the
system that the appliance is not available.
After you complete the maintenance procedure, take the appliance out of maintenance mode. For
information on this procedure, refer to Take an appliance or Media Gateway out of maintenance mode
on page 600.
1. If you are placing an appliance that is part of an HA pair into maintenance mode, place the cluster
into maintenance mode, if it is not already in this mode, by performing the procedure Place a cluster
into maintenance mode to enable control of HA failovers on page 598.

IPC Confidential Unigy 4.3

Enterprise Guide
600 17.4: Maintenance mode procedures

Note
This step does not apply if you are performing a software upgrade that uses the Automatic Deployment
option or Enterprise Install. It also does not apply if you are upgrading the software on Media
Managers or Media Gateways after a Unigy software upgrade.

2. Click Tools ➤ Deployment ➤ Hardware Deployment.

3. In the Deployment Zones panel, click the zone associated with the appliance you are placing into
maintenance mode.
4. Do one of the following according to the type of device you are placing into maintenance mode:
• For a standalone zone, click the Servers tab then click the ACCM.
• For an HA zone, click the Servers tab then click the Standby CCM or ACCM.
• For a Media Manager, click the Servers tab then click the Media Manager (Media Server).
• For a Media Gateway, click the Media Gateways tab then click the MG.

Note
Maintenance mode does not impact existing or new calls on a Media Gateway. An alert is
generated when the Media Gateway is placed into maintenance mode.

5. Click Switch to Maintenance Mode.

The Confirmation message box is displayed.
6. Click Yes.
The system displays the message Device Mode changed successfully.
7. Click OK.

17.4.9 Take an appliance or Media Gateway out of maintenance mode

When you perform a maintenance procedure on a Converged Communications Manager (CCM),
Aggregated Converged Communications Manager (ACCM), Media Gateway (MG), or Media Manager
(MM), such as deploying an update or replacing hardware, you place the appliance into maintenance
mode before performing the procedure to suppress alert notifications. After the maintenance is complete,
take the appliance out of maintenance mode to resume normal operation.
For information on placing an appliance into maintenance mode, refer to Place an appliance or Media
Gateway into maintenance mode to indicate it is unavailable on page 599.
1. Click Tools ➤ Deployment ➤ Hardware Deployment.
2. In the Deployment Zones panel, click the zone associated with the appliance you are taking out of
maintenance mode.
3. Within the Servers tab or the Media Gateways tab, click the appliance then click Switch to Active
Mode.
The Confirmation message box is displayed.
4. Click Yes.
The system displays the message Device Mode changed successfully.
5. Click OK.

December 3, 2019 IPC Confidential

 17.5: Database backup and restore procedures 601

17.4.10 Indicate that maintenance on the Standby appliance is complete

When you perform a maintenance procedure on the Standby appliance in an HA zone, use this
procedure to indicate that the maintenance work on the appliance is complete. This applies only to the
Standby appliance.
Indicating that maintenance on the Standby appliance is complete, by clicking Service is Done,
prepares the system for one of the following:
• If maintenance on the first appliance is complete and the maintenance procedure will also be
performed on the second appliance, clicking Service Done makes the cluster available for a manual
failover so that the maintenance can be performed on the other appliance.
• If maintenance is complete on both appliances, or the maintenance is being performed on only one
appliance, clicking Service Done enables the cluster to be taken out of maintenance mode.
1. If necessary, log in to the UMS: https://vip.
2. Click Configuration ➤ Sites ➤ Servers ➤ Clusters.
3. In the Clusters list, click the zone cluster.
4. Within the Members tab, click the standby appliance then click Service Done.
The state of the Standby appliance changes to MAINTENANCE_AVAILABLE.

17.5 Database backup and restore procedures

17.5.1 Back up and restore considerations
This topic describes the databases that are backed up, how these databases are maintained, the impacts
of restoring the data, and limitations caused by partial replication and Multi-tier Replication.
The Unigy database is involved in backup and restore procedures. The Unigy database includes
configuration, device, and license data for every zone in the enterprise. Each zone maintains a local copy
of this database. When data replication is enabled and partial replication is disabled, interzone
notifications for data changes are sent from each zone to every other zone in the enterprise, so every
zone’s local database includes this data. If partial replication is enabled, a set of data, referred to as the
partial replication data, is stored locally in each generator zone, but is replicated only to the collector
zones.
Beginning with Unigy v2.0, an evolutionary approach to maintaining the Unigy database was
implemented. Database relationships cannot change and columns and tables cannot be removed. This
ensures that from a data standpoint, the Unigy database is backward compatible. A zone that has the
latest database schema initially populates required fields in the new tables with default data. When you
perform a Unigy database backup with an Enterprise backup job, always select a zone that has the latest
software version to ensure that all data is backed up.
If partial replication is enabled, Archive all Zone backup jobs are executed according to the following
rules:
• Backup and restore jobs can be performed only in collector zones. You cannot perform archive
backups or restores in generator zones.
• The archive job runs only in the designated collector zone. It backs up the history data that is
specified in the backup job configuration then runs a job in each applicable zone to delete the
archived data.
• If the enterprise includes multiple realms and partial replication is enabled, to backup the designated
data in all zones, you must run the Archive all Zone backup in a collector zone in each realm. This is

IPC Confidential Unigy 4.3

Enterprise Guide
602 17.5: Database backup and restore procedures

required because the Archive all Zone backup archives data only for the zones in the instances within
the realm. It restores the data only in the zone in which you run the restore.
• If you want to make the first zone that was deployed in the enterprise a generator zone, you must
remove the recurring Archive all Zone backup job that was automatically created when the zone was
initially deployed. Create the recurring backup job and retention policy in one of the collector zones.
A recurring Archive all Zone backup job helps to prevent out-of-memory issues that can be caused by
a high volume of call history data.
If partial replication is enabled, do not change a collector zone to a generator zone or a generator zone to
a collector zone when an Enterprise or Archive All Zone backup is running because this can prevent the
backup from completing or can result in loss of backup data.
It is usually not necessary to restore the Unigy database in a multizone enterprise unless one of the
following conditions exists because the database can be loaded from another zone:
• All zones in the enterprise fail.
• Partial replication is enabled and all collector zones fail.
• Database becomes corrupted.
• All zones in a mixed zone enterprise are restarted and the zone that provides the database dump for
the other zones has a lower version schema that does not include data that is available in the higher
version schema.
• An upgrade requires new COP software and all zones are being upgraded at the same time.
Restoring the Unigy database is a manual, command-line procedure that cannot be run from the UMS
due to file contention issues.
In an enterprise that has zones with different Unigy software versions deployed, when a zone that has
the highest version provides the database for other zones, zones that have a lower version of the database
schema take only the data that their schema supports. If a zone with a lower version of the database
schema provides the database, zones at higher versions take a copy of the database and populate the
additional columns and tables in their schemas with default values. If a higher version zone loads a
lower version database after data was added to tables and columns that apply only to the higher version
schema, this data will be lost because it is not available in the lower version database. If this occurs, it
might be necessary to restore an Enterprise backup to repopulate this data.
To ensure that Multi-tier Replication has no impact on Enterprise backups, it is recommended that you
run these backups when the Wide Area Data Replication tier is not experiencing any issues. Running a
backup when one or more data centers are isolated from the others due to provisioning, connectivity, or
other types of issues, can result in loss of data.
If you are performing an Enterprise backup or restore and Multi-tier Replication is enabled for the
enterprise, it should be enabled for all data centers in the enterprise before you perform the backup or
restore. The operation should be performed from a portal zone, preferably a portal zone that is a
collector zone and that has the highest database schema. This will help to ensure that no data is lost.

Impact of restoring user and archive backups

Restoring a zone’s local user or archive data does not replace the Unigy database, so this data can be
restored from the UMS on a live system. Interzone notifications send the updated local database changes
as the data is restored. Users are replicated to every zone in the enterprise, so every zone has the same
user data in its local database.
Communication history replicates in real time to all zones, unless partial replication is enabled, in which
case this data is replicated only to collector zones. Archive backups archive the communication history
records that were added to the database before a specific date.

December 3, 2019 IPC Confidential

 17.5: Database backup and restore procedures 603

Important
Beginning with Unigy v2.0.1.5 archive backups use a different format to reduce the size of the backup .tar
file and the time required to back up and restore a file. This format is not backward compatible, therefore,
you cannot restore an Archive all Zone backup that was created prior to deploying Unigy v2.0.1.5 in a
v2.0.1.5 or higher zone.
When you restore an Archive all Zone backup, it is no longer necessary to disable data replication in all
zones in the enterprise because the data is restored only in a single zone. The data is replicated to other
zones only if the zones are restarted and the zone in which the data was restored is the source of the
database dump.
After an Archive all Zone backup is run, the system deletes the archived data from all appropriate zones,
therefore, the data is not available for reporting purposes unless it is restored to the system. If partial
replication is enabled and there is more than one realm in the enterprise, the data is backed up and
purged only from the zones associated with the realm for which the data was archived. If partial
replication is not enabled or there is only one realm in the enterprise, the data is backed up and purged
from all zones in the enterprise.
The row IDs for the restored data are the same as when they were backed up, the restore does not add
new rows to the tables.

Impact of restoring Enterprise backups

In a multizone enterprise, in most scenarios it is not necessary to restore Enterprise backups – instead let
interzone notifications handle loading a current copy of the database. This synchronizes content, not
structure (database schema). If a zone is down because of a failure or maintenance, interzone
notifications provide the zone’s content for its local Unigy database when it comes back up and data
replication is enabled. Data Services sends a copy of the Unigy database to any zone that had data
replication disabled for 30 minutes or more. Therefore the following restore scenarios in multizone
systems are resolved by database replication, provided that at least one zone is accessible, functioning,
and contains all required data:
• Recovery from a failed CCM or ACCM appliance after the hardware was replaced and the zone
redeployed.
• Loss of network connectivity so that all zones are unreachable for 30 minutes or more.
• Rebooting a CCM or ACCM.
• Disabling data replication then reenabling it.
Restoring an Enterprise backup is a manual, command-line procedure. The procedure requires not only
disabling data replication in all zones, should any be functioning, but also stopping OCCAS in the zone
at which the backup is being restored. This is because OCCAS caches data and must be stopped and the
cached data cleared before restoring a backup. This is also why it is a manual, command-line procedure
– the UMS needs OCCAS to be running.

Certificates
Certificate data is included in Enterprise backups.

Note
Image and Enterprise backups include the certificates valid at the time the backup was created.

IPC Confidential Unigy 4.3

Enterprise Guide
604 17.5: Database backup and restore procedures

Summary
Enterprise backups should be restored only when necessary because they are dependent on network
connectivity, require disabling data replication, OCCAS, or both, and are not necessary in most
scenarios.

Note
Interzone notifications are sent immediately with a zone’s updates, and have large buffers in memory that
are queued in persistent disc storage if the memory buffers fill. This ensures that interzone notifications
do not interfere with call processing.

Warning
You can view the MySQL database, however, do not make changes through a database utility or MySQL
statements because this can result in a corrupt database. All database changes should be made through
the UMS.

User accounts with the Security Administrator, Advanced Administrator, IPC Project Manager, or IPC
Certified Tech role can schedule and perform backups, restore backups, upload and download backups,
view events, and work with the backup retention policy in the UMS. Accounts with the Basic
Administrator role can view, schedule, and download backups, and view events.

Caution
Be mindful of business hours when performing backups and restores. Perform backup and restore
operations during non-trading hours.

17.5.2 Remote storage of backup files

Creating a remote backup server and specifying it for a backup job automatically stores backup data sets
on a remote system at a customer’s site when a backup job runs immediately or in the future.
This feature stores backup data sets somewhere other than the Converged Communications Manager
(CCM) or Aggregated Converged Communications Manager (ACCM) in a zone. This ensures that a
backup is available if the CCM or ACCM fails.
When remote backup jobs listed within the Backup panel are deleted manually or by the zone’s backup
retention policy, the jobs are deleted from the UMS, and if the user account specified in the remote
server configuration has delete permission on the remote server, the backup files are deleted from the
remote system. Remote storage uses SCP and NFS to transfer the backup .tar files to a remote server
using credentials. Remote storage locations, like backup data sets and events, are periodically replicated
between the appliances in HA pairs and between zones.
To set up remote storage, specify the remote system’s IP address or hostname, the transfer type (SCP or
NFS), connection properties, and a directory path on the remote system when scheduling the backup job.
When the backup job runs, Unigy transfers the assembled backup data set to the specified directory path
on the remote system.
Consider the following when storing backup files on a remote system:
• Remotely stored user and archive backup files can be restored, uploaded, and downloaded using the
UMS.
• Remotely stored enterprise backup files can be uploaded and downloaded using the UMS, but should
be restored from the command line.

December 3, 2019 IPC Confidential

 17.5: Database backup and restore procedures 605

• Remotely stored backup files cannot be restored (user and archive), downloaded, uploaded, or deleted
if the remote system’s configuration has been deleted because the UMS no longer has the credentials
to access the remote system. If the backup event is still listed in the Events page, the remote system
can be configured again using the information in the backup event’s Storage File field.
• A zone’s backup retention policies are enforced on remotely stored backup files by removing them
from the Backup panel and the remote system. Ensure that the user account that is specified in the
remote server configuration for the backup job has delete permission for these files on the remote
server.
• External backup files are uploaded to the UMS’s default location for backup files, /var/opt/ipc/
service_backup_restore. Other than remotely stored user and archive backups listed in the
Backup panel, this is the only location from which a backup file can be restored.

Tip
It is a good idea to store a current backup of the Unigy database on a remote server. This can be done
with an enterprise backup. It is also recommended that each zone have the same remote server
configured.

See the following for the procedures noted in the previous considerations: Add or edit a remote backup
server on page 605.

SCP file transfer

SCP file transfer requires the following configuration of a remote server:
• The target directory on the remote system must exist for remote backup to succeed. This directory is
the location where remote backup files are stored.
• A remote system user with write permission for the target directory must exist. You specify the name
and password of this user when you configure the remote backup job. To enable deletion of the
backup files from the remote server, the user account should also have delete permission.
• SSH access must be enabled for the remote system user.
• Port 22 is the default port for SCP file transfer on a CCM or ACCM.

NFS file transfer

NFS file transfer requires the following:
• The target directory on the remote system must exist for remote backup to succeed. This directory is
the location where remote backup files are stored.
• The target directory must be exposed using NFS. On a Linux system, for example, edit the /etc/
exports file so that it contains a reference to the directory. See the operating system documentation
for instructions about exposing the target directory using NFS.
Unlike SCP, NFS does not require the specification of a user to transfer the backup files to a remote
server.

17.5.2.1 Add or edit a remote backup server

Complete this procedure to create and configure a remote backup server at a customer’s site. This can be
done before scheduling a backup, or as part of scheduling a backup. More than one remote server can be
configured.
The following prerequisite information is required before completing this procedure:

IPC Confidential Unigy 4.3

Enterprise Guide
606 17.5: Database backup and restore procedures

• IP address or host name of the customer’s remote server. The server must support SCP or NFS.
• Complete directory path to where the backup .tar files will be stored. In most instances a drive
letter is not required, only the path from the root directory.
• Remote server name.
• File transfer protocol to use, SCP or NFS. The following additional information is required,
depending on the protocol:
• SCP requires a user name and password authorized to access and write to the backup directory,
SSH access, and default TCP port 22 on a CCM or ACCM.
• NFS requires that the backup directory is exposed using NFS. For example, edit the /etc/
exports file so it contains a reference to the target directory.

Note
As an alternative to using a remote server, a customer can request that backup files be downloaded and
provided to them on disk or USB drive.

1. Click Tools ➤ Backup & Restore.

2. Click the Schedule tab.
The Schedule panel is displayed and lists the currently scheduled backup and restore jobs in a grid.
3. Click Schedule Backup.
The Schedule New Backup Job panel is displayed.
4. For the Storage Type, select Remote.
5. Do one of the following to add, edit, or delete a remote server:
• To add a new remote server, click Edit to the right of Remote Server. The Remote Backup panel is
displayed.
• To edit or delete a configured remote server, select the server in the grid then click Edit.
Figure 117: Remote Backup panel

6. Do one of the following:

• To add or edit a remote server, enter or change the following values:
• Type: file transfer protocol, SCP or NFS.
• Location Name: name of the remote server.
• Server IP/Hostname: remote server IP address or hostname

December 3, 2019 IPC Confidential

 17.5: Database backup and restore procedures 607

• User Name and Password: SCP credentials. Credentials are not required for NFS. To enable
deletion of the backup files, the specified user account must have delete permission on the
remote server.
• Remote Directory: path of the target directory in which to store the backup .tar files. If you
selected NFS for the Type, begin the path with a forward slash (/). SCP does not require the
slash.
• To remove a remote server:
1. Select the server in the grid.
2. Click Delete then in the Delete Confirmation dialog box, click Yes. The message The
BackUp entries will continue to exist in the local database and
will not be deleted from remote server. To delete the entries
from remote server please contact System Administrator. is displayed.
3. Click OK. The server is removed from the grid, but as stated in the message, deleting the server
does not delete the .tar files stored on the server.
7. If you are adding or editing a remote server, click Save.
For a new server, the server information is added to the grid. For an existing server, the data in the
grid is updated.
8. Click Cancel to close the Remote Server dialog box and return to the Schedule New Backup Job
panel.

17.5.3 Download a backup file

Complete this procedure to download a backup file from a CCM, ACCM, or remote server to a location
accessible from the UMS. Downloading a backup file creates a copy of the backup in a location that the
user account’s PC can access. It can be the PC’s local hard drive, a network drive, or removable media.
The backup retention policy does not affect downloaded backup files. It may also be a customer’s policy
to download some backups before they are deleted by the retention policy. It is a good idea to save
backups in an external location that is available in the event of a catastrophic failure of the enterprise,
especially if such a failure causes the remote server to fail.
Prerequisites:
An account that has one of the following roles is required to complete this procedure: Basic
Administrator, IPC Project Manager, Advanced Administrator, or IPC Certified Tech.
1. In the menu bar, click Tools ➤ Backup & Restore.
The Backup & Restore page opens with the Backup tab selected. The Backup page displays the
backup files currently stored by the system. For more information on the fields in this tab, see Backup
& Restore: Backup on page 608.
2. Click a backup file in the list.
3. Click Download.
The Save As dialog box opens.
4. Select or create a directory on the file system, and click Save.
The backup file is saved to the specified location in the file system, and the Save As dialog box
closes.

IPC Confidential Unigy 4.3

Enterprise Guide
608 17.5: Database backup and restore procedures

17.5.3.1 Backup & Restore: Backup

Within this panel, you can view completed backup jobs, upload a backup file from a remote server or
other external storage device, download a backup file to an external location, restore a user or archive
backup, or delete a backup file from a zone’s local backup directory or a remote server.
The backup files displayed within the panel are stored on the CCMs or ACCMs in the zones for which a
backup was run or on a remote server.
Backup files stored locally can be deleted manually from the UMS or automatically through a zone’s
retention policy. Deleted files are removed from this panel and from the zone CCMs or ACCMs.
Remotely stored backups can also be deleted manually or by the zone’s retention policy. The files are
removed from the Backup panel and the remote server.
You can upload backup files stored on a remote server or other external storage device to the local
backup directory on the CCMs or ACCMs in a zone.
If Multi-tier Replication is enabled, it must be enabled for all data centers in the enterprise, or the data
centers must be members of the default data center, before you perform an Enterprise backup.
For more detailed overview information and backup and restore procedures, refer to the Back Up and
Restore Guide.
To open this panel, click Tools ➤ Backup & Restore. The Backup tab is displayed by default.
The ability to perform the various operations available within this panel is controlled by the roles
assigned to a user account:
• User accounts with the Security Administrator, Advanced Administrator, IPC Project Manager, or
IPC Certified Tech role can view, restore, upload, download, and delete backup files from this panel.
• User accounts with the Basic Administrator role can view and download backup files.
• User accounts with the Auditor and System Auditor roles can view the backup information.
Figure 118: Backup page

December 3, 2019 IPC Confidential

 17.5: Database backup and restore procedures 609

Table 67: Backup tab

Name Description Values Notes

ISO/TAR Date and time the Date and time in the format specified for your Backup files
Creation backup file was user account. prior to Unigy
Date/Time created. v2.0.1 are .iso
files. Unigy
v2.0.1 or higher
backup files
are .tar files.
Read-only.
Software Version number of Version number. For information
Version the Unigy software on the version
when the backup naming
was created. conventions,
refer to the
Enterprise
Guide.
Read-only.
Zone Zone in which the Valid zone names that are configured in the In an HA zone,
backup was created Unigy enterprise. the backup file
and where it is resides on both
currently stored. CCMs or
ACCMs in the
zone.
Read-only.
Type/Scope Type of backup that • ENTERPRISE_WIDE_DATA: Backs up the If the enterprise
was performed. master Unigy enterprise database. includes multiple
realms, and
• USER_DATA_ALL: Backs up the data for all partial replication
Unigy users. is enabled, the
• USER_DATA_SINGLE: Backs up the data for ALL_HISTORY_
one or more selected users. ALL_ZONES
backup purges
• ALL_HISTORY_ALL_ZONES: Backs up the
the data only
span of history data specified then deletes
from the zones
the archived data from all applicable zones.
associated with
the instances in
the associated
realm. If partial
replication is not
enabled or there
is only a single
realm, the
backup purges
the archived
data from all
zones in the
enterprise.
Read-only.

IPC Confidential Unigy 4.3

Enterprise Guide
610 17.5: Database backup and restore procedures

Table 67: Backup tab (continued)

Name Description Values Notes

Size (KB) Size of the File size in kilobytes (KB). Read-only.
assembled backup
file.
File Name Path and name of The file names use the naming convention: To see the
the backup file. backup-type_date-and- remote server
time_unique-ID-number.file- configuration,
format-extension. select a remotely
The local default path is: /var/opt/ipc/ stored backup
service_backup_restore. job within the
Event History
Backup files stored on a remote server display
tab. The path is
the configured remote directory path.
in the Storage
File field.
The extension
for Unigy v2.0.1
files is .tar. The
extension for
versions prior to
v2.0.1 is .iso.
Read-only.

Table 68: Buttons

Name Description
Restore Restores the selected backup file if the backup type is USER_DATA_ALL,
USER_DATA_SINGLE, or ALL_HISTORY_ALL_ZONES and the zone is healthy, up, and
available. Only user and archive backup files can be restored from the UMS.
If partial replication is enabled, archive ALL_HISTORY_ALL_ZONES backups can be
restored only in a collector zone. If partial replication is enabled, restore the backup in a
zone associated with the realm for which the backup was created. The data is restored
only in the zone for which the restore is run, it is not replicated to other zones unless the
zones restart and the zone in which the data was restored is the source zone for the
database dump.
Beginning with Unigy v2.0.1.5, archive backups use a different format to reduce the size
of the backup .tar file and the time required to back up and restore a file. This format is not
backward compatible, therefore, you cannot restore an Archive all Zone backup that was
created prior to Unigy v2.0.1.5 to a v2.0.1.5 or higher zone.
Restoring enterprise backups is a command line procedure. In a multizone enterprise, it is
usually not necessary to restore an enterprise backup if the database is available from
another zone and it is not corrupt.
Upload Uploads a backup file to a zone’s local backup directory, /var/opt/ipc/
service_backup_restore. The Upload button opens the Upload Backup Job dialog
box where you select the zone to which you want to upload the file and the name of the
backup file to upload.

December 3, 2019 IPC Confidential

 17.5: Database backup and restore procedures 611

Table 68: Buttons (continued)

Name Description
Download Downloads a backup file to an external data storage device. The Download button opens
the Save As dialog box. Select the folder to which you want to download the backup file
then click Save.
If you need to upload a file stored on a remote server but do not have direct access to the
server, download the file then upload it to the appropriate zone.
Delete Deletes the selected backup file. The Delete button displays the Delete Confirmation
dialog box. Click OK to delete the selected file from the CCMs or ACCMs in the zone. This
does not affect downloaded files stored in other locations. You can also use Delete to
delete the job associated with a backup file that is stored on a remote server and to delete
the file from the remote server.

17.5.4 Upload a backup file

Complete this procedure to copy a backup from a location accessible to the PC of the user logged into
the UMS to the CCM or ACCM. Backups can be restored only if they are in the default backup directory
of a CCM or ACCM at which the user is logged into the UMS: /var/opt/ipc/
service_backup_restore. Remotely stored user or archive backup jobs listed in the Backup page
can also be restored. Backup files can also be uploaded to another zone.
Prerequisites:
• Backup files cannot be uploaded if they are listed in the Backup page in either the /var/opt/ipc/
service_backup_restore directory on the CCM or ACCM of the UMS at which the user is
logged in. Uploading cannot replace existing backup files.
• Backup files stored in a remote location that is not available to the PC of the user logged into UMS
cannot be uploaded without first downloading to a location that the PC can access. Enterprise backup
files in customers’ remote storage locations have to be downloaded to the user’s PC first, then
uploaded. See the procedure, Download a backup file on page 607, to copy a backup file from a
remote storage location to a PC before uploading it.
• An account that has one of the following roles is required to complete this procedure: IPC Project
Manager, Advanced Administrator, or IPC Certified Tech.
1. Click Tools ➤ Backup & Restore.
The Backup & Restore page opens with the Backup tab selected. The Backup tab displays the backup
files currently stored by the system. For more information on the fields in this tab, see Backup &
Restore: Backup on page 608.
2. Click Upload.
The Upload Backup Job dialog box opens.
Figure 119: Backup & Restore - Upload Backup Job

3. Select the Zone to which the system will upload the backup file.

IPC Confidential Unigy 4.3

Enterprise Guide
612 17.5: Database backup and restore procedures

Selecting a zone other than the current zone uploads the backup file to the current zone and the
selected zone. Selecting a different zone is not necessary in most situations because the uploaded
backup is periodically replicated to all zones.
4. Click Choose File, choose the file you are uploading, then click Open.
One of the following happens:
• If the backup file is already in the database, the system displays the message Backup file
exist with same name in the selected zone. View the list within the Backup tab
to find the backup with the same name, date, and type. Use the column heading to filter the list if it
cannot be easily located. Backup files are deleted in the zone where they were created.
• The backup file is uploaded to the system and displayed in the list of backup files within the
Backup tab.

17.5.5 Configure a recurring archive backup job and retention policy

In a large trading environment, call history data can consume a considerable amount of space within a
fairly short period of time, which can result in out of memory issues. To prevent this from happening, a
recurring Archive all Zone backup job and retention policy are automatically created when the first zone
in the enterprise is deployed. This topic describes how to configure the backup job and retention policy
if adjustments are required or you have to move the job to a different zone.
When you configure an Archive all Zone backup, you specify the zone in which it runs and the number
of days worth of data you want to retain in the database. After the system archives the data it deletes it
from the database.
Within a multizone enterprise in which partial replication is not enabled, only one recurring Archive all
Zone backup job is required because the backup archives the history data from all zones in the
enterprise. If partial replication is enabled and the enterprise includes more than one realm, a recurring
Archive all Zone backup and retention policy are required for each realm in the enterprise. This is
because the backup archives and purges the data only for the zones within the associated realm. When
partial replication is enabled, the Archive all Zone backups must be run from a collector zone that stores
the partial replication data for all of the zones within the associated realm.
If you need to make the first zone that was deployed in the enterprise a generator zone and the Archive
all Zone backup is configured to run from that zone, change the backup job to run in a different collector
zone within the same realm.
The amount of call history data accumulated is based on call volume. Begin by scheduling the backups
to run once a week, however, if the system begins to display memory-related issues, schedule the
backups to run more frequently. Due to potential performance issues that can occur when certain seed
data values are changed, no more than fourteen days of data should be retained.

Important
If an archive backup fails due to a high volume of data, run several smaller archive backups by setting the
number of days in the Archive Scope field to a number that archives a smaller subset of the data, that is,
specify a higher number that leaves more data in the database.

An archive backup includes the following data:

• Call history
• User account and password change history
• Login and logout history

December 3, 2019 IPC Confidential

 17.5: Database backup and restore procedures 613

• Reporting history
• Backup and restore event history
• System job history
To control the number of archived data files that reside on the system at one time, also configure the
backup file retention policy. A policy determines when backup files are purged from the system. Backup
files can be stored locally or on a remote file server. If the archive data must be stored for long periods
on time for regulatory or other purposes, consider downloading the files to an external data storage
device. If you need to restore the data, you can upload it from the remote source.
For information on backup and restore processes and procedures, refer to the Back Up and Restore
Guide .
1. Schedule a recurring Archive all Zone backup by performing the procedure Create or schedule a new
backup on page 363.
2. Configure a backup file retention policy for the backup files by performing the procedure Add or edit
backup retention policies on page 613.

17.5.6 Add or edit backup retention policies

Complete this procedure to add or edit the backup retention policy for one or more zones. A zone’s
retention policy is enforced when it is the controlling zone creating a backup.
A zone can have only one retention policy. The system displays an error message if you attempt to save
a new policy for a zone that already has one.
User accounts that have the Advanced Administrator, IPC Project Manager, or IPC Certified Tech role
can add, edit, or delete retention policies. Users with the Basic Administrator role can edit, but not add
or delete retention policies.
1. In the menu bar, click Tools ➤ Backup & Restore.
2. Click the Policy tab.
The Policy panel is displayed and lists the zones that have backup retention policies.
Figure 120: Policy tab

3. Do one of the following:

• To create a retention policy for a zone that does not have one, click +Add Policy. A form is
displayed to define the new policy.
• To edit a policy, click the policy. A form is displayed with the current policy rules.

IPC Confidential Unigy 4.3

Enterprise Guide
614 17.5: Database backup and restore procedures

Figure 121: Add Policy form

4. To create a new policy, in the Zone field, select a zone that does not have a policy.
5. Select or clear the Number of days check box to indicate whether the system enforces the rule. If you
select the check box, in the # Days field, enter the maximum number of days that files will be
retained. If you clear the check box for an existing rule, the value in the # Days field is removed.
6. Select or clear the Number of backups check box to indicate whether the system enforces the rule. If
you select the check box, in the # Backups field, enter the maximum number of files that will be
retained. If you clear the check box for an existing rule, the value in the # Backups field is removed.
7. Select or clear the Cumulative backup size check box to indicate whether the system enforces the
rule. If you select the check box, in the Size(KB) field, enter the maximum cumulative size of
backups in kilobytes. If you clear the check box for an existing rule, the value in the Size(KB) field is
removed.
8. Click Save.
A message box is displayed.
9. Click OK to close the message box.
The new policy is displayed in the list.

17.5.7 Run the post_restore.sh script

After you restore the enterprise database in a multizone enterprise, run the post_restore.sh script to dump
the database and restore it in all zones except the zone where the database was restored.
Perform this procedure in all zones in the enterprise except the zone where the database was restored.
1. Log in to the Active appliance in the zone through SSH.
2. Run the command su -lp and enter the root user account password.
3. Run the command cd /opt/ipc/ha/scripts to change the current directory.
4. Run the following commands to convert the text file format and change ownership and permissions
for the post_restore.sh script:
• dos2unix post_restore.sh
• chmod 777 post_restore.sh

December 3, 2019 IPC Confidential

 17.5: Database backup and restore procedures 615

• chown root:root post_restore.sh

5. Run the command ./post_restore.sh to run the post_restore.sh script.

17.5.8 Database source zone selection algorithms for database dumps

In a multizone enterprise, when data replication is enabled and the appliances in a zone are restarted, the
zone generally loads a copy of the Unigy database from another zone to ensure that it has the most
current data. The zone can be a preferred zone specified in the zone configuration or a zone determined
by the source zone selection algorithm.
Within this topic, the terms current version and current software version refer to the Unigy software
version specified on the cover of this document. References to previous Unigy versions apply to the
versions, patches, service packs, and hotfixes for these versions that the current version supports.

Zone selection algorithm

The system uses the zone selection algorithm to select a zone that will provide a database dump for a
zone that needs to load a current copy of the database. The algorithm differs based on whether Multi-tier
Replication is enabled. Multi-tier Replication is supported only in enterprises where all zones have
Unigy v3.0.0.1 or higher deployed.
When you configure a zone at Configuration ➤ Enterprise ➤ System ➤ Zones, you can specify a
Preferred Zone that serves as the first choice for the database source whenever the zone needs to load a
copy of the Unigy database. This helps to ensure that the optimal zone provides the database. If a
preferred zone is not specified or the preferred zone is not available, the system uses the zone selection
algorithm to select an appropriate zone to provide the database dump.
Blue Wave zones can load the database from any zone in the enterprise that makes operational sense.
In general, a source zone can provide a database dump for up to two zones concurrently. To determine
the availability of a zone, the database replicator for each zone maintains the zone's current replication
state, which is one of the following:
• Available: The zone is not providing a database dump to any zone, so it is available to be the
database source for up to two zones.
• Partially Available: The zone is currently providing the database for one zone, but is available to
provide the database for one other zone.
• Unavailable: The zone is currently providing the database for two zones, so it cannot provide the
database for another zone until the dump for one of the zones is complete. An exception to this rule is
when Multi-tier Replication is enabled and a portal zone requests a database dump from another
portal zone. In this scenario, a portal zone can provide the database even if it is already providing the
database for two other zones.
You can restart multiple zones simultaneously, however, to prevent possible file contention issues,
restart no more than eight zones at a time. Preferred zones, and where applicable, at least one portal
zone, should be started first.
This algorithm is based on instance, database schema, and proximity priorities. Zones within the same
instance are given higher priority. A zone with the same database schema version has a higher priority
than a zone with a higher schema, which has a higher priority than a zone with a lower schema. For
proximity, a zone on the same street is the first priority, a zone in the same city is the next priority, a
zone in the same state is next, and a zone in the same country is next. Distance beyond country is not
considered by the algorithm. Below is the full priority list. Refer to Standard algorithm priority
workflow on page 619 for details on how the system compiles the priority list.
If Multi-tier Replication is enabled, the system uses the following algorithm:

IPC Confidential Unigy 4.3

Enterprise Guide
616 17.5: Database backup and restore procedures

• If the zone requesting the database dump is a local zone, the system overrides the preferred zone
specification and attempts to load the database from the associated data center's portal zone. If the
portal zone is not available, the zone waits for up to three hours for it to become available. If the
portal zone is not available after the three hour timer expires, the zone loads its local database.
Configuration changes that were not replicated to the portal zone will not be replicated to the other
zones in the enterprise.
• If the zone requesting the database dump is a portal zone, the zone can load the database only from an
active portal zone. A portal zone that is in the suspended state cannot provide a database dump for
another portal zone. If an active portal zone is not available, the zone loads its local database. You can
specify a preferred zone for a portal zone, but it must be another portal zone. To ensure that history
data is replicated properly, the preferred zone for a portal zone that is a collector zone should be
another portal zone that is a collector zone in the same realm. The standard algorithm locates an
available portal zone if the preferred zone is not available.

Note
If Multi-tier Replication is suspended for a data center, the portal zone cannot load the database from
another portal zone. To load the database for a portal zone, perform the procedure Refresh (restart) a
portal zone on page 320. The zone will load the database only if its database is out of sync with the
portal zone that is providing the database dump. If you perform a full database dump for a portal zone,
refresh all of the local zones in the data center by disabling then enabling data replication for each
zone.

Standard algorithm
For the standard algorithm, the system compiles a sorted list of all zones in the enterprise and selects the
most appropriate zone to provide a database dump based on the following priorities:
• Priority 1: Zone specified in the zone configuration as the Preferred Zone. When Multi-tier
Replication is enabled and the zone requesting the database is a portal zone, the preferred zone is
considered only if it is a portal zone.
• Priority 2: A zone in the same instance with the same schema version and the same street that is
Available.
• Priority 3: A zone in the same instance with the same schema version and the same street that is
Partially Available.
• Priority 4: A zone in the same instance with the same schema version and the same city that is
Available.
• Priority 5: A zone in the same instance with the same schema version and the same city that is
Partially Available.
• Priority 6: A zone in the same instance with the same schema version and the same state that is
Available.
• Priority 7: A zone in the same instance with the same schema version and the same state that is
Partially Available.
• Priority 8: A zone in the same instance with the same schema version and the same country that is
Available.
• Priority 9: A zone in the same instance with the same schema version and the same country that is
Partially Available.
• Priority 10: A zone in the same instance with the same schema version that is Available.
• Priority 11: A zone in the same instance with the same schema version that is Partially Available.

December 3, 2019 IPC Confidential

 17.5: Database backup and restore procedures 617

• Priority 12: A zone in the same instance with a higher schema version and the same street that is
Available.
• Priority 13: A zone in the same instance with a higher schema version and the same street that is
Partially Available.
• Priority 14: A zone in the same instance with a higher schema version and the same city that is
Available.
• Priority 15: A zone in the same instance with a higher schema version and the same city that is
Partially Available.
• Priority 16: A zone in the same instance with a higher schema version and the same state that is
Available.
• Priority 17: A zone in the same instance with a higher schema version and the same state that is
Partially Available.
• Priority 18: A zone in the same instance with a higher schema version and the same country that is
Available.
• Priority 19: A zone in the same instance with a higher schema version and the same country that is
Partially Available.
• Priority 20: A zone in the same instance with a higher schema version that is Available.
• Priority 21: A zone in the same instance with a higher schema version that is Partially Available.
• Priority 22: A zone in the same instance with a lower schema version and the same street that is
Available.
• Priority 23: A zone in the same instance with a lower schema version and the same street that is
Partially Available.
• Priority 24: A zone in the same instance with a lower schema version and the same city that is
Available.
• Priority 25: A zone in the same instance with a lower schema version and the same city that is
Partially Available.
• Priority 26: A zone in the same instance with a lower schema version and the same state that is
Available.
• Priority 27: A zone in the same instance with a lower schema version and the same state that is
Partially Available.
• Priority 28: A zone in the same instance with a lower schema version and the same country that is
Available.
• Priority 29: A zone in the same instance with a lower schema version and the same country that is
Partially Available.
• Priority 30: A zone in the same instance with a lower schema version that is Available.
• Priority 31: A zone in the same instance with a lower schema version that is Partially Available.
• Priority 32: A zone in a different instance with the same schema version and the same street that is
Available.
• Priority 33: A zone in a different instance with the same schema version and the same street that is
Partially Available.
• Priority 34: A zone in a different instance with the same schema version and the same city that is
Available.

IPC Confidential Unigy 4.3

Enterprise Guide
618 17.5: Database backup and restore procedures

• Priority 35: A zone in a different instance with the same schema version and the same city that is
Partially Available.
• Priority 36: A zone in a different instance with the same schema version and the same state that is
Available.
• Priority 37: A zone in a different instance with the same schema version and the same state that is
Partially Available.
• Priority 38: A zone in a different instance with the same schema version and the same country that is
Available.
• Priority 39: A zone in a different instance with the same schema version and the same country that is
Partially Available.
• Priority 40: A zone in a different instance with the same schema version that is Available.
• Priority 41: A zone in a different instance with the same schema version that is Partially Available.
• Priority 42: A zone in a different instance with a higher schema version and the same street that is
Available.
• Priority 43: A zone in a different instance with a higher schema version and the same street that is
Partially Available.
• Priority 44: A zone in a different instance with a higher schema version and the same city that is
Available.
• Priority 45: A zone in a different instance with a higher schema version and the same city that is
Partially Available.
• Priority 46: A zone in a different instance with a higher schema version and the same state that is
Available.
• Priority 47: A zone in a different instance with a higher schema version and the same state that is
Partially Available.
• Priority 48: A zone in a different instance with a higher schema version and the same country that is
Available.
• Priority 49: A zone in a different instance with a higher schema version and the same country that is
Partially Available.
• Priority 50: A zone in a different instance with a higher schema version that is Available.
• Priority 51: A zone in a different instance with a higher schema version that is Partially Available.
• Priority 52: A zone in a different instance with a lower schema version and the same street that is
Available.
• Priority 53: A zone in a different instance with a lower schema version and the same street that is
Partially Available.
• Priority 54: A zone in a different instance with a lower schema version and the same city that is
Available.
• Priority 55: A zone in a different instance with a lower schema version and the same city that is
Partially Available.
• Priority 56 A zone in a different instance with a lower schema version and the same state that is
Available.
• Priority 57: A zone in a different instance with a lower schema version and the same state that is
Partially Available.

December 3, 2019 IPC Confidential

 17.5: Database backup and restore procedures 619

• Priority 58: A zone in a different instance with a lower schema version and the same country that is
Available.
• Priority 59: A zone in a different instance with a lower schema version and the same country that is
Partially Available.
• Priority 60: A zone in a different instance with a lower schema version that is Available.
• Priority 61: A zone in a different instance with a lower schema version that is Partially Available.
• Priority 62: If no zones are available, load the local database.

Standard algorithm priority workflow

When a zone is deployed or restarted, the system follows this basic workflow to compile a list of
available zones and select the best zone to provide a database dump. It uses the non-configurable
GET_DATABASE_DUMP_TIMEOUT attribute and the following configurable attributes that are
stored in the /etc/opt/ipc/systemconfig/ds/interzone.properties file when it
compiles a list of the available zones.
• RetryDBDumpRequestTimer=60000: Time interval that the system waits for all zones to respond to a
GET_DATABASE_DUMP request after the initial request returns no available zones. Default is
60000 msec.
• RetryDBDumpRequestCount=180: Number of times the system resends the
GET_DATABASE_DUMP request if no zones were available during the previous request. Default is
180 retries.
• IsUpdatedZoneSelectionRequired=true: Determines which algorithm the system uses. If the
enterprise is a mix of v2.0.1 and v2.0.1.5 or higher zones (true) the system uses the algorithm for a
mixed zone enterprise that includes v2.0.1 zones. This scenario is not supported for Unigy v3.0 or
higher. If all zones are at v2.0.1.5 or higher (false), the system uses the algorithm described in this
topic.
This is the workflow for the algorithm for a single version or mixed version zone enterprise with
v2.0.1.5 or higher zones:
1. Determines whether a preferred zone is configured for the zone. If it is, the system sends a
GET_DATABASE_DUMP request to the zone and waits for a response. If the preferred zone is
available, it sets its state to Partially Available or Not Available, depending on whether it is already
providing a database dump for another zone, then provides the database dump.
If the GET_DATABASE_DUMP_TIMEOUT timer expires without a response or the preferred zone
sends an error response, the system proceeds to the next step.
If Multi-tier Replication is enabled and the zone is a local zone, the system overrides the preferred
zone and uses the portal zone for the associated data center. For a portal zone, the preferred zone
must be another portal zone.
2. Sends a GET_DATABASE_DUMP request to all zones in the enterprise. The zones respond with
their current replication availability and software version.
3. Waits until the DUMP_REQUEST_TIMEOUT (10 seconds) expires to give all zones time to
respond.
4. Analyzes the zone responses:
• If no zones are available, the system resends the GET_DATABASE_DUMP request then waits for
the time specified for the RETRY_DATABASE_DUMP_REQUEST_TIMEOUT attribute. If there
are still no zones available, retries until the number of attempts specified for the

IPC Confidential Unigy 4.3

Enterprise Guide
620 17.5: Database backup and restore procedures

RETRY_DATABASE_DUMP_REQUEST_COUNT is exceeded. If there are still no available

zones, the zone loads its local copy of the enterprise database.
• If one or more zones respond, the system creates a priority list that identifies the zones that fit into
each of the priorities specified.
5. When zones are available, the system sends a GET_DATABASE_DUMP request to the highest
priority zone and waits for the zone to respond within the time interval specified for the
GET_DATABASE_DUMP_TIMEOUT attribute. If the zone selected is now not available, this
process is repeated for the next zone in the list until an available zone is found. If an available zone is
not found, the zone uses its local copy of the enterprise database.

Note
If a preferred zone is in the Not Reachable state, a zone that is requesting a database dump from that
zone will request the database from another zone based on the zone selection algorithm. If a preferred
zone is in the Not Available state, a zone waiting to load the database will wait for up to two hours for the
preferred zone to become available. If during the waiting period the preferred zone enters the Not
Reachable state due to lost network connectivity or other failure, the zone waiting for the database dump
will continue to wait until the timeout threshold is reached even though the preferred zone cannot provide
the database.

Restart all zones in a data center when Multi-tier Replication is enabled

When Multi-tier Replication is enabled and all of the zones in a data center are being restarted, the portal
zone should be the first zone started because the local zones in the data center can obtain the database
only from the data center's portal zone.
If a local zone is restarted before a portal zone is available, any configuration changes made in the local
zone will not be replicated to the enterprise.

Restart all zones within an instance in a single instance enterprise

When it is necessary to restart all zones within an instance, you can restart one zone at a time or all
zones simultaneously, however, if Multi-tier Replication is enabled, start the portal zones before you
start the local zones. If you restart all zones simultaneously, the system does the following:
1. Selects one zone within the instance to serve as the peer zone that provides the database for the other
zones. This is the zone with the lowest zone ID, or if Multi-tier Replication is enabled, it is the portal
zone. The other zones wait while the peer zone loads its local database.
2. When the peer zone is up, it informs the Replicator that it is Available.
3. The other zones send a GET_DATABASE_DUMP request to the peer zone, which accepts the
request from two of the zones, sets its state to Unavailable, and begins the database dump for these
two zones.
4. After the dump completes, there are now three zones that can serve as a database source for the
remaining zones. At this point, the system uses the basic workflow to select zones to provide the
database for the other zones.

Restart all zones within an instance in a multi-instance enterprise

When it is necessary to restart all zones within a single instance in a multi-instance enterprise, the
system does the following:
1. Selects one zone within the instance to serve as the peer zone that provides the database for the other
zones. This is the zone with the lowest zone ID, or if Multi-tier Replication is enabled, it is the portal

December 3, 2019 IPC Confidential

 17.6: Soft Client install, upgrade, and uninstall procedures 621

zone. The other zones wait for the peer zone to load the database, which can come from a preferred
zone in another instance or a zone in another instance that is selected by the algorithm.
2. When the peer zone is up, it informs the Replicator that it is Available.
3. The other zones send a GET_DATABASE_DUMP request to the peer zone, which accepts the
request from two of the zones, sets its state to Unavailable, and begins the database dump for these
zones.
4. After the dump completes, there are now three zones that can serve as a database source for the
remaining zones. At this point, the system uses the basic algorithm to select zones to provide the
database for the other zones.

Restart all zones in all instances

If you need to restart all zones in all instances, restart the zones in one instance then after the zones are
restarted, restart the zones in all other instances, one instance at a time. If there are multiple data centers
associated with an instance, restart the zones in one data center at a time.

17.6 Soft Client install, upgrade, and uninstall procedures

17.6.1 Install the Unigy Soft Client software
The Soft Client is installed on desktop or laptop computers, that are running the Microsoft Windows
operating system, to provide communication services through the computer’s audio interface.
Prerequisites: Before installing the Soft Client software, complete the following tasks:
• Because the Soft Client software can be installed programmatically by an administrator, determine
whether it is already installed by clicking Start ➤ All Programs. If IPC Systems Inc ➤ Unigy
Client is in the Start menu, the software is installed.
• Review the Hardware and software requirements for the Unigy Soft Client on page 623 and ensure
that your computer has the required resources.
• Ensure that you can log in to the computer with an account that has administrator privileges.
• Determine whether the client computer has the Microsoft Windows 32-bit or 64-bit operating system.
• Obtain the IP address or virtual IP address (VIP) for the zone from which you are installing the Soft
Client software.
• Obtain the Soft Client home zone IP address or VIP.
Installation options
The following installation options are available. Both can run interactively, initiated by each end user, or
silently as a background process initiated remotely by a Unigy administrator. For information on remote
installation, refer to Remote Soft Client installation on page 625.
• Full installation: Installs all Soft Client components. This topic describes the full installation
procedure.
• Upgrade: Update packages provide fixes, new features, and other changes. An automated update
module checks periodically for updates. When the system detects a new update, a black box is
displayed in the lower right corner of the Unigy Application (Soft Client) icon in the Microsoft
Windows System Tray. For more information on installing updates, see Upgrade the Unigy Soft
Client software – Microsoft Windows 32-bit on page 630 or Upgrade the Unigy Soft Client software
– Microsoft Windows 64-bit on page 628.
You can uninstall the software by rerunning the Soft Client installer program or from the Microsoft
Windows Remove a program utility within the Control Panel. The Uninstall process removes all Soft

IPC Confidential Unigy 4.3

Enterprise Guide
622 17.6: Soft Client install, upgrade, and uninstall procedures

Client files, folders, and shortcuts. For information on this procedure, refer to Uninstall the Unigy Soft
Client software on page 634.
To perform an interactive full installation:
1. In a browser, access the Soft Client installer .msi file with one of the following URLs:
• Microsoft Windows 32-bit: https://ip_or_vip/image/UnigyClientInstaller-
x86.msi
• Microsoft Windows 64-bit: https://ip_or_vip/image/
UnigyClientInstaller.msi
ip_or_vip is the IP address of the appliance in a Unigy standalone zone or the virtual IP address
(VIP) of the HA zone from which you are installing the software.
2. Click Run to initiate the installation, or Save to download the .msi file to your computer.
If you download the file, double-click it to start the installation.
3. When you are prompted to confirm that you want to run the program, click Run.
The Welcome to the Unigy(TM) Client Setup Wizard window is displayed.
4. Click Next.
5. In the End user License Agreement, read the terms of use, select the I accept the terms in the
License Agreement check box, then click Next.
If any prerequisites have not been completed, the wizard prompts you to complete them before
continuing.
6. In the Destination Folder window, confirm the default installation location or use the Change button
to specify a new location then click Next.
7. In the Install Options window, select one, both, or neither of the following options then click Next:
a) Select the Create Shortcut on Desktop check box if you want the system to add a Unigy Client
(Soft Client) shortcut to the desktop in addition to the shortcut it creates in the Microsoft Windows
Start menu.
b) Select the Install Outlook Add-in check box to provide dynamic integration with Microsoft
Outlook contacts.
8. In the Ready to install Unigy(TM) Client window, click Install.
9. If you see the User Account Control message box, click Yes.
The installation begins. After it completes, the Completed the Unigy(TM) Client Setup Wizard
window is displayed indicating that the installation is complete. After a brief delay, the Unigy Config
Tool dialog box is displayed.
10. In the Unigy Config Tool dialog box, configure the connection to the home zone or to a DHCP server
as described in Configure the Soft Client network connection on page 623 then click Save.
11. In the Save message box, click OK.
12. In the Unigy Config Tool dialog box, click Close.
13. In the Completed the Unigy(TM) Client Setup Wizard window, click Finish.
Results:
• The installer creates the IPC Systems Inc folder and Unigy Client and Unigy Client Configuration
Tool short cuts in the Microsoft Windows Start ➤ All Programs menu. Use the Unigy Client
shortcut to run the Soft Client and use the Unigy Client Configuration Tool shortcut to change the
configuration or to redirect the Soft Client to a different zone if a BCP plan is activated.

December 3, 2019 IPC Confidential

 17.6: Soft Client install, upgrade, and uninstall procedures 623

• If you selected the Create Shortcut on Desktop option, the system adds the shortcut to the desktop.
• If you selected the Install Outlook Add-in option, the system installs and enables the add-in within
Microsoft Outlook.

Note
Restarting the client computer after the installation is not required.

17.6.1.1 Hardware and software requirements for the Unigy Soft Client
The Soft Client can be installed on various Microsoft Windows-based devices that have sufficient
storage and memory resources.

Hardware requirements
The following hardware is required to support the Soft Client software on a Windows-based desktop or
laptop computer:
• Sound card (as supported by the operating system). This is not required for a VM computer.
• Network card (as supported by the operating system).
• Hard disk with at least 100 MB of free space for stored files plus 2 GB of space while running the
Soft Client.
• RAM with at least 3 GB of available memory.
Running the Soft Client on Microsoft Surface Pro 3 and Surface Pro 4 is also supported.

Note
The Microsoft Surface Pro on-screen keyboard does not include some of the keys that are assigned to
the default Soft Client keyboard shortcuts. If you cannot use the keyboard shortcuts, either add an
external keyboard or ask your Unigy administrator to change the keyboard shortcuts to use compatible
keys.

Software requirements
The following software is required to support the Soft Client products:
• Microsoft Windows 7, 8.1, or 10 (32-bit or 64-bit)
• Microsoft .NET Framework 4.5
• Microsoft Outlook 2010 or 2013 (32-bit or 64-bit) – required only for integration with Outlook
contacts
The Microsoft Outlook add-in supports dynamic update of local contacts. If you find that the changes
are not updating dynamically, log out of the Soft Client then log in to see the contact changes.
For the latest software requirement information, refer to the Unigy Product Compatibility Matrix
(available only to IPC personnel).

17.6.1.2 Configure the Soft Client network connection

After installation of the Soft Client software, configure the network connection through which the Soft
Client communicates with its home zone.
Unigy Soft Client provides two options for assigning the network connection to the zone with which it
communicates for configuration and call processing purposes. Assignment of the connection varies

IPC Confidential Unigy 4.3

Enterprise Guide
624 17.6: Soft Client install, upgrade, and uninstall procedures

according to the product for which you are configuring the connection. The option is selected at the time
the software is installed, but can be changed at any time.
• Static: With this option, you specify the IP address, virtual IP address (VIP), or fully-qualified
domain name (FQDN) of the zone that serves as the home zone for the Soft Client. If the product is
registering with a single appliance zone, enter the IP address of the zone's ACCM appliance. If the
Soft Client is registering with a High Availability (HA) zone, enter the zone's virtual IP address
(VIP). For both zone types, you also have the option of entering the zone's FQDN. Obtain the
appropriate value from your Unigy administrator. This option is available for all Unigy Soft Client
products.
• Dynamic: This option automatically assigns the appropriate network address based on the value
assigned on the DHCP server. It applies to all zones. The option is not available for Pulse Enterprise.
If your Unigy enterprise is licensed for Business Continuity Planning (BCP) for maintenance and
disaster recovery purposes and your Soft Client is registered with a zone in a multizone enterprise, you
can select a backup zone to which the system redirects the Soft Client if access to the home zone is not
available. You enter this value at the time the BCP plan is activated. For Soft Clients, zone redirection is
not automatic, you must manually initiate it. Obtain the appropriate zone from your Unigy administrator.
This dialog box is displayed automatically after an installation or upgrade. You can also display it at any
other time to change the home zone address or to select a backup zone and initiate the zone redirection
after activation of a BCP plan.
On a Microsoft Windows 7 system, you might have to select a specific Network Adapter.
If a remote installation or update is initiated by a Unigy administrator, the zone address will be updated
as part of this process.

Important
Do not change any of the values within the Advanced tab.

1. If you are not accessing this dialog box as part of the software installation or upgrade procedure, click
Start ➤ All Programs ➤ IPC Systems Inc ➤ Unigy Client Configuration Tool.
The Unigy Config Tool dialog box is displayed.
2. In the Primary field, type the home zone IP address (single appliance zone), VIP (HA zone), or
FQDN.
The IP address, VIP, or FQDN must be specified in the client certificate.
3. The Enable DHCP check box indicates whether the zone IP address or virtual IP address (VIP) is
automatically assigned by a DHCP server. It simplifies free-seating by eliminating the manual steps
required to change the home zone when you log in to a turret and IQ/MAX Sync or log in to IQ/MAX
Omni in a remote zone. Select the check box to enable automatic assignment of the value from a
DHCP server. If you do not select this check box, you can manually change the zone VIP before you
log in at the remote zone. This option does not apply to Pulse Enterprise.
4. Do not configure the BCP field or Use BCP check box when configuring the network settings.
This field is used to select a backup zone to which the system redirects the Soft Client if access to the
home zone is not available.
5. In the Network Adapter list, generally you accept the default value Let Windows Choose, however,
if you cannot open the Soft Client, you might have to select a specific adapter.
Obtain the appropriate adapter name from your Unigy administrator. If you manually change the
adapter and your network connection changes, for example, if you access the Soft Client through a
VPN connection, you must change the adapter value for the new adapter.

December 3, 2019 IPC Confidential

 17.6: Soft Client install, upgrade, and uninstall procedures 625

6. Click Save.
The Save message box is displayed.
7. Click OK.
The information you entered is saved, but the Unigy Config Tool dialog box remains open.
8. Click Close.

17.6.2 Remote Soft Client installation

To eliminate the need for Unigy Soft Client end users to install and upgrade the Soft Client software on
their computers, you can create a script or run commands that use a shell tool to silently install and
configure the software on each user's computer. You can also use this process to upgrade or uninstall the
software.
In the interactive Soft Client installation procedure, each end user runs the
UnigyClientInstaller-x86.msi program (32-bit) or the UnigyClientInstaller.msi
program (64-bit) from a browser, responds to the installation wizard prompts, then enters the IP address
of a Unigy standalone zone or the VIP of an HA zone with which the Soft Client communicates for
configuration and call processing. The wizard prompts include the license agreement, location to which
the software is installed, whether the installation is for all users of the computer or only the current user,
whether the user wants a Soft Client desktop shortcut, and whether the user wants to install the
Microsoft Outlook Add-in. This procedure is quick, simple, and straightforward, but it can be automated
to allow the end users to focus on their primary job responsibilities rather than installing software.
The installer programs support silent installation, which installs and configures the software without the
need for end user interaction. If a version of the software is already installed, you can use a script to
upgrade or uninstall the current version. By default, the silent installation uses the default installation
responses to the installation wizard prompts; that is, it accepts the license agreement, installs the
software to C:\Program Files (x86)\IPC Systems Inc\Unigy Client for all users of
the computer, installs the Microsoft outlook Add-in, and does not add a desktop shortcut (however, it
adds the Unigy Client and Unigy Config Viewer executables to the Microsoft Windows Start menu).
You can run the silent installation command from within a shell tool to install the Soft Client software
on end user computers from a remote location, or if you do not have access to these tools, you can use
the command to install the software locally on each computer without the need to respond to the
installation wizard prompts.
Verify the following requirements before you run the installation commands:
• The client computers must meet the Soft Client hardware and software requirements specified in
Hardware and software requirements for the Unigy Soft Client on page 623.
• The client computers must be accessible at the time the script runs, or the script must be programmed
to run the installation when the client computers become available.
• If the commands are run from a Microsoft Windows command prompt, they must be run with
Administrator privileges.
The installation command includes the following options and information:
• Command option that specifies whether the command installs or uninstalls the software.
• URL that identifies the location of the installer file. You can specify one of the following:
• Standard installation URL, https://ip_vip/image/UnigyClientInstaller-
x86.msi (32-bit) or https://ip_vip/image/UnigyClientInstaller.msi (64-bit),
where ip_vip is the IP address of the appliance in a standalone zone or the VIP of an HA zone
from which you are installing the software.

IPC Confidential Unigy 4.3

Enterprise Guide
626 17.6: Soft Client install, upgrade, and uninstall procedures

• Folder on a network drive or a local drive on the computer running the script. Copy the installer
file from the CCM or ACCM to this location.
• Command option and associated parameters that specify that the installation is to run in silent (quiet)
mode with no user interface displayed, and no user interaction required.
• IP address or VIP of the home zone that provides configuration and call processing support. The
installation program writes this value to the Unigy database. After the installation completes, end
users can view, and if necessary, change the value with the Unigy Config Viewer tool.
• The following optional parameters:
• INSTALLDESKTOPSHORTCUT: creates a desktop shortcut. The default is "" (false). Specify 1
to create the icon.
• INSTALLOUTLOOKADDIN: installs the Microsoft Outlook Add-in for dynamically
synchronizing local contacts. The default is 1 (true). Specify "" to prevent installation of the Add-
in.
• Logging parameter that specifies the name of the installation log file. The log files are stored in
%LOCALAPPDATA%\IPC Systems Inc\UDA\logs. The installation log records the
installation process, displays messages, and at the end, indicates the success or failure of the
installation. Do not include spaces in the log file name. The following success or failure messages are
displayed in the log file for an installation or uninstallation:
• When an installation succeeds, the log includes this message at the end of the file: Product:
Unigy Client -- Installation completed successfully.
• When an uninstallation succeeds, the log includes the message Product: Unigy Client -
Removal completed successfully.
• If the installation fails because the client computer does not have the required software
prerequisites, the log includes messages that inform you what software needs to be installed or
upgraded.
• If a previous version of the software is installed, the log contains a message that instructs you to
uninstall the software before you install the new version.
• If Microsoft Outlook, Office Communicator, or Microsoft Lync are open when you run the
uninstall command, the log includes a message that instructs you to close these applications before
running the installation.
• If the command contains invalid parameters, the installation fails and no information is written to
the log file.
Sample commands are described in the following sections:

Installing the Soft Client software

The following sample commands use Microsoft's msiexec utility to perform different types of
installations. The examples use the 64-bit installer.
• This command runs the installation in silent mode, installs the Microsoft Outlook Add-in, and writes
the installation events to a log file.
msiexec /i msiLocation/image/UnigyClientInstaller.msi /qn ccsip=ip_vip /
log logFile

December 3, 2019 IPC Confidential

 17.6: Soft Client install, upgrade, and uninstall procedures 627

• This command runs the installation in silent mode, adds the Unigy Client icon to the desktop, installs
the Microsoft Outlook Add-in, and writes the installation events to a log file:
msiexec /i msiLocation/image/UnigyClientInstaller.msi /qn ccsip=ip_vip
INSTALLDESKTOPSHORTCUT=1 /log logFile

• This command runs the installation in silent mode, adds the Unigy Client icon to the desktop,
prevents installation of the Microsoft Outlook Add-in, and writes the installation events to a log file:
msiexec /i msiLocation/image/UnigyClientInstaller.msi /qn ccsip=ip_vip
INSTALLDESKTOPSHORTCUT=1 INSTALLOUTLOOKADDIN="" /log logFile

In these commands, msiLocation is the location of the installer file, ip_vip is the home zone IP
address, VIP, or FQDN, and logFile is the name of the installation log file. The log file is a text (.txt)
file. The IP address, VIP, or FQDN must be specified as the Common Name or Alternate Name in the
client certificate.

Upgrading and Uninstalling the Soft Client software

To upgrade the Soft Client software, you must uninstall the current version then install the new version.
The following command uninstalls the software and writes the process events to a log file:
msiexec /log logFile /passive /uninstall
{4F08922F-22F9-4082-8B36-3E6D150317E4}

logFile is the name of the log file and the product ID,
{4F08922F-22F9-4082-8B36-3E6D150317E4}, is a unique GUID that identifies the installer file. The
value must be enclosed within braces.

Important
When you uninstall the software, Microsoft Outlook, Office Communicator, and Microsoft Lync must be
closed on each client computer before you run the script.

Pushing the Soft Client software to one or more computers

To push the Soft Client software to one or more end user computers, or to uninstall the software from
these computers, use a remote shell tool such as Microsoft's PsExec, or ssh tools such as OpenSSH,
copSSH, or WinSSHD. The following example illustrates the use of PsExec to install the software onto
three end user computers.

Note
You can download and extract the PsExec files from the Microsoft SysInternals website. If you download
the files to C:\Windows\System32\, you will not have to specify a file path when you run the
commands.

1. Open the Microsoft Windows Command Prompt.

2. Run PsService.exe to start the PsExec server service.
3. To start PsExec and instruct it to run the installation program on the end user computers, type the
following command then press Enter.
PsExec \\computer1,computer2,computer3 cmd -w

IPC Confidential Unigy 4.3

Enterprise Guide
628 17.6: Soft Client install, upgrade, and uninstall procedures

For computer1, computer2, and computer3, enter the computer name or IP address of each
computer on which you are installing the software.
4. Type the silent installation command that was described previously then press Enter:
msiexec /i msiLocation/UnigyClientInstaller.msi /qn ccsip=ip_vip /log
logFile

The log file is created on the end user computers.

You can use the same procedure for uninstalling the software. Substitute the uninstallation command for
the installation command.

17.6.3 Upgrade the Unigy Soft Client software – Microsoft Windows 64-bit
This topic describes how to upgrade the Soft Client software on a Microsoft Windows 64-bit client
computer.
For information on upgrading the Soft Client software in a Microsoft Windows 32-bit environment, refer
to Upgrade the Unigy Soft Client software – Microsoft Windows 32-bit on page 630.
When you access the Soft Client, if a new software version is available, the Unigy Client icon in the
Microsoft Windows System Tray displays the upgrade indicator and the Upgrade option is displayed in
the Unigy Client menu.
Figure 122: Unigy Client icon showing the upgrade indicator

Prerequisite:
Before you initiate the upgrade, close Microsoft Outlook, Office Communicator, and Microsoft Lync, as
applicable, to enable the system to uninstall the current software version before it installs the new
version.
1. Access the Soft Client Login window by double-clicking the Unigy Client icon or by clicking
Start ➤ All Programs ➤ IPC System Inc ➤ UnigyClient.
2. Within the Microsoft Windows System Tray, right-click the Unigy Client icon to display the available
options.
Figure 123: Unigy Client menu showing the Upgrade option

3. Click Upgrade to initiate the upgrade.

The Unigy Client Update Info message box is displayed. The message shows the current version
followed by the new version that is available for the upgrade.

December 3, 2019 IPC Confidential

 17.6: Soft Client install, upgrade, and uninstall procedures 629

Figure 124: Unigy Client Update Info message box

4. Click Yes to proceed with the upgrade.

Windows Installer begins the upgrade process.
5. If you see the User Account Control window requesting permission to allow the system to make
changes, click Yes.
Windows Installer uninstalls the current software version then displays the Welcome to Unigy(TM)
Client Setup Wizard window.
6. Click Next.
7. In the End-User License Agreement window, read the Terms of Use, select the I accept the terms in
the License Agreement check box, then click Next.

Note
If you decline the upgrade, the upgrade indicator on the Unigy Client icon is cleared and the Upgrade
option is removed from the menu.

If any prerequisites have not been completed, the wizard prompts you to complete them before
continuing.
8. In the Destination Folder window, confirm the default installation location or click Change to
specify a new location then click Next.
9. In the Install Options window, select one, both, or neither of the following options then click Next:
a) Select the Create Shortcut on Desktop check box if you want the system to add a Unigy Client
(Soft Client) shortcut to the desktop in addition to the shortcut it creates in the Microsoft Windows
Start menu.
b) Select the Install Outlook Add-in check box to provide dynamic integration with Microsoft
Outlook contacts.
10. In the Ready to Install Unigy(TM) Client window, click Install.
11. If you see the User Account Control message box, click Yes.
The installation begins. After it completes, the Completed the Unigy(TM) Client Setup window is
displayed. After a brief delay, the Unigy Config Tool dialog box is displayed.
12. In the Unigy Config Tool, confirm or configure the connection to the home zone or to a DHCP server
as described in Configure the Soft Client network connection on page 623 then click Save.
13. In the Save message box, click OK.
14. In the Unigy Config Tool dialog box, click Close.
15. In the Completed the Unigy(TM) Client Setup window, click Finish.

IPC Confidential Unigy 4.3

Enterprise Guide
630 17.6: Soft Client install, upgrade, and uninstall procedures

17.6.4 Upgrade the Unigy Soft Client software – Microsoft Windows 32-bit
This topic describes how to upgrade the Soft Client software on a Microsoft Windows 32-bit client
computer.
For information on upgrading the Soft Client software in a Microsoft Windows 64-bit environment, refer
to Upgrade the Unigy Soft Client software – Microsoft Windows 64-bit on page 628.
When you access the Soft Client, if a new software version is available, the Unigy Client icon in the
Microsoft Windows System Tray displays the upgrade indicator and the Upgrade option is displayed in
the Unigy Client menu.
Figure 125: Unigy Client icon showing the upgrade indicator

Prerequisite:
Before you initiate the upgrade, close the Unigy Soft Client, Microsoft Outlook, Office Communicator,
and Microsoft Lync, as applicable, to enable the system to uninstall the current software version before it
installs the new version.

Note
To upgrade the Soft Client software on Microsoft Windows 32-bit systems, you cannot use the Upgrade
option in the Unigy Client menu as you can with Windows 64-bit systems; instead you must manually
uninstall the current version then install the new version.

1. Uninstall the current Soft Client software version by performing the procedure Uninstall the Unigy
Soft Client software on page 634.
2. Install the new software from a browser by accessing the URL https://ip_or_vip/image/
UnigyClientInstaller-x86.msi, where ip_or_vip is the IP address or virtual IP address
(VIP) of the zone from which you are running the installation.
3. Click Run.
4. If you are prompted to confirm that you want to run the program, click Run.
The Welcome to the Unigy(TM) Client Setup Wizard window is displayed.
5. Click Next.
6. In the End-User License Agreement window, read the Terms of Use, select the I accept the terms in
the License Agreement check box, then click Next.
7. In the Destination Folder window, confirm the default installation location or click Change to
specify a new location then click Next.
8. In the Install Options window, select one, both, or neither of the following options then click Next:
a) Select the Create Shortcut on Desktop check box if you want the system to add a Unigy Client
(Soft Client) shortcut to the desktop in addition to the shortcut it creates in the Microsoft Windows
Start menu.
b) Select the Install Outlook Add-in check box to provide dynamic integration with Microsoft
Outlook contacts.
9. In the Ready to Install Unigy(TM) Client window, click Install.
10. If you see the User Account Control message box, click Yes.
The installation begins. After it completes, the Completed the Unigy(TM) Client Setup window is
displayed. After a brief delay, the Unigy Config Tool dialog box is displayed.

December 3, 2019 IPC Confidential

 17.6: Soft Client install, upgrade, and uninstall procedures 631

11. In the Unigy Config Tool dialog box, confirm or configure the connection to the home zone or to a
DHCP server as described in Configure the Soft Client network connection on page 623 then click
Save.
12. In the Save message box, click OK.
13. In the Unigy Config Tool dialog box, click Close.
14. In the Completed the Unigy(TM) Client Setup Wizard window, click Finish.

17.6.5 Roll back the Unigy Soft Client software – Microsoft Windows 64-bit
If the Unigy software is rolled back to a previous version, you must roll back the Unigy Soft Client
software on the client computers to the same version. This topic describes how to roll back the software
on a Microsoft Windows 64-bit client computer.
For information on rolling back the Soft Client software in a Microsoft Windows 32-bit environment,
refer to Roll back the Unigy Soft Client software – Microsoft Windows 32-bit on page 633.
When you access the Soft Client, if the Unigy software is at a lower version than the current Soft Client
version, the Unigy Client icon in the Microsoft Windows System Tray displays the rollback indicator
and the Rollback option is displayed in the Unigy Client menu. The system also displays the tool tip
Unigy - Roll Back to Old Version when you move your mouse over the icon.
Figure 126: Unigy Client icon showing the rollback indicator

Prerequisite
Before you perform this procedure, close Microsoft Outlook, Office Communicator, and Microsoft
Lync, as applicable, to enable the system to uninstall the current software version before it installs the
lower version.
1. Access the Soft Client Login window by double-clicking the Unigy Client icon or by clicking
Start ➤ All Programs ➤ IPC System Inc ➤ UnigyClient.
2. Right-click the Unigy Client icon in the Microsoft Windows System Tray then click Rollback.
The Unigy™ Client Info message box prompts you to confirm that you want to roll back from the
currently Installed Version to the Download Version.
3. Click Yes.
4. If you see the User Account Control message box requesting permission for the system to make
changes, click Yes.
The system uninstalls the higher version software then presents the Unigy Client(TM) wizard.
5. Perform one of the following procedures based on the software version you are rolling back to:
• For versions prior to Unigy v3.0, do the following:
1. In the License Agreement window, read the Terms of Use, click I Agree then click Next.
2. In the Welcome to the Unigy(TM) Client Setup Wizard window, click Next.
3. In the Select Installation Folder window, accept the default folder or click Browse to select a
different folder. Also, select either Everyone, to install the software for all users who can log in
to the client computer, or Just me, to install the software for only your use, then click Next.
4. In the Unigy Client, window, select the Create Shortcut on Desktop check box if you want the
installer to add a shortcut icon to your desktop, then click Next.
5. In the Confirm Installation window, click Next.

IPC Confidential Unigy 4.3

Enterprise Guide
632 17.6: Soft Client install, upgrade, and uninstall procedures

6. The installer begins the installation process.

7. If you see the User Account Control message box requesting permission for the system to make
changes, click Yes.
The installer installs the software then displays the Installation Complete window. After a brief
delay, followed soon after by the Unigy Configuration Tool message box with the message
Unable to resolve CCM IP through DHCP services. Please enter CCM
IP manually. Reason: No data received from DHCP server!
8. In the Unigy Configuration Tool message box , click OK.
9. In the Unigy Config Tool dialog box, configure the connection to the home zone or to a DHCP
server as described in Configure the Soft Client network connection on page 623 then click
Save.
10. In the Save message box, click OK.
11. In the Unigy Config Tool dialog box, click Close.
12. In the Installation Complete window, click Close.
• For Unigy v3.0 or higher, do the following:
1. In the Welcome to the Unigy(TM) Client Setup Wizard window, click Next.
2. In the End-User License Agreement window, read the Terms of Use, select the I accept the
terms in the License Agreement check box, then click Next.
3. In the Destination Folder window, accept the default installation location or click the Change
button to specify a new location then click Next.
4. In the Install Options window, select one, both, or neither of the following options then click
Next:
• Create Shortcut on Desktop: select this check box if you want the system to add a Unigy
Client (Soft Client) shortcut to the desktop in addition to the shortcut it creates in the
Microsoft Windows Start menu.
• Install Outlook Add-in: select this check box to provide dynamic integration with Microsoft
Outlook contacts.
5. In the Ready to Install Unigy(TM) Client window, click Install. The installer begins the
installation process.
6. If you see the User Account Control message box, click Yes.
After the installation completes, the Completed the Unigy(TM) Client Setup window is
displayed. After a brief delay, the Unigy Config Tool dialog box is displayed.
7. In the Unigy Config Tool dialog box, confirm or configure the connection to the home zone or
to a DHCP server as described in Configure the Soft Client network connection on page 623
then click Save.
8. In the Save message box, click OK.
9. In the Unigy Config Tool dialog box, click Close.
10. In the Completed the Unigy(TM) Client Setup window, click Finish.

December 3, 2019 IPC Confidential

 17.6: Soft Client install, upgrade, and uninstall procedures 633

17.6.6 Roll back the Unigy Soft Client software – Microsoft Windows 32-bit
If the Unigy software is rolled back to a previous version, you must roll back the Unigy Soft Client
software on the client computers to the same version. This topic describes how to roll back the software
on a Microsoft Windows 32-bit client computer.
For information on rolling back the Soft Client software in a Microsoft Windows 64-bit environment,
refer to Roll back the Unigy Soft Client software – Microsoft Windows 64-bit on page 631.
When you access the Soft Client, if the Unigy software is at a lower version than the current Soft Client
version, the Unigy Client icon in the Microsoft Windows System Tray displays the rollback indicator
and the Rollback option is displayed in the Unigy Client menu. The system also displays the tool tip
Unigy - Roll Back to Old Version when you move your mouse over the icon.
Figure 127: Unigy Client icon showing the rollback indicator

Prerequisite:
Before you initiate the rollback, close the Unigy Soft Client, Microsoft Outlook, Office Communicator,
and Microsoft Lync, as applicable, to enable the system to uninstall the current software version before it
installs the lower version.

Note
To roll back the Soft Client software on Microsoft Windows 32-bit systems, you cannot use the Rollback
option in the Unigy Client menu as you can with Windows 64-bit systems; instead you must manually
uninstall the current version then install the lower version.

1. Uninstall the current Soft Client software version by performing the procedure Uninstall the Unigy
Soft Client software on page 634.
2. Install the lower software version from a browser by accessing the URL https://ip_or_vip/
image/UnigyClientInstaller-x86.msi, where ip_or_vip is the IP address or virtual IP
address (VIP) of the zone from which you are running the installation.
3. Click Run.
4. If you are prompted to confirm that you want to run the program, click Run.
The Welcome to the Unigy(TM) Client Setup Wizard window is displayed.
5. Click Next.
6. In the End-User License Agreement window, read the Terms of Use, select the I accept the terms in
the License Agreement check box, then click Next.
7. In the Destination Folder window, confirm the default installation location or click Change to
specify a new location then click Next.
8. In the Install Options window, select one, both, or neither of the following options then click Next:
a) Select the Create Shortcut on Desktop check box if you want the system to add a Unigy Client
(Soft Client) shortcut to the desktop in addition to the shortcut it creates in the Microsoft Windows
Start menu.
b) Select the Install Outlook Add-in check box to provide dynamic integration with Microsoft
Outlook contacts.
9. In the Ready to Install Unigy(TM) Client window, click Install.
10. If you see the User Account Control message box, click Yes.

IPC Confidential Unigy 4.3

Enterprise Guide
634 17.6: Soft Client install, upgrade, and uninstall procedures

The installation begins. After it completes, the Completed the Unigy(TM) Client Setup window is
displayed. After a brief delay, the Unigy Config Tool dialog box is displayed.
11. In the Unigy Config Tool dialog box, confirm or configure the connection to the home zone or to a
DHCP server as described in Configure the Soft Client network connection on page 623 then click
Save.
12. In the Save message box, click OK.
13. In the Unigy Config Tool dialog box, click Close.
14. In the Completed the Unigy(TM) Client Setup Wizard window, click Finish.

17.6.7 Uninstall the Unigy Soft Client software

The uninstall process removes all Soft Client files, folders, and log files, deletes all update files and
configuration files, and removes shortcuts from the Start ➤ All Programs menu and the desktop. You
can uninstall the Soft Client software by rerunning the Soft Client installer program or through the
Uninstall a program utility within the Microsoft Windows Control Panel. This topic describes how to
remove the software by rerunning the UnigyClientInstaller-x86.msi (32-bit) or
UnigyClientInstaller.msi (64-bit) file.
Prerequisite:
Before uninstalling the Soft Client software, close the Soft Client, Microsoft Outlook, Office
Communicator, and Microsoft Lync, as applicable.
1. In a browser, access the Soft Client installer file that was used for the original installation with one of
the following URLs, where ip_or_vip is the IP address of the appliance in the Unigy standalone
zone or the virtual IP address (VIP) of the HA zone from which you are running the installer.
• Microsoft Windows 32-bit: https://ip_or_vip/image/UnigyClientInstaller-
x86.msi
• Microsoft Windows 64-bit: https://ip_or_vip/image/
UnigyClientInstaller.msi
2. Click Run to initiate the uninstall or Save to download the installer file to your computer.
If you download the file, double-click it to start the uninstall.
3. If you are prompted to confirm that you want to run the program, click Run.
The system displays the Welcome to the Unigy(TM) Client Setup Wizard.
4. Click Next.
a) The Change, remove, or repair installation window is displayed.
5. Click Remove.
The Ready to remove Unigy(TM) Client window is displayed.
6. Click Remove.
7. If you see the User Account Control message box, click Yes.
The system uninstalls the Soft Client software then displays the Completed the Unigy(TM) Client
Setup Wizard window.
8. Click Finish.

December 3, 2019 IPC Confidential

 17.7: Validation procedures 635

17.7 Validation procedures

17.7.1 Validation workflow
After you deploy or upgrade a Unigy enterprise, run the tests specified in this topic to validate the
integrity of the system.

Table 69: Validation workflow

Activity Topics Notes

Test interzone replication. Run interzone diagnostic tool on page This applies only to a
646 multizone enterprise.
Confirm that the license is
installed in all zones.
Run the interzone
diagnostic tool.
Add data, such as users or
lines, in one zone and
confirm that the data is
displayed in all other
zones.
View system components by View system devices by zone on page Determine whether the
zone. 643 devices are connected to
the correct zone.
Perform the walk the floor Run Walk the Floor diagnostics on page Run all of the tests in the
diagnostic tests. 644 Walk the Floor folder.
View registered turrets. View registered IQ/MAX and IQ/MAX Confirm that turrets that
Edge turrets on page 651 should be registered with a
zone are registered.
View registered Pulse devices. View registered Pulse devices on page Confirm that Pulse devices
651 that should be registered
with a zone are registered.
View registered Soft Clients. View registered Soft Clients on page Confirm that Soft Client
652 that should be registered
with a zone are registered.
Monitor devices. • Monitor devices on page 652 Determine whether any
issues were detected.
Generate a System Generate system configuration report Review the report and
Configuration report. on page 653 confirm that the component
configurations are correct.
Run call control diagnostic tests. • Run Verify Intercom Connection on Confirm that all tests
page 654 complete successfully.

• Run Verify Private Line Conference

on page 656
• Run Verify Dialtone Line Connection
on page 658
• Run Verify Inbound Call Connection
on page 660

IPC Confidential Unigy 4.3

Enterprise Guide
636 17.7: Validation procedures

Table 69: Validation workflow (continued)

Activity Topics Notes

Make calls from turrets, Pulse • Make an intercom call from a turret Confirm that the calls are
devices, and Soft Clients. on page 662 processed properly.

• Make an intercom call from a Soft

Client on page 663
• Make a dial tone line call on page
663
• Make a line call with automatic line
selection on page 665
• Make a call from Pulse Enterprise on
page 665
• Make a call from a search result –
Pulse on page 666
• Make a conference call on page
666
• Make a conference call from a Soft
Client on page 666
• Make a group call from the directory
– Pulse on page 667

Test recording. • Verify IP Recording Status on page Review the results to

668 confirm that the
connections and recording
mixes are correct.
Test alerts. Run CCM AFM Alerts test on page Verify alerts are being sent
670 to Critical Alert system.
Test HA failover. Test HA on page 671 Applies only to HA zones.
Confirm that the failover
occurs and the state of
both appliances is
AVAILABLE.
Test BCP failover. • Manually activate a BCP plan (fail Applies only to multizone
over) on page 294 enterprises that have a
Business Continuity
• Deactivate a BCP plan (fail back) on Planning license.
page 296 Confirm that the devices
are properly redirected to
backup zones and directed
back to the home zone
based on the BCP plan.

17.7.2 Validate a zone before an upgrade, rollback, or other operations

Perform these steps to validate a zone prior to deploying software, rolling back a deployment, or
performing other operations that impact zones to determine whether the zone is in a stable state.

December 3, 2019 IPC Confidential

 17.7: Validation procedures 637

1. Check the state of the zone by performing the procedure Check the state of a zone from a browser on
page 499.
2. In an HA zone, confirm that internal processes are communicating properly by performing the
procedure Run CCM Software Version on page 648.
3. In a multizone enterprise, if more than one zone is deployed and data replication is enabled in each
zone, confirm that replication is working properly by performing the procedure Run interzone
diagnostic tool on page 646.
4. In a multizone enterprise, check the replication status by performing one of the following procedures:
• Check a zone's replication status with checkReplication on page 507.
• Check the data replication status for all zones in the enterprise on page 513.
5. In a multizone enterprise, check the transient data status by performing one of the following
procedures:
• Check a zone's transient channel status with checkTransientChannels on page 514.
• Check the transient channel status for all zones in the enterprise on page 514.
6. Run the Automated Health Check by performing the procedure Run automated health check from the
command line on page 639.
7. Run Enterprise Watch by performing the procedure Analyze an enterprise with Enterprise Watch on
page 643.
8. Determine whether there are any system alerts that indicate issues that should be corrected before
performing the operation.
9. If Multi-tier Replication is enabled, perform the following diagnostic tests:
• Check a zone’s Multi-tier Replication status on page 250
• Check an enterprise’s Multi-tier Replication status on page 258
• Diagnose latency for Multi-tier Replication on page 260
10. For an upgrade or rollback, confirm that there is sufficient disk space available by running the
command df -h from the command line.
Below are general space requirement guidelines; however, you should determine the actual size of
each .iso file to confirm that sufficient disk space is available.

Volume Space requirement

/tmp Minimum: 3 times the size of the update .iso file.
Recommended: at least 10 GB.
After you upload the .iso file to a zone, this space is no longer required.
/opt Minimum: 2 times the size of the update .iso file.
Recommended:
• For a Unigy update, this is approximately 4.4 GB.
• For a Blue Wave update, this is approximately 4 GB.
/var/spool/backup Sufficient space for an image backup. The space required varies based on
the number of zones and the size of the Unigy database.
To determine the size of existing backups, run the following command:
du -h /var/spool/backup/system-backup

IPC Confidential Unigy 4.3

Enterprise Guide
638 17.7: Validation procedures

17.7.3 Validate a zone after a deployment, rollback, or other operations

After performing a deployment, rollback, or other operation that can impact zones, perform these tests to
determine whether the system is performing properly. If one of these tests fails, resolve the issues before
performing any other actions, such as retrying an upgrade or deploying software on other system
devices.

Note
After an upgrade, the timestamp in the Date Created field for all the alerts changes to a post upgrade time.

1. Check the status of the zone by performing the procedure Check the state of a zone from a browser on
page 499.
2. Confirm that internal processes are communicating properly by performing the procedure Run CCM
Software Version on page 648.
3. In a multizone enterprise, if more than one zone is deployed and data replication is enabled in each
zone, confirm that replication is working properly by performing the procedure Run interzone
diagnostic tool on page 646.
If data replication is not enabled in all zones, run this test after you enable replication in all of the
zones.
4. In a multizone enterprise, check the replication status by performing one of the following procedures:
• Check a zone's replication status with checkReplication on page 507.
• Check the data replication status for all zones in the enterprise on page 513.
5. In a multizone enterprise, check the transient data status by performing one of the following
procedures:
• Check a zone's transient channel status with checkTransientChannels on page 514.
• Check the transient channel status for all zones in the enterprise on page 514.
6. Run the Walk the Floor diagnostic test by performing the procedure Run Walk the Floor diagnostics
on page 644.
7. Run Automated Health Check (AHC) by performing one of the following procedures:
• Run TAC Health Check from the UMS on page 640
• Run automated health check from the command line on page 639
8. Run Enterprise Watch by performing the procedure Analyze an enterprise with Enterprise Watch on
page 643.
9. If Multi-tier Replication is enabled, perform the following diagnostic tests:
• Check a zone’s Multi-tier Replication status on page 250
• Check an enterprise’s Multi-tier Replication status on page 258
• Diagnose latency for Multi-tier Replication on page 260
10. If the zone is fully deployed and CDIs are registered with the zone, confirm that you can make calls,
including conference and speaker calls, from each CDI type.
If you encounter any of the following Media Manager-related issues after an upgrade or rollback,
reboot the ACCMs or MMs by performing the procedure Reboot CCM on page 587 or Run Reboot
Media Manager on page 588.
• Speaker channels cannot connect.

December 3, 2019 IPC Confidential

 17.7: Validation procedures 639

• Cannot make conference calls.

• Cannot log in to the Unigy Soft Client due to a media issue.
11. If the zone is a Blue Wave zone, confirm that the Blue Wave applications function properly.
If any of these tests fail and you cannot determine the source of the problem, reboot the appliance(s) in
the zone by performing the procedure Reboot CCM on page 587.

17.7.4 Verify zone replication and line status port information

After you deploy a zone in a multizone enterprise, determine whether the zones are communicating
properly. The primary means for obtaining this information is to run checkHAStatus; however, if you
cannot access this information , you can use this procedure to confirm that port 9802 is established as
the listen port for replication and that the line status port 9800 is active and there are established
connections between the zone and the appliances in all other zones.
For information on running checkHAStatus, refer to Check the state of a zone from a browser on page
499 or Check the state of an HA zone from the UMS on page 500.
1. Log into the zone through SSH with the zone VIP.
2. Type su -lp then press Enter to obtain root user privileges.
Type the root user password.
3. Run the following commands to ensure that port 9802 is established as the listen port for data
replication:
a) netstat -anpl | grep 9802 | grep EST
b) netstat -anpl | grep 9802 | grep LISTEN
4. Run the following commands to confirm that the line status port is active and there are established
connections between the zone and the appliances in all other zones that are online:
a) netstat -anpl | grep 9802
There should be a socket in the LISTEN state and sockets to every other appliance in the enterprise
in the ESTABLISHED state.
b) netstat -anpl | grep 9800
There should be a socket in the LISTEN state and sockets to every other zone in the enterprise in
the ESTABLISHED state.

17.7.5 Run automated health check from the command line

Use this procedure to check the health of all components in a Unigy enterprise and generate a report
containing the RAG status and other details for each component from the command line.
Use this procedure to run the Automated Health Check script: healthCheckMain.sh, located
at: /opt/ipc/healthcheck/scripts/.

To run the health check from the UMS instead, refer to the procedure Run TAC Health Check from the
UMS on page 640
Configure the healthCheckInput.conf file before you run the script to test only the zones you
intend the script to run against. Do this to remove zones that are actively trading at the time of
execution.
1. Log in to the Unigy appliance (VIP) using the dynamic password feature and elevate to superuser.

IPC Confidential Unigy 4.3

Enterprise Guide
640 17.7: Validation procedures

su -lp
2. Change the directory: cd /opt/ipc/healthcheck/scripts/.
3. As a best practice, verify the configuration input file exists and that the content meets your needs by
typing: cat healthCheckInput.conf.
4. If the file does not exist, generate it with the command: ./healthCheckMain.sh --
generate.
5. To edit the configuration file, use the command: ./healthCheckMain.sh --modify.
6. Check your changes by running: cat healthCheckInput.conf.
7. Validate the changes with the command: ./healthCheckMain.sh --validate.
8. Execute the script: ./healthCheckMain.sh --manualStart.
9. Retrieve the output file, located at /opt/ipc/healthcheck/scripts on the CCM in the zone
from where you ran Automated Health Check.
The Automated Health Check output file name is AHC_EnterpriseName_-
####_Z#_DDMMYY######.html where: EnterpriseName is the name of the enterprise,
#### is the time offset, Z# is the zone, and DDMMYYHHMMSS is the date and time the script was
run.
All of the zones in the group you specified will be in the one report, which is retrieved from the zone
from which it was run.

17.7.6 Run TAC Health Check from the UMS

Use this procedure to check the health of all components in a Unigy enterprise and view a health check
report as an HTML file containing RAG (red, amber, green) status of each component from the UMS.

Note
This diagnostic test is only available to run from zones that are at Unigy v4.3 or higher. You can choose
devices from zones with lower Unigy versions, but you cannot run the diagnostic from those zones.

You must be logged in to the Unigy Management System and be authorized to generate and view this
test. Only users with the IPC Certified Technician licensed role can access the diagnostics panels.

Note
IPC does not advise running this test during business/trading hours. This test is considered intrusive.
While trading is not affected by these tests, multiple tests will produce invalid results if run during trading
hours.

This test runs the healthCheckMain.sh script in /opt/ipc/healthcheck/scripts/. It

overwrites the groupN.zoneids value based on your selected devices. It uses the thresholds in the
healthCheckInput.conf for the output.
Duration: Varies, depending upon the size of the Unigy database.
Usage: Determined by Service Delivery.

Note
IPC recommends that you do not run the health checks on a zone more than once a day.

December 3, 2019 IPC Confidential

 17.7: Validation procedures 641

If a zone VIP is down or it is out of network, the health check will not be run on that zone. Information
about zones that are unreachable and unavailable will not be included in the health check output. Only
information about zones that are reachable and available will be included in the output.
1. From the UMS, click Tools ➤ Diagnostics.
2. Click Create New Test.
3. Expand TAC from the Available Tests panel.
4. Check the Run Health Check test and click Select.
The Run Health Check tab is displayed.

Note
It is not necessary to select a Zone because this test automatically runs from the zone from which you
logged in and uses the active CCM to retrieve results from all of the Selected Devices.

5. Select devices for this test.

a) Click +Assign.
b) Select devices from the Devices for Zone list.
Only active appliances appear in the list.

Note
You must select all devices from the initiating zone in order to select devices from other zones.

c) To create a Group containing these devices, click Save Device List and give it a name.
In future runs, you can select this group of devices rather than having to rebuild the list.
d) Click < Assign.
6. To schedule the test, including on a recurring basis, click Schedule Test.
A Confirmation dialog is displayed, ensuring you understand the intrusiveness of this test.
Figure 128: Confirmation dialog

a) Click Ok to continue.
The Schedule Test Details dialog is displayed.

IPC Confidential Unigy 4.3

Enterprise Guide
642 17.7: Validation procedures

Figure 129: Schedule Test Details dialog

b) Enter your scheduling criteria.

Use the Online Help for field guidance.
The system prevents you from overlapping scheduled of this health checks when the tests have any
zones in common. It imposes a 30 minute gap between scheduled tests.
The JSON files are copied and sent to SLIC via Filebeat.
7. To run the test immediately, click Perform Test.
A confirmation dialog is displayed to ensure you want to run this test during trading hours.
Figure 130: Confirmation dialog

Check the checkbox and click Ok if you want to continue.

The Diagnostic Status Panel is displayed.

Note
If the test time will overlap with a scheduled test, the system will not allow you to preform a test.

8. View the status in the Diagnostic Status area.

When the test is complete, the value in the Progress column in the Diagnostics Status Details panel
is 100.
The Total Jobs value in the Result Info column of the diagnostic Status table equals the number of
CCMs and ACCMs tested.
9. Click to View results in the Output column.
10. Click Download Bundle to open the TAC health check HTML file.

December 3, 2019 IPC Confidential

 17.7: Validation procedures 643

Note
Links and downloadable bundles are password protected. To access a link or bundle, when prompted
for credentials, enter the Unigy install account credentials.

17.7.7 Analyze an enterprise with Enterprise Watch

This topic describes how to analyze a Unigy enterprise with Enterprise Watch.
Prior to accessing Enterprise Watch, you must enable Web links by performing the procedure Enable or
disable WebLogic, SWMS, and Enterprise Watch Web link access on page 337.
1. Within a browser, access https://vip/deployment/EnterpriseWatch.html, where
vip is the VIP of the zone from which you are running Enterprise Watch.
You can also access Enterprise Watch from Single Click Deployment.
If you are using Enterprise Watch while upgrading multiple zones within the enterprise, use the VIP
of the zone that is deployed first.
2. Enter the credentials for the install user account then click OK.
3. In the text box above the panel on the left, type the VIP for the zone you want to analyze.
The value defaults to the VIP in the URL you used to access Enterprise Watch, but you can enter the
VIP for any zone in the enterprise.
4. Click Refresh Status to display an entry for each zone.
5. Expand a zone to view the CCM, ACCM, and MM appliances in the zone.
6. To view more detailed information for an appliance, expand the appliance entry.
A list of the monitored entities is displayed with their status indicator.
• Healthy ( Green )
• Warning ( Amber )
• Error ( Red)
The status changes every two minutes.
7. To view more detailed information for an entity, click the entity.
The details are displayed below the left panel. If you do not see the details, scroll to the bottom of the
page.
For additional information, refer to Enterprise Watch on page 215.
8. To compare the enterprise from the perspective of two different zones side by side, type the second
zone VIP in the text box above the panel on the right then click Refresh Status.
If the enterprise is healthy, the status displayed for each zone will be the same.

17.7.8 View system devices by zone

You can view the system devices deployed in each zone through the Hardware Deployment Plan Details
panel.
The following devices are available for viewing:
• Converged Communications Managers (CCMs) or Aggregated Converged Communications
Managers (ACCM)s
• Media Managers (MMs)

IPC Confidential Unigy 4.3

Enterprise Guide
644 17.7: Validation procedures

• Media Gateways (MGs)

• Turrets
• Pulse devices
• Soft Clients
For each device, you can view the device name, model, serial number, MAC address, IP address, device
mode, and for all devices except CCMs, MMs, and ACCMs, the device location.
1. Click Tools ➤ Deployment ➤ Hardware Deployment.
The Deployment Zones panel is displayed.
2. Click the zone for which you are viewing the device information.
3. Do one or more of the following:
• Click the Servers tab to view information about the CCMs, MMs, or ACCMs in the zone.
• Click the Media Gateways tab to view information about the MGs.
• Click the IQ/MAX & Edge tab to view information about the IQ/MAX and IQ/MAX Edge turrets.
• Click the Soft Clients tab to view information about the Unigy Soft Clients.
• Click the Pulse tab to view information about the Pulse devices.
• Click the IQ/MAX TOUCH tab to view information about the IQ/MAX TOUCH turrets.

17.7.9 Run Walk the Floor diagnostics

Walk the Floor is a procedure that ensures all Unigy components perform as expected after an
installation or system upgrade.

Note
The CCM and Turret & Pulse Walk the Floor diagnostics are intrusive. IPC recommends that intrusive
diagnostics be run after the trading day or during routine maintenance periods.

This topic provides the general steps to create a diagnostic test containing all walk the floor commands.
A test can contain as many or as few commands as you need to meet your requirements.

Note
Configure test extensions, private lines, and dial tone lines before running the walk the floor diagnostics.

1. In the UMS menu bar, select Tools ➤ Diagnostics.

The Diagnostic Status panel is displayed.
2. Click Create New Test.
3. Expand Walk the floor from the Available Tests tab.
4. Select a test category and click Select.
For example, the Turret & Pulse tab contains a check list for all walk the floor communication device
tests. By default, all the tests in the category are selected.

December 3, 2019 IPC Confidential

 17.7: Validation procedures 645

Figure 131: New Diagnostic Test – Walk the Floor tests for Turret & Pulse

5. Optionally, uncheck the box next to any test that you do not want to perform.

Note
Informational commands (that is, non-Walk the floor) cannot be combined with a Walk the floor
category test. To combine Informational and Walk the floor commands, select individual tests (not an
entire Walk the floor category). This combination can then be saved as a template for future use.

6. If necessary, select the Zone that you want to perform the test in.

Note
You can only perform a test in one zone at a time.

7. Click +Assign to select devices. Then do any of the following:

• From the Devices for Zone tab, select one or more devices, then click <Assign.
• From the Device List tab, select a device list (group of devices), then click <Assign.
8. Repeat the above steps to add more tests, as necessary.
9. When finished, click Perform Test.

Note
If the Walk the Floor selection includes any intrusive commands, a confirmation dialog is displayed. If
you still want to run the commands, check Execute test during working hours and click OK.

IPC Confidential Unigy 4.3

Enterprise Guide
646 17.7: Validation procedures

The Diagnostics Status panel is displayed.

10. Verify the diagnostic test results.
a) Select the test in the grid, then click View Detail. When the test is complete, the value in the
Progress column in the Diagnostics Status Details panel is 100.
b) Click click to view in the Output column to see the output.
If a turret test fails or produces bad results, follow these suggestions for next steps:
• Check your network configuration.
• Check that the CCM Server IP matches the CCM VIP address.
• Use the turret’s admin tool ping utility to check network connectivity of the CCM or the turret's own
address and verify that packets are being sent and received.

Also see Diagnostics on page 709.

17.7.10 Run interzone diagnostic tool

Checks the health of zones in a multi-zone Unigy enterprise. The tool can compare one zone’s database
tables to all other zones’ database tables and identify differences in the number of records. The tool can
also test interzone replication functionality.
This tool will only execute on the active CCM or ACCM.
Results are presented in N x N format. For the most meaningful analysis, run the test on the CCM in the
most stable zone.

Table 70: Duration

Test Intrusive Duration

Count comparison No Minutes, dependent upon number of zones, number of
tables being compared, and amount of data in each table.
Replication health check No Maximum of 20 seconds. If time exceeds 20 seconds, the
test failed.

Usage: It is essential that every database in the enterprise contain (mostly) identical information.
Perform the Count Comparison test to verify that the databases in a multi-zone Unigy enterprise are
staying in sync during operation.
Perform the Replication Health Check after adding or removing a zone from a Unigy enterprise to verify
that the new zone can communicate with others or to diagnose network connectivity interruptions.
You must be logged in to the Unigy Management System and be authorized to generate and view this
test.
1. Select Tools ➤ Diagnostics.
2. Click Create New Test.
3. Expand CCM from the Available Tests tab.
4. Select the Interzone Diagnostic Tool and click Select.
The Interzone Diagnostic Tool tab is displayed. The IP addresses of all the CCMs and ACCM in your
Unigy enterprise are listed in the IP address field.
5. If necessary, select the Zone with the CCM or ACCM you want to run the test on.

December 3, 2019 IPC Confidential

 17.7: Validation procedures 647

6. Click +Assign to select devices. Then do any of the following:

• From the Devices for Zone tab, select one or more devices, then click <Assign.
• From the Device List tab, select a device list (group of devices), then click <Assign.

Note
Only active appliances appear in the Available Devices list.

7. Select the appropriate interzone test from the Test Name field. Options include: Count comparison
or Replication health check.
The following screen example shows the Count comparison test selected.
Figure 132: Interzone Diagnostic Tool panel

8. If you are doing a count comparison test, consider the following:

a) To compare the databases of every zone, leave the IP Address list as is.
b) Remove one or more IP addresses from the IP Address list if you do not want the zone it
represents to be included in the comparison results.
c) To compare all database tables, leave the Entity Name field blank.
d) To compare specific database tables, enter the names of one or more database tables in the Entity
Name field, separated by commas. Tables that might be of interest include: Zone, User,
Button, Device, ResourceAOR, and Trunk.
9. Click Perform Test.
The Diagnostic Status panel is displayed.
10. Select the test from the grid and click View Detail.
When the test is complete, the value in the Progress column in the Diagnostics Status Details panel is
100.
11. Click click to view in the Output column.
12. Click Download Bundle to save or open the output.log file.
The following is sample output from a Replication Health Check.

IPC Confidential Unigy 4.3

Enterprise Guide
648 17.7: Validation procedures

Figure 133: Replication Health Check Output.log

17.7.11 Run CCM Software Version

Compares the software version of a CCM or ACCM with the mapped software package version in the
database.
You must be logged in to the Unigy Management System and be authorized to generate and view this
test.
This test is not intrusive.
1. Select Tools ➤ Diagnostic.
2. Click Create New Test.
3. Under the Available tests tab select CCM.
4. Select CCM Software Version and click Select.
5. If necessary, select the Zone of the CCM or ACCM you want to run the test on.

Note
It is possible, but not recommended, that diagnostic tests be run during trading hours. IPC
recommends that all diagnostic tests be run after the trading day or during routine maintenance
periods.

6. Click +Assign to select devices. Then do any of the following:

• From the Devices for Zone tab, select one or more devices, then click <Assign.
• From the Device List tab, select a device list (group of devices), then click <Assign.
7. Click Perform Test.
8. Select the test from the grid, then click View Detail.
When the test is complete, the value in the Progress column in the Diagnostics Status Details panel is
100.
9. Click click to view in the Output column.

December 3, 2019 IPC Confidential

 17.7: Validation procedures 649

Figure 134: Software Verification Output Panel

17.7.12 Run MM software version

Verifies the software version of the Media Manager matches the database.
This test is not intrusive.
You must be logged in to the Unigy Management System and be authorized to generate and view this
test.
1. Click Tools ➤ Diagnostic.
2. Click Create New Test.
3. Expand Media Manager in the Available Tests tab.
4. Select the MM Software Version test and click Select.
5. If necessary, select the Zone with the MM you want to run the test on.
6. Click +Assign to select devices. Then do any of the following:
• From the Devices for Zone tab, select one or more devices, then click <Assign.
• From the Device List tab, select a device list (group of devices), then click <Assign.
7. Click Perform Test.
8. To view the status of the test, select the test from the grid then click View Detail.
When the test is complete, the value in the Progress column in the Diagnostics Status Details panel is
100.
9. Click click to view in the Output column.

IPC Confidential Unigy 4.3

Enterprise Guide
650 17.7: Validation procedures

Figure 135: Media Manager Software Verification Output Panel

17.7.13 Run Media Gateway software version

This test verifies that the firmware version running on the Media Gateway matches what is deployed by
Unigy.
You must be logged in to the Unigy Management System and be authorized to generate and view this
test.
This test is not intrusive.
1. Select Tools ➤ Diagnostics.
2. Click Create New Test.
3. Expand Media Gateway from the Available Tests tab.
4. Select the MG Software Version test and click Select.
5. If necessary, select the Zone with the devices you want to run the test on.
6. Click +Assign to select devices. Then do any of the following:
• From the Devices for Zone tab, select one or more devices, then click <Assign.
• From the Device List tab, select a device list (group of devices), then click <Assign.
7. Click Perform Test.
The Diagnostic Status panel is displayed.
8. Select the test from the grid, and click View Detail.
When the test is complete, the value in the Progress column in the Diagnostics Status Details panel is
100.
9. Click click to view in the Output column.

December 3, 2019 IPC Confidential

 17.7: Validation procedures 651

Figure 136: Media Gateway Software Version Output Panel

If the software version on the device is at a lower level than the CCM, go to Tools ➤ Deployment ➤
Software Deployment, click the Deploy tab then upgrade the device.

17.7.14 View registered IQ/MAX and IQ/MAX Edge turrets

View the turrets that are currently registered in the system.
Registered turrets are displayed in the UMS even if they are offline or do not have a logged in user.
Use the legacy (Flash) UMS (https://<your_VIP>/ums/UMSClient.html) or Mass Edit
Client to accomplish this task. This topic describes the legacy procedure.
1. Click Configuration ➤ Sites.
2. Optionally, filter the turrets that will be displayed by Instance, Location, or Zone.
3. Click Communication Devices ➤ IQ/MAX & Edge.
The IQ/MAX & Edge panel displays a list of registered turrets that match the filter criteria, and if
applicable, identifies users who are logged on to the turrets.
4. Click a turret.
The IQ/MAX & Edge panel is displayed. View or edit the turret configuration properties within this
panel. For information on these properties, refer to the UMS online help or the UMS UI Guide.

17.7.15 View registered Pulse devices

View the devices that are currently registered in the system.
Registered devices are displayed in the UMS even if they are offline or do not have a logged in user.
Use the legacy (Flash) UMS (https://<your_VIP>/ums/UMSClient.html) or Mass Edit
Client to accomplish this task.
1. Click Configuration ➤ Sites.
2. Optionally, filter the Pulse devices that will be displayed by Instance, Location, or Zone.
3. Click Communication Devices ➤ Pulse.
The Pulse panel displays a list of registered Pulse devices that match the filter criteria, and if
applicable, identifies users who are logged on to the devices.
4. Click a device.
The Pulse panel is displayed. View or edit the Pulse configuration properties within this panel. For
information on these properties, refer to the UMS online help or the UMS UI Guide.

IPC Confidential Unigy 4.3

Enterprise Guide
652 17.7: Validation procedures

17.7.16 View registered Soft Clients

View the Soft Clients that are currently registered in the system.
Registered Soft Client are displayed in the UMS even if they are offline or do not have a logged in user.
Use the legacy (Flash) UMS (https://<your_VIP>/ums/UMSClient.html) or Mass Edit
Client to accomplish this task.
1. Click Configuration ➤ Sites.
2. Optionally, filter the Soft Clients that will be displayed by Instance, Location, or Zone.
3. Click Communication Devices ➤ Soft Clients.
The Soft Clients panel displays a list of registered Soft Clients that match the filter criteria, and if
applicable, identifies users who are logged on to the clients.
4. Click a Soft Client.
The Soft Client panel is displayed. View or edit the client configuration properties within this panel.
For information on these properties, refer to the UMS online help or the UMS UI Guide.

17.7.17 View registered IQ/MAX TOUCH turrets

View the IQ/MAX TOUCH turrets that are currently registered in the system.
Registered turrets are displayed in the UMS even if they are offline or do not have a logged in user.
Use the legacy (Flash) UMS (https://<your_VIP>/ums/UMSClient.html) or Mass Edit
Client to accomplish this task. This topic describes the legacy procedure.
1. Click Configuration ➤ Sites.
2. Optionally, filter the turrets that will be displayed by Instance, Location, or Zone.
3. Click Communication Devices ➤ IQ/MAX TOUCH.
The IQ/MAX TOUCH panel displays a list of registered turrets that match the filter criteria, and if
applicable, identifies users who are logged on to the turrets.
4. Click a turret.
The IQ/MAX TOUCH panel is displayed. View or edit the turret configuration properties in this panel.
For information on these properties, refer to the UMS online help or the UMS UI Guide.

17.7.18 Monitor devices

Use the UMS Monitoring Dashboard to monitor the current status of Unigy system devices.
UMS user accounts with the role of Advanced Administrator, IPC Certified Technician, and Auditor are
authorized to use UMS monitoring.
To monitor the device from the Topology view, click the device and choose an option from the pop-up
menu:
• Device Details: View more information about the device such as IP, VIP, or MAC address.
• Historical Alerts: View historical alerts for the device.
• Summary Alerts: View current alerts for the device.
• User Information: View user login details for a turret.

December 3, 2019 IPC Confidential

 17.7: Validation procedures 653

17.7.19 Generate system configuration report

This report is used to identify and verify the configuration of any component in the system. This report
displays configuration details for devices in the enterprise and can be filtered by zone, device type, or
device IP address.
The report output also indicates how the zone is being used. If the zone is a dedicated Blue Wave zone,
then the CDIs Allowed and Lines Allowed values in the System Configuration report will be false and
BW Support value will be true. If the zone is a Unigy zone, then the reverse will be indicated. If the
zone is a co-located Blue Wave zone, then the CDIs Allowed and Lines Allowed values will be true and
the BW Support value will also be true.
1. Click Tools ➤ Reporting ➤ Reporting Configuration.
2. Click System Report ➤ SystemConfiguration.
3. Select a report:

To: Do the following:

Run the default report. Select SystemConfiguration_default.

Run the report from a template. Select the template name (if available).

The report filter and output fields are displayed.

Figure 137: SystemConfiguration_default panel

IPC Confidential Unigy 4.3

Enterprise Guide
654 17.7: Validation procedures

4. To run a report, choose one of the following:

• To run the default report, click Run Report.
• To run a custom report, enter or select the appropriate choices and click Run Report.
A File Download dialog box is displayed.
5. Choose one of the following:
• To save the generated report, click Save and select the destination drive and folder in which to
save the report.
• To open the report for display, click Open.
Figure 138: System Configuration Report

17.7.20 Run call control diagnostic tests

17.7.20.1 Run Verify Intercom Connection
This test makes a handset ICM call between two turrets and checks the full-duplex audio quality. It
enables an analog loopback that measures audio levels and the round-trip mouth-to-ear delay.
Duration: Tests approximately 100 turrets in 2 minutes.

Note
This test cannot be performed on Pulse devices. Users must be logged on to the turrets being tested and
an even number of turrets are required.

Usage: This test pairs turrets and each turret dials intercom calls using a personal extension just as if you
were sitting in front of the turret. The test toggles the handset and adjusts the receiving volume on one
turret then performs an audio and VoIP round trip analysis test. The test sends noises and tones in both
directions, conducts audio analysis, and determines if the audio quality of both turrets stays within the
configured thresholds for tone level, noise level, delay, distortion, anomaly, and duration. Also, if a

December 3, 2019 IPC Confidential

 17.7: Validation procedures 655

turret is configured for IP recording, the test sends speech to the voice recorder for further analysis. The
paired turret tests run in parallel.

Note
This test is intrusive. IPC does not advise performing this test during business/trading hours.

You must be logged in to the Unigy Management System and be authorized to generate and view this
test.
1. Select Tools ➤ Diagnostic.
2. Click Create New Test.
3. Expand Call Control from the Available Tests tab.
4. Select the Verify Intercom Connection test and click Select.
5. Provide the required information to define the test. You can use the default values.
Figure 139: Verify Intercom Connection panel

6. If necessary, select the Zone of the turrets you want to run the test on.
7. Click +Assign to select devices. Then do any of the following:
• From the Devices for Zone tab, select one or more devices, then click <Assign.
• From the Device List tab, select a device list (group of devices), then click <Assign.

Note
Select an even number of turrets since the test works with pairs.

8. Click Perform Test.

IPC Confidential Unigy 4.3

Enterprise Guide
656 17.7: Validation procedures

Note
Since this test is intrusive, the following confirmation dialog displays.
Figure 140: Confirmation for intrusive test

If you still want to run this intrusive test, check Execute test during working hours, then click OK.

9. Select the test from the grid, then click View Detail.
When the test is complete, the value in the Progress column in the Diagnostics Status Details panel is
100.
10. Click click to view in the Output column.
If the test fails, check the output to find the cause. Verify no one picked up or hung up the test call.
Resolve the issue and rerun the test.

17.7.20.2 Run Verify Private Line Conference

Establishes a private or open connexion line call on two turrets or the same turret, tests the Media
Manager conference connection, and checks the full-duplex audio quality.
Duration: Configurable. Recommendation is 60 seconds; fastest possible is 5 seconds.
Usage: This test is typically performed on two turrets and requires the same open connexion or private
MRD line assigned to a button on the turret(s) being tested.

Note
Call control tests are intrusive and will hang up any active handset calls to take over the selected turrets.
Therefore, perform this test prior to or after trading hours when no one is using the turrets. All call control
tests run audio and VoIP analysis in both directions to test full duplex quality. This test also sends audio
test tones out towards the private line and is heard by the distant end.

You must be logged in to the Unigy Management System and be authorized to generate and view this
test.
1. Select Tools ➤ Diagnostic.
2. Click Create New Test.
3. Expand Call Control from the Available Tests tab.
4. Select the Verify Private Line Conference test and click Select.

December 3, 2019 IPC Confidential

 17.7: Validation procedures 657

Figure 141: Verify Private Line Conference panel

5. Provide the required information for the test:

a) Select the Source Turret Handset and Target Turret Handset. For example, select Left and Left if
testing two turrets or Left and Right if testing using the same turret.
b) Enter the Source Line Button (1 to 600) for the Open Connexion, ARD, or MRD. This represents
the first selected device. To find a valid button number, go to System Designer ➤ End User
Configuration then select the User of the device and click Face Layout tab.)
c) Enter the Target Line Button (1 to 600) for the Open Connexion, ARD, MRD. This represents the
second selected device. The buttons can be different, what is important is that you are picking up
the same line resource on both turrets so that they are joined to the same Media Manager bridge.
d) Enter the Duration. The recommendation is 60 seconds.
6. If necessary, select the Zone of the turrets you want to run the test on.
7. Click +Assign to select devices. Then do any of the following:
• From the Devices for Zone tab, select one or more devices, then click <Assign.
• From the Device List tab, select a device list (group of devices), then click <Assign.

Note
Select an even number of turrets since the test works with pairs.

8. Click Perform Test.

IPC Confidential Unigy 4.3

Enterprise Guide
658 17.7: Validation procedures

Note
Since this test is intrusive, the following confirmation dialog displays.
Figure 142: Confirmation for intrusive test

If you still want to run this intrusive test, check Execute test during working hours, then click OK.

9. Select the test from the grid, then click View Detail.
When the test is complete, the value in the Progress column in the Diagnostics Status Details panel is
100.
10. Click click to view in the Output column.

17.7.20.3 Run Verify Dialtone Line Connection

This test establishes a dial tone call using a line button on two turrets, or the same turret, and checks the
full-duplex audio quality or outbound call routing.
Duration: Configurable. Recommendation is 60 seconds; fastest possible is 5 seconds.
Usage: Use this test to verify that an external dial tone call can be placed between two Unigy turrets.
Since all turrets will not share the same lines, this test will likely only be used for a few turrets.
However, the same turret's right and left handsets can be used as both the sending and receiving turrets.
You can also use this test to test outbound call routing. For example, you can have a Unigy turret pick up
a specific line and call your cell phone. To accomplish this, select one turret for the test, set the source
line and dial digits to your cell phone number, then set the target line to anything (it is not used). The test
will fail because it expects the target line button to ring, but it will pick up the source line and call your
cell phone.
You must be logged in to the Unigy Management System and be authorized to generate and view this
test.

Note
Call control tests are intrusive and will hang up any active handset calls to take over the selected turrets.
Therefore, perform this test during non-business (non-trading) hours when no one is using the turrets. All
call control tests run audio and VoIP analysis in both directions to test full duplex quality.

1. Select Tools ➤ Diagnostic.

2. Click Create New Test.
3. Expand Call Control from the Available Tests tab.
4. Select the Verify Dialtone Line Connection test and click Select.

December 3, 2019 IPC Confidential

 17.7: Validation procedures 659

Figure 143: Verify Dialtone Line Connection panel

5. Provide the required information to define the test:

a) Select the Source Turret Handset and Target Turret Handset. For example, select Left and Left if
testing two turrets or Left and Right if testing using the same turret.
b) Enter the Dial Digits. These are the digits to dial from the source turret line button you choose to
make the call from.
c) Enter the Source Line Button (1 to 600). This represents the line that the first selected device will
dial from. To find a valid button number, go to System Designer ➤ End User Configuration
then select the User of the device, and click Face Layout tab.)
d) Enter the Target Line Button (1 to 600). This represents the line that the test will wait for
incoming ring and answer on.
e) Enter the Duration. The recommendation is 60 seconds.
6. If necessary, select the Zone of the turrets you want to run the test on.
7. Click +Assign to select an even number of turrets or just one turret. Do any of the following:
• From the Devices for Zone tab, select one or more devices, then click <Assign.
• From the Device List tab, select a device list (group of devices), then click <Assign.
8. Click Perform Test.

IPC Confidential Unigy 4.3

Enterprise Guide
660 17.7: Validation procedures

Note
Since this test is intrusive, the following confirmation dialog displays.
Figure 144: Confirmation for intrusive test

If you still want to run this intrusive test, check Execute test during working hours, then click OK.

9. Select the test from the grid, then click View Detail.
When the test is complete, the value in the Progress column in the Diagnostics Status Details panel is
100.
10. Click click to view in the Output column.

17.7.20.4 Run Verify Inbound Call Connection

This test makes a Unigy turret wait for and answer an inbound dialtone call that you will initiate
manually. It then runs audio VoIP analysis tests on the call.
Duration: Configurable.
Usage: Perform this test to verify an inbound dialtone call connection. You will have one minute to call
the turret once you initiate the test. To verify it answers, the turret will play a -24dBFS test tone
followed by a burst of -24dBFS white noise then loops back your audio for 10 seconds. During the
loopback you should speak to listen to your voice and quality.
You must be logged in to the Unigy Management System and be authorized to generate and view this
test.

Note
Call control tests are intrusive and will hang up any active handset calls to take over the selected turrets.
Therefore, perform this test prior to or after trading hours when no one is using the turrets. All call control
tests run audio and VoIP analysis in both directions to test full duplex quality.

1. Select Tools ➤ Diagnostic.

2. Click Create New Test.
3. Expand Call Control from the Available Tests panel.
4. Select Verify Inbound Call Connection and click Select.

December 3, 2019 IPC Confidential

 17.7: Validation procedures 661

Figure 145: Verify Inbound Call Connection

5. Provide the required information to define the diagnostic test:

a) Select the Source Turret Handset. For example, select Left.
b) Enter the Source Line Button (1 to 600). This represents the line that you will dial in to. To find a
valid button number, go to System Designer ➤ End User Configuration then select the User of
the device and click Face Layout tab.)
c) Enter the Duration (in seconds). For example, enter 5 for the fastest test.
6. If necessary, select the Zone of the turrets you want to run the test on.
7. In the Selected Devices area, click + Assign. In the Available to Assign window, do any of the
following:
• Select one or more devices from the Devices for Zone tab and click < Assign.
• Select a device list from the Device List tab and click < Assign.
8. Click Perform Test.

IPC Confidential Unigy 4.3

Enterprise Guide
662 17.7: Validation procedures

Note
Since this test is intrusive, the following confirmation dialog displays.
Figure 146: Confirmation for intrusive test

If you still want to run this intrusive test, check Execute test during working hours, then click OK.

The Diagnostic Status panel is displayed.

9. Make a phone call to the number on the button you specified in the Source Line Button field as
defined in the Usage statement earlier in this topic.
10. Select the test from the grid, then click View Detail.
When the test is complete, the value in the Progress column in the Diagnostics Status Details panel is
100.
11. Click click to view in the Output column to see results.

17.7.21 Test calls

17.7.21.1 Make an intercom call from a turret
You can make an intercom call by using a predefined directory entry that specifies an intercom
extension, or by specifying an intercom connection when using the Dial Pad. This topic describes how to
use the Dial Pad to make an intercom call.
1. To dial a call, open the Contextual Call Display.
2. Press the ICM (intercom) button.
3. Enter the extension number in using the dialpad.
The call is established using an intercom connection.

17.7.21.2 Dial an intercom call from a Pulse

Use the Dial pad to place an intercom call.
You can place a point-to-point intercom call in several different ways:
• Dial the intercom extension.
• Tap the Favorites intercom button for the user you want to call.
• Use the Unigy directory.

Note
The number of digits in a personal or intercom extension is set in the Unigy Management System. When
dialing an extension that is shorter than the required number of digits, you must pad the extension with
leading zeroes.

December 3, 2019 IPC Confidential

 17.7: Validation procedures 663

1. Tap the Intercom icon.

2. Tap Dial.
3. Dial the extension you want to call.
4. Tap Call.

17.7.21.3 Make an intercom call from a Soft Client

You can make an intercom call by using an intercom point of contact in a directory entry, or by
specifying an intercom connection when using the Dial Pad. This topic describes how to use the Dial
Pad to make an intercom call.
When using the Dial Pad, you can click the down arrow in the number entry box to access a drop-down
list of options, including ICM (intercom).
Figure 147: Dial Pad icon and drop-down options

1 Dial Pad icon

2 Drop-down list for the Dial Pad

1. To dial a call, click the Dial Pad icon in the main window.
The Dial Pad slides out to the right.
2. Click the down arrow for the Dial Pad drop-down list and choose ICM (intercom).
3. Enter the intercom extension number in the number entry box.

Note
A user can have a different personal extension number for internal line calls.

4. Click Call or press the Enter key.

If you are calling a turret, Pulse, Pulse Enterprise, or IQ/MAX Omni end user and the Auto answer
ICM calls feature is enabled, the call is answered automatically. If the Intercom Splash Tone feature
is enabled, a splash tone is played to announce the incoming call.
If the call cannot be completed (for example, if the number is invalid or a user is not logged in), an
error message is displayed in the message area on the main window.
The call is established using an intercom connection.

17.7.21.4 Make a dial tone line call

A dial tone line call is an externally routed, switched call that is connected to an outside party through a
central office (CO) switch or Private Branch Exchange (PBX).

IPC Confidential Unigy 4.3

Enterprise Guide
664 17.7: Validation procedures

If you or your Unigy administrator customized your line status colors, the colors specified in this topic
might be different.
1. Select an idle side for the call by tapping the Left Available status area or the Right Available status
area in the footer of the touch screen. If you want to use the default handset, skip this step.
The selected status area turns to Left Ready or Right Ready, becomes illuminated, and the
Contextual Call Display is opened.

Note
To make this a hands-free call, tap the Hands-Free option in the Contextual Call Display at any time.

2. Tap a dial tone line button on the Favorites button sheet.

The line button turns green, and dial tone is heard.

Note
Optionally, select a previously configured speed dial button to dial that number immediately.

3. Dial the number on the dial pad.

The call is established. The station at the distant end responds in one of the following ways:
• It generates a ringback tone if the call is ringing and waiting to be answered.
• It generates a busy tone if the line is busy and cannot accept a call.
• It generates a re-order (fast busy) tone if there is an error condition.
• It goes off-hook and the call is answered. The Contextual Call Display turns green and displays
call-specific information and options. Adjust settings in the Contextual Call Display for volume,
privacy, and muting as needed.
The following illustrates the display in Favorites after a dial tone call is placed from extension 3048
to extension 3000.
Figure 148: Making a dial tone call

December 3, 2019 IPC Confidential

 17.7: Validation procedures 665

17.7.21.5 Make a line call with automatic line selection

When a call is dialed, the turret automatically searches for an available line on which to transmit the call
(referred to as an implicit hunt).
An implicit hunt for an available line is only performed if the auto hunt feature is enabled for a user
profile through the Unigy Management System.

1. Select an idle side for the call.

The Contextual Call Display opens.
2. On the dial pad, dial the first digit of the phone number.
The word hunting is briefly displayed in the Status Area of the selected handset. The system hunts
for an available line and seizes it.
3. Continue to dial the number.
The system stores the digits until the complete number is entered. The turret dials the stored digits.
Digits are added to the call area Status Area as they are dialed, for example to select options during
an Interactive Voice Response (IVR) call.

17.7.21.6 Make a call from Pulse Enterprise

You can make a call by clicking a point of contact icon on a contact entry, by dialing, or by selecting a
speaker channel.

Note
Dial tone lines are not supported in Pulse Enterprise.

Note
If you have an active call and switch from a wireless to a wired network connection, or from a wired to
wireless connection, the call is dropped, an error message is displayed indicating that you need to log in
again, and the Login window is displayed.

1. Initiate a call using any of the following methods:

• To call a contact using the preferred point of contact, double-click a directory contact entry, right-
click a contact entry and choose Call, or click the contact entry to expand it and click the preferred
point of contact icon.
To call using a different point of contact, right-click the contact entry and choose View Contact
Details, then click the alternate point of contact in the contact profile.
• Click a hoot line, point of contact, or broadcast button in the Button Sheet.
• For intercom calls, click the Dial Pad icon in the Toolbar of the main window, select ICM from the
Dial Pad drop-down list, enter the number in the Dial Pad, and click the Call button.
You can also initiate group intercom calls through the Dial Pad drop-down list.
• Click the speaker activity icon for a channel entry in the Speaker application.
When you initiate a call, a call initiation display appears in the middle of the desktop until the call is
established. Once the call is established, call status information and call controls appear in the Activity
display.
If the line is already busy in a private call, the message area indicates that the call has been rejected.
2. To end the call, click the Release button.
The call is removed from the Activity display.

IPC Confidential Unigy 4.3

Enterprise Guide
666 17.7: Validation procedures

17.7.21.7 Make a call from a search result – Pulse

Establish an intercom call from an intercom directory search result.
1. Tap the Intercom button.
2. Tap Search.
3. Type the search term.
Search results are refined as you type.
4. Tap and hold on the contact you want to call.
5. Tap Call.
The call is established.

17.7.21.8 Make a conference call

Make a conference call by adding lines to an existing call.
You can put a turret in conference mode by pressing the Conference button while in a call or before a
call is started. While in conference mode, you can add or remove lines as needed by pressing buttons
representing private lines or dial tone lines.

Note
• Conference is for dial tone lines and private lines only; it cannot be used with intercom calls.
• If a conference call is placed on hold, the result depends on whether unsupervised conferences are
enabled. If the unsupervised conference feature is not enabled, the conference ends and all lines are
placed on individual holds; you must re-enter conference mode and add the lines to re-establish the
conference.
• Conference mode cannot be disabled during a call.

1. Select a handset side.

The Contextual Call Display shows controls for the call.
2. Establish a call by selecting a line button or using the dial pad.

Note
Only use the dial pad to call when establishing the first call in the conference.

3. Press the Conference key on the selected side of the dial pad.
The Conference icon is displayed in the handset status area.
4. Add a line to the call by tapping a line button from the Favorites application (with signaling if
necessary). You can continue to add lines to the conference by tapping more line buttons without
pressing the Conference key again.
The Contextual Call Display shows the number of lines on the call, and buttons for the lines on the
conference show busy and conference indications.
5. To remove a line from the conference, tap the line button.
The tapped line is removed from the call.
6. To end the call, press the Release button.
All of the lines in the conference are released and the conference ends.

17.7.21.9 Make a conference call from a Soft Client

Make a conference call by adding lines to an existing call.

December 3, 2019 IPC Confidential

 17.7: Validation procedures 667

Note
• Conference is for dial tone lines and private lines only; it cannot be used with intercom calls.
• If a conference call is placed on hold, the result depends on whether unsupervised conferences are
enabled. If the unsupervised conference feature is not enabled, the conference ends and all lines are
placed on individual holds; you must re-enter conference mode and add the lines to re-establish the
conference.

1. While on an active call, click the Conference button in the Activity display.
2. Click additional lines to add to the conference.
To add a dial tone line, seize a dial tone line and dial using the Dial Pad on the main window. (The
dial pad on the Activity display is used only to send digits on an active call.)
You can continue to add parties to a conference call until you release the call.

Note
In a conference call, you can signal only the last manual ringdown (MRD) line added to the
conference.

As lines are added, the Activity display shows the following information:
• On the top row, a conference indicator, the number of attendees, and the elapsed time for the
conference.
• For each line, a row that includes a Release button for that line.
Figure 149: Conference Activity display

Lines in the conference appear as busy on line buttons.

3. To remove a line that you added from a conference call that you initiated, click the Release button
next to the line.
You can also click the associated line button to remove a line from the conference.
The conference continues with the remaining lines. This is also the case if a distant user exits the
conference.
4. To exit the conference call, click the main Release button on the Activity display.
All lines are released and the conference ends, unless there is another turret or Unigy Soft Client user
on the conference. In that case, that turret or Soft Client user assumes ownership of the conference,
which continues until the last turret or Soft Client user releases the call.

17.7.21.10Make a group call from the directory – Pulse

Establish an intercom call to an intercom group from the intercom directory.

IPC Confidential Unigy 4.3

Enterprise Guide
668 17.7: Validation procedures

1. Tap and hold a group name.

The group details are displayed.
2. Tap Call to place an intercom call to that group.

17.7.22 Verify IP Recording Status

Use this panel to check that recording streams are connected and mixing the correct audio.
Only users with the IPC Certified Tech role can access, create, schedule, and run this diagnostic test.
To access this panel, click Tools ➤ Diagnostic. Click Create New Test. Expand Turret & Pulse, then
select the Verify IP Recording Status check box and click Select.

Table 71: Selected Devices

Name Descriptions Values Notes

Device Name Names of Selected communication
communication devices devices to run this test
selected from the on.
Available Devices or
Device List panels.

Table 72: Available Devices

Name Description Values Notes

Name Unigy communication List of registered To filter the list, enter
device names. communication devices device search criteria.
for the selected zone. To remove the filter, click
the x icon in the search
field.
Login Name Name of the user logged List of users. To filter the list, enter
in to the communication login name search
device. criteria. To remove the
filter, click the x icon in
the search field.

Table 73: Device List

Name Description Values Notes

Device List Name Names of String. Up to 255 To filter the list, enter
communication device alphanumeric device list name search
lists. characters. criteria. To remove the
filter, click the x icon in
the search field. To
delete a device list, click
the minus icon next to
the device list name.

December 3, 2019 IPC Confidential

 17.7: Validation procedures 669

Table 74: Available Tests

Name Description Values Notes

Zone Filter field for specifying List of available zones. Test can only be
the devices to display Select the zone that executed in one zone at
based on the zone you contains the devices you a time.
select. want to create the
diagnostic test for.
Search Topic... Text field for entering
search criteria to locate
a test.

Table 75: Available Templates

Name Description Values Notes

Name Names of available Up to 64 alphanumeric Long names do not
diagnostic templates. characters. wrap and may require
resizing the panel to
view them.
To filter the list, enter
template name search
criteria. To remove the
filter, click the x icon in
the search field. To
select a template, drag it
to the New Diagnostic
Test tab. To delete a
template, click the minus
icon next to the template
name.
VoIP Quality Preconfigured provided
for IPC Certified Techs
that contains all tests
and commands related
to VoIP Quality.
IP Recording Preconfigured provided
for IPC Certified Techs
that contains all tests
and commands related
to IP recording.
Patch Upgrade Preconfigured template
provided for IPC Note
Certified Techs that
contains all tests and Informational
commands used to diagnostics cannot be
verify all Unigy added to this template.
components are However, it is possible
operational after a patch to create a custom
upgrade. template containing any
combination of individual
walk the floor tests and
informational tests.

IPC Confidential Unigy 4.3

Enterprise Guide
670 17.7: Validation procedures

Table 76: Buttons

Name Description
Search Search the available tests for the text entered in the Search
Topic... field. Filters the list on the basis of this text.

Reset Reset the available tests tree to its original state.

Expand All ( + ) Expand all nodes of the available tests tree.
Collapse All ( - ) Collapse all nodes of the available tests tree.
Save as Template Save the selected tests and values as a diagnostic template
for future use.
Save Device List Save the list of devices for future use.
Schedule Test Schedule selected diagnostic test to be run on selected
devices.
Cancel Cancel diagnostic test(s) currently being configured.
Perform Test Perform diagnostic test(s) on selected device(s).
Remove Remove the selected device.

17.7.23 Run CCM AFM Alerts test

Generates an SNMP test trap to port 162 for manual verification that the event is logged. The test alert
will be sent to all configured NOCs.
Duration: Less than 10 seconds.
Usage: Perform this test to ensure that the Critical Alert is receiving alerts from the Unigy system.
This test is not intrusive.
You must be logged in to the Unigy Management System and be authorized to generate and view this
test.
1. Select Tools ➤ Diagnostic.
2. Click Create New Test.
3. Expand CCM in the Available tests tab.
4. Select AFM Alerts Test and click Select.
5. If necessary, select the Zone with the CCM you want to run the test on.
6. Click +Assign to select devices (CCMs or ACCMs). Then do any of the following:
• From the Devices for Zone tab, select one or more devices, then click <Assign.
• From the Device List tab, select a device list (group of devices), then click <Assign.
7. Click Perform Test.
The Diagnostic Status panel is displayed.
8. Select the test from the grid, then click View Detail.
When the test is complete, the value in the Progress column in the Diagnostics Status Details panel is
100.
9. Click click to view in the Output column.

December 3, 2019 IPC Confidential

 17.7: Validation procedures 671

Figure 150: CCM AFM Alerts Test Output panel

17.7.24 Test HA
Confirm that a zone responds properly to an HA failover.
1. Ensure that there is at least one active call.
2. Perform the procedure Force an HA failover on page 546.
3. For stateful HA, confirm that calls that were active prior to the failover are still active. For stateful
and stateless HA, confirm that you can make calls and can access the UMS.

17.7.25 Test BCP

Use this procedure to test BCP.
1. Perform the procedure Manually activate a BCP plan (fail over) on page 294
2. Perform the procedure Deactivate a BCP plan (fail back) on page 296

17.7.26 Validate JGroups protocol values for the Unigy and Blue Wave channels on an
appliance - manual procedure
This topic describes how to validate the JGroups protocol values set for the Unigy Replicator and Line
Status channels, Blue Wave Adapter Async and RPC channels, and Blue Wave Director Async and RPC
channels on a Unigy or Blue Wave appliance.
The protocol settings for the Unigy channels are in the following files:
• Unigy Replicator channel: interzone-pers.xml
• Unigy Line Status channel: interzone.xml
The protocol settings for the Blue Wave Adapter channels are in the following files:
• Blue Wave Adapter Async channel: bw_adaptor_jgroups_config.xml
• Blue Wave Adapter RPC channel: bw_adapter_jgroups_rpc_config.xml
The protocol settings for the Blue Wave Director channels are in the following files:
• Blue Wave Director Async channel: bw_director_jgroups_config.xml

IPC Confidential Unigy 4.3

Enterprise Guide
672 17.7: Validation procedures

• Blue Wave Director RPC channel: bw_director_jgroups_rpc_config.xml

The InstallProtParallelXML and InstallProtParallelXMLBWD scripts run these
commands and save the output to the Merge3_Validation_Allservers.txt and
Merge3_Validation_BWservers.txt files in the /var/spool/backup/EXP5 directory. If you ran
these scripts, it is not necessary to perform this procedure, instead, display the contents of these text files
on each appliance as described in the protocol update procedures that update the JGroups configuration
files using the wrapper scripts.
1. Access the command line on the appliance for which you are validating the JGroups protocol values.
2. Run the command su -lp and enter the root user account password.
3. For the Unigy Replicator and Line Status channels run the following commands; these apply to Unigy
and Blue Wave appliances:
a) grep -i merge3 /etc/opt/ipc/ds/interzone.xml /etc/opt/ipc/ds/interzone-pers.xml
The output should be:
/etc/opt/ipc/ds/interzone.xml: <MERGE3
/etc/opt/ipc/ds/interzone-pers.xml: <MERGE3

b) grep -i fd_all /etc/opt/ipc/ds/interzone.xml /etc/opt/ipc/ds/interzone-pers.xml

The output should be:
/etc/opt/ipc/ds/interzone.xml: <FD_ALL
/etc/opt/ipc/ds/interzone-pers.xml: <FD_ALL

c) grep -i unicast3 /etc/opt/ipc/ds/interzone.xml /etc/opt/ipc/ds/interzone-pers.xml

The output should be:
/etc/opt/ipc/ds/interzone.xml: <UNICAST3
/etc/opt/ipc/ds/interzone-pers.xml: <UNICAST3

d) grep -i nakack2 /etc/opt/ipc/ds/interzone.xml /etc/opt/ipc/ds/interzone-pers.xml

The output should be:
/etc/opt/ipc/ds/interzone.xml: <pbcast.NAKACK2
/etc/opt/ipc/ds/interzone-pers.xml: <pbcast.NAKACK2

4. For the Blue Wave Adapter Async and RPC channels, run the following commands; these apply to
Unigy and Blue Wave appliances:
a) grep -i merge3 /etc/opt/ipc/bluewave/bw_adaptor_jgroups_config.xml /etc/opt/ipc/bluewave/
bw_adapter_jgroups_rpc_config.xml
The output should be:
/etc/opt/ipc/bluewave/bw_adaptor_jgroups_config.xml: <MERGE3
/etc/opt/ipc/bluewave/bw_adapter_jgroups_rpc_config.xml: <MERGE3

b) grep -i fd_all /etc/opt/ipc/bluewave/bw_adaptor_jgroups_config.xml /etc/opt/ipc/bluewave/

bw_adapter_jgroups_rpc_config.xml
The output should be:
/etc/opt/ipc/bluewave/bw_adaptor_jgroups_config.xml: <FD_ALL
/etc/opt/ipc/bluewave/bw_adapter_jgroups_rpc_config.xml: <FD_ALL

c) grep -i unicast3 /etc/opt/ipc/bluewave/bw_adaptor_jgroups_config.xml /etc/opt/ipc/bluewave/

bw_adapter_jgroups_rpc_config.xml

December 3, 2019 IPC Confidential

 17.8: Miscellaneous procedures 673

The output should be:

/etc/opt/ipc/bluewave/bw_adaptor_jgroups_config.xml: <UNICAST3
/etc/opt/ipc/bluewave/bw_adapter_jgroups_rpc_config.xml: <UNICAST3

d) grep -i nakack2 /etc/opt/ipc/bluewave/bw_adaptor_jgroups_config.xml /etc/opt/ipc/bluewave/

bw_adapter_jgroups_rpc_config.xml
The output should be:
/etc/opt/ipc/bluewave/bw_adaptor_jgroups_config.xml: <pbcast.NAKACK2
/etc/opt/ipc/bluewave/bw_adapter_jgroups_rpc_config.xml:
<pbcast.NAKACK2

5. For the Blue Wave Director Async and RPC channels, run the following commands; these apply only
to Blue Wave appliances:
a) grep -i merge3 /etc/opt/ipc/bluewave/bw_director_jgroups_config.xml /etc/opt/ipc/bluewave/
bw_director_jgroups_rpc_config.xml
The output should be:
/etc/opt/ipc/bluewave/bw_director_jgroups_config.xml: <MERGE3
/etc/opt/ipc/bluewave/bw_director_jgroups_rpc_config.xml: <MERGE3

b) grep -i fd_all /etc/opt/ipc/bluewave/bw_director_jgroups_config.xml /etc/opt/ipc/bluewave/

bw_director_jgroups_rpc_config.xml
The output should be:
/etc/opt/ipc/bluewave/bw_director_jgroups_config.xml: <FD_ALL
/etc/opt/ipc/bluewave/bw_director_jgroups_rpc_config.xml: <FD_ALL

c) grep -i unicast3 /etc/opt/ipc/bluewave/bw_director_jgroups_config.xml /etc/opt/ipc/bluewave/

bw_director_jgroups_rpc_config.xml
The output should be:
/etc/opt/ipc/bluewave/bw_director_jgroups_config.xml: <UNICAST3
/etc/opt/ipc/bluewave/bw_director_jgroups_rpc_config.xml: <UNICAST3

d) grep -i nakack2 /etc/opt/ipc/bluewave/bw_director_jgroups_config.xml /etc/opt/ipc/bluewave/

bw_director_jgroups_rpc_config.xml
The output should be:
/etc/opt/ipc/bluewave/bw_director_jgroups_config.xml: <pbcast.NAKACK2
/etc/opt/ipc/bluewave/bw_director_jgroups_rpc_config.xml:
<pbcast.NAKACK2

17.8 Miscellaneous procedures

17.8.1 Remove button association properties
Use the UMS to remove a button from the button sheet for a user or an end user group.

Note
Use the legacy (Flash) UMS (https://<your_VIP>/ums/UMSClient.html) or Mass Edit
Client to accomplish this task.

IPC Confidential Unigy 4.3

Enterprise Guide
674 17.8: Miscellaneous procedures

A user must have one of the following roles to make changes to fields in this panel: Basic Administrator,
Advanced Administrator, IPC Project Manager, or IPC Certified Tech.
1. Click System Designer ➤ End User Configuration.
The End User Groups list and the Users list are displayed.
2. do one of the following:
• To remove buttons for future members of an end user group, select the end user group.
• To remove buttons for a user, select the user.
3. Select the device type from the list.
The tabs supported by this device type are displayed. Tabs not supported by this device type are
inactive (grayed out).
4. Click the appropriate tab, depending on the device:
• For IQ/MAX TOUCH, click Favorites.
• For IQ/MAX and IQ/MAX Edge, click Face Layout; then select the appropriate number from the
BU's (Buttons Units) list.
5. CTRL+ click or double-click the button you want to remove.
The Edit Button menu is displayed.
Figure 151: Edit Button menu

6. Click Remove Association.

You are asked to confirm the operation.
7. Click Yes.
8. In the top panel, click Save.

17.8.2 Configure turret network settings

Configure the network settings on a turret.
This task can be performed by system administrators or users with administrative privileges.
The following network information is required to complete this task:
• Domain name: This is not required for DHCP deployment.
• DHCP or static IP settings
• NIC duplex mode
• Server information

December 3, 2019 IPC Confidential

 17.8: Miscellaneous procedures 675

1. If the turret is logged in, and the Application Launch Pad is displayed, select Settings and proceed to
the next step. Otherwise, the Waiting for Backroom screen is displayed. From the Waiting for
Backroom screen, select Admin.
2. From the Programming shortcuts menu, select More ➤ Admin.
3. Enter the administration password and select Next.
4. Press Configure Network.
5. Press IP Config to set your IP configuration.
• Select:
• Use DHCP - for dynamic IP addressing.
• Static IP - for static addressing (DHCP disabled):
1. Enter a Station IP Address.
2. Enter a Subnet Mask.
3. Enter a Default Gateway.
4. Enter a Domain Name.
Press Save after each step.
6. Press Servers.
a) Select:
• CCM - Enter the Converged Communications Manager IP address.
• NTP Servers - Press this button to enter or edit NTP server information.
• NTP Server - Toggles between your NTP servers.
• Edit - Edit your NTP server information.
• Enter IP Address - Enter the IP address for your NTP server.
• Remove - Removes the displayed NTP server.
A system administrator could configure the enterprise DHCP service to send DHCP option 66 or
112 to automatically configure turret IP addresses. To accept new addresses through DHCP, press
Use DHCP Values and commit the change again.

Note
When option 66 is updated, the new values are taken on reboot, not on the fly.

b) Press Save.
7. Press Advanced Settings.
a) Press the NIC Duplex button.
b) Press the Primary NIC button to toggle between modes.
The modes are:
• Auto (default) - Choose this for optimal performance.
• 100 Full

Note
Always use Auto, unless explicitly told to use 100 Full.

IPC Confidential Unigy 4.3

Enterprise Guide
676 17.8: Miscellaneous procedures

c) Press Save.
8. At the Configure Network screen, press Commit. Press OK when the changes have been committed.
The network configuration settings are applied to the turret.
9. At the Admin menu, select Restart Station ➤ Restart.
The turret is restarted with the updated network configuration settings.

17.8.3 Configure Pulse network settings

Network settings must be configured by an administrator for the device to function on the network.
Figure 152: Pulse network settings

1. Select Settings from the Application Launch Pad.

2. Tap Admin.
3. Enter your administration password and press Done.
The administration menu is displayed.
4. Tap Network.
a) Tap Enable DHCP to toggle DHCP addressing On or Off.
b) For static IP configurations, enter the CCM IP Address.
c) Enter the Pulse Module IP Address, Subnet Mask, and Gateway IP Address.
d) Configure the Pulse NIC speed and duplex settings in Autonegotiate Network Port Speed.
Auto-negotiation is recommended and is enabled by default at the factory.
5. Tap Save Changes.
A dialog prompts you to restart the device and apply the network settings.

Note
The device must be restarted when switching between static and DHCP addressing.

17.8.4 Create, edit, or delete lines and extensions with Mass Edit Client
Complete this procedure to create, edit, or delete a large number of line ResourceAORs (private lines,
extensions, OOPS, or Open Connexions) using the Mass Edit Client Lines and Extensions feature,
which is an interactive, macro-enabled spreadsheet accessible from the UMS.

1. Log in to the UMS of a zone that has Unigy software version 3.0 or higher installed.
2. Click Tools ➤ Mass Edit Client ➤ Lines and Extensions and then: Private Lines, Extensions,
OOPS, Open Connexion, or PBX Shared Lines.

December 3, 2019 IPC Confidential

 17.8: Miscellaneous procedures 677

Note
This procedure illustrates working with the Mass Edit Client Extension feature (the
LinesAndExtensionsExtensions.xlms spreadsheet). The other spreadsheets have
different names and different line properties (cells) but the steps are basically the same when
interacting with Private Lines, OOPs, Open Connexion, or PBX Shared Lines spreadsheets.

3. Open the spreadsheet.

4. If the spreadsheet opens in protected view, click Enable Editing in the yellow bar at the top of the
spreadsheet. Click Enable Content. If prompted, click Yes to make this file a trusted document.
5. Click Log In.
For information on the Login fields, refer to Login Mass Edit Client on page 706.
6. Within the Login dialog box, click Login.
The spreadsheet updates to show that it is connected to the VIP and now has additional buttons across
the top. Notice too that the first three rows in Column B display User and VIP login information and
indicate Connected.
Figure 153: Search tab with user logged on (connected)

7. Click New Search.

The Lines And Extensions Extensions search dialog box opens.
Figure 154: Lines and Extensions Search dialog box

8. To return all currently configured extensions, click Search. (Optionally, enter search criteria.)
Partial values can be entered as search criteria in conjunction with wild card characters. The Mass
Edit Client Search dialog box supports the percent symbol and underscore as wild card characters to
be entered as search criteria. The percent symbol % matches zero or more characters. The underscore
character _ matches exactly one character. If one of the wild card characters is included in the data
being searched, use the back slash character \ before that character to escape the special meaning of
the wild card character. The same also applies to escape the special meaning of the back slash
character.
While the search is in progress, cell B3 of the spreadsheet turns pink and indicates Searching...
alternating with Displaying... as records are retrieved and displayed in blocks, until all records

IPC Confidential Unigy 4.3

Enterprise Guide
678 17.8: Miscellaneous procedures

are retrieved. When the search is complete, cell B3 turns green and indicates Loaded. Cell A3 of the
spreadsheet displays the number of rows (database records) loaded.
Figure 155: Populated LinesAndExtensionsExtensions.xlsm spreadsheet

9. Locate the rows (that is, extensions) to edit, then in Column A, Action, select Update from the list.
Extensions can also be marked for deletion by selecting Delete in the Action Column. In the
following example, one extension is marked for update and another for deletion.
Figure 156: Selecting Update or Delete in Action Column of the Search tab

10. Click Prepare Changes.

A macro copies the rows marked for Update or Delete from the Search tab to the Changes tab and
displays them.
Figure 157: Changes tab after clicking Prepare Changes

Note
The color of the text in the cells of the Changes tab indicates which are editable (black) and which are
read-only (blue).

11. To edit a row marked for Update, either select an option from a list or type in the value.

Tip
If a drop-down list of valid values is not available in the cell you want to edit, access the Enum Loader
tab to load label and value pairs.

12. If necessary, click the Enum Loader tab and click either Load Dynamic Enums or Load Static
Enums to return a list of Enum label and value pairs for the properties that require entry of an Enum

December 3, 2019 IPC Confidential

 17.8: Miscellaneous procedures 679

value instead of the property label. You can copy and paste a valid value from this tab to the
appropriate cell of the Changes tab.
13. To create a new extension, click Create Record in the Changes tab, then fill in the required
properties.
14. To load user or MG trunk information to associate with extensions (or private lines), click the
Associations tab then click either Load Users or Load MG Trunks.
Information for the user(s) or MG trunks is loaded.

Note
Only users that are members of an End User Group and do not yet have an extension assigned to
them can display here.

Figure 158: Associations tab

15. For users, if necessary, copy the appropriate User ID from the Associations tab and paste to the
appropriate cell of the Associated User Id column in the Changes tab to assign this individual that
extension.
16. For trunks, if necessary, copy the appropriate Trunk ID from the Associations tab and paste to the
appropriate cell of the same column in the Changes tab.
17. When the updates in the Changes tab are ready to be validated, click Validate Changes.
If the validation is successful, an information dialog displays.
18. Click OK.
19. When the changes are complete and ready to be saved to the Unigy database, click Save Changes.
If the changes are valid, they are saved and a summary of the request(s) are displayed in the Save
Progress tab.

If the save process fails, Column E will indicate one or more failures. Also, the Action Column of the
Changes tab indicates Failed and is highlighted with a red background, and a Failure Message
displays in the last column of that row in the spreadsheet..
20. Click Save Changes.
The changes, if valid, are saved and a summary of the request(s) display in the Save Progress tab.
21. If there are failures, click the Changes tab and review each Failure Message. The message identifies
a field whose value could not be saved. Do any of the following in the Changes tab to attempt to fix
the failure:
a) Try to correct the value(s) if any are identified in the Failure Message column before changing the
Action back to the original operation attempted (that is, Update or Create or Delete) and saving
the changes again.
b) To re-enter all the changes (including recreating any new lines or extensions), click Clear
Changes, then click the Search tab and change the Action from Prepared back to Update
(Column A) for each proposed change. Repeat the process by clicking Prepare Changes, make

IPC Confidential Unigy 4.3

Enterprise Guide
680 17.8: Miscellaneous procedures

the changes again (and re-add new records too if desired), click Validate Changes, then click
Save Changes.
22. Repeat from Prepare Changes in step 10 to make more edits to the same extensions or complete a
new search (step 8) to edit different extensions.

Note
To work with other types of Resource AORs, return to the UMS Tools ➤ Mass Edit Client ➤ Lines and
Extensions feature and select a different type.

23. Optionally, save the spreadsheet locally for your records.

24. Logout, and close the LinesAndExtensionsExtensions.xlsm spreadsheet.

17.8.4.1 Enum Loader tab

The Enum Loader tab provides Enum label and value pairs for properties (cells) in a Mass Edit Client
spreadsheet that require entry of an Enum value instead of the property’s label, which is visible in the
UMS user interface that maps to the property.
Enums can be static or dynamic.
Static Enums use a finite set of valid values defined in the system to represent the property’s labels.
Valid Static Enum values display as drop-down selections in the cells of the spreadsheets and you
populate these in the Changes tab by clicking the appropriate value from the list. The labels for these
values are more meaningful than the value so you use the Enum Loader tab to load the label and value
pairs to get a better understanding of what the value represents.
Dynamic Enums are used for properties that have user-defined values. For example, the values for the
Unigy Location property can be created by the UMS user to suit their environment. The values could be
New York Back Room and New York Front Room, and in this case the system might use an Enum
value of 1 for New York Back Room and an Enum value of 2 for New York Front Room. In that case,
you would need to enter a 1 or a 2 in the Unigy Location cell of the Changes tab of the Mass Edit
Client spreadsheet instead of New York Back Room New York Front Room because dynamic
Enum values do not appear as drop down selections in the Changes tab.
For any Enum, you can copy the appropriate value from the Enum Loader tab and paste it into the
appropriate cell of the Changes tab.
If there are no Enums for a particular spreadsheet, the Enum Loader tab is not displayed in the
spreadsheet. The following is an example of the Enum Loader tab of the userProperties.xlsm
spreadsheet.
Figure 159: Mass Edit Client Media Gateway Enum Loader tab

The following table identifies some examples of enumerations used. It is not intended to be a complete
list.

December 3, 2019 IPC Confidential

 17.8: Miscellaneous procedures 681

Table 77: Properties requiring Enum value instead of label in Mass Edit Client

Mass Edit Client Editable Sub-Entities Static Enum Values Dynamic Enum
Entity Values
Button Properties NA No
Speaker Properties No No
User Properties Locale, Account Active, Date Display Format,
Authentication Type Time Display Format,
Location, Account
Policy, Configuration
Group, Authentication
Domain
Address Address Type No
Contact Type No
Point of Contact Media Type, Point of Contact No
Type
Notes No No
Trader Features Auto Select/Hold, Language, Unigy Location, Billing
CLI Display Preference, Group, MusicOnHold,
Handset Call Mute Options, Home Zone, Float
Speaker Microphone Mute priority profile, Codec
Options, Condition for Profile, Intercom
Intercom Calls Diversion, Splash Tone
Intercom Diversion Mode,
Handset Button Press and
Release Actions, Handset
Select Mode, Record on
Demand
Audio Handset Receive Noise Record Mix Profile
Reduce Mode, Handset
Transmit Noise Reduce
Mode, Handset Receive
Equalization, Speaker
Transmit Noise Reduce
Mode, Speaker Receive
Equalization, HFM Transmit
Noise Reduce Mode, HFM
Transmit Auto Gain Control
Mode, HFM Receive
Equalization, Recording
protocol, LineIn Mixer Output
Module, Speaker Replay
Playback Output Module
Display Pinned application on Button No
Module 1, Pinned application
on Button Module 2, Pinned
application on Button Module
3, Number of increments in
calls progress bar, Font face
for button descriptors, Font
size for button descriptors

IPC Confidential Unigy 4.3

Enterprise Guide
682 17.8: Miscellaneous procedures

Table 77: Properties requiring Enum value instead of label in Mass Edit Client (continued)

Mass Edit Client Editable Sub-Entities Static Enum Values Dynamic Enum
Entity Values
Soft Client Default Application Record Mix Profile
Trunk Trunk Type, Connected Party No
Analog Update, Far End Connection,
Outgoing Transport Type,
Telephone Profile, Echo
Canceler, Connection Type,
Channel Select Mode
Protocol Type, Trunk Type, No
CAS Connection Type, Connected
Party Update, Dialing Mode,
SubscribeMWI, Channel
Select Mode, Registration
Mode, Outgoing Transport
Type, Echo Canceler, Play
Ringback Tone to Trunk
Protocol Type, Connected No
ISDN Party Update, SubscribeMWI,
Outgoing Transport Type,
Connection Type, Channel
Select Mode, Registration
Mode, Echo Canceler, Play
Ringback Tone to Trunk,
ISDN Termination Side, QSIG
Transfer Mode, ISDN Transfer
Capabilities, Progress
Indicator to ISDN, Enable
Receiving of Overlap Dialing,
Far End Connection
Trunk Type, Connection Type, Zone, Media Manager
SIP Outgoing Transport Type, Profile
Connected Party Update,
Diversion Header

December 3, 2019 IPC Confidential

 17.8: Miscellaneous procedures 683

Table 77: Properties requiring Enum value instead of label in Mass Edit Client (continued)

Mass Edit Client Editable Sub-Entities Static Enum Values Dynamic Enum
Entity Values
Media Gateway Properties Gateway TDM Type, Location, CODEC
Disconnect Call on Busy Tone Profile
Detection, Disconnect on Dial
Tone, Dialing Mode, Waiting
for Dialtone, Echo Canceller,
Answer Supervision, Channel
Select Mode, SIP Transport
Type, Enable SIPS, Enable
TCP Connection Reuse,
Enable Remote Party ID, Add
Number Plan and Type to RPI
Header, Play Ringback Tone
to Tel, Enable Semi Attended
Transfer, Digital Cut Through,
Use Default Proxy, Proxy
Redundancy Mode, Always
Use Proxy, Mutual
Authentication Mode, Caller
ID, Disconnect on Broken
Connect, DTMF Transport
Type, Enable Current
Disconnect, Enable DID
Wink, Enable Hold, Silence
Suppression, Out-Of-Service
Behavior, Incoming Transport
Type
IQ/MAX TOUCH Device > General Device State, NIC Settings, Location
Parameters Turret Personality
Device > Audio No No
Parameters
Device > VoIP Transport, DSPJitter Buffer Media Manager Profile,
Parameters Implementation Mode CODEC Profile
Device > Inbound Tone No No
Levels
Device > Outbound Tone No No
Levels
Device > Engineering No No
Access Parameters
Device > SNMP SNMP Version Use SNMP Profile
Parameters
Device > BCP No No
Preference
Device > VoIP Quality VQ Report Mode, Mode, No
Metrics Protocol

IPC Confidential Unigy 4.3

Enterprise Guide
684 17.8: Miscellaneous procedures

Table 77: Properties requiring Enum value instead of label in Mass Edit Client (continued)

Mass Edit Client Editable Sub-Entities Static Enum Values Dynamic Enum
Entity Values
Trader > Features Auto Select/Hold, Language, Unigy Location, Billing
CLI Display Preference, Group, MusicOnHold,
Handset Call Mute Options, Home Zone, Float
Speaker Microphone Mute priority profile, Codec
Options, Condition for Profile, Intercom
Intercom Calls Diversion, Splash Tone
Intercom Diversion Mode,
Handset Button Press and
Release Actions, Handset
Select Mode, Record on
Demand
Trader > Audio Handset Receive Noise Record Mix Profile
Reduce Mode, Handset
Transmit Noise Reduce
Mode, Handset Receive
Equalization, Speaker
Transmit Noise Reduce
Mode, Speaker Receive
Equalization, HFM Transmit
Noise Reduce Mode, HFM
Transmit Auto Gain Control
Mode, HFM Receive
Equalization, Recording
protocol, Speaker Replay
Playback Output Module
Trader > Display UI Font Size, High Priority No
Calls, Low Priority Calls,
iBusy, iHold, uBusy, uHold
Speaker Directory Group No No
> Members
Turret General Properties Device State, NIC Settings, Location
Turret Personality, Speaker
License
Audio Parameters No No
VoIP Parameters Transport, DSPJitter Buffer Media Manager Profile,
Implementation Mode CODEC Profile
Inbound Tone Levels No No
Outbound Tone Levels No No
Engineering Access No No
Parameters
SNMP Parameters SNMP Version Use SNMP Profile
BCP Preference No No
VoIP Quality Metrics VQ Report Mode, Mode, No
Protocol

December 3, 2019 IPC Confidential

 17.8: Miscellaneous procedures 685

Table 77: Properties requiring Enum value instead of label in Mass Edit Client (continued)

Mass Edit Client Editable Sub-Entities Static Enum Values Dynamic Enum
Entity Values
Pulse General Properties Device State, NIC Settings, Location
Personality, Speaker License
Audio Parameters No No
VoIP Parameters Transport, DSP Jitter Buffer Media Manager Profile,
Implementation Mode CODEC Profile
Inbound Tone Levels No No
Outbound Tone Levels No No
Engineering Access No No
Parameters
SNMP Parameters SNMP Version Use SNMP Profile
BCP Preference No No
VoIP Quality Metrics VQ Report Mode, Mode, No
Protocol
Soft Client General Properties Device State, Audio NetEQ, CODEC Profile
Audio VAD, Audio NS, Audio
AGC, Audio EC, Audio VQEs,
Speaker Channel License
Inbound Tone Levels No No
Outbound Tone Levels No No
BCP Preference No No
VoIP Quality Metrics VQ Report Mode, Mode, No
Protocol
Lines and Private Lines Private Line Type, Handset Alliance Site, Instance
Extensions Mute, Mic Mute, Forking
Type, Source
Extensions Handset Mute, Mic Mute, OOPS Resource,
Diversion Reason, Source Alliance Site, Instance
OOPs Type, Handset Mute, Mic Alliance Site, Instance
Mute, Source
Open Connexion No Instance
Zone Dial Pattern Properties No Zone
Location Dial Properties No Instance
Pattern
Location Mappings No Instance
Enterprise Contact General Properties Type No
Point of Contact Media Type, Point of Contact No
Type
Personal Contact General Properties Locale, Type No

IPC Confidential Unigy 4.3

Enterprise Guide
686 17.8: Miscellaneous procedures

Table 77: Properties requiring Enum value instead of label in Mass Edit Client (continued)

Mass Edit Client Editable Sub-Entities Static Enum Values Dynamic Enum
Entity Values
Point of Contact Media Type, Point of Contact No
Type
Address Address Type No
Notes No No
Directory Category General Properties No No

17.8.5 Edit button sheets with Mass Edit Client

Complete this procedure to edit a large number of buttons using the Mass Edit Client Button feature,
which is an interactive, macro-enabled spreadsheet accessible from the UMS.

1. Log in to the UMS of the zone that has Unigy software version 3.0 or higher installed.
2. Click Tools ➤ Mass Edit Client ➤ Button.
3. Open the spreadsheet using a supported version of Internet Explorer that is installed on the PC.
A Windows Internet Explorer dialog box opens prompting What do you want to do with
ButtonProperties.xlsm?.
4. Click Open.
5. If a Security Alert dialog box opens and prompts Do you want to proceed?, click Yes.
6. If a Select Certificate dialog box opens, click OK.
7. If a Windows Security dialog box opens, enter your User name Password and click OK or optionally
just click OK. (This happens twice.)
The spreadsheet downloads and opens in Excel.
8. If the spreadsheet opens in protected view, click Enable Editing in the yellow bar at the top of the
spreadsheet. Click Enable Content. If prompted, click Yes to make this file a trusted document.
9. Click Log In.
For information on the Login fields, refer to Login Mass Edit Client on page 706.
10. Within the Login dialog box, click Login.
The spreadsheet updates to show that it is connected to the VIP and now has additional buttons across
the top. Notice too that the first three rows in Column B display User and VIP login information and
indicate Connected.
Figure 160: Search tab with user logged on (connected)

11. Click New Search.

The Button Search dialog box opens.

December 3, 2019 IPC Confidential

 17.8: Miscellaneous procedures 687

Figure 161: Button Search dialog box

12. Enter search criteria in at least one field. For example, enter the name of an End User Group in the
Group Name field to load all users in that group. Then click Search.

Partial values can be entered as search criteria in conjunction with wild card characters. The Mass
Edit Client Search dialog box supports the percent symbol and underscore as wild card characters to
be entered as search criteria. The percent symbol % matches zero or more characters. The underscore
character _ matches exactly one character. If one of the wild card characters is included in the data
being searched, use the back slash character \ before that character to escape the special meaning of
the wild card character. The same also applies to escape the special meaning of the back slash
character.
While the search is in progress, cell B3 of the spreadsheet turns pink and indicates Searching...
alternating with Displaying... as records are retrieved and displayed in blocks, until all records
are retrieved. When the search is complete, cell B3 turns green and indicates Loaded. Cell A3 of the
spreadsheet displays the number of rows (database records) loaded. For Mass Edit Client Buttons, the
count is always a multiple of 600 because there are 600 buttons per button sheet and search criteria is
matched on a button sheet basis.

Caution
While it is possible to log out and disconnect to edit the downloaded button sheets, doing so runs the
risk of working with an outdated copy because of edits others made while you were logged out.
Consider disconnecting, editing buttons, and logging in later only to configure button sheets for new
end users who are not working with their button sheets.

13. Locate the row (that is, button) to edit, then in Column A, Action, select Update from the list.
14. Click Prepare Changes.
A macro copies the rows marked for Update from the Buttons tab to the Changes tab and displays
them.
Figure 162: Changes sheet after clicking Prepare Changes in the ButtonProperties.xlsm sheet

IPC Confidential Unigy 4.3

Enterprise Guide
688 17.8: Miscellaneous procedures

Note
The color of the text in the cells of the Changes tab indicates which are editable (black) and which are
read-only (blue).

15. Edit a button or configure a new button in the Changes tab. To edit, either select an option from a list
or type in the value.
If a previously unconfigured button was selected for update, select the appropriate Button Type from
the list in Column G to configure a new button.

Note
Unconfigured buttons have a button type of Invalid Button Type.

16. Optionally, click the Associations tab and click one of the buttons to load information about
configured lines (private, dial tone, Open Connexion or oops) or contacts (personal or enterprise).
a) Use private, dial tone, Oops, or Open Connexion line information to add buttons that use the line
or to identify a line that a programmed button is using.
b) Use enterprise contact information to add a point of contact to the button sheet.
c) User personal contact information to add a personal contact to the button sheet.
Figure 163: Associations sheet

17. When the edits in the Changes sheet are complete, click Validate Changes.
An information dialog displays.
18. Click OK.
19. Click Save Changes.
The changes, if valid, are saved and a summary of the request(s) display in the Save Progress tab.
20. If there are failures, click the Changes tab and review each Failure Message. Typically the message
identifies a field whose value could not be saved. Fix the problem in the offending cell(s), change
Action back to Update and save the changes again.
21. If you plan to make more changes using the same spreadsheet, first click the Changes tab then click
Clear Changes. This ensures that you do not populate the tab with duplicate records (rows), which
could lead to unintended results including editing changes that you already made and saved.

December 3, 2019 IPC Confidential

 17.8: Miscellaneous procedures 689

22. Do one of the following:

a) To change properties for different button sheets, start a new search (go back to step 11).
b) To make additional changes to the same set of Media Gateway property records, repeat the process
from Prepare Changes (go back to step 14).
23. Optionally, save the spreadsheet locally for your records.
24. Logout and close the ButtonProperties.xlsm spreadsheet.
Button sheet changes, whether made through the UMS panels or the Mass Edit Client tool, are applied
dynamically to users’ button sheets and do not require that users logoff and log back on to see the
changes.

17.8.6 Generate assigned license report

This report provides customer report to manage assigned license usage and determine when to extend
license purchases. This report provides information about the licenses assigned to each end user
including the license feature name, hard limit, alarm threshold limit, the group that the end user is a
member of, and total assigned per license.
1. Click Tools ➤ Reporting ➤ Reporting Configuration.
2. Click System Report ➤ AssignedLicense.
3. Select a report:

To: Do the following:

Run the default report. Select AssignedLicense_Default.

Run the report from a template. Select the template name (if available).

The report filter and output fields are displayed.

IPC Confidential Unigy 4.3

Enterprise Guide
690 17.8: Miscellaneous procedures

Figure 164: AssignedLicense_Default panel

4. To run a report, choose one of the following:

• To run the default report, click Run Report.
• To run a custom report, enter or select the appropriate choices and click Run Report.

Note
For a detailed description of the Assigned license report filters, see Reporting: Assigned License
Report on page 691.

A File Download dialog box is displayed.

5. Choose one of the following:
• To save the generated report, click Save and select the destination drive and folder in which to
save the report.
• To open the report for display, click Open.

December 3, 2019 IPC Confidential

 17.8: Miscellaneous procedures 691

Figure 165: Assigned License Report

17.8.6.1 Reporting: Assigned License Report

This report provides information about the licenses assigned to each end user group including the license
feature name, hard limit, alarm threshold limit, the group that the end user is a member of, and total
assigned per license. The Assigned License report panel allows you to optionally filter the report by
period of time or type of license and run the report.
You must have one of the following roles to change, generate, or view this report: Basic Administrator,
Advanced Administrator, IPC Project Manager, IPC Certified Technician, and Auditor.
To access this panel, click Tools ➤ Reporting ➤ Report Configuration ➤ System Report ➤
AssignedLicense ➤ AssignedLicense_default.
Figure 166: AssignedLicense_Default panel

IPC Confidential Unigy 4.3

Enterprise Guide
692 17.8: Miscellaneous procedures

Table 78: Assigned License Default Panel

Name Description Values Notes

Group Name List of end user groups. Select the group name Select multiple end user
from the list. groups by using CTRL
+click or CTRL+Shift.

Start Time Calendar date to begin Date time input field.

the reporting duration. Should be earlier than
the end date and cannot
be later than the current
date.
If no start date and time
is entered, the report
output will begin with the
earliest information
found in the Unigy
database about
assigned licenses.

December 3, 2019 IPC Confidential

 17.8: Miscellaneous procedures 693

Table 78: Assigned License Default Panel (continued)

Name Description Values Notes

End Time Calendar date to end Date time input field.
the reporting duration. Cannot be later than the
current date.
If no end date is
entered, the report
output will include up to
the latest information
found in the database
about assigned licenses.
If neither a start nor end
time is entered, the
report will contain all
assigned license
information found in the
database.
Licensable Feature List of Unigy Enterprise • Express Trader Select multiple licensing
feature licenses. License features by using CTRL
+click or CTRL+Shift.
• Standard Trader
License

• Enterprise Trader
License

• Pulse User License

• Administrator only -
User License

• Pulse Enterprise
Intercom only
software License

• Pulse Enterprise
Intercom & Hoot
software License

• IQ/MAX Sync for OCS

• FastFind License

• Quick Dial License

• Voice Recording API

(per recording
channel) License

• Blue Wave API - CTI

• Blue Wave API -

Management License

• IQ/MAX TOUCH No
Spkr User Application

• IQ/MAX TOUCH 4 Spkr

User Application

• IQ/MAX TOUCH 8 Spkr

User Application

IPC Confidential Unigy 4.3

Enterprise Guide
694 17.8: Miscellaneous procedures

Table 78: Assigned License Default Panel (continued)

Name Description Values Notes

• IQ/MAX TOUCH 16
Spkr User Application

• IQ/MAX TOUCH 24
Spkr User Application

• IQ/MAX TOUCH 32
Spkr User Application

• Device_APP_1

• Device_APP_2

• Device_APP_3

• Device_APP_4

• Device_APP_5

Note
For information on report output fields, see Reporting: Output format on page 694.

Table 79: Buttons

Name Description
Save As Template Save the report as a template.
Run Report Run the report.

17.8.6.1.1 Reporting: Output format

The reports are provided in different output format, you can also provide a name and notes for these
reports.
The following fields are available in all the reports:

Table 80: Report Output Format

Name Description Values Notes

Report Format File type of the delivered • PDF Required
report.
• CSV

• HTML

Notes Report details. Editable text field. Enter

a maximum of 100
characters.
Name Name for the report. Editable text field. Enter
a maximum of 100
characters.

December 3, 2019 IPC Confidential

 17.8: Miscellaneous procedures 695

17.8.7 Edit and upload report

Use this panel to edit and upload customized reports. You can also customize the uploaded report. For
information about customizing the report, refer to Generate a custom report on page 695.
1. Click Tools ➤ Reporting ➤ Upload Report.
The Report List panel is displayed.
Figure 167: Report List panel

2. Do one or any of the following:

• Select the report from the list and click Edit to edit the report.
• Click +Add New to upload a new report.
The Upload Report panel is displayed.
Figure 168: Upload Report

3. Click Choose File next to the Report Definition field to upload the report definition file.
4. Click Upload.

Note
The Report Name is populated from the Report Definition file that is uploaded.

5. Click Choose File next to the Report Design (JRXML) field to upload the XML file for the report.
6. Click Upload.
7. Click Choose File next to the Search Form (XData) field to upload the XData file for the report.
8. Click Upload.
9. Click Back.
The new uploaded report appears in the Report List panel.

17.8.8 Generate a custom report

Use this feature to run custom reporting options. If the customer has a need for a custom report, they
need to contact their IPC Account Executive and make a request for the report.

IPC Confidential Unigy 4.3

Enterprise Guide
696 17.8: Miscellaneous procedures

You have to upload reports before you customize the reports. For information on edit or upload report,
refer to Edit and upload report on page 695.

Note
If you have custom reports and you are upgrading from Unigy V2.0, after you complete the upgrade you
need to delete the old custom reports and then re-upload the reports. This is necessary because the
custom report format has been changed to support additional fields. Delete the reports by performing the
procedure Delete a custom report on page 696. Then re-upload the reports by performing the
procedure Edit and upload report on page 695.

1. Click Tools ➤ Reporting ➤ Reporting Configuration.

2. Click Custom Report.
3. Select the default report template, Custom_default, or a custom template, if a custom template is
available.
A set of report filtering criteria and report output fields are displayed.
4. Select the type of report to run:
• To run the default report, click the Run Report icon.
• To run a custom report, enter or select the appropriate choices on the Custom Report panel.
• To save the report parameters as a template, click Save as Template.

Note
Template name must be original and the new report template will be displayed under the Custom
Report option in the System Report panel.

A File Download dialog box is displayed, prompting to save the generated report to a destination or
open the report for immediate display.
5. Choose one of the following:
• To save the generated report to a destination, click Save. A Save As window is displayed. Select
the destination folder in which to save the report.
• To open the report for display, click Open. The Custom report is displayed in the specified
reporting format.

17.8.9 Delete a custom report

Follow this procedure to delete a custom report. This deletes the custom report from all the zones where
the report is available.
1. Click Tools ➤ Reporting ➤ Upload Report.
The Report List panel displays, listing all custom reports.
2. Click the report you want to delete.
3. Click Delete.

17.8.10 Sync BCP manually - Unigy V1

This procedure describes how to manually synchronize zone data.
Syncs are performed from an Active primary zone to an Inactive secondary (BCP) zone.

December 3, 2019 IPC Confidential

 17.8: Miscellaneous procedures 697

Note
Unigy version 1 supports data synchronization from the primary zone to the secondary (BCP) zone only.
Bidirectional sync is not supported.

Manual BCP syncs should not ordinarily be required; daily syncs are configured to run automatically.
This procedure is generally performed when patching or upgrading. It is part of a sequence of
procedures that sync the zone data, set the primary zone as the Active zone, and disable BCP.
BCP syncs require the time zones on the appliances and voice recorders within a zone to be the same. If
you changed a hardware or Unigy location time zone or added an appliance from a different time zone,
ensure that the system clock is set to the same time zone. For information on comparing and changing
time zones, refer to Change the system time zone on page 426.

Note
Consider the working hours throughout the enterprise when scheduling and performing BCP data syncs.

1. If you are not already, log in to the UMS in the primary zone with the VIP: http://vip or
http://vip/dms/DMSClient.html.
2. Click Configuration ➤ Site Configuration ➤ BCP.
3. Click the Enact tab and ensure that the primary zone is the active zone (has a BCP Status of
Active).
Figure 169: BCP Status

4. From the Configuration tab, click Sync Now to push the primary zone data to the secondary zone.
This might take up to 40 minutes the first time you sync, depending on the amount of data. If the
operation takes more than 10 minutes, the system displays a message indicating that the
synchronization is still running.
5. Verify that the synchronization was successful:
a) Confirm that the Last Sync To Time is reflected in the displayed value.
b) From an SSH session with the active primary appliance in Zone 1, type grep
"syncSuccess" /var/log/messages and press Enter.
The output must contain:
Synchronization completed successfully!

You can display the contents of the UNIGYBCP.log file, that also contains this message, by
running cat /var/opt/ipc/log/UNIGYBCP/UNIGYBCP.log.
c) Verify that you can log in to the UMS in the secondary(BCP) zone using the primary zone IPC
Technician account.

IPC Confidential Unigy 4.3

Enterprise Guide
698 17.8: Miscellaneous procedures

17.8.11 Run Sync MM NTP Config

This task syncs up the selected Media Managers with the NTP setting of their managing Converged
Communications Managers, then reboots the devices.
Duration: Approximately 30 seconds.
Usage: The test copies the ntp.conf file from the CCM to the MM to ensure that the MM is in sync
with the updated NTP servers and then reboots the MM to reflect this change.
This test is intrusive.
You must be logged in to the Unigy Management System and be authorized to generate and view this
test.

Note
This is not a valid test for an ACCM. Do not perform this test on an ACCM.

1. Select Tools ➤ Diagnostic.

2. Click Create New Test.
3. Expand Media Manager in the Available tests tab.
4. Select the Sync MM NTP config test and click Select.
5. If necessary, select the Zone with the MM you want to run the test on.
6. Click +Assign to select devices. Then do any of the following:
• From the Devices for Zone tab, select one or more devices, then click <Assign.
• From the Device List tab, select a device list (group of devices), then click <Assign.
7. Click Perform Test.
8. To view the status of the test, select the test from the grid and click View Detail.
9. Click click to view in the Output column.
Figure 170: Sync MM NTP config Output panel

A failure occurs if Unigy cannot read or set the NTP value, cannot successfully reboot the device, or
cannot sync the time.

10. If the MMs that were synchronized and rebooted are in a Virtual Machine (VM), refer to Reapply the
license for an MM in a VM after a reboot on page 590.

17.8.12 Replication
Unigy supports various types of data replication that provide different levels of data granularity. This
topic provides a high-level description of each type and a list of the data they replicate.
The following replication types are available:

December 3, 2019 IPC Confidential

 17.8: Miscellaneous procedures 699

• Intrazone replication: In an HA zone, data is replicated between the active CCM or ACCM
appliance and the standby appliance to ensure that the standby appliance can assume the role of active
appliance if the active appliance is not available.
• Data replication: This is the default replication architecture that is in effect when the other interzone
replication types (partial replication and Multi-tier Replication) are not enabled. It replicates all data
to all zones in the enterprise. In a multizone enterprise, you enable this replication type to ensure that
the enterprise database is synchronized for all zones. In a large enterprise with high call volume and
zones in widely distributed geographic regions, this replication can impact system performance
because the data is replicated to every zone, across the LAN and WAN.
When you disable data replication for a zone, the system also disables partial replication and Multi-
tier Replication for the zone.
• Partial replication: To limit the performance impact imposed by replicating high volumes of history
and other types of data to all zones in a large enterprise, you can enable partial replication to limit
replication of this partial replication data to a subset of zones known as collector zones. This reduces
the volume of data replicated across the enterprise by replicating this data only to the collector zones.
Partial replication is realm based, with collector zones collecting data only for the zones within the
instances in the realm. Partial replication is also referred to as Regional Area Data Replication
(RADR) because the realms generally represent geographic regions. For additional information on
this replication type, refer to Partial replication (Regional Area Data Replication) on page 701.
• Multi-tier Replication: To reduce the volume of configuration data that is replicated throughout the
enterprise, you can enable Multi-tier Replication, which is an extension of the default data replication
architecture. It limits the replication of configuration data across the WAN to a subset of zones known
as portal zones. This architecture is composed of a Local Area Data Replication (LADR) tier and a
Wide Area Data Replication (WADR) tier. LADR replicates configuration changes between the zones
within a data center. WADR replicates the configuration data between the portal zones, reducing the
data that crosses the WAN, while ensuring that the enterprise data is synchronized. Each data center
has a portal zone. Transient channel data (line status and presence) and Blue Wave data are not
affected by Multi-tier Replication. These are still replicated to all zones in the enterprise through the
default data replication architecture. Multi-tier Replication and partial replication work independently,
replicating different data, but to enable Multi-tier Replication you must first enable partial replication.
For additional information on this replication type, refer to Multi-tier Replication on page 229.

Data replicated by the Unigy interzone replication types

The following table describes the data replicated by each of the Unigy interzone replication types.
Because partial replication and Multi-tier Replication replicate different data, it is important to configure
the collector zones and portal zones in a way that ensures optimal network performance and no loss of
data.

IPC Confidential Unigy 4.3

Enterprise Guide
700 17.8: Miscellaneous procedures

Data Replication Partial Replication Multi-tier Replication

History Data History Data
• AccountChangeHistory • AlertHistory
• AlertHistory • AuthorizationFailureHistory
• AuthorizationFailureHistory • CallRouteQuality
• BackupRestoreEvent • CommunicationHistory
• CallRouteQuality • CommunicationHistoryNote
• CommunicationHistory • MMCapacityHistory
• CommunicationHistoryNote • MMCapacityHistoryInterval
• Job • VoiceQualityReports
• JobDetail
• JobExecutionEvent
• JobGenericParam
• JobParamValue
• LoginHistory
• MMCapacityHistory
• MMCapacityHistoryInterval
• PasswordChangeHistory
• ReportHistory
• VoiceQualityReports

User Data User Data

• AccountPolicy Information • AccountPolicy Information
• Authorization Information • Authorization Information
• Directory Information • Directory Information
• Personal Directory Information • Personal Directory Information
• PointOfContact Information • PointOfContact Information
• Preferred POC Information • Preferred POC Information
• User Groups Information • User Groups Information
• Certificate Information • Certificate Information

Devices Devices
• Alliance MX Information • Alliance MX Information
• Media ManagerInformation • Media ManagerInformation
• Media Service Information • Media Service Information
• Voice Recorder Information • Voice Recorder Information
• Pulse Information • Pulse Information
• Unigy Soft Client Information • Unigy Soft Client Information

December 3, 2019 IPC Confidential

 17.8: Miscellaneous procedures 701

Data Replication Partial Replication Multi-tier Replication

Call Related Information Call Related Information
• BCP Information • BCP Information
• Button Sheet Information • Button Sheet Information
• CDI-related Information • CDI-related Information
• Call Route Quality Information • Call Route Quality Information
• CODEC Profile Information • CODEC Profile Information
• Device-related Information • Device-related Information
• Dial Pattern Information • Dial Pattern Information
• Front Room Information • Front Room Information
• Licensed Feature Information • Licensed Feature Information
• Hunt Group Information • Hunt Group Information
• NOC Configuration • NOC Configuration
Information Information
• Record Mix Information • Record Mix Information
• Resource AOR Information • Resource AOR Information
• Speaker Directory Information • Speaker Directory Information
• Trunk Information • Trunk Information

Enterprise Enterprise
• Enterprise Information • Enterprise Information
• Instance Information • Instance Information
• Address Information • Address Information
• Location Information • Location Information
• Zone Status Information • Zone Status Information
• Interzone Status Information • Interzone Status Information
• Backup and Restore • Backup and Restore
Information Information

Alerts Alerts
• AFM Information • AFM Information
• Alert Information • Alert Information
• Alert Metadata Information • Alert Metadata Information
Unigy Software Information Unigy Software Information

17.8.13 Partial replication (Regional Area Data Replication)

Partial replication, also known as Regional Area Data Replication, limits the volume of history and
related data that is replicated between the zones in a Unigy multizone enterprise to reduce network
traffic.
For information on the different replication types Unigy supports and the data replicated by each, refer
to Replication on page 698.

IPC Confidential Unigy 4.3

Enterprise Guide
702 17.8: Miscellaneous procedures

Partial replication provides the following benefits:

• Limits replication of data that is not related to device or user transactions and data changes made
from the UMS.
• Reduces network bandwidth utilization.
• Reduces zone startup and restart time for most zones because the Unigy database that is imported is
considerably smaller.
Partial replication is disabled by default. When it is enabled, the enterprise consists of the following
types of zones:
• Collector zones: These zones receive and process interzone data from all zones. In a new enterprise,
all zones are collector zones until you assign generator zones and enable partial replication. The only
limit on the number of collector zones in the enterprise is that there must be at least two collector
zones for redundancy. However, when possible, configure at least two collector zones in each realm
to ensure that there will be no partial replication data lost for the zones within the realm if a collector
zone is not available during a zone refresh, zone upgrade, zone hardware replacement, or for any
other reason the collector zone is unavailable. If you disable partial replication, all zones become
collector zones.
• Generator zones: These zones replicate partial replication data to the collector zones, but not to other
generator zones. Partial replication data for these zones is stored locally.

Realms
To further limit the replication of the partial replication data, you can assign instances to a realm. A
realm is a collection of one or more instances that defines sets of collector zones to which the partial
replication data is replicated.

Partial replication data

When partial replication is enabled, the following data is stored locally on appliances in the generator
zones and replicated only to the collector zones within the associated realm. The data is stored in a data
store that is separate from the Unigy data that is provided with a database dump.
• AlertHistory
• AuthorizationFailureHistory
• CallRouteQuality
• CommunicationHistory
• CommunicationHistoryNote
• MMCapacityHistory
• MMCapacityHistoryInterval
• VoiceQualityReports
Within the documentation, the data specified in this list is referred to as the partial replication data. Each
generator zone stores only its own partial replication data. Collector zones receive this data from all
zones within a realm, including other collector zones.

Partial replication requirements, recommendations, and limitations

Consider the following before you configure and enable partial replication:

December 3, 2019 IPC Confidential

 17.8: Miscellaneous procedures 703

• All zones in the enterprise must be at Unigy v2.0.1.5 hotfix 8 or higher.

• An enterprise that has partial replication enabled must include at least two collector zones for
redundancy and at least one generator zone.
• If the enterprise has zones at different software and schema versions, the collector zones should be at
the highest version to ensure that all data is collected.
• To prevent data loss, there must be at least two collector zones per realm to provide redundancy
within the realm.
• You cannot distinguish between Unigy and Blue Wave zones, so if these zones cannot be identified
by their names, determine which zones are in each category before you enable partial replication.
• Blue Wave zones must be collector zones and Monitor API rules must be enforced to ensure that
applications such as Proteus can access the partial replication data.
• When partial replication is enabled, upgrade the collector zones before you upgrade the generator
zones. All Blue Wave zones are collector zones and must be upgraded before you upgrade the Unigy
collector zones.
• In a single zone realm, if additional zones will be added to the realm, make the zone a collector zone.
If there are no plans to make the realm a multizone realm, the zone can be either a generator zone or a
collector zone.
• Network bandwidth should be a consideration when selecting collector zones due to the inherent load
of incoming partial replication data.
• Changing generator zones to collector zones should be done during non-business hours, or if this is
not possible, at a time when call activity is low. This procedure is intrusive and can have a major
impact on system performance. During this process, the partial replication data for all zones in the
enterprise, or all zones within a realm, if there are multiple realms, is pushed to each new collector
zone at a rate of 1200 records per minute. The zone receives all available partial replication data for
each zone, not just the most recent data. With a high volume of data, this can take a considerable
amount of time to complete.
• Disabling partial replication converts all generator zones to collector zones. For the reasons stated in
the previous bullet point, this procedure should be performed during non-business hours.
• Do not change a generator zone to a collector zone or a collector zone to a generator zone while an
Enterprise or Archive All Zone backup is running because this can result in loss of backup data.
• Partial replication can be configured, enabled, and disabled only by a user with the IPC Certified Tech
role. User accounts with the Basic Administrator, Advanced Administrator, and IPC Project Manager
role can view the partial replication configuration.
• There should be a recurring Archive all Zone backup job and retention policy configured in at least
one zone in each realm. An Archive all Zone backup archives then purges history data within a realm
for a specific time period, which helps to prevent out of memory errors that can result from high call
history volume. If there is a single realm or if partial replication is not enabled, the backup archives
the data from all zones in the enterprise.
• When partial replication is enabled, you cannot run Archive all Zone backups from generator zones;
these backups are permitted only in collector zones. A recurring Archive all Zone backup is
automatically created in the first zone that is added to the enterprise during initial deployment. If you
want the first zone to be a generator zone, delete the Archive all Zone backup job from the zone then
add it and a retention policy to a collector zone.

IPC Confidential Unigy 4.3

Enterprise Guide
704 17.8: Miscellaneous procedures

• If an enterprise has multiple instances, it is not necessary to have collector zones in each instance.
• When you disable partial replication, you can remove zones from the Generator Zones panel, but one
zone will always remain in the panel. This is because after you enable partial replication for the first
time, the system always enforces the partial replication rule that requires at least one generator zone.
This prevents you from removing the last generator zone from the panel; however, when partial
replication is disabled, the system considers this zone a collector zone even though it does not allow
you to move it to the Collector Zones panel.

Partial replication configuration and system behavior

Within the Partial Replication tab at Configuration ➤ Enterprise ➤ System Features ➤ Interzone
Communication, you can do the following:
• Configure zones as generators or collectors without enabling partial replication. This provides the
ability to set up partial replication and have the configuration approved before you enable partial
replication.
• Enable partial replication, which instructs the system to alter normal replication behavior based on the
generator and collector zone configuration.
• Modify the configuration. You can change the partial replication configuration to make generator
zones collector zones or collector zones generator zones. It is not necessary to disable partial
replication to make these changes.
If you disable partial replication, all zones become collector zones and the partial replication data is
replicated to all former generator zones, however, the partial replication configuration remains intact,
so if you temporarily disable the feature, it will not be necessary to reconfigure it prior to reenabling
it.
The system does the following when partial replication is enabled or disabled:
• Identifies the generator zones based on the configuration within the Partial Replication tab.
• Displays one of the following values in the UMS menu bar for the zone. If there are multiple realms,
the system also displays the realm number (#), for example Col1.
• Col# for collector zones
• Gen# for generator zones
• If you enable partial replication in an enterprise that has been operating without partial replication,
the generator zones purge the partial replication data for other zones from their local database.
Removal of partial replication data from a generator zone does not impact any other zone. Collector
zones retain the partial replication data for other zones.
• If you disable partial replication after it was enabled, the system reclassifies all zones as collector
zones. Zones that are classified as generator zones before you disable partial replication receive the
partial replication data for all other zones within the enterprise, or within the associated realm if there
are multiple realms.
• When a new collector zone is brought into service or a collector zone is reCOPed, the zone loads the
Unigy database from another zone then synchronizes its partial replication data store from another
collector zone in the realm.
• When a collector zone is restarted (refreshed), the zone loads the Unigy database from another zone
then updates its partial replication data store by pulling data updates that were made while the zone
was offline from the collector and generator zones in the realm. The data is transmitted at a rate of
600 rows at a time.

December 3, 2019 IPC Confidential

 17.8: Miscellaneous procedures 705

• When a new generator zone is brought into service or the appliances are rebooted, the zone does not
retrieve the partial replication data for other zones, but preserves its own partial replication data.
• If partial replication is enabled, any new Unigy zones that are added to the enterprise are added as
generator zones; Blue Wave zones are added as collector zones. If partial replication is disabled, new
zones added to the enterprise are added as collector zones.

Multi-tier Replication
Partial replication and Multi-tier Replication work independently of each other, however, you must
enable partial replication prior to enabling Multi-tier Replication. Prior to disabling partial replication,
you must disable Multi-tier Replication in all data centers.
Portal zones can be collector zones or generator zones. Consider the following when you restart or
upgrade zones when Multi-tier Replication is enabled:
• Each data center has one portal zone. Within a data center, portal zones must be restarted or upgraded
before the local zones to ensure that the data is synchronized properly with the other data centers.
• Collector zones should be restarted or upgraded before generator zones to ensure that they have the
latest database schema so no history data is lost.

Backup and restore

Backups
When you perform an Enterprise or Archive all Zone backup, you specify the collector zone from which
the backup will be run.
When partial replication is enabled, Archive all Zone backups can be performed only in collector zones.
An Archive all Zone job runs in the designated zone and after the backup is complete, a purge job runs
in each zone to delete the archived data. When partial replication is enabled and there is more than one
realm in the enterprise, an Archive all Zone backup backs up and purges only the data for the zones in
the associated realm. If there is a single realm, the system backs up and purges the data for all zones in
the enterprise.
Restores
When partial replication is enabled, do not attempt to restore onto a generator zone an Enterprise backup
that was taken from a collector zone. The system does not prevent you from doing this, so it is important
to confirm the type of backup and zone type before you restore a database. Be especially careful if the
zone from which the backup was made was changed from a collector zone to a generator zone after the
backup was created. In this situation, restore the backup in another collector zone.
You can restore Archive all Zone backups only in a collector zone. The data will be restored only in the
zone in which the restore is run, it is not replicated to other zones.

Reports
The following reports include a History field that identifies the type of replication that is in effect when
the report is run:
• Communication History report
• Line Usage report
• Trunk Usage report
• Speaker Usage report
• Call Traffic Weekly report

IPC Confidential Unigy 4.3

Enterprise Guide
706 17.8: Miscellaneous procedures

• Call Traffic Daily report

• Media Manager Capacity report
• Authorization Failure report
The History field has the following values based on the partial replication setting and the type of zone
for which the report is run:
• If partial replication is enabled and the report is run for a collector zone, the value is Full.
• If partial replication is enabled and the report is run for a generator zone, the value is Partial.
• If partial replication is disabled, the value is Full for all zones.
If you enable partial replication then later disable it and run the reports listed above, the results displayed
for a zone vary based on the type of zone and its state:
• If you run the reports for zones that were collector zones before partial replication was disabled, the
reports show all historical data.
• If you run the reports for zones that were generator zones before partial replication was disabled, the
reports for some or all of these zones might include only data for events that occurred after partial
replication was disabled. This is because generator zones store only their own partial replication data
when partial replication is enabled. After the zones retrieve the partial replication data for all zones,
the reports contain all of the data.

Blue Wave zones

Blue Wave zones must be collector zones. When you assign zones as generator zones, there is nothing in
the UMS that distinguishes a Blue Wave zone from a Unigy zone. Providing a zone name that identifies
the zone as a Blue Wave zone will eliminate this concern.

17.8.14 Login Mass Edit Client

This topic describes the login screens for Mass Edit Client, one for Unigy v4.2 and later and one for
Unigy v4.1 and earlier.
When you access a Mass Edit Client spreadsheet, you can log in to any zone in the enterprise, not just
the zone from which you launched Mass Edit Client. However, the zone for which you are accessing the
spreadsheet must be at the same Unigy version as the zone you are logged in to.
If multi-factor authentication is enabled for the user account with which you are accessing a Mass Edit
Client spreadsheet, the system sends a security token to your e-mail address after you enter your user

name and click the button in the first Login panel. In the second Login panel, you must enter the
account password and security token. The token field is not displayed if multi-factor authentication is
disabled.

Log in Mass Edit Client - Unigy v4.2 and later

The Mass Edit Client Login screen was changed to support multi-factor authentication, introduced in
Unigy v4.2.

December 3, 2019 IPC Confidential

 17.8: Miscellaneous procedures 707

Figure 171: Login - screen 1

Figure 172: Login - screen 2

Table 81: Login

Name Description Values Notes

Unigy VIP VIP of the zone for which A unique IP address of up to 24 Enter the VIP for a zone
you are accessing the characters in dot-decimal that has the same Unigy
Mass Edit Client notation: nnn.nnn.nnn.nnn software version as the
spreadsheet. zone you are logged in
to.
User Name Login name of a Unigy String.
user account with an
administrative, project
manager, or technician role
assigned.

IPC Confidential Unigy 4.3

Enterprise Guide
708 17.8: Miscellaneous procedures

Table 81: Login (continued)

Name Description Values Notes

Password Password for the user String. VIP and User Name are
account. retained if the session
expires; the Password is
not. The password must
be reentered each time.
Token Multi-factor authentication Token value. This field is displayed
security token. only if multi-factor
authentication is enabled
for the user account you
are logging in with. Enter
the token value that the
system sent to your e-
mail account when you

clicked the button

within the first Login
panel.
Tokens are available for
a limited time. If the
token expires before you
log in, start a new login
session; Unigy sends a
new token.

Table 82: Buttons (Login Mass Edit Client)

Name Description
Displays the second spreadsheet Login panel. If multi-factor authentication is enabled
for the user account you are logging in with, the system sends a security token to the
e-mail account specified for your user account.
Cancel Cancels the log in.
Login Initiates the log in.

Log in Mass Edit Client - Unigy v4.1 and earlier

Figure 173: Login (Mass Edit Client)

December 3, 2019 IPC Confidential

 17.8: Miscellaneous procedures 709

Table 83: Login dialog box

Name Description Values Notes

Unigy VIP VIP of the zone for which A unique IP address of up to 24 Enter the VIP for a zone
you are accessing the characters in dot-decimal that has the same Unigy
Mass Edit Client notation: nnn.nnn.nnn.nnn software version as the
spreadsheet. zone you are logged in
to.
User Name Login name of a Unigy String.
user account with an
administrative, project
manager, or technician role
assigned.
Password Password for the user String. VIP and User Name are
account. retained if the session
expires; the Password is
not. The password must
be reentered each time.

Table 84: Buttons

Name Description
Cancel Cancels the log in.
Login Initiates the log in.

17.8.15 Diagnostics
Diagnostics is a centralized function that enables UMS users with the Advanced Administrator or IPC
Certified Tech role to execute and manage diagnostic tests directly from a UMS client. The diagnostic
service interacts with agents on the device to execute tests in the zone of the target device regardless of
where the UMS user logs in. The agent can be an SNMP agent, shell script, or Web Service.
The tool allows these UMS users to more efficiently manage the diagnostics process. It offers the ability
to quickly search for diagnostics, to create and run diagnostics, schedule diagnostic tests, use or
customize the preconfigured diagnostic templates provided by IPC (only accessible to IPC Certified
Techs), create and run custom templates, and create and reuse device lists.
Diagnostics are intended to be run on devices in an active zone. Do not execute diagnostic commands on
devices in a standby zone.

Note
All results for diagnostics listed in the table below are stored in the Unigy database for viewing and
analysis. It is also possible to create and save a Unigy system report containing diagnostic results. Use
Tools ➤ Reporting ➤ Reporting Configuration then select System Report ➤ Diagnostic Test ➤
DiagnosticTest_Default.

The UMS provides two types of Unigy diagnostics:

• Walk the floor diagnostics are designed for the IPC Certified Tech to verify the overall health of a
system after a Unigy installation or software upgrade. The UMS provides quick access to Walk the
Floor diagnostics from the Available tests tree as well as from the Available Templates area.

IPC Confidential Unigy 4.3

Enterprise Guide
710 17.8: Miscellaneous procedures

• Informational diagnostics provide data that can be used for further analysis and evaluation. For
example, an informational diagnostic can be used to display SIP statistics for a turret or Pulse device,
or collect VoIP quality data about devices.
Intrusive diagnostics affect the usage of a device by dropping calls or diminishing performance and
therefore should only be performed outside of trading hours. A warning displays prior to execution of an
intrusive test and the user has the option to either cancel the execution or continue on. Also, it is
important to note that the system allows intrusive tests to be scheduled during trading hours, however, a
scheduled test will systematically fail if it is run during the trading day. Trading days and hours are
configured on the UMS Zone Configuration panel.

Note
Links and downloadable bundles are password protected. To access a link or bundle, when prompted for
credentials, enter the Unigy install account credentials.

The following table identifies the diagnostics available to the UMS Advanced Administrator role.
All diagnostics in the table are available to the IPC Certified Tech.

Table 85: UMS Diagnostics

Diagnostic Intrusive Purpose Advanced Description

Admin
Access
Turret & Pulse 6
Time No Verify No Verifies the communication device time
Verification installation matches the CCM time.
or upgrade
(part of Walk
the Floor)
Change No Informational Yes Changes the syslog severity levels to match
Logging the specified communication device logs.
Threshold
Dump Logs No Informational No Retrieves the dump logs from the specified
communication device.
Display No Informational Yes Displays the hardware versions for the target
Hardware devices.
Versions
Display No Informational No Displays the software versions for the target
Software (part of Walk devices.
Versions the Floor)
Screen No Informational No Captures the current screen images from the
Capture specified communication devices.
Display No Informational Yes Displays the network configuration for the
Network target devices.
Configuration

6 Unless otherwise noted, this category of diagnostics can be executed on all turrets (IQ/MAX TOUCH, IQ/MAX,
IQ/MAX Edge) and Pulse devices.

December 3, 2019 IPC Confidential

 17.8: Miscellaneous procedures 711

Table 85: UMS Diagnostics (continued)

Diagnostic Intrusive Purpose Advanced Description

Admin
Access
Display SIP No Informational Yes Displays the SIP call information for the target
Call Info devices.
Display SIP No Informational Yes Displays the SIP jitter statistics for the target
Jitter Stats devices.
Display SIP No Informational Yes Displays the SIP registration information for the
Registration target devices.
Info
Display SIP No Informational Yes Displays the SIP statistics for the target
Statistics devices.
Display SIP No Informational Yes Displays the SIP RTP statistics for the target
RTP Statistics devices.
Display SIP No Informational Yes Displays the SIP RTCP statistics for the target
RTCP devices.
Statistics
Handset Yes Verify Yes Adjusts the handset receive volume and
Volume Installation verifies the audio level changes as expected.
Adjustment or Upgrade
Test (part of Walk
the Floor)
Software No Verify Yes Verifies the software version running on the
Version Installation communication device matches the database.
or Upgrade
Force Logoff Yes Informational No Forces a specified user to log off from a
communication device.
Restore Yes Informational No Restores the previous logon for a
Logon communication device.
Configuration No Verify No Verifies all button descriptors on the currently
Verification Installation displayed page match the user configuration
or Upgrade data in the database.
(part of Walk
the Floor)
System No Verify No Verifies the device configuration license
Configuration Installation matches the database.
Verification or Upgrade
(part of Walk
the Floor)
Verify Network No Verify No Verifies the communication device network
Duplex Installation interface is in 100 Full mode.
or Upgrade
(part of Walk
the Floor)

IPC Confidential Unigy 4.3

Enterprise Guide
712 17.8: Miscellaneous procedures

Table 85: UMS Diagnostics (continued)

Diagnostic Intrusive Purpose Advanced Description

Admin
Access
Clear SIP No Informational Yes Clears all the device RTP statistics and resets
Audio the counters to 0.
Statistics
Verify IP No Verify No Verifies the record streams are connected and
Recording Installation mixing the correct audio.
Status or Upgrade
(part of Walk
the Floor)
Reboot Yes Post No Reboots one or more communication devices
Device Configuratio from the UMS panel.
n or Upgrade Reboot communication devices on page 591.
VoIP Analysis No Verify No Analyzes VoIP quality for previous and
Installation currently active calls.
or Upgrade
(part of Walk
the Floor)
Generate No Informational No Generates a test trap from the communication
Alerts Test device.
Trap
Verify Event No Verify No Verifies line status communication between the
Services Installation communication device and the CCM is working.
or Upgrade
(part of Walk
the Floor)
Bootloader Yes Informational Yes Verifies the bootrom(s) version on the device
Sync and reboots the device if it is not in sync with
the bootloader. Not applicable to IQ/MAX
TOUCH devices.
Locate Device No Informational Yes
CDI NIC No Verify No Reports the configured speed and current
Diagnostic Installation speed of the network interface controller (NIC)
or Upgrade ports and verifies that the speed is a minimum
(part of Walk of 100baseTx-FD.
the Floor)
Generate Yes Informational No Generates audio for voice recording testing,
Voice which then needs to be manually verified on
Recording the voice logger.
Speech
Display SIP No Informational Yes Retrieves and displays telephony statistics
Proxy Info about the device, including the VIP it is
connected to.
Soft Client

December 3, 2019 IPC Confidential

 17.8: Miscellaneous procedures 713

Table 85: UMS Diagnostics (continued)

Diagnostic Intrusive Purpose Advanced Description

Admin
Access
User Details No Informational Yes Performs diagnostics on the Soft Client voice
engine and provides a log of the diagnostic
metrics for further analysis.
Generate Yes Informational Yes Generates audio for voice recording testing,
Voice which then needs to be manually verified on
Recording the voice logger.
Speech - UDA
Media Gateway
Configuration No Verify No Verifies the configuration data matches the
Verification Installation database.
or Upgrade
(part of Walk
the Floor)
Software No Verify No Verifies the active software version matches
Version Installation the database.
or Upgrade Run Media Gateway software version on page
(part of Walk 650.
the Floor)
Line Status No Verify No Verifies the device configuration license
Verification Installation matches the database.
or Upgrade
(part of Walk
the Floor)
MG NIC No Verify No Reports the configured speed and current
Diagnostic Installation speed of the network interface controller (NIC)
or Upgrade ports and verifies that the speed is a minimum
(part of Walk of 1000 MB per second.
the Floor)
Converged Communications Manager
AFM Alert No Verify No Generates an SNMP trap for manual event
Test Installation logged verification.
or Upgrade Run CCM AFM Alerts test on page 670.
(part of Walk
the Floor)
Validate Yes Verify No Database integrity test.
Schema Installation
or Upgrade
(part of Walk
the Floor)
NTP Time No Verify No Verifies the CCM time matches the NTP server
Verification Installation time.
or Upgrade
(part of Walk
the Floor)

IPC Confidential Unigy 4.3

Enterprise Guide
714 17.8: Miscellaneous procedures

Table 85: UMS Diagnostics (continued)

Diagnostic Intrusive Purpose Advanced Description

Admin
Access
CCM Time No Verify No Verifies the time for CCM A matches the time
Verification Installation for CCM B.
or Upgrade
(part of Walk
the Floor)
CCM No Verify No Verifies the active software version matches
Software Installation the database.
Version or Upgrade Run CCM Software Version on page 648.
(part of Walk
the Floor)
Display OS No Informational Yes Displays a list of the Linux RPM packages
RPMs installed on the CCM.
Reboot CCM Yes Post No Reboots the CCM from the UMS.
configuration Reboot CCM on page 587
or upgrade
ULC No Informational Yes Collects various logs from the CCM to verify
the overall health of the Unigy system.
Interzone No Informational No Checks the health of the zones in a multi-zone
Diagnostic system.
Tool (IZDT) Run interzone diagnostic tool on page 646.
Count
Comparison
IZDT No Verify No
Replication Installation
Health Check or Upgrade
Platform No Informational No Displays the Common Operating Platform
History (COP) version that was used to install or
upgrade the IPC customized Linux operating
system components on the Unigy Common
Server Platform (CSP).
System Logs Yes Informational No Collects log files that were recently modified.
CCM NIC No Verify No Reports the configured speed and current
Diagnostic Installation speed of the network interface controller (NIC)
or Upgrade ports and verifies that the speed is a minimum
(part of Walk of 100 MB per second.
the Floor)
CCM Bond Yes Informational No Verifies that the bonded NIC configuration is
Test working.
Interzone No Verify Yes Verifies whether or not the saved JGroup
Parameters Configuratio database configuration is in effect.
Validation n

December 3, 2019 IPC Confidential

 17.8: Miscellaneous procedures 715

Table 85: UMS Diagnostics (continued)

Diagnostic Intrusive Purpose Advanced Description

Admin
Access
Purge Yes Contact No Purges external directory contacts.
External Maintenance
Directory
Contacts
Media Manager
MM Time No Verify No For standalone and multi-zone installations,
Verification Installation verifies the MM time matches the CCM time
or Upgrade and also lists the NTP servers for this device.
(part of Walk
the Floor)
MM Software No Verify No Verifies the active software version for the MM
Version Installation matches the database.
or Upgrade Run MM software version on page 649.
(part of Walk
the Floor)
Reboot MM Yes Post No Reboots the MM from the UMS.
configuration Run Reboot Media Manager on page 588
or upgrade
MM Bond Test Yes Informational No Verifies that the bonded NIC configuration is
working.
MM NIC No Verify No Reports the configured speed and current
Diagnostic Installation speed of the network interface controller (NIC)
or Upgrade ports and verifies that the speed is a minimum
(part of Walk of 100 Mb per second.
the Floor)
Sync MM NTP Yes Post No Syncs the CCM’s NTP server settings to the
config Configuratio MM and reboots the MM.
n or Upgrade Run Sync MM NTP Config on page 698
Call Control
Verify Yes Verify Yes Makes a handset intercom call between two
Intercom Installation turrets and checks the full-duplex audio quality.
Connection or Upgrade Run Verify Intercom Connection on page 654.
Verify Private Yes Verify Yes Establishes a private or open connexion line
Line Installation call on two turrets, or the same turret, to test
Connection or Upgrade the MM conference connection and check the
full-duplex audio quality.
Run Verify Private Line Conference on page
656.
Verify Dial Yes Verify Yes Establishes a dial tone call between two Unigy
Tone Line Installation turrets or the same turret and runs audio and
Connection or Upgrade VoIP analysis tests.
Run Verify Dialtone Line Connection on page
658

IPC Confidential Unigy 4.3

Enterprise Guide
716 17.8: Miscellaneous procedures

Table 85: UMS Diagnostics (continued)

Diagnostic Intrusive Purpose Advanced Description

Admin
Access
Verify Inbound Yes Verify Yes Makes a turret answer an inbound dialtone call,
Call Installation then runs audio VoIP analysis tests on that call.
Connection or Upgrade Run Verify Inbound Call Connection on page
660.
Walk the Floor
Turret & Yes Verify No Includes all Walk the Floor tests for
Pulse 7 Installation communication devices.
or Upgrade For generic steps, see Run Walk the Floor
(part of Walk diagnostics on page 644.
the Floor)
CCM Yes Verify No Includes all Walk the Floor tests for CCM/
Installation ACCMs.
or Upgrade
(part of Walk
the Floor)
MM No Verify No Includes all Walk the Floor tests for MMs.
Installation
or Upgrade
(part of Walk
the Floor)
MG No Verify No Includes all Walk the Floor tests for MGs.
Installation
or Upgrade
(part of Walk
the Floor)

The IQ/MAX TOUCH turret also includes a diagnostic tool that runs a suite of diagnostic tests that
provide detailed information about the turret. For more information about this tool, refer to the IQ/MAX
TOUCH Turret Hardware Installation Manual.

17.8.16 Update the JGroups protocols on individual appliances for the Unigy and Blue Wave
Adapter channels - Unigy and Blue Wave zones
Use this procedure to update the JGroups protocols to MERGE3, FD_ALL, NAKACK2, and
UNICAST3 for the Unigy Replicator and Line Status channels and the Blue Wave Adapter Async and
RPC channels for Unigy or Blue Wave appliances on which you are performing certain maintenance
procedures in an enterprise in which the JGroups protocols were updated.
This procedure is necessary to ensure that the JGroups protocols for the appliances you are maintaining
match the protocols in the other zones in the enterprise. All zones must have the same JGroups protocol
versions.

7 This category of diagnostics can be executed on all turrets (IQ/MAX TOUCH, IQ/MAX, IQ/MAX Edge) as well
as Pulse devices.

December 3, 2019 IPC Confidential

 17.8: Miscellaneous procedures 717

Important
If you encounter a problem with this procedure, contact IPC Support, do not reboot the appliances.
Rebooting the appliances can result in protocol conflicts.

Prerequisites:
The following must be true before you perform this procedure:
• The appliances you are updating must have the appropriate Unigy bridge patch or hotfix deployed.
This provides the scripts required to update the JGroups protocols for the Unigy Replicator and Line
Status channels and the Blue Wave Adapter Async and RPC channels.
• All Blue Wave appliances you are updating must have the appropriate Blue Wave bridge patch
deployed. This provides the scripts required to update the JGroups protocols for the Blue Wave
Director Async and RPC channels.
• The zone you are updating is in a healthy state. Verify this by performing the procedure Check the
state of a zone from a browser on page 499.
Perform steps 1 through 10 on each CCM and ACCM appliance you are updating. Perform step 11 for
the associated zone.
1. Within the tool you use for SSH access (for example, PuTTY), enable logging to capture the session
output.
2. Access the appliance command line.
3. Run the command su -lp and enter the root user account password.
4. Change the current directory to /etc/opt/ipc/ha/scripts.
5. Run the following command to update the protocols for the Unigy Replicator channel:
./installProtXML.sh -7501 -nakack2 -unicast3 -merge3 -fdall
6. Run the following command to update the protocols for the Unigy Line Status channel:
./installProtXML.sh -7502 -nakack2 -unicast3 -merge3 -fdall
7. Run the following command to update the protocols for the Blue Wave Adapter Async channel:
./installProtXML.sh -7503 -nakack2 -unicast3 -merge3 -fdall
8. Run the following command to update the protocols for the Blue Wave Adapter RPC channel:
./installProtXML.sh -7504 -nakack2 -unicast3 -merge3 -fdall
9. Repeat steps 1 through 8 for each appliance you are updating.
10. To confirm that the correct protocol values are set, refer to Validate JGroups protocol values for the
Unigy and Blue Wave channels on an appliance - manual procedure on page 671.
11. Update the JGroups TCP Ping Timeout value to 200 for the zone you updated.
a) Log in to the UMS with the zone VIP.
b) Click Configuration ➤ Enterprise ➤ System Features ➤ Interzone communication.
c) Within the Enterprise Configuration tab, change the JGroups TCP Ping Timeout value to 200
then click Save.

IPC Confidential Unigy 4.3

Enterprise Guide
718 17.8: Miscellaneous procedures

17.8.17 Update the JGroups protocols on individual appliances for the Blue Wave Director
channels - Blue Wave zones
Use this procedure to update the JGroups protocols for the Blue Wave Director Async and RPC channels
on Blue Wave appliances on which you are performing certain maintenance procedures in an enterprise
in which the JGroups protocols were updated.
This procedure is necessary to ensure that the JGroups protocols for the appliances you are maintaining
match the protocols in the other zones in the enterprise. All zones must have the same JGroups protocol
versions.

Important
If you encounter a problem with this procedure, contact IPC Support, do not reboot the appliances.

Prerequisites:
Before you perform this procedure, confirm that the procedure Update the JGroups protocols on
individual appliances for the Unigy and Blue Wave Adapter channels - Unigy and Blue Wave zones on
page 716 was performed.
Perform this procedure on all Blue Wave CCM or ACCM appliances you are updating.
1. Access the appliance command line.
2. Run the command su -lp and enter the root user account password.
3. Change the current directory to /etc/opt/ipc/bluewave.
4. Run the following command to update the protocols for the Blue Wave Director Async channel:
./installProtXMLBWD.sh -7505 -nakack2 -unicast3 -merge3 -fdall
5. Run the following command to update the protocols for the Blue Wave Director RPC channel:
./installProtXMLBWD.sh -7506 -nakack2 -unicast3 -merge3 -fdall
6. To confirm that the correct protocol values were set for the Unigy and Blue Wave channels, refer to
Validate JGroups protocol values for the Unigy and Blue Wave channels on an appliance - manual
procedure on page 671.

December 3, 2019 IPC Confidential

 719

A Dynamic passwords
Secure SHell (SSH) access to a customer’s Unigy enterprise is restricted to the shelldiag system
account, which employs a time-based One Time Password (OTP) solution referred to as Dynamic
Password. The dynamic password feature also enables access to secure communications configuration in
the UMS.
The password is regenerated at predefined intervals following the UTC clock.
The system generates a token for the shelldiag account every 4 hours. Authorized IPC employees
use a token to retrieve the password.
The system also generates a token for the superuser account every 30 minutes. Authorized IPC
employees can elevate the shelldiag account to a superuser account using this additional token
and another password.
The following system accounts use the dynamic password feature:
• shelldiag.
• superuser.
The IPC certified tech can also obtain a dynamic password to access the secure communications feature
in the UMS. These tokens are generated every 4 hours.
A dynamic password is used to access the following Unigy appliances:
• CCMs
• ACCMs
• MMs
The following menu item in the UMS requires a dynamic password to access it: Configuration ➤
Enterprise ➤ Security ➤ Secure Communications. For more information about configuring secure
communications, refer to the Secure Communications chapter of the Enterprise Guide.

Dynamic password and other security considerations

• Dynamic password is implemented on a per zone basis and the feature becomes available after the
zone is successfully deployed.
• Passwords are valid for the given time period and are the same across the enterprise.
• A token is a randomized set of characters. Although tokens are expected to be unique per appliance, it
is possible that two or more appliances will have the same token. This is because they are generated
randomly.
• The dynamic password feature is not applicable to the diag account, which is generally used for
programmatic access to an appliance or device.
• Elevation to superuser and system access to turrets through the diag account continue to be
available.
• The dynamic password feature is not applicable to the database account.

IPC Confidential Unigy 4.3

Enterprise Guide
720 A.1: Password Manager Web application

• If a V3.0 zone deployment does not complete successfully, the authorized IPC employee can use the
shelldiag or the superuser account as a static password account until the situation is corrected
and the deployment of that zone succeeds.
• The dynamic password feature is not deployed on pre-V3.0 appliances.
• The following applies to the unigyadmin static password account:
• For mixed-zone enterprises (that is, enterprises with a combination of V2.0.1 and V3.0 and later
zones), the unigyadmin account will be retained for backwards compatibility.
• For new installations or when all the zones in an enterprise are upgraded, the unigyadmin
account will be hardened and unigyadmin shell access will not be available. Bear in mind that
during an upgrade, as soon as the last appliance is upgraded, the unigyadmin account becomes
hardened.
• If one or more zones are rolled back after an upgrade, unigyadmin will become unhardened and
shell access using this account will become available on all zones in the enterprise. Bear in mind
that as soon as the first zone is successfully rolled back, the unigyadmin account becomes
unhardened.
• The above-mentioned hardening applies to CCM, ACCM, or MM.
• System account management has been removed from the UMS menu: Enterprise ➤ Security ➤
System Accounts. The diag and unigyadmin accounts can no longer be managed from the
UMS.
• The install static password account is no longer available for shell access on a CCM, ACCM, or
MM.
• IMPORTANT: UMS users are no longer able to use the IPC Certified Tech role to SSH to a Unigy
appliance or a turret.

A.1 Password Manager Web application

IPC employees use the Password Manager Web application to generate dynamic passwords for use with
the shelldiag and superuser accounts and also to gain access to the Secure Communications
menu and secure communications-related Mass Edit Client spreadsheets in the UMS.
Employees use their IPC credentials (username and password) to log in to the Password Manager web
application. Access to an Internet connection is required.
IPC employees are authenticated against the IPC Corporate Microsoft Active Directory (AD) and must
be on the corp.root.ipc.com Active Directory and be a member of the Service Delivery Dynamic
Password AD Group. Before you begin using the Dynamic Password feature, contact your manager to
ensure that you are a member this group.

A.2 Establish an SSH session using the shelldiag account

Follow this procedure to establish an SSH session on a Unigy appliance in a customer’s Unigy
enterprise. This involves initiating an SSH session, obtaining a token, entering the token in the Password
Manager to generate a password, then returning to the SSH session and using the password to establish
the session.

December 3, 2019 IPC Confidential

 A.2: Establish an SSH session using the shelldiag account 721

Note
An SSH session can be initiated from a client, such as PuTTY, or directly (by connecting a laptop to the
console port on the appliance) or remotely (by using the Integrated Dell Remote Access Controller
(iDRAC)) from the CCM console. The following procedure describes the behavior of the interface when
using an SSH client. There are slight differences in the interface and interaction with the interface when
accessing from the CCM console. For details, see Dynamic Password and CCM console versus SSH
client on page 728.

The shelldiag account provides SSH access to a CCM, ACCM, or MM.

Note
Sessions time out due to inactivity as follows:
• SSH sessions time out in five minutes
• Password Manager sessions time out in ten minutes

1. Open an SSH session to a CCM, ACCM, or MM and log in using the shelldiag account.

Note
A CCM console session can also be used to obtain the token.

Figure 174: SSH shelldiag log in

When you press the Enter key, the start time of the validity period, the warning notice, and the
password token are displayed as illustrated in the following figure.
Figure 175: SSH shelldiag session - with token

2. Left click with the mouse and drag to copy the token from the SSH session. Do not include leading or
trailing spaces. As soon as you release the mouse left-click button, the token is automatically copied
to the clipboard.

IPC Confidential Unigy 4.3

Enterprise Guide
722 A.2: Establish an SSH session using the shelldiag account

Important
Do not press CTRL+C to copy the token. This sends a CTRL+C character to your session and causes
process interruption and causes the SSH session to close.

3. Access the Password Manager web application using either https://nw.dynamic.ipc.com or

https://ny.dynamic.ipc.com.
The Password Manager Login screen is displayed.
4. Enter your IPC Username and Password and click Login.
The Token input box is displayed.
5. Place your cursor in the Token input box, right click then Paste.
You can also manually type in the value.
Figure 176: Password Manager Generate Output

6. Click Generate Output.

The password is displayed in the Output field as illustrated in the following figure.
Figure 177: Password Manager Output

December 3, 2019 IPC Confidential

 A.3: Elevate shelldiag to superuser 723

7. Copy the password from the Output field.

8. Return to the SSH session. Mouse right click the SSH cursor then press the Enter key to paste the
password. Optionally paste/enter the output by pressing the CTRL+Insert keys on your keyboard
or manually typing in the password.

Important
If you paste the output, the SSH client does not display the password, so be careful to only paste it
once.

The session begins.

For example, in the following figure, the shelldiag prompt indicates the user is logged in.
Figure 178: SSH shelldiag successful log in

A.3 Elevate shelldiag to superuser

Follow this procedure to elevate your shelldiag session to superuser privileges.
This procedure illustrates the process of elevating to superuser using an SSH session, but the same
can also be accomplished when logged in directly to the CCM console.

Note
An SSH session timeouts in five minutes due to inactivity.

1. Following the procedure to Establish an SSH session using the shelldiag account on page 720 or use
the shelldiag account to log on directly from the CCM console.
2. Issue the following command: su -lp.
A new token is issued as illustrated in the following figure.

IPC Confidential Unigy 4.3

Enterprise Guide
724 A.3: Elevate shelldiag to superuser

Figure 179: SSH superuser session token

3. Left click with the mouse and drag to copy the new token from the SSH session. Do not include
leading or trailing spaces. As soon as you release the mouse left-click button, the token is
automatically copied to the clipboard.

Important
Do not press CTRL+C to copy the token. This sends a CTRL+C character to your session and causes
process interruption and causes the SSH session to close.

4. Access the Password Manager web application using either https://nw.dynamic.ipc.com or

https://ny.dynamic.ipc.com.
The Password Manager Login screen is displayed.
5. Enter your IPC Username and Password and click Login.
The Token field is displayed.
6. Place your cursor in the Token field, right click then Paste.
You can also manually type in the value.

December 3, 2019 IPC Confidential

 A.3: Elevate shelldiag to superuser 725

Figure 180: Password Manager

7. Click Generate Output to generate the password.

The output (that is, password) is displayed as illustrated in the following figure.
Figure 181: Password Manager Output

8. Copy the password from the Output field on this screen.

9. Return to the SSH session. Mouse right click the SSH cursor and press the Enter key on your
keyboard to paste the password. Optionally, press the CTRL+Insert keys to paste or manually type
in the password.

Note
If you paste the output, the SSH client will not display the password, so be careful to only paste it
once.

The superuser session begins.

For example, in the following figure, the root prompt indicates the user is logged in to ipc-z1-
ccm1-instl.

IPC Confidential Unigy 4.3

Enterprise Guide
726 A.3: Elevate shelldiag to superuser

Figure 182: SSH superuser successful log in

10. When your superuser session is finished, issue the following command from the SSH command line
to regenerate the superuser password: dynamicregen as illustrated in the following figure.

Note
dyanmicregen can only be run as superuser. Once you quit the superuser session,
dynamicregen cannot be run.

December 3, 2019 IPC Confidential

 A.3: Elevate shelldiag to superuser 727

Figure 183: SSH dynamicregen of superuser password

The superuser account access password and token for this appliance is immediately regenerated as
illustrated in the following figure.
Figure 184: SSH session dynamicregen of superuser password

IPC Confidential Unigy 4.3

Enterprise Guide
728 A.4: Dynamic Password and CCM console versus SSH client

A.4 Dynamic Password and CCM console versus SSH client

When working with the dynamic password feature, bear in mind the following behavioral differences
between the CCM console and the SSH client.
If using the CCM console the following is different from the SSH session:
• The banner is displayed along with the token before the user types the user name.
• The token provided is for shelldiag account use only.
• Content cannot be copied and pasted into the CCM console. Therefore, the password must be
manually type in.

A.5 Regenerate superuser account password

The superuser password can be regenerated on demand. As a best practice it should always be
regenerated immediately after finishing with the superuser access.
To regenerate the superuser password, issue the following command from your SSH session:
dynamicregen.
The superuser account access password and token for this appliance is immediately regenerated.

A.6 Password Manager Help topics

A.6.1 Password Manager - Generate Output panel
Use the Password Manager panel to generate a dynamic password to be used in conjunction with the
shelldiag system account, the Secure Communications feature in the UMS, or an elevated dynamic
password to be used in conjunction with the superuser system account.
Figure 185: Password Manager - Generate Output panel

December 3, 2019 IPC Confidential

 A.6: Password Manager Help topics 729

Table 86: Generate Output Panel

Name Description Values

Token Token being used to generate A randomized set of exactly 16
the dynamic password. alphanumeric and special characters
and does not include spaces, tabs, or
new lines.
You paste the token into this field.
Output Dynamic password that is A randomized set of exactly 10
generated. alphanumeric and special characters.
When you copy and paste the
password, be sure not to copy any
spaces.
Account Type Type of account this dynamic
User - for use with shelldiag
password is being generated
for. account or Secure
Communications feature in the
UMS.

Superuser - for use with superuser

account.
Read-only.
UTC Date & Time Universal date and time in Read-only.
which the validity period starts
for this dynamic password.
Local Date & Time Local date and time in which Read-only.
the validity period starts for
this dynamic password.
Exp Local Date & Time Local date and time in which Read-only
the validity period expires for
this dynamic password.

Table 87: Buttons

Name Description
Generate Output Generates a dynamic password, populates the
Output, Account Type, and Date & Time fields.

IPC Confidential Unigy 4.3

Enterprise Guide
730 A.6: Password Manager Help topics

December 3, 2019 IPC Confidential

 731

B iDRAC hardening
The Integrated Dell Remote Access Controller (iDRAC) provides remote access to the CCM, MM,
ACCM, and voice recorder appliances in a Unigy enterprise for deployment and troubleshooting
purposes. This appendix describes how to harden iDRAC 6, iDRAC 7, and iDRAC 8 to control iDRAC
access to an appliance.
Hardening iDRAC provides additional security for a Unigy enterprise. Beginning in 2018, IPC
Manufacturing hardens iDRAC on all appliances it ships to customers. Perform the iDRAC hardening
procedures referenced in this topic only if Manufacturing did not harden an appliance or it is necessary
to rebuild an appliance.
To get the latest iDRAC security updates, you should consider installing the latest firmware update. For
information on accessing the firmware and installation instructions, refer to Install the latest iDRAC
firmware on page 731. Check with IPC Support for the current iDRAC firmware versions supported.
The hardening procedure includes the following configuration changes:
• Adding an administrative user account.
• Disabling the predefined root user account to prevent iDRAC access with this account.
• Setting the Remote Presence Port for the Virtual Console.
• Setting SSL encryption.
• Disabling SSH, Telnet, and SNMP Agent.
Refer to the following procedures as applicable:
• Harden iDRAC 6 on page 732
• Harden iDRAC 7 on page 736
• Harden iDRAC 8 on page 740
• Harden iDRAC 9 on page 746

B.1 Install the latest iDRAC firmware

Use this procedure to upgrade the iDRAC firmware to get the latest security, performance, and defect
updates.
1. Record the current iDRAC firmware version:
a) Log in to iDRAC: https://idrac_ip, where idrac_ip is the iDRAC IP address.
b) Click Server.
c) In the Server Information section, locate Firmware Version and record the current version.
2. Access the firmware release notes and installation instructions on the Dell Support site:
a) Within a browser, access the Dell Support website: support.dell.com.
b) In the Product support section, do one of the following:
• If you have the service tag or product ID for the appliance for which you are installing the
iDRAC firmware:

IPC Confidential Unigy 4.3

Enterprise Guide
732 B.2: Harden iDRAC 6

1. Enter the tag or ID within the Enter a Service Tag or other product ID box.
2. Click Submit.
• If you do not have the service tag or product ID:
1. In the Browse for a product box, click View products.
2. Click Servers, Storage, & Networking.
3. Click PowerEdge.
4. Click the server model you are upgrading.
c) Click Drivers & Downloads.
d) Click iDRAC with Lifecycle controller.
e) Locate the latest version and compare it to the version you recorded in step 1.
If the most recent version is installed, it is not necessary to complete this procedure.
f) Click View details then download and read the release notes. Follow the installation instructions
near the end of the release notes to upgrade the firmware.

B.2 Harden iDRAC 6

Perform this procedure to harden iDRAC 6 to prevent unauthorized access.

Note
Perform this procedure on all CCM, ACCM, MM, and Voice Recorder appliances that have iDRAC 6
installed.

1. Establish an HTTPS session to iDRAC:

a) In a browser, access https://iDRAC_ip_address, where iDRAC _ip_address is the
iDRAC IP address.
b) Enter the iDRAC root user account Username, Password, and if applicable, the Domain.
c) Click Submit.
2. Add an iDRAC user account to serve as the administrative user in place of the root user account:
a) In the left panel, click iDRAC Settings.
b) Within the Network/Security tab, click Users.

December 3, 2019 IPC Confidential

 B.2: Harden iDRAC 6 733

Figure 186: iDRAC Users panel

c) In the Users panel, click the next available User ID. The next available ID is the next sequential
number where the User Name column is blank.
d) Click Next.
Figure 187: iDRAC General section

e) In the General section, select the Enable User check box.

f) Type the appropriate values for the new user in the User Name, New Password, and Confirm
New Password fields.
• For User Name, enter ipciDrac.
• For Password, contact IPC Central Support for the authorized password.
Figure 188: iDRAC IPMI User Privileges section

g) In the IPMI User Privileges section, select Administrator for the Maximum LAN User Privilege
Granted and Maximum Serial Port User Privilege Granted fields.

IPC Confidential Unigy 4.3

Enterprise Guide
734 B.2: Harden iDRAC 6

Figure 189: iDRAC User Privileges section

h) In the iDRAC User Privileges section, select Administrator in the Roles field.
i) Verify that all of the check boxes in the iDRAC User Privileges section are selected.
j) Click Apply.
k) Click Go back to the User Main Menu.
l) Click Go Back to Users.
3. Disable the predefined root user account so it cannot be used to access iDRAC:
a) Click the User ID of the root user account.
b) Click Next.
Figure 190: iDRAC General section - disable user

c) In the General section, clear the Enable User check box then click Apply.
d) Click Go back to the User Main Menu.
e) Click Go Back to Users.
4. Set the Remote Presence Port for the Virtual Console:
a) In the left panel, click System.
b) In the Virtual Console Preview panel, click Settings.

December 3, 2019 IPC Confidential

 B.2: Harden iDRAC 6 735

Figure 191: IDRAC Virtual Console section

c) In the Virtual Console section, change the Remote Presence Port from 5900 to 5899 then click
Apply.
5. Set SSL encryption, change the HTTP port to a more obscure port, and disable SSH, Telnet, and
SNMP Agent:
a) In the left panel, click iDRAC Settings.
b) Within the Network/Security tab, click Services.
Figure 192: iDRAC Services section

c) In the Web Server section, change the HTTP Port Number from 80 to 8079.
d) Change the SSL Encryption field to 128-bit or higher.

IPC Confidential Unigy 4.3

Enterprise Guide
736 B.3: Harden iDRAC 7

e) In the SSH, Telnet, and SNMP Agent sections, clear the Enabled check box.
f) Click Apply.

B.3 Harden iDRAC 7

Perform this procedure to harden iDRAC 7 to prevent unauthorized access.

Note
Perform this procedure on all Unigy CCM, ACCM, MM, and Voice Recorder appliances that have iDRAC
7 installed.

1. Establish an HTTPS session to iDRAC:

a) In a browser, access https://iDRAC_ip_address, where iDRAC _ip_address is the
iDRAC IP address.
b) Enter the iDRAC root account Username, Password, and if applicable, the Domain.
c) Click Submit.
2. Add an iDRAC user account to serve as the administrative user in place of the root user account:
a) In the left panel, click iDRAC Settings ➤ User Authentication.
Figure 193: iDRAC Users panel

b) In the Users panel, click the next available User ID. The next available ID is the next sequential
number where the User Name column is blank.
c) Within the Local Users tab, click Next.

December 3, 2019 IPC Confidential

 B.3: Harden iDRAC 7 737

Figure 194: iDRAC General section

d) In the General section, select the Enable User check box.

e) Type the appropriate values for the new user in the User Name, New Password, and Confirm
New Password fields.
• For User Name, enter ipciDrac.
• For Password, contact IPC Central Support for the authorized password.
Figure 195: iDRAC IPMI User Privileges section

f) In the IPMI User Privileges section, select Administrator for the Maximum LAN User Privilege
Granted and Maximum Serial Port User Privilege Granted fields.
Figure 196: iDRAC User Privileges section

g) In the iDRAC User Privileges section, select Administrator in the Roles field.
h) Verify that all of the check boxes in the iDRAC User Privileges section are selected.

IPC Confidential Unigy 4.3

Enterprise Guide
738 B.3: Harden iDRAC 7

i) Click Apply.
j) Click Back to User Main Menu.
k) Click Back to Users.
3. Disable the predefined root user account so it cannot be used to access iDRAC:
a) Click the User ID of the root user account.
b) Click Next.
Figure 197: iDRAC General section - disable user

c) In the General section, clear the Enable User check box then click Apply.
d) Click Back to User Main Menu.
e) Click Back to Users.
4. Set the Remote Presence Port for the Virtual Console:
a) In the left panel, click Server then click the Console tab.
Figure 198: iDRAC Virtual Console section

b) In the Virtual Console section, change the Remote Presence Port from 5900 to 5899 then click
Apply.
5. Set SSL encryption, change the HTTP port to a more obscure port, and disable SSH, Telnet, and
SNMP Agent:
a) In the left panel, click iDRAC Settings ➤ Network.
b) Click the Services tab.

December 3, 2019 IPC Confidential

 B.3: Harden iDRAC 7 739

Figure 199: iDRAC Web Server section

c) In the Web Server section, change the HTTP Port Number from 80 to 8079.
d) Set the SSL Encryption field to 128-bit or higher.

IPC Confidential Unigy 4.3

Enterprise Guide
740 B.4: Harden iDRAC 8

Figure 200: iDRAC SSH, Telnet, and SNMP Agent sections

e) In the SSH, Telnet, and SNMP Agent sections, clear the Enabled check box.
f) Click Apply.

B.4 Harden iDRAC 8

Perform this procedure to harden iDRAC 8 to prevent unauthorized access.

December 3, 2019 IPC Confidential

 B.4: Harden iDRAC 8 741

Note
Perform this procedure on all Unigy CCM, ACCM, MM, and Voice Recorder appliances that have iDRAC
8 installed.

1. Establish an HTTPS session to iDRAC:

a) In a browser, access https://iDRAC_ip_address, where iDRAC _ip_address is the
iDRAC IP address on the appliance you are configuring.
b) Enter the iDRAC root user account Username, Password, and if applicable, the Domain.
c) Click Submit.
2. Add an iDRAC user account to serve as the administrative user in place of the root user account:
You will disable the root account in step 3.
a) In the left panel, click iDRAC Settings ➤ User Authentication.
Figure 201: Local Users: Users panel

b) In the Users panel, click the next available User ID. The next available ID is the next sequential
number where the User Name column is blank.
c) In the User Main Menu panel within the Local Users tab, click Next.

IPC Confidential Unigy 4.3

Enterprise Guide
742 B.4: Harden iDRAC 8

Figure 202: Local Users: User Configuration: General section

d) In the General section of the User Configuration panel, select the Enable User check box.
e) Type the appropriate values for the new user in the User Name, New Password, and Confirm
New Password fields.
• For User Name, enter ipciDrac.
• For Password, contact IPC Central Support for the authorized password.
Figure 203: Local Users: User Configuration: IPMI User Privileges section

f) In the IPMI User Privileges section, select Administrator for the Maximum LAN User Privilege
Granted and Maximum Serial Port User Privilege Granted fields.
Figure 204: Local Users: User Configuration: iDRAC User Privileges section

g) In the Roles field within the iDRAC User Privileges section, select Administrator.

December 3, 2019 IPC Confidential

 B.4: Harden iDRAC 8 743

h) Verify that all of the check boxes in the iDRAC User Privileges section are selected.
i) Click Apply.
j) Click Back to User Main Menu.
k) Click Back to Users.
3. Disable the predefined root user account so it cannot be used to access iDRAC:
a) In the left panel, click iDRAC Settings ➤ User Authentication.
Figure 205: Local Users: Users panel

b) In the Users panel, click the User ID of the root user account.
c) In the User Main Menu panel, click Next.

IPC Confidential Unigy 4.3

Enterprise Guide
744 B.4: Harden iDRAC 8

Figure 206: Local Users: User Configuration: General section - disable user

d) In the General section of the User Configuration panel, clear the Enable User check box then
click Apply.
e) Click Back to User Main Menu.
f) Click Back to Users.
4. Set the Remote Presence Port for the Virtual Console:
a) In the left panel, click Server ➤ Virtual Console.
Figure 207: Server: Virtual Console section

b) In the Virtual Console section, change the Remote Presence Port from 5900 to 5899 then click
Apply.
5. Set SSL encryption, change the HTTP port to a more obscure port, and disable SSH, Telnet, and
SNMP Agent:
a) In the left panel, click iDRAC Settings ➤ Network.
b) Click the Services tab at the top of the panel.

December 3, 2019 IPC Confidential

 B.4: Harden iDRAC 8 745

Figure 208: Services: Web Server section

c) In the Web Server section, change the HTTP Port Number from 80 to 8079.
d) Set the SSL Encryption field to 128-bit or higher.

IPC Confidential Unigy 4.3

Enterprise Guide
746 B.5: Harden iDRAC 9

Figure 209: Services: SSH, Telnet, and SNMP Agent sections

e) In the SSH, Telnet, and SNMP Agent sections, clear the Enabled check box.
f) Click Apply.

B.5 Harden iDRAC 9

Perform this procedure to harden iDRAC 9 to prevent unauthorized access.

Note
Perform this procedure on all Unigy CCM, ACCM, MM, and Voice Recorder appliances that have iDRAC
9 installed.

1. Establish an HTTPS session to iDRAC:

a) In a browser, access https://iDRAC_ip_address, where iDRAC_ip_address is the
iDRAC IP address for the appliance you are configuring.
b) Enter the iDRAC root user account Username, Password, and if applicable, Domain.
c) Click Log In.
2. Add an iDRAC user account to serve as the administrative user in place of the root user account.
You will disable the root account in step 3.

December 3, 2019 IPC Confidential

 B.5: Harden iDRAC 9 747

a) In the menu bar, click iDRAC Settings then in the iDRAC Settings section, click Users.
Figure 210: iDRAC Settings

b) In the Local Users section, click + Add.

Figure 211: User Account Settings

c) In the User Name, New Password, and Confirm New Password fields, type the appropriate
values for the new user as follows:
• For User Name, enter ipciDrac.
• For Password, contact IPC Central Support for the authorized password.
d) For User Role in the User Privileges section, select Administrator.
e) Verify that all of the check boxes in the User Privileges section are selected then scroll down to
the Advanced Settings section.

IPC Confidential Unigy 4.3

Enterprise Guide
748 B.5: Harden iDRAC 9

Figure 212: Advanced Settings

f) For LAN Privilege Level, select Administrator.

g) For Serial Port Privilege Level, select Administrator.
h) Click Save.
i) In the Success message box, click OK.
The system adds the user account and sets the State to Enabled.
Figure 213: iDRAC Settings showing the ipciDrac user account

3. Disable the predefined root user account so it cannot be used to access iDRAC:
a) In the Local Users section, click the root user account.
b) Click the Disable button.
c) In the Success message box, click OK.
The system changes the State to Disabled.
4. Set the Remote Presence Port for the Virtual Console:

December 3, 2019 IPC Confidential

 B.5: Harden iDRAC 9 749

a) In the menu bar, click Configuration then in the Configuration section, click Virtual Console.
Figure 214: Virtual Console

b) Change the Remote Presence Port from 5900 to 5899 then click Apply.
5. Set SSL encryption and the TLS protocol, change the HTTP port to a more obscure number, and
disable SSH, Telnet, and SNMP Agent:
a) In the menu bar, click iDRAC Settings then in the iDRAC Settings section, click Services.

IPC Confidential Unigy 4.3

Enterprise Guide
750 B.5: Harden iDRAC 9

Figure 215: iDRAC Settings: Services

b) Expand the Web Server section.

c) Change the HTTP Port Number from 80 to 8079.
d) Confirm that the SSL Encryption is 128-Bit or higher.
e) Set the TLS Protocol to TLS 1.2 Only then click Apply.
f) Expand the SSH section, set the Enabled property to Disabled, then click Apply.
g) Expand the Telnet section, set the Enabled property to Disabled, then click Apply.
h) Expand the SNMP Agent section, set the Enabled property to Disabled, then click Apply.
6. Disable Microsoft Active Directory, the Generic LDAP Directory Service and Smart Card:
a) In the menu bar, click iDRAC Settings.
b) In the iDRAC Settings section, click Users.

December 3, 2019 IPC Confidential

 B.5: Harden iDRAC 9 751

Figure 216: iDRAC Settings: Users: Directory Services

c) Expand the Directory Services section and confirm that Microsoft Active Directory and Generic
LDAP Directory Service are Disabled. If they are not, click each service then click the Disable
button.
d) Expand the Smart Card section and confirm that Configure Smart Card Logon and Enable CRL
Check for Smart Card Logon are Disabled. If they are not, select Disabled for each then click
Apply.
7. Confirm or configure time and USB settings:
a) In the menu bar, click iDRAC Settings.
b) In the iDRAC Settings section, click Settings.

IPC Confidential Unigy 4.3

Enterprise Guide
752 B.5: Harden iDRAC 9

Figure 217: Time Zone and NTP Settings

c) Expand the Time Zone and NTP Settings section. For Time Zone, select the appropriate time
zone for the associated backroom, confirm that Enable Network Time Protocol (NTP) is
Disabled, then if you changed either value, click Apply.
d) Expand the Management USB Settings section, set the USB Management Port to Disabled then
click Apply.
8. Confirm or configure the Connectivity settings. If you have to change any value, make the change
then click Apply.
a) In the menu bar, click iDRAC Settings.
b) In the iDRAC Settings section, click Connectivity.
Figure 218: Network: Common Settings

c) Expand the Common Settings section and confirm that Register iDRAC on DNS is Disabled.
d) Expand the Auto Config section and confirm that DHCP Provisioning is Disabled.
e) Expand the IPV6 Settings section and confirm that Enabled IPV6 is Disabled.
f) Expand the IPMI Settings section and confirm that Enable IPMI Over LAN is Disabled.
g) Expand the VLAN Settings section and confirm that Enabled VLAN ID is Disabled.
h) Expand the Advanced Network Settings section, confirm that IP Range Enabled is Disabled and
IP Blocking Enabled is Enabled, then confirm that the following values are set properly:
• IP Blocking Fail Count=3
• IP Blocking Fail Window=60

December 3, 2019 IPC Confidential

 B.5: Harden iDRAC 9 753

• IP Blocking Penalty Time=60

i) In the Federal Information Processing Standards section, confirm that FIPS Mode is Disabled.
j) Expand the Serial section and confirm that the Enable property is Disabled.
k) Expand the Serial Over LAN section and confirm that Enable Serial Over LAN is Enabled.
l) Expand the OS to iDRAC Pass-through section and confirm that State is Disabled.

IPC Confidential Unigy 4.3

Enterprise Guide
754 B.5: Harden iDRAC 9

December 3, 2019 IPC Confidential

 755

C BIOS configuration
C.1 Configure the BIOS settings for R620 appliances
IPC Manufacturing configures the BIOS password and boot settings on all appliances before shipping
them. This topic describes how to reconfigure the BIOS settings if it becomes necessary to do so.
Use the Tab, arrow, and Enter keys to navigate the screens and select and execute the UI controls.
Depending on how you are accessing the BIOS Boot Manager utility, you might also be able to use a
mouse.

Note
Perform this procedure only if it is necessary to correct properties that are set improperly.

1. Reboot or power cycle the appliance.

The appliance starts and displays the Boot Settings screen with four options.
Figure 219: Boot Settings screen

2. Press F11 BIOS Boot Manager.

Note
You have only a few seconds to do this, so it is important that you watch for this prompt. If you miss
the prompt, repeat step 1.

The option changes to Entering BIOS Boot Manager and the boot process continues. Within
approximately 30 seconds, the system displays the BIOS Boot Manager Main Menu.

IPC Confidential Unigy 4.3

Enterprise Guide
756 C.1: Configure the BIOS settings for R620 appliances

Figure 220: Boot Manager Main Menu - Launch System Setup – System BIOS menu

3. Select Launch System Setup then press Enter.

4. Select System BIOS then press Enter.
The System BIOS Settings menu is displayed.

December 3, 2019 IPC Confidential

 C.1: Configure the BIOS settings for R620 appliances 757

Figure 221: System BIOS Settings menu

5. Select Integrated Devices then press Enter.

The Integrated Devices properties are displayed.
Figure 222: System BIOS Settings – Integrated Devices properties

6. Verify that the setting for the Network Interface Card, Integrated Network Card 1 is Enabled. If it is
not, select Enabled.
7. Select Back then press Enter.
The System BIOS Settings menu is displayed.

IPC Confidential Unigy 4.3

Enterprise Guide
758 C.1: Configure the BIOS settings for R620 appliances

Figure 223: System BIOS Settings – Boot Settings menu

8. Select the Boot Settings option then press Enter.

The Boot Settings menu is displayed.
9. Verify that Boot Mode is set to BIOS then select BIOS Boot Settings and press Enter.
The BIOS Boot Settings properties are displayed.
10. Select Boot Sequence then press Enter.
The Change Order panel is displayed.
Figure 224: BIOS System Setup – Boot Sequence – Change Order panel

11. Arrange the devices in the sequence shown above by selecting a device and using the + or - button to
move the device up or down. After the sequence is correct, select OK then press Enter.

December 3, 2019 IPC Confidential

 C.1: Configure the BIOS settings for R620 appliances 759

Figure 225: System BIOS Settings – Boot Settings – BIOS Boot Settings properties

12. In the Boot Option Enable/Disable section, disable the devices that are not required for boot up. To
boot only from the hard drive, disable the other options by doing the following:
a) Clear the check box for the optical drive entry.
b) Clear the check box for the network interface card entry.
Figure 226: System BIOS Settings – Boot Settings – BIOS Boot Settings properties

13. Select Back and press Enter twice to return to the System BIOS Settings menu.

IPC Confidential Unigy 4.3

Enterprise Guide
760 C.1: Configure the BIOS settings for R620 appliances

Figure 227: System BIOS – System BIOS Settings menu

14. Select System Profile Settings then press Enter.

The System Profile Settings properties are displayed.
Figure 228: System BIOS Settings – System Profile Settings

15. Verify that System Profile is set to Performance. If it is not, select Performance from the list.
16. Select Back then press Enter.
The System BIOS Settings menu is displayed.
17. Select System Security then press Enter.
The System Security properties are displayed.

December 3, 2019 IPC Confidential

 C.1: Configure the BIOS settings for R620 appliances 761

Figure 229: System BIOS Settings – System Security properties

18. Select the System Password text box.

The password character options are displayed at the bottom of the page.
Figure 230: System BIOS Settings – System Security properties

19. In the Setup Password field, type the BIOS setup password then press Enter.
The password can be up to 32 characters and can include the following characters: spaces 0–9 a–z +
" , - . / ; [ \ ] `. Alphabetic characters must be lowercase.
20. Select Back then press Enter.
21. Select Finish then press Enter.
The system prompts you to Save your changes.
22. Select Yes then press Enter to save the changes and exit the BIOS Boot Manager utility.
The system reboots the appliance to apply the changes.

IPC Confidential Unigy 4.3

Enterprise Guide
762 C.2: Configure the BIOS settings for R630 appliances

C.2 Configure the BIOS settings for R630 appliances

IPC Manufacturing configures the BIOS password and boot settings on all appliances before shipping
them. This topic describes how to reconfigure the BIOS settings if it becomes necessary to do so at a
customer site.
You can use your mouse or the Tab, arrow, and Enter keys to navigate the screens and select and
execute the UI controls.

Note
Perform this procedure only if it is necessary to correct properties that are set improperly.

1. Reboot or power cycle the appliance.

The appliance starts and displays the Boot Settings screen with the following options.
Figure 231: Boot options

2. Press F2 = System Setup.

Note
You have only a few seconds to do this, so it is important that you watch for this prompt. If you miss
the prompt, repeat step 1.

The option changes to Entering System Setup and the boot process continues. Within approximately
30 seconds, the system displays the System Setup Main Menu.
Figure 232: System Setup Main Menu

3. Click System BIOS.

The System BIOS Settings menu is displayed.

December 3, 2019 IPC Confidential

 C.2: Configure the BIOS settings for R630 appliances 763

Figure 233: System BIOS Settings menu

4. Click Integrated Devices.

The Integrated Devices properties are displayed.
Figure 234: System BIOS Settings – Integrated Devices properties

5. Verify that the setting for the Network Interface Card, Integrated Network Card 1 is Enabled. If it is
not, select Enabled.

IPC Confidential Unigy 4.3

Enterprise Guide
764 C.2: Configure the BIOS settings for R630 appliances

6. Click Back.
The System BIOS Settings menu is displayed.
Figure 235: System BIOS Settings menu

7. Click Boot Settings.

Figure 236: Boot Settings screen

8. Verify that Boot Mode is set to BIOS then click Boot Option Settings.
The BIOS Boot Settings properties are displayed.

December 3, 2019 IPC Confidential

 C.2: Configure the BIOS settings for R630 appliances 765

9. Click Boot Sequence.

The Change Order dialog box is displayed.
Figure 237: BIOS System Setup – Boot Sequence – Change Order panel

10. Arrange the devices in the sequence shown above by selecting a device and using the + or - button to
move the device up or down. After the sequence is correct, click OK.
11. In the Boot Option Enable/Disable section, disable the devices that are not required for boot up. To
boot only from the hard drive, disable the other options by doing the following:
a) Clear the check box for the optical drive entry.
b) Clear the check box for the network interface card entry.

IPC Confidential Unigy 4.3

Enterprise Guide
766 C.2: Configure the BIOS settings for R630 appliances

Figure 238: System BIOS Settings – Boot Settings – BIOS Boot Settings properties

12. Click Back to return to the System BIOS Settings menu.

Figure 239: System BIOS – System BIOS Settings menu

13. Click System Profile Settings.

The System Profile Settings properties are displayed.

December 3, 2019 IPC Confidential

 C.2: Configure the BIOS settings for R630 appliances 767

Figure 240: System BIOS Settings – System Profile Settings

14. Verify the following:

• System Profile is set to Performance.
• CPU Power Management is set to Maximum Performance.
• Memory Frequency is set to Maximum Performance.
15. Click Back.
The System BIOS Settings menu is displayed.

IPC Confidential Unigy 4.3

Enterprise Guide
768 C.2: Configure the BIOS settings for R630 appliances

Figure 241:

16. Click System Security.

The System Security properties are displayed.
Figure 242: System BIOS Settings – System Security properties

17. Within the Setup Password text box type the BIOS setup password then press the Tab key.
The password character options and considerations are displayed in the note at the bottom of the
page.

December 3, 2019 IPC Confidential

 C.3: Configure the BIOS settings for R640 appliances 769

After you click Tab, the Message dialog box is displayed.

Figure 243: Message box

18. Reenter the password then click OK.

19. Click Back.
20. Click Finish.
The system displays the Warning message box prompting you to confirm that you want to save your
changes.
21. Click Yes to save the changes.
The system displays the Success message box.
22. Click OK.
The system displays the System Setup Main Menu.
23. Click Finish.
The system displays a Warning message.
24. Click Yes to confirm that you want to apply the changes and reboot the appliance.
The system reboots the appliance.

C.3 Configure the BIOS settings for R640 appliances

IPC Manufacturing configures the BIOS password and boot settings on all appliances before shipping
them. This topic describes how to reconfigure the BIOS settings if it becomes necessary to do so at a
customer site.
You can use your mouse or the Tab, arrow, and Enter keys to navigate the screens and select and
execute the UI controls.

Note
Perform this procedure only if it is necessary to correct properties that are set improperly.

1. Reboot or power cycle the appliance.

The appliance starts and displays the Boot Settings screen with the following options. If you are
rebooting from iDRAC and set the Next Boot option to BIOS Setup, the system displays this screen
then automatically displays the System Setup Main Menu shown in step 2.

IPC Confidential Unigy 4.3

Enterprise Guide
770 C.3: Configure the BIOS settings for R640 appliances

Figure 244: Boot options

2. If you are not using iDRAC or did not set iDRAC to automatically access the BIOS settings, press F2
= System Setup.

Note
You have only a few seconds to do this, so it is important that you watch for this prompt. If you miss
the prompt, repeat step 1.

The option changes to Entering System Setup and the boot process continues. Within approximately
30 seconds, the system displays the System Setup Main Menu.
Figure 245: System Setup Main Menu

3. Click System BIOS.

The System BIOS Settings menu is displayed.

December 3, 2019 IPC Confidential

 C.3: Configure the BIOS settings for R640 appliances 771

Figure 246: System BIOS Settings menu

4. Click Integrated Devices.

The Integrated Devices screen is displayed.

IPC Confidential Unigy 4.3

Enterprise Guide
772 C.3: Configure the BIOS settings for R640 appliances

Figure 247: System BIOS Settings – Integrated Devices screen

5. Verify that the setting for Integrated Network Card 1 is Enabled. If it is not, select Enabled.
6. Click Back.
The System BIOS Settings menu is displayed.

December 3, 2019 IPC Confidential

 C.3: Configure the BIOS settings for R640 appliances 773

Figure 248: System BIOS Settings menu

7. Click BIOS Boot Settings.

The Boot Settings screen is displayed.

IPC Confidential Unigy 4.3

Enterprise Guide
774 C.3: Configure the BIOS settings for R640 appliances

Figure 249: Boot Settings screen

8. Verify that Boot Mode is set to BIOS then click BIOS Boot Settings.
The BIOS Boot Settings screen is displayed.
9. Click Boot Sequence.
The Change Order dialog box is displayed.

December 3, 2019 IPC Confidential

 C.3: Configure the BIOS settings for R640 appliances 775

Figure 250: System BIOS Settings – Boot Settings – BIOS Boot Settings screen

10. Arrange the devices in the sequence shown above by selecting a device and clicking the + or - button
to move the device up or down. After the sequence is correct, click OK.
This sequence enables the appliance to boot from a DVD when deploying the COP software. To
prevent the system from booting from a DVD after the COP is deployed, you can move the hard drive
to the top position, however, if it is necessary to redeploy the COP in the future, you will have to
change the sequence to allow the appliance to boot from the DVD.
11. In the Boot Option Enable/Disable section, disable the devices that are not required for boot up. To
boot only from the hard drive or the optical drive, disable the NIC option by clearing the check box
for this option.

IPC Confidential Unigy 4.3

Enterprise Guide
776 C.3: Configure the BIOS settings for R640 appliances

Figure 251: BIOS System Setup – Boot Sequence – Change Order dialog box

12. Click Back then click Back again to return to the System BIOS Settings menu.

December 3, 2019 IPC Confidential

 C.3: Configure the BIOS settings for R640 appliances 777

Figure 252: System BIOS Settings menu

13. Click System Profile Settings.

The System Profile Settings screen is displayed.

IPC Confidential Unigy 4.3

Enterprise Guide
778 C.3: Configure the BIOS settings for R640 appliances

Figure 253: System BIOS Settings – System Profile Settings screen

14. Verify the following:

• System Profile is set to Performance.
• CPU Power Management is set to Maximum Performance.
• Memory Frequency is set to Maximum Performance.
15. Click Back.
The System BIOS Settings menu is displayed.

December 3, 2019 IPC Confidential

 C.3: Configure the BIOS settings for R640 appliances 779

Figure 254: System BIOS Settings menu

16. Click System Security.

The System Security screen is displayed.

IPC Confidential Unigy 4.3

Enterprise Guide
780 C.3: Configure the BIOS settings for R640 appliances

Figure 255: System BIOS Settings – System Security screen

17. Within the Setup Password text box type a new BIOS setup password then press the Tab key.
The password character options and considerations are displayed in the note at the bottom of the
page.
After you click Tab, the Message dialog box is displayed.
Figure 256: Message box

18. Reenter the password then click OK.

19. Click Back.
20. Click Finish.
The system displays the Warning message box prompting you to confirm that you want to save your
changes.
21. Click Yes to save the changes.
The system displays the Success message box.
22. Click OK.
The system displays the System Setup Main Menu.
23. Click Finish.

December 3, 2019 IPC Confidential

 C.3: Configure the BIOS settings for R640 appliances 781

The system displays a Warning message.

24. Click Yes to confirm that you want to Exit.
The system reboots the appliance.

IPC Confidential Unigy 4.3

Enterprise Guide
782 C.3: Configure the BIOS settings for R640 appliances

December 3, 2019 IPC Confidential

 783

Index
A taking out of maintenance mode 600
alerts
ACCM clearing 565
as a time source 427, 430 reenabling forwarding to trap destinations 596
assigning a location 517 removing 564
changing hostname 415 analysis
changing IP address 412 with Enterprise Watch 215, 643
ACCMs appliance images
changing an IP address 409 backing up 385
configuring network connections 450 compressing and copying 385
confirming registration 362 appliance personality
deploying 465 files available in Single Click Deployment 165
downgrading software 100 appliance software
enabling registration 496 rolling back 386
maintenance service done 601 appliances
network properties 462, 464 Blue Wave 102
placing into maintenance mode 599 changing NTP servers 423
powering down 339 configuring with Network Configurator 450
powering up 340 confirm not registered with an SCD appliance 163
rebooting from UMS 587 confirm removed from an SCD appliance 169
removing from the database 359 confirming registration 362
shutting down 339 deploying 465
taking out of maintenance mode 600 deploying Blue Wave 106, 109
active appliance enabling registration 496
IP address 377 moving to a different network 402
Active Directory groups 720 personality 450
addresses placing into maintenance mode 599
adding 242 powering down 339
editing 242 powering up 340
addresses.txt rearming a Standby 547
generating 567 rebooting 321
Advanced Administrator registered with an SCD appliance 162
installing license files 483 registering with Single Click Deployment 160
AFM remove from Single Click Deployment appliance 199
alert diagnostics 670 removing from Single Click Deployment 168
Aggregated Converged Communications Manager removing from the database 359, 361
changing hostname 415 replacing 344
changing IP address 412 replacing R610, R620, or R630 with R640 341
Aggregated Converged Communications Managers shutting down 339
assigning a location 517 Single Click Deployment 150
changing an IP address 409 taking out of maintenance mode 600
confirming registration 362 upgrading with SCD 60
deploying 465 archive backup
enabling registration 496 definition 369, 370
maintenance service done 601 archive data
placing into maintenance mode 599 creating a recurring job 612
powering down 339 artifacts
powering up 340 importing to Single Click Deployment 164
removing from the database 359 assigned license
shutting down 339 system reports 689, 691

IPC Confidential Unigy 4.3

Enterprise Guide
784

assigned license report 689, 691 overview 283–288

Async channel reactivate a plan 296
updating JGroups protocols 718 redeactivate a plan 298
authentication servers Soft Client redirection 298
reestablishing connection 335 testing 671
Automated Health Check BCP status
run script 639 change to Active 498
Available Artifact BIOS
Single Click Deployment 212 configuring 755, 762
Available Artifacts configuring - R640 769
Single Click Deployment 165 upgrade for Spectre and Meltdown patch 147
Blue Wave
B confirming an update was deployed 552
deploy 102
back up and restore deploying 106, 109
databases 601–604 deploying updates 93, 114, 116, 120
back-up image deploying zones 495
rollback 391 initial deployment 102
backup software deployment and upgrades 101
image 601–604 upgrade deployment 114
page 608 upgrading 21
backup files Blue Wave administration console
cannot upload from remote location 611 accessing 544
deleting 608 Blue Wave deployment
downloading 607, 608 rolling back 102, 106, 109, 114, 116, 120
uploading 350, 374, 377, 608, 611 boot options
uploading does not replace local 611 configuring 755, 762
uploading to a Single Click Deployment appliance 166, configuring - R640 769
213 browser support
backup jobs desktops 720
completing 363 mobile 720
editing scheduled 366 business continuity planning
restoring 372 configuring user login priorities 292
restoring manually at command line 377 Business Continuity Planning
scheduling 363 activating a plan 293, 294
backup types 363, 367, 369, 370, 372, 376, 379, 381 configuring 290
backups deactivate a plan 296
creating an archive backup job 612 disabling automatic activation 293
remote 604, 605 overview 283–288
restoring manually 350, 374 reactivate a plan 296
bandwidth utilization 701, 702, 704–706 redeactivate a plan 298
BARRIER 514 Soft Client redirection 298
BCP business continuity planning (BCP)
activating a plan 293, 294 constraints 290
configuring 290 failover event 289
configuring user login priorities 292 buttons
constraints 290 editing with mass edit client 686
deactivate a plan 296 remove properties 673
disabling automatic activation 293
failover event 289 C
line redirection 299
manual sync 696 call control
Media Gateways 569 verifying dial tone connections 658

December 3, 2019 IPC Confidential

 785

verifying ICM connections 654 output details 507

verifying inbound call connections 660 checkTransientChannels 514, 638
verifying private line connections 656 clock
calls setting time zone 426
conference, making 666 Cluster Operation Output Details 502, 504–506
dial tone line 665 clusters
initiating 665 enabling 545
intercom 663 maintenance service done 601
making 663, 665 placing into maintenance mode 598
making a conference 666 status 499, 500, 502, 504–506
CAS files take out of maintenance mode 599
resyncing 582 collector zones 316, 701, 702, 704–706
synchronizing 579 Common Operating Platform
CCM deploying 448
as a time source 427, 430 reCOP and appliance 448
changing hostname 415 upgrading 41
changing IP address 412 communication devices
CCM console 728 rebooting 592
CCMs verifying IP recording status 668
assigning a location 517 communication history
changing an IP address 409 back up 601–604
configuring network connections 450 conference
confirming registration 362 creating 666
deploying 465 conferences
downgrading software 100 making 666
enabling registration 496 configuration
interzone diagnostics 646 changes that require a reboot 335
maintenance service done 601 post installation procedures 427, 430
network properties 462, 464 Soft Client network connection 623
placing into maintenance mode 599 time source 427, 430
configure
powering down 339
DHCP 674
powering up 340
network settings 674
rebooting from UMS 587
static IP 674
removing from the database 359
constraints
shutting down 339
BCP 290
taking out of maintenance mode 600
controlling zone
CDIs
creates backup 363
downgrading software 100
Converged Communications Manager
downgrading the software 562
change IP address 412
registering 496
changing hostname 415
secure communications override 276 Converged Communications Managers
certificates
assigning a location 517
copy between enterprises 442
changing an IP address 409
for Soft Client secure communications 270
confirming registration 362
types supported 268
deploying 465
upload a self-signed for secure communications 269
enabling registration 496
certified administrator license files
maintenance service done 601
installing 483
placing into maintenance mode 599
changes that require rebooting 335
powering down 339
channel 514
powering up 340
checkEnterpriseConfiguration 258, 259
removing from the database 359
checkGlobalReplicationTier 250, 251
shutting down 339
checkReplication

IPC Confidential Unigy 4.3

Enterprise Guide
786

taking out of maintenance mode 600 delegated authentication

COP reestablishing connection with server 335
deploying 448 deployment
determine software version 450 appliance personality 467, 471, 472, 476
files available in Single Click Deployment 165 Blue Wave 102, 114
reCOP an appliance 448 Blue Wave appliance 106, 109
upgrading 41 Blue Wave Director appliance 102
corrupt database change zone ID 323
recovering from 380 configure plan 181, 187
country base deploying a replica system 279
changing 324, 544 deploying software updates 558
designations 476 deploying subsequent zones 495
updating a Media Gateway country.dat file 325 deploying the peer zone 489
country.dat file deploying zones 491
uploading to a Media Gateway 325 downgrading the software 562
countrybase hotfixes 21
changing 324, 544 network properties 462, 464
Critical Alert 670 patches 21
custom personality software 465
report 695 rebooting Media Gateways 591
custom report
redeploy an appliance in a zone 328
deleting 696
redeploy peer zone 349
rolling back 102, 106, 109, 114, 116, 120
D rolling back a software deployment 386
rolling back updates 387, 389
data
service packs 21
conversion script 23
unable to upload ISO file 548
restoring enterprise backup 380
updating devices 558
data center
validating enterprise 635
changing portal zone 249
validating system processes 638
data centers
deployments
disabling Global Replication Controls 246
Blue Wave 101
enabling global replication controls 243
device lists 709
data replication
device registration
checking status for all zones 513
confirming 362
disabling 498
disabling 497
enabling 497
devices
enabling partial replication 316, 701, 702, 704–706
deploying updates 558
database
downgrading the software 562
determining source zone 615, 619–621
enabling registration 496
schema change 23
monitoring 652
database restore
removing from the database 359
post_restore.sh script 614
DHCP
databases
configuration 674
back up 601–604
diag account 720
data in archive backup 369, 370
diagnostics
data in user backup 369, 370
interzone 646
referenced 371
rebooting communication devices 592
datacenters
syncing MM NTP config 698
suspending or resuming Multi-tier Replication 247
default data center TAC health check 640
assigning 243 templates 709
switching 249 tests 709
verifying dial tone connections 658

December 3, 2019 IPC Confidential

 787

verifying ICM connections 654 configure 439

verifying inbound call connections 660 enterprise line sharing considerations 435–437
verifying IP recording 668 Enterprise system
verifying private line connections 656 deploying zones 491
Walk the Floor 644 Enterprise Watch
dial pad providing access to 337, 518, 519, 522, 527, 529, 532,
dialing calls 663 543
Dial Pad enterprises
making an intercom call 663 analyze with Enterprise Watch 643
dial tone line calls analyzing with Enterprise Watch 215
implicit hunt 665 merging 305
making 663, 665 Enum 680
directory error
make a group call 667 automated restore cannot be performed 372
disable secure communications scheduling jobs within 30 minutes of another job 366,
Media Gateway 274 369
disaster recovery Express system
configuring BCP 290 deploying zones 491
with BCP 283–288 extensions
disconnected zones associating trunks with an extension 582
recovering from 326 external directory servers
disk image specifying a DNS 421
restoring from the command line 393
DNS F
specifying 421
Domain Name System servers fail back
specifying 421 BCP plan 296
domain names failover
changing enterprise domain name 301 BCP 289, 293, 294
changing for an instance 304 HA 546
dynamic passwords 719 FD 514
FD_ALL
E setting 716, 718
features
edit assigning licenses to users 484
report list 695 installing license files 481
edit and upload report 695 revoking user licenses 487
enterprise fingerprints
changing domain name 301 obtaining 479
changing name 301 firmware
configuring zones 518, 519, 522, 527, 529, 532, 543 upgrading iDRAC 731
deploying subsequent zones 495 fix_my_pass.sh script 565
deploying zones 489 FQDNs
removing CDIs from 361 specifying a DNS 421
removing zones 309 FRAG 514
validating 635
enterprise backup G
definition 369, 370
enterprise database backup generateAddresses.sh 567
restoring 380 generator zones 316, 701, 702, 704–706
Enterprise Deployer 149 getEnterpriseReplication 513, 638
Enterprise Install 85, 86 getEnterpriseReplication.sh
enterprise line sharing generating addresses file 567

IPC Confidential Unigy 4.3

Enterprise Guide
788

getTransientChannelInfo 514, 638 hoot lines

getTransientChannelInfo.sh re-establish failed or stuck lines 543
generating addresses file 567 host names
global enterprise changing for Media Gateways 420
upgrades 27 hostname
global replication controls changing for CCM or ACCM 415
enabling 243 changing for Media Manager 417
Global Replication Controls hot fixes
activation overview 238–241 deploying 116, 120
assigning the default data center 243 uploading 116, 120
changing portal zone 249 hotfixes
disabling 246 deploying 21, 46, 53, 69, 73, 93, 114, 550
switching the default data center 249 deploying in parallel 86
GMS 514 deploying with automated deployment 78
group call deployment overview 25–29
make 667 uploading 46, 53, 69, 73, 78, 86, 93, 114
version 29
H HTTPS 263

HA I
changing from stateless to stateful 303
changing VIP 399 iDRAC
confirm that it is enabled 546 adding a user 731
deploying updates 73, 116, 120 configuring 731
enabling 545 disabling a user 731
failover 546 disabling SNMP Agent 731
powering down appliances 339 disabling SSH 731
powering up appliances 340 disabling Telnet 731
replacing an appliance 344 hardening 731
status 499, 502, 504–506 setting SSL encryption 731
testing 671 setting the Virtual Console remote presence port 731
zone status 500 upgrading the firmware 731
HA clusters iDRAC 6
placing into maintenance mode 598 adding a user 732
replacing an appliance 344 configuring 732
HA zones disabling a user 732
rebuilding 347 disabling SNMP Agent 732
hardening disabling SSH 732
iDRAC 731 disabling Telnet 732
iDRAC 6 732 hardening 732
iDRAC 7 736 setting SSL encryption 732
iDRAC 8 740 setting the Virtual Console remote presence port 732
iDRAC 9 746 iDRAC 7
hardware adding a user 736
removing from the database 359 configuring 736
hardware requirements disabling a user 736
Single Click Deployment VM 151, 152 disabling SNMP Agent 736
health check disabling SSH 736
TAC 640 disabling Telnet 736
High Availability
hardening 736
confirm that it is enabled 546
setting SSL encryption 736
deploying updates 73, 116, 120
setting the Virtual Console remote presence port 736
enabling 545 iDRAC 8

December 3, 2019 IPC Confidential

 789

adding a user 740 changing domain name 304

configuring 740 changing the name 304
disabling a user 740 moving zones 312
disabling SNMP Agent 740 intercom
disabling SSH 740 dial an intercom call 662
disabling Telnet 740 making a call 663
hardening 740 intercom search
setting SSL encryption 740 call from search result 666
setting the Virtual Console remote presence port 740 interoperability
iDRAC 9 enterprise line sharing 435–437
adding a user 746 interzone replication 698, 699
configuring 746 IP address
disabling a user 746 active and standby appliances 377
disabling SNMP Agent 746 IP addresses
disabling SSH 746 changing 407
disabling Telnet 746 changing CCM or ACCM 412
hardening 746 changing for a different network 402
setting SSL encryption 746 changing for CCMs or ACCMs 409
setting the Virtual Console remote presence port 746 changing for Media Gateways 419
image changing Media Manager 416
restore point 383 network connection 623
restoring from the command line 393 IPC Certified Tech
image backup installing license files 483
disable device registration 497 IPC Certified Technician 488
restoring 393 IQ/MAX
images viewing registered turrets 651
compressing and copying 385 IQ/MAX Edge
making 385 viewing registered turrets 651
implicit hunt IQ/MAX Edge turrets
dial tone line calls and 665 changing the home zone 355
Import an Artifact IQ/MAX Touch
Single Click Deployment 211 removing from the database 359
INI IQ/MAX TOUCH
uploading default portion 583 viewing registered turrets 652
IQ/MAX touch turrets
uploading incremental changes to default portion 585
INI files changing the home zone 359
IQ/MAX turrets
Media Gateway 585
changing the home zone 355
install account 720
ISO files
installation
transferring to other appliances 478
Blue Wave 102
uploading 547, 548
Enterprise Install 85, 86
uploading an update file 547
license files 482
remote 625–627
silent 625–627 J
Soft Client 621
JGroups
upgrading 32-bit clients 630
tuning 420
upgrading 64-bit clients 628
JGroups failure detection(FD)
installProtXML.sh 716
setting 716, 718
installProtXMLBWD.sh 718
JGroups MERGE protocol
instance
setting 716, 718
secure communications 272
JGroups protocols
instances
validate values 671
adding 303

IPC Confidential Unigy 4.3

Enterprise Guide
790

L placing appliances into 599

take a cluster out of 599
license files taking appliances out of 600
certified administrator 483 zones 597, 598
enterprise license Map Details
installing 481 Single Click Deployment 188
installing 481–483 mass edit client
obtaining 480 creating lines and extensions 676
updating 482 creating ResourceAORs 676
license fingerprints editing buttons 686
obtaining 479 editing lines and extensions 676
licenses editing resourceAORs 676
downgrading 484 editing ResourceAORs 676
reducing number of feature licenses 484 log in 706, 708
line sharing 435 media gateway
Line Status channel software version verification 650
updating JGroups protocols 716 Media Gateway
lines applying changes to device 586
BCP redirection 299 disable secure communications 274
configuring the OOPS line 324 downloading INI files 585
re-establish failed MRD and hoot lines 543 firmware downgrade 572
lines and extensions resyncing CAS files 582
deleting with mass edit client 676 roll back 572
editing with mass edit client 676 secure communications 273
Linux Media Gateway modules
deploying 448 configuring 580
Local Survivability zones Media Gateways
converting 336 adding 568, 569
location
BCP 569
assigning to appliances 517
changing host name 420
locations
changing IP address 419
adding 516
configuring 578
editing 516
deploying software updates 558
setting time zone 424
downgrading software 100
log in
downgrading the software 562
mass edit client 706, 708
Login Form enabling SSH access 587
Single Click Deployment 172 module order 577, 578
login priorities placing into maintenance mode 599
configuring for BCP 292 powering down 341
low bandwidth powering up 341
uploading an ISO file 548 rebooting 591
retrieving the configuration 577
M setting NTP Server 587
synchronize CAS files 579
MAC addresses taking out of maintenance mode 600
removing from database 359 updating software 570
Main Menu updating the country.dat file 325
Single Click Deployment 173 Media Manager
maintenance changing hostname 417
service done 601 changing IP address 416
maintenance mode reconfiguring 418
clusters 601 Media Managers
for clusters 598 assigning a location 517

December 3, 2019 IPC Confidential

 791

configuring network connections 450 registering 496

confirming registration 362 removing from the database 359
deploying 465 replacing 352
deploying software updates 558 secure communications override 276
downgrading software 100, 393 shutting down 339
downgrading the software 562 syncing NTP config 698
invalid licenses in a VM 590 taking out of maintenance mode 600
network properties 462, 464 modules
placing into maintenance mode 599 Media Gateway 577, 578
powering down 339, 340 monitor
powering up 340 devices 652
rebooting from UMS 588 Monitor
registering 496 Single Click Deployment 190
removing from the database 359 MRD lines
shutting down 339 re-establish failed or stuck lines 543
multi-factor authentication
taking out of maintenance mode 600
specifying a DNS 421
media server software diagnostics 649
Multi-tier Replication
Meltdown vulnerability patch 147
pre-implementation check list 244
memory
relationship with partial replication 701, 702, 704–706
creating a recurring archive backup 612
suspending or resuming 247
MERGE 514
multizone enterprise
MERGE3
reCOP a zone 331, 333
setting 716, 718
multizone hardware failure
MGs
recovering from 350
adding 569
MySQL password has algorithm
changing host name 420
making compatible 565
changing IP address 419
deploying software updates 558
downgrading software 100 N
downgrading the software 562
NAKACK 514
placing into maintenance mode 599
NAKACK2
powering down 341
setting 716, 718
powering up 341
names
secure communications override 276
changing a zone name 307
setting NTP Server 587
changing an instance name 304
shutting down 339
changing the enterprise name 301
taking out of maintenance mode 600 network
MM
changing CCM or ACCM hostname 415
changing hostname 417
changing Media Gateway host name 420
changing IP address 416
changing Media Gateway IP address 419
reconfiguring 418
changing Media Manager hostname 417
MMs
configuring 674
assigning a location 517
preventing timeouts 420
confirming registration 362
Network Configurator
deploying 465
changing NIC configuration 418
deploying software updates 558
network properties 462, 464
downgrading software 100 network settings
downgrading the software 562 configure 676
invalid licenses in a VM 590 networks
placing into maintenance mode 599 bonded NICs 450
powering down 339, 340 configuring connection 623
powering up 340 configuring with Network Configurator 450

IPC Confidential Unigy 4.3

Enterprise Guide
792

moving appliances 402 P

properties 462, 464
new packages 25–29
report 695 partial replication
New Servers disabling 317
Single Click Deployment 221 enabling 316, 701, 702, 704–706
NTP server 427, 430 Partial replication
NTP servers relationship with Multi-tier Replication 701, 702,
changing 423 704–706
NTP Servers password
setting for a MG 587 regenerate superuser 728
Password Manager 720, 728
O passwords
configuring BIOS password 755, 762
OCCAS configuring BIOS password - R640 769
changes that require a reboot 335 iDRAC 731
OCD Build Report iDRAC 6 732
Single Click Deployment 208 iDRAC 7 736
OOPS line iDRAC 8 740
configuring 324 iDRAC 9 746
Open Virtual Appliance files patch
for deploying a Single Click Deployment appliance 152, upgrade requires enterprise backup 371
154 patches
OpenSIPs proxy 336 deploying 21, 46, 53, 69, 73, 93, 114, 116, 120, 550
operating system deploying in parallel 86
deploying 448 deploying OS patches from command lime 142, 144
patching 125, 126, 129 deploying with automated deployment 78
operating system patch deployment overview 25–29
deleting file 146 forcing an HA failover 546
operating system patches OS 125, 126, 129
automatic installation 131 uploading 46, 53, 69, 73, 78, 86, 93, 114, 116, 120
installing during trading hours 139 uploading an OS patch ISO 146
manual installation 134 PBXs
with OS Enterprise Install 137 enabling secure communications 275
OS upload a self-signed certificate 269
patching 125, 126, 129 peer zone
OS patch deploying 489
deleting file 146 redeploy 349
uploading 146 personality
OS patches software deployment 467, 471, 472, 476
automatic installation 131 Personality Deployer
deploying from command line 142, 144 transferring ISO files 478
installing during trading hours 139 Personality Deployer application 465
manual installation 134 personality software
versioning 130, 131 deploying 465
with OS Enterprise Install 137 portal zones
OS patching 125, 126, 129 changing 249
out of memory refreshing 320
creating a recurring archive backup 612 post installation procedures 427, 430
OVAs post_restore.sh script 614
for deploying a Single Click Deployment appliance 152, priorities
154 for logins after BCP failover 292
private lines

December 3, 2019 IPC Confidential

 793

associating trunks with a private line 581 from loss of WAN 326, 327
procedures referenced by workflows 447 validating 638
properties Red Hat Linux
network 462, 464 deploying 448
prototype devices redeploy a zone 331, 333
updating after upgrade 566 redeploy an appliance 328
Published Userinfo Base 437 redundancy
PUIB 437 through BCP 283–288
Pulse Regional Area Data Replication 701, 702, 704–706
changing home zone VIP 399 registration
confirming registration 362 enabling 496
removing from enterprise 361 remote backup
restarting 596 creating or editing location 605
view registered devices deleting location 607
registered devices storage location 605
Pulse 651 uploading 611
Pulse devices remote installation 625–627
change home zone 356 remote presence port
rebooting from UMS 591 setting for iDRAC 731
registering 496 setting for iDRAC 6 732
removing from the database 359 setting for iDRAC 7 736
pushing the Soft Client software 625–627 setting for iDRAC 8 740
setting for iDRAC 9 746
Q remote uninstallation 625–627
remove properties
quiet installation 625–627 buttons 673
quiet uninstallation 625–627 replacing
Media Managers 100, 339, 340, 352, 359, 362, 393,
R 450, 462, 464, 465, 496, 517, 558, 562, 588, 590, 599,
600
R610 appliances replica system
replacing with R640 appliances 341 deploying 279
R620 appliances replication
replacing with R640 appliances 341 check status 507
R630 appliances checkReplication output 507
replacing with R640 appliances 341 d 601–604
RAG status 639 disabling 498
rearm a Standby appliance 547 disabling and enabling 377
reboot enabled 601–604
CCMs from UMS 587 enabling 497
communication devices 592 enabling partial replication 316, 701, 702, 704–706
Media Managers from UMS 588 Multi-tier Replication 229, 232, 233, 235–237
pulse devices from UMS 591 Replicator channel
turrets from UMS 591 updating JGroups protocols 716
rebooting report
Media Gateways 591 custom 695
resolving a stuck reboot 590 new 695
reCOP 312 report list
reCOP a zone 331, 333 edit 695
reCOP an appliance 448 reporting 695
reCOP can appliance 328 Report output format 694
recovery reporting
from a corrupt database 380 report list 695

IPC Confidential Unigy 4.3

Enterprise Guide
794

requirements schema version upgrade 611

hardware 623 script
software 623 restore_unigy.sh 376, 377, 379, 381
ResourceAORS scripts
deleting with mass edit client 676 data conversion 23
editing with mass edit client 676 secure communications
restore configuration 271
a disk image 393 configuring instance 272
data for an enterprise 380 configuring SIP trunks 275
scenarios 601–604 enabling for SIP trunks 275
restore point Media Gateway 273
restoring 393 override instance setting 276
restore_unigy.sh script 376, 379, 381 Soft Client certificates 270
restoring upload a self-signed certificate 269
editing scheduled 366 secure RTP
enterprise backup 377 CDIs 276
Enterprise backup 374 instance 272
restore_unigy.sh script 377 secure SIP
zone backup 377 CDIs 276
retention policy instance 272
adding 613 SIP trunks 275
editing 613 Server Profile panel 196
roles Servers History
IPC Technician 488 Single Click Deployment 201
rollback service done 601
an update 387, 389 service packs
appliance software 386 deploying 21, 46, 53, 69, 73, 93, 114, 116, 120, 550
configure plan 181, 187 deploying in parallel 86
restoring a disk image 393 deploying with automated deployment 78
validating 638 deployment overview 25–29
rollback point 383 uploading 46, 53, 69, 73, 78, 86, 93, 114, 116, 120
RPC channel version 29
updating JGroups protocols 718 Session Border Controllers
RPMs 25–29 enabling secure communications 275
RTP upload a self-signed certificate 269
secure 263 shelldiag
using 720
S Show All Servers
Single Click Deployment 206
SBCs shutdown
enabling secure communications 275 system 339
SCD silent installation 625–627
creating a VM 152 silent uninstallation 625–627
for upgrading appliances 60 Single Click Deployment
in a virtual environment 151 appliances 150
on a laptop 154 assign an appliance to a different user account 170
VM hardware requirements 151, 152 Available Artifact 212
schedule Available Artifacts 165
backup procedure 363 change user password 169
editing backup or restore procedure 366 changing account appliance is assigned to 168
error within 30 minutes of another job 366, 369 configure SMTP 163, 224
schema confirm an appliance unregistered 163
data conversion 23 confirm an appliance was removed 169

December 3, 2019 IPC Confidential

 795

create image backup 165 disabling for iDRAC 8 740

creating a VM 152 disabling for iDRAC 9 746
delete a database backup file 213 SNMP alerts
display registered appliances 162 removing 564
for upgrading appliances 60 SNMP forwarding
Import an Artifact 211 disabling per zone and destination 597
Import Enterprise DB Upload form 166, 213 enabling per zone and destination 597
importing artifacts 164 Soft Client
in a virtual environment 151 installing 621
Login Form 172 requirements 623
Main Menu 173 rolling back 32-bit clients 633
Map Details 188 rolling back 64-bit clients 631
Monitor 190 uninstalling 634
New Servers 221 upgrading 32-bit clients 630
OCD Build Report 208 upgrading 64-bit clients 628
panels 171 version 634
plan 181, 187 Soft Clients
post upgrade steps 39, 67 change home zone 358
register Unigy appliances 160 changing home zone VIP 399
remove a Unigy appliance 199 configuring network connection 623
removing a Unigy appliance 168 confirming registration 362
rolling back 167 deploying software updates 558
Select a Server panel 195 downgrading the software 562
Select Servers panel 176 enable log in 498
Servers History 201 redirecting after a BCP event 298
Show All Servers 206 registering 496
tasks 159 removing from enterprise 361
unregistering Unigy appliances 162 removing from the database 359
upgrade software 222 viewing registered 652
software
upgrading 31, 170
downgrading 100, 393
upload a database backup file 213
upgrading with Single Click Deployment 60
uploading a database backup file 166
software deployment
User Profile 169, 226
Blue Wave 102
viewing an appliance profile 168
software diagnostics media server 649
viewing appliance profiles 195
software requirements 623
VM hardware requirements 151, 152
software upgrades
Single Click Deployment appliance
Blue Wave 114
on a laptop 154
deploying 21
SIP port 336
software version 29
SIP trunks
software versions
enabling secure communications 275
interoperability 25–29
secure SIP 275
Spectre vulnerability patch 147
SIPsecure 263
split brain syndrome
SMTP
recovering from 327
configuring 563
SSH
properties 564
disabling for iDRAC 731
SMTP Configuration
disabling for iDRAC 6 732
Single Click Deployment 163, 224
disabling for iDRAC 7 736
SNMP Agent
disabling for iDRAC 8 740
disabling for iDRAC 731
disabling for iDRAC 9 746
disabling for iDRAC 6 732
SSH remote access
disabling for iDRAC 7 736
enabling 587

IPC Confidential Unigy 4.3

Enterprise Guide
796

SSL encryption TCP 514

setting for iDRAC 731 TCPPING 514
setting for iDRAC 6 732 Telnet
setting for iDRAC 7 736 disabling for iDRAC 731
setting for iDRAC 8 740 disabling for iDRAC 6 732
setting for iDRAC 9 746 disabling for iDRAC 7 736
STABLE 514 disabling for iDRAC 8 740
Standard system disabling for iDRAC 9 746
deploying zones 491 testEnterpriseReplication 260, 261
standby appliance testing
IP address 377 with a replica system 279
STATE_TRANSFER 514 time
stateful HA changing NTP servers 423
changing to from stateless 303 comparing and setting 426
stateless HA setting time zone 424
changing to stateful 303 time source
static IP configuring 427, 430
configuration 674 time zone
status comparing and setting 426
active and standby appliance 377 time zones
determining for appliances and clusters 499, 502, setting system 424
504–506 timeouts
standby appliance 377 preventing 420
transient channels 514 tone cadence
superuser 723 update values 567
support trading days 533
with a replica system 279 trading hours 533
SWMS Admin Console transient channels
providing access to 337, 518, 519, 522, 527, 529, 532, checking status 514
543 checking status for all zones 514
SWMS licenses trunks
invalid license 590 associating trunks with a private line 581
sync BCP 696 associating trunks with an extension 582
sync MM NTP config Turret & Pulse Reboot Device panel 592
MMs 698 Turret & Pulse Verify IP Recording Status panel 668
system turrets
shutdown 339 changing home zone VIP 399
system components changing the home zone 355, 359
viewing by zone 643 confirming registration 362
system configuration deploying software updates 558
system reports 653 downgrading the software 562
system configuration report 653 rebooting from UMS 591
system processes registering 496
validating 638 removing from enterprise 361
system reports
removing from the database 359
assigned license 689, 691
restarting 595
system configuration 653
verifying dial tone connections 658
system time zone
verifying ICM connections 654
setting 424
verifying inbound call connections 660
verifying private line connections 656
T
TAC health check 640

December 3, 2019 IPC Confidential

 797

U that require a new COP 41

updating prototype devices 566
UNICAST 514 User Profile
UNICAST3 Single Click Deployment 169, 226
setting 716, 718 user-all backup
Unigy appliances definition 369, 370
assign to a different Single Click Deployment user 170 user-specific backup
Unigy enterprises definition 369, 370
merging 305 users
Unigy Soft Client adding an iDRAC 6 user 732
requirements 623 adding an iDRAC 7 user 736
rolling back 32-bit clients 633 adding an iDRAC 8 user 740
rolling back 64-bit clients 631 adding an iDRAC 9 user 746
upgrading 32-bit clients 630 adding an iDRAC user 731
upgrading 64-bit clients 628 disabling an iDRAC 6 user 732
version 634 disabling an iDRAC 7 user 736
Unigy Soft Clients disabling an iDRAC 8 user 740
change home zone 358 disabling an iDRAC 9 user 746
confirming registration 362 disabling an iDRAC user 731, 732
downgrading the software 562 IPC Technician 488
redirecting after a BCP event 298 revoking feature licenses 487
Unigy software
upgrading with Single Click Deployment 31
V
Unigy v2.0
clearing alerts 565 validation
Unigy v2.0.1
after deployment or rollback 638
clearing alerts 565
zone 636
unigyadmin account 720
VERIFY_SUSPECT 514
uninstall
version
Soft Client 634
Soft Client 634
uninstallation
versioning
remote 625–627
OS patches 130, 131
silent 625–627 versions
updates
software 29
confirming an update was deployed 552 VIP
deploying 46, 53, 69, 73, 93, 114, 116, 120, 550 changing 399
deploying in parallel 86 vipaddresses.txt
deploying with automated deployment 78 generating 567
enterprise license files 482 VIPs
rolling back 387, 389 changing for a different network 402
that require a new COP 41 virtual
uploading 46, 53, 69, 73, 78, 86, 93, 114, 116, 120 Single Click Deployment appliance 154
uploading an ISO file 547 Virtual Console
updateToneCadenceFreqForExistingInstances.sh 567 setting port for iDRAC 731
upgrade setting port for iDRAC 6 732
configure plan 181, 187 setting port for iDRAC 7 736
unable to upload ISO file 548 setting port for iDRAC 8 740
upgrades setting port for iDRAC 9 746
Blue Wave 114 virtual environment
Blue Wave software 101 Single Click Deployment 151
deploying 21 virtual IP address
forcing an HA failover 546 changing 399
rolling back 387, 389 virtual machines

IPC Confidential Unigy 4.3

Enterprise Guide
798

for Single Click Deployment appliance 152 checkReplication output 507

VMs configuring 518, 519, 522, 527, 529, 532, 543
for a Single Click Deployment appliance 152 configuring the OOPS line 324
voice recorders confirming communication 639
specifying a DNS for certificates 421 converting Local Survivability zones 336
upload a self-signed certificate 269 deleting 309
Voice Recorders deploying 491
shutting down 339 deploying subsequent 495
deploying the peer 489
W disabling data replication 498
enabling data replication 497
Walk the Floor 644 Enterprise Install 85, 86
WAN moving to a different instance 312
recovery from failure 326, 327 moving to different data center 315
warm standby 353 placing into maintenance mode 597
Web links powering down a Media Gateway 341
providing access to 337 powering up 340
weblinks
powering up a Media Gateway 341
providing access to 518, 519, 522, 527, 529, 532, 543
rebuilding an HA zone 347
Weblogic Admin Console
reCOP (redeploy) 331, 333
providing access to 337, 518, 519, 522, 527, 529, 532,
redeploy peer 349
543
redeploying after software failure 333
redeploying one appliance 328
Z reenabling forwarding to trap destinations 596
refreshing 318, 319
zone
refreshing portal zones 320
changing VIP 399
removing 309
controlling creates backup 363
replacing after software failure 331
upgrade requires enterprise backup 371
replacing an appliance 344
validating 638
restarting 318, 319
Zone Deployer 491
restarting portal zones 320
zone deployment
setting time zone 424
confirm that HA is enabled 546
zone IDs shutting down 340
changing 323 SNMP forwarding maintenance 596
zone selection algorithm 615, 619–621 status 499, 500, 502, 504–506
zones synchronizing 491
adding 307 taking out of maintenance mode 598
adding or editing 515 types 316, 701, 702, 704–706
analyzing with Enterprise Watch 215 validating 636
Blue Wave 495
change BCP status 498
change Pulse home zone 356
change Soft Client home zone 358
changing an IQ/MAX Edge turret home zone 355
changing an IQ/MAX Touch home zone 359
changing an IQ/MAX turret home zone 355
changing appliance IP addresses 407
changing NTP servers 423
changing the name 307
check replication status 507
checking data replication status 513
checking transient channel status 514

December 3, 2019 IPC Confidential

Part Number: B02200736, Release: 02
IPC Systems, Inc.
777 Commerce Drive
Fairfield, CT 06825-5500 USA