Grandstream Networks UCM6300 Series User manual

Grandstream Networks Inc.
UCM6300 Series/UCM6300 Audio Series IP PBX
High Availability User Guide

UCM6300 Series/UCM6300 Audio Series:
High Availability User Guide
P a g e | 2
Table of Contents
SUPPORTED DEVICES ................................................................................................. 5
INTRODUCTION............................................................................................................. 6
TYPICAL NETWORK TOPOLOGY ................................................................................ 7
HA PREREQUISITES ..................................................................................................... 8
Prerequisites..............................................................................................................................................8
Connecting UCM for HA Setup..................................................................................................................8
Network Configuration...............................................................................................................................8
HA CONFIGURATIONS................................................................................................ 10
For UCM without UCMRC Plan...............................................................................................................10
For UCM with UCMRC Plan....................................................................................................................13
Scenario 1: Two new UCMs on factory default settings and both UCM use UCMRC service. ..........13
Scenario 2: 1 UCM is configured and running, and the 2nd UCM needs to be added for HA setup. Both
UCM use UCMRC service. ..................................................................................................................14
HA CONFIGURATION PARAMETERS ........................................................................ 15
UCMRC CONFIGURATIONS........................................................................................ 19
UCMRC Plan ...........................................................................................................................................19
Custom Domain Configuration ................................................................................................................19
VERIFY HA SETTINGS ................................................................................................ 21
ACTIVE/STANDBY ROLE IN HA ................................................................................. 22
Automatic Failure Detection ....................................................................................................................22
Active UCM: Self-Failure Detection.........................................................................................................22
Standby UCM: Periodic Heartbeat ..........................................................................................................23
Force Switch............................................................................................................................................23
FIRMWARE UPGRADE................................................................................................ 24
REPLACING UCM IN HA ............................................................................................. 25
HA Setup with UCMRC............................................................................................................................25
Scenario 1: UCM A’s station type is “Primary” and it’s the active UCM. UCM B’s station type is
“Secondary” and it’s in standby status.................................................................................................25
Scenario 2: UCM A’s station type is “Secondary” and it’s the active UCM. UCM B’s station type is

UCM6300 Series/UCM6300 Audio Series:
High Availability User Guide
P a g e | 3
“Primary” and it’s in standby status......................................................................................................25
HA Setup without UCMRC ......................................................................................................................26
DISABLING HA SETUP................................................................................................ 27
CLOUD IM IN HA SETUP............................................................................................. 28
USING UCMRC WITH HA ............................................................................................ 29
Switching UCMRC Role in HA ................................................................................................................29
SERVICE STATUS........................................................................................................ 30
Active/Standby Status .............................................................................................................................30
Web UI Access for UCM..........................................................................................................................30
Log in Wave.............................................................................................................................................30
FAILOVER DURING CALL........................................................................................... 31
DATA SYNC .................................................................................................................. 32
BACKUP AND RESTORE ............................................................................................ 33
MAINTENANCE............................................................................................................ 34

UCM6300 Series/UCM6300 Audio Series:
High Availability User Guide
P a g e | 4
Table of Figures
Figure 1: Typical Network Topology ..............................................................................................................7
Figure 2: Network Settings............................................................................................................................9
Figure 3: HA Settings on Primary UCM ......................................................................................................10
Figure 4: HA Settings on Secondary UCM..................................................................................................11
Figure 5: HA Configured on Secondary UCM.............................................................................................12
Figure 6: HA Status on Secondary UCM ....................................................................................................12
Figure 7: Add UCM to GDMS......................................................................................................................19
Figure 8: Assign UCMRC Plan to UCM ......................................................................................................19
Figure 9: Edit Device...................................................................................................................................20
Figure 10: Configure Custom Domain ........................................................................................................20
Figure 11: HA Status for Active UCM ..........................................................................................................21
Figure 12: HA Status for Standby UCM ......................................................................................................21
Figure 13: Active and Standby UCM Failover.............................................................................................22
Figure 14: Force Switch ..............................................................................................................................23
Figure 15: GDMS Display for UCM HA Status............................................................................................29
Figure 16: System Alert Events...................................................................................................................34
Figure 17: HA Logs .....................................................................................................................................34
Table of Tables
Table 1: UCM Models Supporting High Availability Feature .........................................................................5
Table 2: HA Related Parameters.................................................................................................................15

UCM6300 Series/UCM6300 Audio Series:
High Availability User Guide
P a g e | 5
SUPPORTED DEVICES
Following table shows the UCM models supporting high availability feature described in this guide:
Table 1: UCM Models Supporting High Availability Feature
UCM Models Supporting High Availability Feature
UCM6300 Series
UCM6301
Firmware 1.0.9.x or higher
UCM6302
Firmware 1.0.9.x or higher
UCM6304
Firmware 1.0.9.x or higher
UCM6308
Firmware 1.0.9.x or higher
UCM6300 Audio Series
UCM6300A
Firmware 1.0.9.x or higher
UCM6302A
Firmware 1.0.9.x or higher
UCM6304A
Firmware 1.0.9.x or higher
UCM6308A
Firmware 1.0.9.x or higher

UCM6300 Series/UCM6300 Audio Series:
High Availability User Guide
P a g e | 6
INTRODUCTION
High Availability feature on Grandstream UCM6300 series/UCM6300 Audio series provides enterprises a
reliable solution for PBX redundancy and failover support. In HA setup, there are two UCM with one UCM
in “active” role and the other in “standby” role. The two UCM must be the same model and use the same
firmware version. The data on the active UCM will be synchronized to the standby UCM in real-time manner
and the standby UCM monitors active UCM’s running status regularly. When the active UCM runs into
hardware or critical software issues, the standby UCM will take over immediately and become the active
server. HA feature supports automatic call recovery for UDP point-to-point calls and conference calls,
allowing enterprises to communicate and collaborate without the hassle of service interruption.

UCM6300 Series/UCM6300 Audio Series:
High Availability User Guide
P a g e | 7
TYPICAL NETWORK TOPOLOGY
Figure 1: Typical Network Topology
The two UCM in High Availability setup must be deployed in the same location and connected directly to
each other via heartbeat port on each UCM. The primary UCM and secondary UCM can be connected to
each other via a straight-through Ethernet cable on the heartbeat port. For each UCM, connect its WAN or
LAN port to the uplink network device. For FXO port, an RJ11 telephone adapter is required to split the
PSTN line connection into two ports for each UCM’s FXO port to connect to.

UCM6300 Series/UCM6300 Audio Series:
High Availability User Guide
P a g e | 8
HA PREREQUISITES
Prerequisites
The two UCM used for High Availability deployment must be the same model and use the same firmware
version to ensure proper sync-up on the configuration and data.
Connecting UCM for HA Setup
The two UCM in High Availability setup must be deployed in the same location and connected directly to
each other via heartbeat port on each UCM.
•Connect a straight-through Ethernet cable between the heartbeat port on the primary UCM and
secondary UCM.
•For each UCM, connect its WAN or LAN port to the uplink network device (such as a switch or
router).
•For FXO port, an RJ11 telephone adapter is required to split the PSTN line connection into two
ports for each UCM’s FXO port to connect to. The same FXO port must be used on each UCM
when connecting to the adapter.
Network Configuration
Before enabling High Availability feature on the two UCM, the system admin must configure each UCM with
proper network settings.
Notes:
•The network “Method” on the UCM must be set to “Switch” or “Router”.
•The IPv4 address configured on the UCM must be static IP. It can be configured under UCM web
UI→Network Settings→Basic Settings.

UCM6300 Series/UCM6300 Audio Series:
High Availability User Guide
P a g e | 9
Figure 2: Network Settings

UCM6300 Series/UCM6300 Audio Series:
High Availability User Guide
P a g e | 10
HA CONFIGURATIONS
For UCM without UCMRC Plan
For two new UCM on factory default setting, system admin can choose to configure any of them for HA first.
However, if one of the UCM is already configured, up and running for PBX service, system admin should
configure this UCM as HA Primary server and complete all HA settings on it first so it can act as active role.
Assuming no UCMRC (Remote Connect) service is used on any UCM, please refer to the steps below to
configure HA on UCM:
1. Ensure both UCM have the same model and same firmware version. They have been connected
properly at the same location and configured with static IP.
2. Select one UCM to be the active device (UCM A). If both UCM are new on factory default settings,
select any of them as the active UCM. If one of the UCM is already configured and running, then
select this UCM as the active device.
3. If Cloud IM service is needed, please enable Cloud IM on UCM A (active UCM) and ensure Cloud
IM is disabled on the other UCM (UCM B).
4. Log in the active UCM (UCM A) web UI and go to System Settings→HA page. Enable HA and
configure UCM A as Primary station type. Please refer to HA related parameters in table 2 below
and complete other HA related settings. Save the HA settings on UCM A and reboot UCM A. Ensure
UCM A boots up normally.
Figure 3: HA Settings on Primary UCM

UCM6300 Series/UCM6300 Audio Series:
High Availability User Guide
P a g e | 11
5. Verify HA status on UCM A. Log in UCM A using its static IP and admin login information. On web
UI→System Settings→HA page, ensure HA function is enabled. HA status should display “Active”.
6. After ensuring UCM A’s HA status as active, configure UCM B as secondary UCM and complete
UCM B’s HA settings. Log in UCM B’s web UI and go to System Settings→HA page, enable HA
and set the station type as “Secondary”. Please refer to HA related parameters in table 2 below to
complete other HA related settings. Save the settings and reboot UCM B.
Figure 4: HA Settings on Secondary UCM
7. After UCM B boots up normally, log in UCM B’s web UI via its static IP address and admin login
information. Go to System Settings→HA page, ensure the HA function is enabled, “Switch” button
is grey and only HA peer IP / peer MAC address options are available for configuration. The HA
status should display as “Standby”.

UCM6300 Series/UCM6300 Audio Series:
High Availability User Guide
P a g e | 12
Figure 5: HA Configured on Secondary UCM
Figure 6: HA Status on Secondary UCM

UCM6300 Series/UCM6300 Audio Series:
High Availability User Guide
P a g e | 13
For UCM with UCMRC Plan
Scenario 1: Two new UCMs on factory default settings and both UCM use UCMRC service.
1. Ensure both UCM have the same model and same firmware version. They have been connected
properly at the same location and configured with static IP.
2. Since both UCM are on factory settings, select any of the UCM to be the active UCM (UCM A).
3. If Cloud IM service is needed, please enable Cloud IM on UCM A (active UCM) and ensure Cloud
IM is disabled on the other UCM (UCM B).
4. Log in the active UCM (UCM A) web UI and go to System Settings→HA page. Enable HA and
configure UCM A as Primary station type. Please refer to HA related parameters in table 2 below
and complete other HA related settings. Save the HA settings on UCM A and reboot UCM A. Ensure
UCM A boots up normally.
5. Verify HA status on UCM A. Log in UCM A using its static IP and admin login information. On web
UI→System Settings→HA page, ensure HA function is enabled. HA status should display as
“Active”.
6. After ensuring UCM A’s HA status is active, now configure UCM B as secondary UCM and complete
the HA settings. Log in UCM B’s web UI and go to System Settings→HA page, enable HA and set
the station type as “Secondary”. Please refer to HA related parameters in table 2 below to complete
other HA related settings. Save the settings and reboot UCM B.
7. Verify UCM B’s HA status. UCM B boots up normally, log in UCM B’s web UI via the static IP
address and admin login information. Go to System Settings→HA page, ensure the HA function is
enabled, “Switch” button is grey and only HA Peer IP / Peer MAC address options are available for
configuration.
8. Purchase UCMRC plan for both UCM. Log in UCM web UI and go to Value-added Features→UCM
RemoteConnect→Plan page, click on “Learn More”. Then follow the page to add the 2 UCM to
GDMS and assign UCMRC plan for them. It doesn’t matter which UCM is assigned with UCMRC
plan first.
9. For UCM A which has station type “Primary”, configure custom domain name. Please refer to
“Custom Domain Configuration” section below.
Note: For UCMRC related settings, please refer to section “UCMRC Configurations”.

UCM6300 Series/UCM6300 Audio Series:
High Availability User Guide
P a g e | 14
Scenario 2: 1 UCM is configured and running, and the 2nd UCM needs to be added for HA
setup. Both UCM use UCMRC service.
1. Ensure both UCM have the same model and same firmware version. They have been connected
properly at the same location and configured with static IP.
2. Since UCM A is already configured and running, choose this UCM as the active UCM.
3. If Cloud IM service is needed, please enable Cloud IM on UCM A (active UCM) and ensure Cloud
IM is disabled on the other UCM (UCM B).
4. Log in the active UCM (UCM A) web UI and go to System Settings→HA page. Enable HA and
configure UCM A as Primary station type. Please refer to HA related parameters in table 2 below
and complete other HA related settings. Save the HA settings on UCM A and reboot UCM A. Ensure
UCM A boots up normally.
5. Verify HA status on UCM A. Log in UCM A using its static IP and admin login information. On web
UI→System Settings→HA page, ensure HA function is enabled. HA status should display “Active”.
6. After ensuring UCM A’s HA status as active, now configure UCM B as secondary UCM and
complete the HA settings. Log in UCM B’s web UI and go to System Settings→HA page, enable
HA and set the station type as “Secondary”. Please refer to HA related parameters in table 2 below
to complete other HA related settings. Save the settings and reboot UCM B.
7. Verify UCM B’s HA status. UCM B boots up normally, log in UCM B’s web UI via the static IP
address and admin login information. Go to System Settings→HA page, ensure the HA function is
enabled, “Switch” button is grey and only HA peer IP/HA MAC address buttons are available for
configuration.
8. Purchase UCMRC plan for both UCM. If UCM A already has UCMRC plan, then purchase UCMRC
for UCM B only. Log in UCM web UI and go to Value-added Features→UCM
RemoteConnect→Plan page, click on “Learn More”. Then follow the page to add the UCM to GDMS
and assign UCMRC plan. It doesn’t matter which UCM is assigned with UCMRC plan first.
9. For UCM A which has station type “Primary”, configure custom domain name. Please refer to
custom domain name configuration section below. If UCM A already has custom domain name, this
step can be skipped.
Note: For UCMRC related settings, please refer to section “UCMRC Configurations”.

UCM6300 Series/UCM6300 Audio Series:
High Availability User Guide
P a g e | 15
HA CONFIGURATION PARAMETERS
Table 2: HA Related Parameters
Settings
Description
Value
Range
Default
Value
Notes
High Available
Enable
Enable or disable HA.
Yes/No
No
Force Switch
Force to switch the roles of
active UCM and standby
UCM.
NA
NA
Caution: Please do not use this
function unless necessary (e.g.,
it can be used during firmware
upgrading).
HA Station
Type
Configure the HA station
type for the UCM.
Primary
Secondary
NA
In HA setup, one UCM must be
primary and the other one must
be secondary.
HA Cluster IP
This is the IP address for
the active UCM in service.
NA
NA
This IP address is shared by the
primary and secondary UCM.
The UCM in active status
providing PBX service will
always be using this IP address
regardless it’s the primary or
\secondary UCM. This IP
address can only be used for the
active UCM.
HA Peer IP
This is the IP address of
the peer UCM in HA setup.
NA
NA
This is the static IP address of
the peer UCM in HA setup
connected via heartbeat port.
HA Peer MAC
Address
This is the MAC address
of the peer UCM in HA
setup.
NA
NA
This is the MAC address of the
peer UCM in HA setup
connected via heartbeat port.
Heartbeat Port
This is the port used for
communication between
the two UCM via heartbeat
port.
0 - 65535
9527
It is recommended to use default
port.

UCM6300 Series/UCM6300 Audio Series:
High Availability User Guide
P a g e | 16
Heartbeat
Timeout
Period (s)
This is the heartbeat
timeout period that active
and standby UCM will
check with each other for
the status (in seconds).
3 - 10
7
If the standby UCM detects the
active UCM disconnected, when
it reaches the timeout, failover
will be triggered and the standby
UCM will start taking over as
active UCM.
Software Fault
Switch
Enable failover upon
software failure
On/Off
Off
If enabled, when there is critical
software failure such as
deadlock or system crash
detected, it will trigger failover
from active UCM to standby
UCM. Otherwise, failover will not
happen.
Hardware
Fault Switch
Enable failover upon
hardware failure
On/Off
Off
If enabled, when there is
hardware failure such as FXO
port no longer working, it will
trigger failover from active UCM
to standby UCM. Otherwise,
failover will not happen.
After enabling High Available feature, please configured the following parameters:
•Station Type (mandatory):
In HA setup, one UCM must be set as primary and the other one must be set as secondary. The
two UCM cannot be configured as the same type. Otherwise, HA function will not work properly.
This configuration is to ensure that there is always a UCM on active status and the other one on
standby status during negotiation which will automatically determine the active/standby server.
When failure condition happens, it is crucial that the failover mechanism does not end up with two
active servers negotiated.
The active UCM is the PBX providing service and it’s not always the primary server configured in
HA. The primary secondary station type is configured but any UCM in HA setup can be the active
or standby role when needed. For example, if UCM A is configured as primary station type and
UCM B is configured as secondary station type, at the beginning UCM A is in active role and UCM
B is in standby role. After failover happens, UCM A’s station type configuration is still primary but
it’s now in standby role and UCM B is in active role.

UCM6300 Series/UCM6300 Audio Series:
High Availability User Guide
P a g e | 17
•HA Cluster IP (mandatory):
This is the IP address for the UCM that provides PBX service in HA setup. This IP is always
associated with the UCM in active status. For example, when configuring IP phone to register to
UCM, this is the SIP server IP address to be configured on the IP phone. When configuring SIP
peer trunk, this is the SIP server IP address to be configured as peer trunk server IP. In HA setup,
the static IP configured for each UCM will not be used for PBX service directly. Normally the cluster
IP address is in the same subnet as the static IP address configured on the UCM.
•HA Peer IP (mandatory):
This is the static IP configured on the peer UCM in HA setup. This is used for notifying GDMS when
active and standby roles change.
•Peer MAC Address (optional):
This is the MAC address of the peer UCM in HA setup. It is used for UCM with Remote Connect
service to configure the MAC address of the peer UCM.
•Heartbeat Port (mandatory):
This is the port used for communication between active and standby UCM for heartbeat negotiation.
It is recommended to use the default port number 9527.
•Heartbeat Timeout Period (mandatory):
This is the timeout period for heartbeat (in seconds). The standby UCM will check regularly whether
the active UCM is working normally. If the standby UCM detects that the active UCM has been
disconnected for this period, the standby UCM will consider the active UCM in faulty state and will
then automatically take over as active UCM.
•Software Fault Switch:
If enabled, when the active UCM experiences software failure such as system crash with core dump
generated, it will trigger failover automatically and the standby UCM will take over. If disabled, HA
alert events will be reported without failover.
•Hardware Fault Switch:
If enabled, when the active UCM has hardware failure such as FXO port no longer working, it will
trigger failover automatically and the standby UCM will take over. If disabled, HA alert events will
be reported without failover. Please note plugging or unplugging telephone cable on FXO port is
not considered as hardware failure.
•Force Switch:
This will force active and standby UCM to switch roles. It will trigger the standby UCM to take over
and switch the active UCM to standby role. This should be used only when necessary, such as

UCM6300 Series/UCM6300 Audio Series:
High Availability User Guide
P a g e | 18
firmware upgrading or if active UCM cannot automatically trigger switchover.
After the above configurations, click on Save and follow the reboot prompt to reboot the device.
Note: HA configuration requires the UCM to reboot. Please reboot the UCM during non-service hour to
avoid service interruption.

UCM6300 Series/UCM6300 Audio Series:
High Availability User Guide
P a g e | 19
UCMRC CONFIGURATIONS
UCMRC Plan
To ensure that UCMRC plan can be used normally on HA setup, UCMRC plan must be purchased and
assigned to both UCM on GDMS. If only one UCM has UCMRC plan, GDMS operation may fail due to HA
backup.
Steps:
1. Log in GDMS web UI and go to UCMRC→UCM Devices. Click to add new device and enter the
UCM information.
Figure 7: Add UCM to GDMS
2. On GDMS→Plan & Services→My Plan, click on Assign Plan icon to assign the plan for UCM.
Figure 8: Assign UCMRC Plan to UCM
Custom Domain Configuration
For UCM with UCMRC service already, configure custom domain name for the primary UCM (station type
“Primary”) and ensure this UCM uses custom domain name.

UCM6300 Series/UCM6300 Audio Series:
High Availability User Guide
P a g e | 20
Custom Domain Name must be set via GDMS. Log in GDMS and go to UCMRC→UCM Devices, select the
UCM and click on “Edit Device” to configure it.
Figure 9: Edit Device
Figure 10: Configure Custom Domain
Click on “Switch to Custom Domain” to edit device custom server access, private secret key and etc. Save
the configuration. After changing custom domain name, please notify UCM users the new public address
for UCM. For more information about configuring custom domain name on GDMS, please refer to GDMS
user manual.