Figure 110: Voicemail Group ..................................................................................................................... 195
Figure 111: Ring Group ............................................................................................................................. 197
Figure 112: Ring Group Configuration ...................................................................................................... 199
Figure 113: Sync LDAP Server option ...................................................................................................... 200
Figure 114: Manually Sync LDAP Server .................................................................................................. 200
Figure 115: Ring Group Remote Extension .............................................................................................. 201
Figure 116: Paging/Intercom Group .......................................................................................................... 203
Figure 117: Page/Intercom Group Settings ............................................................................................... 204
UCM6100 firmware contains third-party software licensed under the GNU General Public License (GPL).
Grandstream uses software under the specific terms of the GPL. Please see the GNU General Public
License (GPL) for the exact terms and conditions of the license.
Grandstream GNU GPL related source code can be downloaded from Grandstream web site from:
http://www.grandstream.com/support/faq/gnu_gpl
Page 18
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 17 of 305
CHANGE LOG
This section documents significant changes from previous versions of the UCM6100 user manuals. Only
major new features or major document updates are listed here. Minor updates for corrections or editing are
not documented here.
FIRMWARE VERSION 1.0.9.26
Added Announcements Center [ANNOUNCEMENTS CENTER]
FIRMWARE VERSION 1.0.9.25
Added UCM Zero Config model templates for provisioning GXP2200EXT coupled with GXV3240.
[MODEL TEMPLATES]
Added ability to select the voicemail storage (Support Email + WAV). [VOICEMAIL EMAIL
SETTINGS]
FIRMWARE VERSION 1.0.9.23
Added SSH enable/disable option in LCD or WEB [SSH ACCESS]
Added remote peer extensions in Ring Group [REMOTE EXTENSION IN RING GROUP]
Added ability to prepend digits in inbound routes [Table 58: Inbound Rule Configuration
Parameters]
Added ability to search extensions on Extension page. [SEARCH AND EDIT EXTENSION]
Added user portal for users to log in with extension number, access user information, extension
configuration and CDR. [USER PORTAL]
Added support to send Fax via web UI. [FAX SENDING]
Added "Enable LDAP" option to skip the extension from UCM default LDAP phonebook. [Table 34:
Added DDNS Support. [DDNS SETTINGS]
Added support for Call Barging using feature codes. [ENABLE SPY]
Added ability to search the CDR by called number. [Table 100: CDR Filter Criteria]
Added ability to select the file types for automatic backup. [BACKUP/RESTORE]
Added automatic backup support on SD Card or USB storage. [BACKUP/RESTORE]
Added support to skip trunk authentication by time condition. [Table 36: SIP Extension
Configuration Parameters - Features]
Page 19
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 18 of 305
Added option to send P-Asserted-Identity header in SIP Register Trunk. [Table 51: SIP Register
Trunk Configuration Parameters]
Added ability to specify trunks in CDR filters. [CDR]
Added ability to use Pattern in Caller Number to filter CDR. [CDR]
Added support to send UNREGISTER when VoIP trunk is disabled. [Table 51: SIP Register Trunk
Configuration Parameters]
Added LDAP Client support [LDAP CLIENT CONFIGURATIONS]
Added option to specify the chronological order of voice mails. [Table 62: Voicemail Settings]
Added option to configure whether to skip pressing 1/2 to accept or reject calls from Follow Me.
[Table 70: Follow Me Settings]
Added option to specify port range in Port Forwarding configuration. [Table 14: UCM6102 Network
Settings->Port Forwarding]
Added ability to go back to IVR menu from Dial By Name by pressing the star key. [DIAL BY NAME
CONFIGURATION]
Added support to upgrade SIP end device via SD card in Zero Config. [Table 29: Global Policy
Parameters: Maintenance]
Added ability to filter alert logs. [ALERT LOG]
Added ability to delete alert logs. [ALERT LOG]
Added NAT option for peer trunk. [Table 52: SIP Peer Trunk Configuration Parameters]
Improved Automatic Download CDR result format. [CDR]
Added end point firmware management support to allow end point device to upgrade via
UCM6100 local storage or USB media. [Table 29: Global Policy Parameters: Maintenance]
Added link to access phone web GUI in Zero Config. [MANAGE DEVICES]
Added model update support to download model templates for surveillance and GSwave. [MODEL
UPDATE]
Added filter for searching in Alert Log. [ALERT LOG]
Added DAHDI Out Line Selection. [Table 48: Analog Trunk Configuration Parameters]
Added automatic CDR download. [CDR]
Added multi-user management and concurrent user login support. [USER MANAGEMENT]
Added operation log. [OPERATION LOG]
Page 20
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 19 of 305
Added option to specify web access session timer. [LOGIN TIMEOUT SETTINGS]
Added call monitor/barge-in support. [ACTIVE CALLS AND MONITOR]
Added GSwave QR code support. [EMAIL TO USER]
Added ability to add customized Pvalue on Model Template. [MODEL TEMPLATES]
Updated maximum length of web UI login password to 30 characters. [CHANGE PASSWORD]
Added Fax gateway support for Fax mode on FXS and FXO port. [Table 43: FXS Extension
Configuration Parameters - Media] [Table 48: Analog Trunk Configuration Parameters]
Added “NAT” option and “Send PPI Header” option in SIP register trunk configuration. [Table 51:
SIP Register Trunk Configuration Parameters]
Added REC API (access for call recording files). [API CONFIGURATION]
Added “Synchronize All Data” option in Data Sync. [DATA SYNC]
Added “Delect Selected Sound Files” option for Music On Hold files. [MUSIC ON HOLD]
FIRMWARE VERSION 1.0.7.11
Added office time and holiday setting. [OFFICE TIME] [HOLIDAY]
Added new architecture for auto provisioning via Zero Config. [
Page 21
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 20 of 305
PROVISIONING]
Added Alert-info configuration for distinctive ringing on inbound route. [Table 58: Inbound Rule
Configuration Parameters]
Added SLA support to monitor FXO trunk. [SLA STATION]
Added Follow Me support. [FOLLOW ME]
Added One-Key Dial support. [ONE-KEY DIAL]
Added FXO Dial Delay option for analog trunk. [Table 48: Analog Trunk Configuration Parameters]
Added Music On Hold selection per extension. [EXTENSIONS]
Added Call Forward Time Condition per extension. [EXTENSIONS]
Added custom prompt support for ring group announcement. [Table 66: Ring Group Parameters]
Added custom prompt support for paging/intercom group announcement. [Table 67:
Paging/Intercom Group Configuration Parameters]
Added options to delete voicemail and Fax files via cleaner. [CLEANER]
Added DTMF configuration per trunk. [VOIP TRUNKS]
Added call queue Music On Hold customization. [Table 68: Call Queue Configuration Parameters]
Added call queue destination support. [Table 68: Call Queue Configuration Parameters]
Added batch add blacklist file support. [BLACKLIST CONFIGURATIONS]
FIRMWARE VERSION 1.0.6.11
Added service check options under web UI->Maintenance->Troubleshooting->Service Check
page to regularly check Asterisk service.
FIRMWARE VERSION 1.0.6.10
Added static routes function. [STATIC ROUTES]
Added option to provision end devices’ date format, time format and time zone in zero config.
Added option to disable extension/trunk.
Added TEL URL support for extension/trunk.
Added option to dial trunk password per extensions.
Added export extension and import extension function. [EXPORT EXTENSIONS] [IMPORT
EXTENSIONS]
Added option "Need Registration" for SIP register trunk.
Added option "The Maximum Number of Call Line" for trunk.
Added Dial By Name. [DIAL BY NAME]
Added voicemail password and Email address for voicemail group extension.
Added auto record support for ring group and call queue.
Added VFax file display, download and delete interface in web UI.
Changed web page name from "Hardware Config" to "Ports Config".
Page 22
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 21 of 305
Added payload configuration for audio/video codecs. [INTERNAL OPTIONS/PAYLOAD]
Added activity calls status on web UI status page.
Added CDR API support. [API CONFIGURATION]
Added more alert events support such as Register SIP Failed, Register SIP Trunk Failed, Restore
Config, User Login Success, User Login Failed, SIP Internal Call Failure and etc. [ALERT
EVENTS LIST]
FIRMWARE VERSION 1.0.5.19
Added built-in data migration tool to support upgrading from 1.0.4.7 to 1.0.5.19 without factory
reset.
Added "Direct Dial Voicemail Prefix" feature code back. [Table 75: UCM6100 Feature Codes]
Changed valid range for option "Current Disconnect Threshold". [Table 48: Analog Trunk
Configuration Parameters]
FIRMWARE VERSION 1.0.5.14
New backend data structure and web UI performance improvement. 1.0.5.14 is not compatible
with previous firmware versions. Once upgraded to 1.0.5.14, the device needs to be FULLY
RESET and RE-CONFIGURED MANUALLY.
Added traditional Chinese language for web UI. [WEB GUI LANGUAGES]
Updated LDAP configuration example. [LDAP SERVER]
Added "Enable Filter Source Caller ID" and "Custom Dynamic Route" options for outbound route
Added more language support for voice prompt. [LANGUAGE SETTINGS FOR VOICE PROMPT]
Added "Ring Group Destination" for ring group configuration. [Table 66: Ring Group Parameters]
Added "Extension Groups" section in web UI. [EXTENSION GROUPS]
Added "Pickup Groups" section in web UI. [PICKUP GROUPS]
Added BLF function description. [BLF AND EVENT LIST]
Updated default extension range. [Table 76: Internal Options/General]
Added sample descriptions for downloaded CDR file. [DOWNLOADED CDR FILE]
FIRMWARE VERSION 1.0.4.7
Asterisk updated to version 1.8.23.1.
Added DID routing support for incoming calls. [Table 50: Create New SIP Trunk]
Added DOD routing support. [DIRECT OUTWARD DIALING (DOD)]
Added GXP one-button Voicemail access. [Table 34: SIP Extension Configuration Parameters]
Added Hot-Desking Support. [Table 34: SIP Extension Configuration Parameters]
Added one-button on-demand call recording for GXP
Add new option to enable or disable "FXS TISS Override" on Hardware Config page. [Table 79:
Internal Options/Ports Config]
Added more modes for FXS Two-Wire Impedance Synthesis
Added LDAP Sync manual trigger function and synced date displaying. [VOIP TRUNKS]
Improved LDAP Sync function, added retrying, file verifying and progress displaying function
Added option "Pick Extension Period" on auto-provision settings page of Zero Config
Added multiple extension assignment support on device edit page of Zero Config
Added "Reset All Extensions" button at the Zero Config page to recycle all assigned extensions.
[AUTO PROVISIONING]
Added system crash alarm, core dump detection and allow users to download core dump file.
[Figure 164: System Events->Alert Events Lists: System Crash]
Add "Keep Trunk CID" option for VoIP trunks, and keep the priorities: DOD->Extension
CallerID->Trunk CallerID->Global CallerID. [Table 50: Create New SIP Trunk]
FIRMWARE VERSION 1.0.3.13
Added Fail2Ban support for SIP authentication. [FAIL2BAN]
Added voice prompt "Language" selection and "Auto Record" option for extension. [Table 34: SIP
Added "Auto Record" option for trunk.
Added "Digit Timeout" option and voice prompt "Language" selection for IVR. [Table 61: IVR
Configuration Parameters]
Added "Direct Dial Voicemail Prefix" feature code to directly dial or transfer to extension's
voicemail. [Table 75: UCM6100 Feature Codes]
Added "Enforce Strong Passwords" option. [Table 76: Internal Options/General]
Added FXS MWI Mode. [Table 79: Internal Options/Ports Config]
Added system events with alert and Email notification support. [SYSTEM EVENTS]
Added new web page for recording files. [RECORDING FILES]
FIRMWARE VERSION 1.0.2.21
Added weight information. [Table 1: Technical Specifications]
Added NTP server support. [NTP SERVER]
Added Czech language for web GUI display. [WEB GUI LANGUAGES]
Added VLAN support. "Layer 2 QoS 802.1Q/VLAN tag" and "Layer 2 QoS 802.1p priority value"
Page 24
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 23 of 305
options for network port settings are added. [NETWORK SETTINGS]
Updated LDAP client configurations information.
Added sample Email settings. [EMAIL SETTINGS]
Added manual time settings. [TIME SETTINGS]
Added "Enable Pick Extension" and "Extension Segment" options for auto provisioning settings.
Changed one of the discovery method from "SIP MESSAGE (OPTIONS)" to "SIP MESSAGE
(NOTIFY)" in zero-config feature.
Added pickup group feature. [Table 75: UCM6100 Feature Codes]
Added PSTN detection instructions for "Auto Detect" and "Semi-auto Detect". [PSTN
DETECTION]
Added "Auth ID" option for SIP register trunk configuration. [Table 50: Create New SIP Trunk]
Added LDAP sync options for peer SIP trunk. [Table 50: Create New SIP Trunk]
Changed the default setting of outbound route "Privilege Level" from "Internal" to "International" to
avoid potential misconfiguration and security risk.
Added DISA and Fax to IVR key press event options. [Table 61: IVR Configuration Parameters]
Added "Min Message Time" option in voicemail settings. [Table 62: Voicemail Settings]
Added Fax setting samples. [FAX/T.38]
Added DISA support for inbound route and IVR.
Added Event List support to monitor local extensions and remote extensions. [BLF AND EVENT
LIST]
Added feature code *0 for "Disconnect". [Table 75: UCM6100 Feature Codes]
Added feature code *8 for "Pickup Extension" in pickup group feature. [Table 75: UCM6100
Feature Codes]
Added "Record Prompt" and "Custom Name of Pickup Group" options in internal options. [Table
76: Internal Options/General]
Added warning information for "Allow Guest Call" option to avoid potential security risk caused by
Changed reset mode to two mode "User Data" and "All". [RESET AND REBOOT]
FIRMWARE VERSION 1.0.1.22
This is the initial version.
Page 25
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 24 of 305
This page intentionally left blank
Page 26
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 25 of 305
WELCOME
Thank you for purchasing Grandstream UCM6100 series IP PBX appliance. The UCM6100 series IP PBX
is an innovative IP PBX appliance designed for small to medium business. Powered by an advanced
hardware platform with robust system resources, the UCM6100 offers a highly versatile state-of-the-art
Unified Communication (UC) solution for converged voice, video, data, fax and video surveillance
application needs. Incorporating industry-leading features and performance, the UCM6100 offers quick
setup, deployment with ease and unrivaled reliability all at an unprecedented price point.
Changes or modifications to this product not expressly approved by Grandstream, or operation of this
product in any way other than as detailed by this User Manual, could void your manufacturer warranty.
Warning:
Please do not use a different power adaptor with the UCM6100 as it may cause damage to the products
and void the manufacturer warranty.
This document is subject to change without notice. The latest electronic version of this user manual is
available for download here:
http://www.grandstream.com/support
Reproduction or transmittal of the entire or any part, in any form or by any means, electronic or print, for
any purpose without the express written permission of Grandstream Networks, Inc. is not permitted.
Page 27
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 26 of 305
This page intentionally left blank
Page 28
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 27 of 305
PRODUCT OVERVIEW
FEATURE HIGHTLIGHTS
1GHz ARM Cortex A8 application processor, large memory (512MB DDR RAM, 4GB NAND Flash),
and dedicated high performance multi-core DSP array for advanced voice processing.
Integrated 2/4/8/16 PSTN trunk FXO ports, 2 analog telephone FXS ports with lifeline* capability in
case of power outage, and up to 50 SIP trunk options.
Gigabit network port(s) with integrated PoE, USB, SD; integrated NAT router with advanced QoS
support (UCM6102 only).
Supports a wide range of popular voice codes (including G.711 A-law/U-law, G.722, G.723.1, G.726,
G.729A/B, iLBC (30ms only), GSM), video codec (including H.264, H.263, H.263+), and Fax (T.38).
Hardware DSP based 128ms-tail-length carrier-grade line echo cancellation (LEC).
Supports up to 500 SIP endpoint registration, up to 60 concurrent calls and up to 32 conference
attendees.
Flexible dial plan, call routing, site peering, call recording.
Automated detection and provisioning of IP phones, video phones, ATA and other endpoints for easy
deployment.
Hardware encryption accelerator to ensure strongest security protection using SRTP, TLS, and
HTTPS.
Figure 1: UCM6102/UCM6104/UCM6108/UCM6116
Page 29
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 28 of 305
TECHNICAL SPECIFICATIONS
Interfaces
Analog Telephone FXS Ports
2 ports (both with lifeline capability in case of power outage)
UCM6102/6104: Dual 10M/100M/1000M RJ45 Ethernet ports with
integrated PoE Plug (IEEE 802.3at-2009)
UCM6108/6116: Single 10M/100M/1000M RJ45 Ethernet port with
integrated PoE Plug (IEEE 802.3at-2009)
NAT Router
Yes, UCM6102 only
Peripheral Ports
USB, SD/SDHC (VFAT)
LED Indicators
Power/Ready, Network, PSTN Line, USB, SD
LCD Display
128x32 graphic LCD with DOWN and OK button
Reset Switch
Yes
Voice/Video Capabilities
Voice-over-Packet
Capabilities
LEC with NLP Packetized Voice Protocol Unit, 128ms-tail-length carrier
grade Line Echo Cancellation, Dynamic Jitter Buffer, Modem detection
and auto-switch to G.711
The UCM6100 FXS interfaces are metallic through to the FXO interfaces. If there is power outage,
FXS1 port will fail over to FXO 1 port, FXS 2 port will fail over to FXO 2 port. The user can still access
the PSTN connected with the FXO interfaces from FXS interfaces.
Before deploying and configuring the UCM6100 series, the device needs to be properly powered up and
connected to network. This section describes detailed information on installation, connection and warranty
policy of the UCM6100 series.
EQUIPMENT PACKAGING
Table 2: UCM6102/UCM6104 Equipment Packaging
CONNECT YOUR UCM6100
CONNECT THE UCM6102
Figure 2: UCM6102 Front View
Page 33
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 32 of 305
Figure 3: UCM6102 Back View
To set up the UCM6102, follow the steps below:
1. Connect one end of an RJ-45 Ethernet cable into the WAN port of the UCM6102.
2. Connect the other end of the Ethernet cable into the uplink port of an Ethernet switch/hub.
3. Connect the 12V DC power adapter into the 12V DC power jack on the back of the UCM6102. Insert
the main plug of the power adapter into a surge-protected power outlet.
4. Wait for the UCM6102 to boot up. The LCD in the front will show the device hardware information
when the boot process is done.
5. Once the UCM6102 is successfully connected to network, the LED indicator for WAN in the front will
be in solid green and the LCD shows up the IP address.
6. (Optional) Connect PSTN lines from the wall jack to the FXO ports; connect analog lines (phone and
Fax) to the FXS ports.
CONNECT THE UCM6104
Figure 4: UCM6104 Front View
Page 34
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 33 of 305
Figure 5: UCM6104 Back View
To set up the UCM6104, follow the steps below:
1. Connect one end of an RJ-45 Ethernet cable into the LAN 1 port of the UCM6104.
2. Connect the other end of the Ethernet cable into the uplink port of an Ethernet switch/hub.
3. Connect the 12V DC power adapter into the 12V DC power jack on the back of the UCM6104. Insert
the main plug of the power adapter into a surge-protected power outlet.
4. Wait for the UCM6104 to boot up. The LCD in the front will show the device hardware information
when the boot process is done.
5. Once the UCM6104 is successfully connected to network, the LED indicator for LAN 1 in the front will
be in solid green and the LCD shows up the IP address.
6. (Optional) Connect PSTN lines from the wall jack to the FXO ports; connect analog lines (phone and
Fax) to the FXS ports.
CONNECT THE UCM6108
To set up the UCM6108, follow the steps below:
1. Connect one end of an RJ-45 Ethernet cable into the LAN port of the UCM6108.
2. Connect the other end of the Ethernet cable into the uplink port of an Ethernet switch/hub.
3. Connect the 12V DC power adapter into the 12V DC power jack on the back of the UCM6108. Insert
the main plug of the power adapter into a surge-protected power outlet.
4. Wait for the UCM6108 to boot up. The LCD in the front will show the device hardware information
when the boot process is done.
5. Once the UCM6108 is successfully connected to network, the LED indicator for NETWORK in the front
will be in solid green and the LCD shows up the IP address.
6. (Optional) Connect PSTN lines from the wall jack to the FXO ports; connect analog lines (phone and
Fax) to the FXS ports.
Page 35
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 34 of 305
CONNECT THE UCM6116
Figure 6: UCM6108 Front View
Figure 7: UCM6108 Back View
Figure 8: UCM6116 Front View
Figure 9: UCM6116 Back View
To set up the UCM6116, follow the steps below:
1. Connect one end of an RJ-45 Ethernet cable into the LAN port of the UCM6116.
2. Connect the other end of the Ethernet cable into the uplink port of an Ethernet switch/hub.
3. Connect the 12V DC power adapter into the 12V DC power jack on the back of the UCM6116. Insert
the main plug of the power adapter into a surge-protected power outlet.
4. Wait for the UCM6116 to boot up. The LCD in the front will show the device hardware information
when the boot process is done.
Page 36
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 35 of 305
5. Once the UCM6116 is successfully connected to network, the LED indicator for NETWORK in the front
will be in solid green and the LCD shows up the IP address.
6. (Optional) Connect PSTN lines from the wall jack to the FXO ports; connect analog lines (phone and
Fax) to the FXS ports.
SAFETY COMPLIANCES
The UCM6100 series IP PBX complies with FCC/CE and various safety standards. The UCM6100 power
adapter is compliant with the UL standard. Use the universal power adapter provided with the UCM6100
package only. The manufacturer’s warranty does not cover damages to the device caused by unsupported
power adapters.
WARRANTY
If the UCM6100 series IP PBX was purchased from a reseller, please contact the company where the
device was purchased for replacement, repair or refund. If the device was purchased directly from
Grandstream, contact our Technical Support Team for a RMA (Return Materials Authorization) number
before the product is returned. Grandstream reserves the right to remedy warranty policy without prior
notification.
Use the power adapter provided with the UCM6100 series IP PBX. Do not use a different power adapter as
this may damage the device. This type of damage is not covered under warranty.
The UCM6100 series provides LCD interface, LED indication and web GUI configuration interface.
The LCD displays hardware, software and network information. Users could also navigate in the LCD
menu for device information and basic network configuration.
The LED indication at the front of the device provides interface connection and activity status.
The web GUI gives users access to all the configurations and options for UCM6100 series setup.
This section provides step-by-step instructions on how to use the LCD menu, LED indicators and Web GUI
of the UCM6100 series. Once the basic settings are done, users could start making calls from UCM6100
extension registered on a SIP phone as described at the end of this section.
USE THE LCD MENU
Default LCD Display
When the device is powered up, the LCD will show device model (e.g., UCM6116), hardware version
(e.g., V1.5A) and IP address. Press "Down" button and the system time will be displayed as well.
Menu Access
Press "OK" button to start browsing menu options. Please see menu options in [Table 3: LCD Menu
Options].
Menu Navigation
Press the "Down" arrow key to browser different menu options. Press the "OK" button to select an
entry.
Exit
If "Back" option is available in the menu, select it to go back to the previous menu. For "Device Info"
"Network Info" and "Web Info" which do not have "Back" option, simply press the "OK" button to go
back to the previous menu. Also, the LCD will display default idle screen after staying in menu option
for 15 seconds.
LCD Backlight
The LCD backlight will be on upon key pressing. The backlight will go off after the LCD stays in idle for
30 seconds.
Page 39
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 38 of 305
Table 3: LCD Menu Options
View Events
Critical Events
Other Events
Device Info
Hardware: Hardware version number
Software: Software version number
P/N: Part number
WAN MAC: WAN side MAC address (UCM6102 only)
LAN MAC: LAN side MAC address
Uptime: System up time
Network Info
For UCM6104/UCM6108/UCM6116:
LAN Mode: DHCP, Static IP, or PPPoE
LAN IP: IP address
LAN Subnet Mask
For UCM6102:
WAN Mode: DHCP, Static IP, or PPPoE
WAN IP: IP address
WAN Subnet Mask
LAN IP: IP address
LAN Subnet Mask
Network Menu
For UCM6104/UCM6108/UCM6116:
LAN Mode: Select LAN mode as DHCP, Static IP or PPPoE
Static Route Reset: Click to reset the static route setting
For UCM6102:
WAN Mode: Select WAN mode as DHCP, Static IP or PPPoE
Static Route Reset: Click to reset the static route setting
Factory Menu
Reboot
Factory Reset
LCD Test Patterns
Press "OK" to start. Then press "Down" button to test different LCD
patterns. When done, press "OK" button to exit.
Fan Mode
Select "Auto" or "On".
LED Test Patterns
Page 40
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 39 of 305
Select "All On" "All Off" or "Blinking" and check LED status.
RTC Test Patterns
Select "2022-02-22 22:22" or "2011-01-11 11:11" to start the RTC
(Real-Time Clock) test pattern. Then check the system time from LCD idle
screen by pressing "DOWN" button, or from web GUI->System Status->General page. Reboot the device manually after the RTC test is
done.
Hardware Testing
Select "Test SVIP" to perform SVIP test on the device. This is mainly for
factory testing purpose which verifies the hardware connection inside the
device. The diagnostic result will display in the LCD after the test is done.
Web Info
Protocol: Web access protocol. HTTP or HTTPS. By default it's HTTPS
Port: Web access port number. By default it's 8089
Solid: Connected
Flashing: Data Transferring
OFF: Not Connected
USE THE LED INDICATORS
The UCM6100 has LED indicators in the front to display connection status. The following table shows the
status definitions.
Table 4: UCM6102/UCM6104 LED INDICATORS
Page 41
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 40 of 305
Table 5: UCM6108/UCM6116 LED INDICATORS
LED
LED Status
NETWORK
Solid: Connected
OFF: Not Connected
ACT
USB
SD
Phone (FXS)
Line (FXO)
Solid: Connected
Flashing: Data Transferring
OFF: Not Connected
USE THE WEB GUI
ACCESS WEB GUI
The UCM6100 embedded Web server responds to HTTP/HTTPS GET/POST requests. Embedded HTML
pages allow users to configure the device through a Web browser such as Microsoft IE, Mozilla Firefox,
Google Chrome and etc.
Figure 10: UCM6116 Web GUI Login Page
Page 42
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 41 of 305
To access the Web GUI:
1. Connect the computer to the same network as the UCM6100.
2. Ensure the device is properly powered up and shows its IP address on the LCD.
3. Open a Web browser on the computer and enter the web GUI URL in the following format:
http(s)://IP-Address:Port
where the IP-Address is the IP address displayed on the UCM6100 LCD.
By default, the protocol is HTTPS and the Port number is 8089.
For example, if the LCD shows 192.168.40.167, please enter the following in your web browser:
https://192.168.40.167:8089
4. Enter the administrator’s login and password to access the Web Configuration Menu. The default
administrator's username and password is "admin" and "admin". It is highly recommended to change
the default password after login for the first time.
By default, the UCM6100 has "Redirect From Port 80" enabled. Therefore, if users type in the UCM6100 IP
address in the web browser, the web page will be automatically redirected to the page using HTTPS and
port 8089. For example, if the LCD shows 192.168.40.167, please enter 192.168.40.167 in your web
browser and the web page will be redirected to:
https://192.168.40.167:8089
The option "Redirect From Port 80" can be configured under the UCM6100 web GUI->Settings->HTTP Server.
There are four main sections in the Web GUI for users to view the PBX status, configure and manage the
PBX.
Status: Displays PBX status, System Status, System Events and CDR.
PBX: To configure extensions, trunks, call routes, zero config for auto provisioning, call features,
internal options, IAX settings and SIP settings.
Page 43
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 42 of 305
Settings: To configure user management, network settings, firewall settings, change password,
LDAP Server, HTTP Server, Email Settings, Time Settings, NTP server, recording storage and login
timeout.
Maintenance: To perform firmware upgrade, backup configurations, cleaner setup, reset/reboot,
syslog setup and troubleshooting.
WEB GUI LANGUAGES
Currently the UCM6100 series web GUI supports English, Simplified Chinese, Traditional Chinese,
Spanish, French, Portuguese, Russian, Italian, Polish, German and etc.
Users can select the displayed language in web GUI login page, or at the upper right of the web GUI after
logging in.
SAVE AND APPLY CHANGES
Click on "Save" button after configuring the web GUI options in one page. After saving all the changes,
make sure click on "Apply Changes" button on the upper right of the web page to submit all the changes. If
the change requires reboot to take effect, a prompted message will pop up for you to reboot the device.
Figure 11: UCM6100 Web GUI Language
Page 44
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 43 of 305
MAKE YOUR FIRST CALL
Power up the UCM6100 and your SIP end point phone. Connect both devices to the network. Then follow
the steps below to make your first call.
1. Log in the UCM6100 web GUI, go to PBX->Basic/Call Routes->Extensions.
2. Click on "Create New SIP Extension" to create a new extension. You will need User ID, Password and
Voicemail Password information to register and use the extension later.
3. Register the extension on your phone with the SIP User ID, SIP server and SIP Password information.
The SIP server address is the UCM6100 IP address.
4. When your phone is registered with the extension, dial *97 to access the voicemail box. Enter the
Voicemail Password once you hear "Password" voice prompt.
5. Once successfully logged in to the voicemail, you will be prompted with the Voice Mail Main menu.
6. You are successfully connected to the PBX system now.
Page 45
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 44 of 305
This page intentionally left blank
Page 46
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 45 of 305
SYSTEM SETTINGS
This section explains configurations for system-wide parameters on the UCM6100. System settings are
under “Settings” tag on UCM6100 web GUI. System settings include User Management, Network Settings,
Firewall, Change Password, LDAP server, HTTP server, Email settings, Time Settings, NTP Server,
Recordings Storage and Login Timeout settings.
USER MANAGEMENT
User management is on web GUI->Settings->User Management page. User could create multiple
accounts for different administrators to log in the UCM6100 web GUI. Additionally the system will
automatically create user accounts along with creating new extensions for extension users to login to the
web UI using their extension number and password. All existing user accounts for web UI login will be
displayed on User Management page as shown in the following figure.
USER PRIVILEGES
Three privilege levels are supported:
Super Admin
Figure 12: User Management Page Display
Page 47
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 46 of 305
- This is the highest privilege. Super Admin can access all pages on UCM6100 web GUI, change
configuration for all options and execute all the operations.
- Super Admin can create, edit and delete one or more users with “Admin” privilege
- Super Admin can edit and delete one or more users with “Consumer” privilege
- Super Admin can view operation logs generated by all users.
- By default, the user account “admin” is configured with “Super Admin” privilegeand it’s the only
user with “Super Admin” privilege. The User Name and Privilege level cannot be changed or
deleted.
- Super Admin could change its own login password on web UI->Settings->Change Password
page.
- Super Admin could view operations done by all the users in web UI->Settings->User
Management->Operation Log.
Admin
- Users with “Admin” privilege canonly be created by “Super Admin” user.
- “Admin” privilege users are not allowed to access the following pages:
- “Admin” privilege users cannot create new users for login.
Consumer
- A user account for web UI login is created automatically by the system when a new extension is
created.
- The user could log in the web UI with the extension number and password to access user
information, extension configuration and CDR of that extension.
CREATE NEW WEB UI USER
When logged in as Super Admin, click on to create a new account for web UI user. The
following dialog will prompt. Configure the parameters as shown in below table.
Page 48
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 47 of 305
User Name
Configure a username to identify the user which will be required in web UI login.
Letters, digits and underscore are allowed in the user name.
User Password
Configure a password for this user which will be required in web UI login. Letters,
digits and underscore are allowed.
Privilege
This is the role of the web UI user. Currently only “Admin” is supported when
Super Admin creates a new user.
Department
Enter the necessary information to keep a record for this user.
Fax
Email Address
First Name
Last Name
Home Number
Phone Number
Figure 13: Create New User
Table 6: User Management - Create New User
Once created, the Super Admin can edit the users by clicking on or delete the user by clicking on .
Figure 14: User Management – New Users
Page 49
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 48 of 305
USER PORTAL
The user could log in web UI user portal using the extension number and password. When there is an
extension created in the UCM6100, the corresponding user account for the extension is automatically
created. The user portal allows limited access including user information, extension configuration and CDR
information of the extension. The login username is the extension number and the password is configured
by Super Admin. The following figure shows the dialog of editing the account information by Super Admin.
The User Name must be the extension number and it’s not configurable.
Figure 15: Edit User Information by Super Admin
The following figure shows an example of login page using extension number 1000 as the username.
Figure 16: User Portal Login
After login, the web UI displays is shown as below.
Page 50
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 49 of 305
Figure 17: User Portal Layout
For the configuration parameter information in each page, please refer to [Table 6: User Management -
Create New User] for options in User Portal->Basic Information->User Information page; please refer to
[EXTENSIONS] for options in User Portal->Basic Information->Extension page; please refer to [CDR] for
User Portal->Basic Information->CDR page.
CONCURRENT MULTI-USER LOGIN
When there are multiple web UI users created, concurrent multi-user login is supported on the UCM6100.
Multiple users could edit options and have configurations take effect simultaneously. However, if different
users are editing the same option or making the same operation (by clicking on “Apply Changes”), a
prompt will pop up as shown in the following figure.
Figure 18: Multiple User Operation Error Prompt
OPERATION LOG
Super Admin has the authority to view operation logs on UCM6100 web GUI->Settings->User
Management->Operation Log page. Operation logs list operations done by all the web UI users, for
example, web UI login, creating trunk, creating outbound rule and etc. There are 6 columns to record the
operation details “Date”, “User Name”, “IP Address”, “Results”, “Page Operation” and “Specific Operation”.
Page 51
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 50 of 305
Figure 19: Operation Logs
Date
The date and time when the operation is executed.
User Name
The username of the user who performed the operation.
IP Address
The IP address from which the operation is made.
Results
The result of the operation.
Page Operation
The page where the operation is made. For example, login, logout, delete user,
create trunk and etc.
Specific Operation
Click on to view the options and values configured by this operation.
The operation log can be sorted and filtered for easy access. Click on the header of each column to sort.
For example, clicking on "Date" will sort the logs according to operation date and time. Clicking on "Date"
again will reverse the order.
Table 7: Operation Log Column Header
User could also filter the operation logs by time condition, IP address and/or username. Configure these
conditions and then click on .
Page 52
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 51 of 305
Figure 20: Operation Logs Filter
The above figure shows an example that operations made by user “support” on device with IP
192.168.40.173 from 2014-11-01 00:00 to 2014-11-06 15:38 are filtered out and displayed.
To delete operation logs, users can perform filtering first and then click on to
delete the filtered result of operation logs. Or users can click on to delete all
operation logs at once.
CHANGE BINDNG EMAIL
UCM6100 allows user to configure binding email in case login password is lost. UCM6100 login credential
will be sent to the designated email address. The feature can be found under web UI->Settings->User
Management->Change Binding Email.
Figure 21: Change Binding Email
Page 53
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 52 of 305
Table 8: Change Binding Email option
Enter the password of
the account
Enter the current login user credential for UCM6100
Email Address
Email Address is used to retrieve password when password is lost
Method
Select "Route", "Switch" or "Dual" mode on the network interface of UCM6102.
The default setting is "Route".
Route
WAN port interface will be used for uplink connection. LAN port interface will
be used to serve as router.
Switch
WAN port interface will be used for uplink connection. LAN port interface will
be used as bridge for PC connection.
Dual
Both ports can be used for uplink connection. Users will need assign LAN 1 or
NETWORK SETTINGS
After successfully connecting the UCM6100 to the network for the first time, users could login the Web GUI
and go to Settings->Network Settings to configure the network parameters for the device.
The network setting options are similar for UCM6108 and UCM6116. Additional network functions and
settings are available for UCM6102 and UCM6104:
In this section, all the available network setting options are listed for each model. Select each tab in web
GUI->Settings->Network Settings page to configure LAN settings, WAN settings (UCM6102 only),
802.1X and Port Forwarding (UCM6102 only).
BASIC SETTINGS
Please refer to the following tables for basic network configuration parameters on UCM6102, UCM6104,
and UCM6108/UCM6116 respectively.
Table 9: UCM6102 Network Settings->Basic Settings
Page 54
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 53 of 305
LAN 2 as the default interface in option "Default Interface" and configure
"Gateway IP" for this interface.
Preferred DNS Server
Enter the preferred DNS server address. If Preferred DNS is used, UCM will try to
use it as Primary DNS server.
WAN (when "Method" is set to "Route")
IP Method
Select DHCP, Static IP, or PPPoE. The default setting is DHCP.
IP Address
Enter the IP address for static IP settings. The default setting is 192.168.0.160.
Subnet Mask
Enter the subnet mask address for static IP settings. The default setting is
255.255.0.0.
Gateway IP
Enter the gateway IP address for static IP settings. The default setting is 0.0.0.0.
DNS Server 1
Enter the DNS server 1 address for static IP settings. The default setting is
0.0.0.0.
DNS Server 2
Enter the DNS server 2 address for static IP settings.
User Name
Enter the user name to connect via PPPoE.
Password
Enter the password to connect via PPPoE.
Layer 2 QoS
802.1Q/VLAN Tag
Assign the VLAN tag of the layer 2 QoS packets for WAN port. The default value
is 0.
Layer 2 QoS 802.1p
Priority Value
Assign the priority value of the layer 2 QoS packets for WAN port. The default
value is 0.
LAN (when Method is set to "Route")
IP Address
Enter the IP address assigned to LAN port. The default setting is 192.168.2.1.
Subnet Mask
Enter the subnet mask. The default setting is 255.255.255.0.
DHCP Server Enable
Enable or disable DHCP server capability. The default setting is "Yes".
DNS Server 1
Enter DNS server address 1. The default setting is 8.8.8.8.
DNS Server 2
Enter DNS server address 2. The default setting is 208.67.222.222.
Allow IP Address From
Enter the DHCP IP Pool starting address. The default setting is 192.168.2.100.
Allow IP Address To
Enter the DHCP IP Pool ending address. The default setting is 192.168.2.254.
Default IP Lease Time
Enter the IP lease time (in seconds). The default setting is 43200.
LAN (when Method is set to "Switch")
IP Method
Select DHCP, Static IP, or PPPoE. The default setting is DHCP.
IP Address
Enter the IP address for static IP settings. The default setting is 192.168.0.160.
Subnet Mask
Enter the subnet mask address for static IP settings. The default setting is
255.255.0.0.
Gateway IP
Enter the gateway IP address for static IP settings. The default setting is 0.0.0.0.
DNS Server 1
Enter the DNS server 1 address for static IP settings. The default setting is
0.0.0.0.
Page 55
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 54 of 305
DNS Server 2
Enter the DNS server 2 address for static IP settings.
User Name
Enter the user name to connect via PPPoE.
Password
Enter the password to connect via PPPoE.
Layer 2 QoS
802.1Q/VLAN Tag
Assign the VLAN tag of the layer 2 QoS packets for LAN port. The default value is
0.
Layer 2 QoS 802.1p
Priority Value
Assign the priority value of the layer 2 QoS packets for LAN port. The default
value is 0.
LAN 1 / LAN 2 (when Method is set to "Dual")
Default Interface
If "Dual" is selected as "Method", users will need assign the default interface to be
LAN 1 (mapped to UCM6102 WAN port) or LAN 2 (mapped to UCM6102 LAN
port) and then configure network settings for LAN 1/LAN 2. The default interface is
LAN 2.
IP Method
Select DHCP, Static IP, or PPPoE. The default setting is DHCP.
IP Address
Enter the IP address for static IP settings. The default setting is 192.168.0.160.
Subnet Mask
Enter the subnet mask address for static IP settings. The default setting is
255.255.0.0.
Gateway IP
Enter the gateway IP address for static IP settings when the port is assigned as
default interface. The default setting is 0.0.0.0.
DNS Server 1
Enter the DNS server 1 address for static IP settings. The default setting is
0.0.0.0.
DNS Server 2
Enter the DNS server 2 address for static IP settings.
User Name
Enter the user name to connect via PPPoE.
Password
Enter the password to connect via PPPoE.
Layer 2 QoS
802.1Q/VLAN Tag
Assign the VLAN tag of the layer 2 QoS packets for LAN port. The default value is
0.
Layer 2 QoS 802.1p
Priority Value
Assign the priority value of the layer 2 QoS packets for LAN port. The default
value is 0.
Method
Select "Switch" or "Dual" mode on the network interface of UCM6104. The default
setting is "Switch".
Switch
LAN 1 port interface will be used for uplink connection. LAN 2 port interface
will be used as bridge for PC connection.
Dual
Both ports can be used for uplink connection. Users will need assign the
default interface in option "Default Interface". Users will need assign LAN 1 or
Enter the preferred DNS server address. If Preferred DNS is used, UCM will try to
use it as Primary DNS server.
IP Method
Select DHCP, Static IP, or PPPoE. The default setting is DHCP.
IP Address
Enter the IP address for static IP settings.
Subnet Mask
Enter the subnet mask address for static IP settings.
Gateway IP
Enter the gateway IP address for static IP settings.
DNS Server 1
Enter the DNS server 1 address for static IP settings.
DNS Server 2
Enter the DNS server 2 address for static IP settings.
User Name
Enter the user name to connect via PPPoE.
Password
Enter the password to connect via PPPoE.
Layer 2 QoS
802.1Q/VLAN Tag
Assign the VLAN tag of the layer 2 QoS packets for LAN port. The default value is
0.
Layer 2 QoS 802.1p
Priority Value
Assign the priority value of the layer 2 QoS packets for LAN port. The default
value is 0.
Method: Route
When the UCM6102 has method set to Route in network settings, WAN port interface is used for
uplink connection and LAN port interface is used as a router. Please see a sample diagram below.
For UCM6102, WAN port interface is used for uplink connection; LAN port interface is used as bridge
for PC connection. For UCM6104, LAN 1 port interface is used for connection; LAN 2 port interface is
used as bridge for PC connection.
For UCM6102, both WAN port and LAN port are used for uplink connection. For UCM6104, WAN port
will be mapped to LAN 1 interface; LAN port will be mapped to LAN 2 interface. Users will need assign
LAN 1 or LAN 2 as the default interface in option "Default Interface" and configure "Gateway IP" if
static IP is used for this interface.
Page 60
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 59 of 305
Figure 24: UCM6102 Network Interface Method: Dual
802.1X
IEEE 802.1X is an IEEE standard for port-based network access control. It provides an authentication
mechanism to device before the device is allowed to access Internet or other LAN resources. The
UCM6100 supports 802.1X as a supplicant/client to be authenticated. The following diagram and figure
show UCM6100 uses 802.1X mode “EAP-MD5” on WAN port as client in the network to access Internet.
Figure 25: UCM6100 Using 802.1X as Client
Page 61
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 60 of 305
802.1X Mode
Select 802.1X mode. The default setting is "Disable". The supported 802.1X
mode are:
EAP-MD5
EAP-TLS
EAP-PEAPv0/MSCHAPv2
Identity
Enter 802.1X mode identity information.
MD5 Password
Enter 802.1X mode MD5 password information.
802.1X Certificate
Select 802.1X certificate from local PC and then upload.
802.1X Client
Certificate
Select 802.1X client certificate from local PC and then upload.
Figure 26: UCM6100 Using 802.1X EAP-MD5
The following table shows the configuration parameters for 802.1X on UCM6100. Identity and MD5
password are required for authentication, which should be provided by the network administrator obtained
from the RADIUS server. If “EAP-TLS” or “EAP-PEAPv0/MSCHAPv2” is used as the 802.1X mode, users
will also need upload 802.1X CA Certificate and 802.1X Client Certificate, which should be also generated
from the RADIUS server.
Table 12: UCM6100 Network Settings->802.1X
STATIC ROUTES
The UCM6100 provides users static routing capability that allows the device to use manually configured
routes, rather than information only from dynamic routing or gateway configured in the UCM6100 web
GUI->Network Settings->Basic Settings to forward traffic. It can be used to define a route when no other
routes are available or necessary, or used in complementary with existing routing on the UCM6100 as a
failover backup, and etc.
Page 62
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 61 of 305
Click on to create a new static route. The configuration parameters are listed
Destination
Configure the destination IP address or the destination IP subnet for the
UCM6100 to reach using the static route.
Example:
IP address - 192.168.66.4
IP subnet - 192.168.66.0
Netmask
Configure the subnet mask for the above destination address. If left blank, the
default value is 255.255.255.255.
Example:
255.255.255.0
Gateway
Configure the gateway address so that the UCM6100 can reach the destination
via this gateway. Gateway address is optional.
Example:
192.168.40.5
Interface
Specify the network interface on the UCM6100 to reach the destination using the
static route.
For UCM6102, LAN interface is eth0; WAN interface is eth1.
For UCM6104, LAN1 interface is eth0; WAN interface is eth1.
For UCM6108/UCM6116, only LAN interface is available.
in the table below.
Once added, users can select to edit the static route.
Select to delete the static route.
Table 13: UCM6100 Network Settings->Static Routes
Static routes configuration can be reset from LCD menu->Network Menu.
The following diagram shows a sample application of static route usage on UCM6104.
Page 63
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 62 of 305
Figure 27: UCM6104 Static Route Sample
The network topology of the above diagram is as below:
Network 192.168.69.0 has IP phones registered to UCM6104 LAN 1 address
Network 192.168.40.0 has IP phones registered to UCM6104 LAN 2 address
Network 192.168.66.0 has IP phones registered to UCM6104 via VPN
Network 192.168.40.0 has VPN connection established with network 192.168.66.0
In this network, by default the IP phones in network 192.168.69.0 are unable to call IP phones in network
192.168.66.0 when registered on different interfaces on the UCM6104. Therefore, we need configure a
static route on the UCM6104 so that the phones in isolated networks can make calls between each other.
Figure 28: UCM6104 Static Route Configuration
Page 64
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 63 of 305
PORT FORWORDING (UCM6102 ONLY)
WAN Port
Specify the WAN port number or a range of WAN ports. Up to 8 ports can be
configured.
Note:
When it is set to a range, WAN port and LAN port must be configured with the
same range, such as WAN port: 1000-1005 and LAN port: 1000-1005, and access
from WAN port will be forwarded to the LAN port with the same port number, for
example, WAN port 1000 will be port forwarding to LAN port 1000.
LAN IP
Specify the LAN IP address.
LAN Port
Specify the LAN port number or a range of LAN ports.
Note:
When it is set to a range, WAN port and LAN port must be configured with the
same range, such as WAN port: 1000-1005 and LAN port: 1000-1005, and access
from WAN port will be forwarded to the LAN port with the same port number, for
example, WAN port 1000 will be port forwarding to LAN port 1000.
Protocol Type
Select protocol type "UDP Only", "TCP Only" or "TCP/UDP" for the forwarding in
the selected port. The default setting is "UDP Only".
The UCM network interface supports router function which provides users the ability to do port forwarding.
If the UCM6102 LAN mode is set to "Route" under web GUI->Settings->Network Settings->Basic Settings page, port forwarding is available for configuration.
The port forwarding configuration is under web GUI->Settings->Network Settings->Port Forwarding
page. Please see related settings in the table below.
The following figures demonstrate a port forwarding example to provide phone’s web UI access to public
side.
The UCM6102 network mode is set to “Route”
The UCM6102 WAN port is connected to uplink switch, with a public IP address configured, e.g.
1.1.1.1.
The UCM6102 LAN port provides DHCP pool that connects to multiple phone devices in the LAN
network 192.168.2.x. The UCM6102 is used as a router, with gateway address 192.168.2.1
Page 65
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 64 of 305
There is a GXP2160 connected under the LAN interface network of the UCM6102. It obtains IP
address 192.168.2.100 from UCM6102 DHCP pool
On the UCM6102 web UI->Settings->Network Settings->Port Forwarding, configure a port
forwarding entry as the figure shows below.
WAN Port: This is the port opened up on the WAN side for access purpose.
LAN IP: This is the GXP2160 IP address, under the LAN interface network of the UCM6102.
Protocol Type: We select TCP here for web UI access using HTTP.
Figure 29: UCM6102 Port Forwarding Configuration
This will allow users to access the GXP2160 web UI from public side, by typing in address “1.1.1.1:8088”.
Figure 30: GXP2160 Web Access Using UCM6102 Port Forwarding
Page 66
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 65 of 305
DDNS SETTINGS
DDNS setting allows user to access UCM6100 via domain name instead of IP address.
The UCM supports DDNS service from the following DDNS provider:
1. Register domain in DDNS service provider. Please note the UCM6100 needs to have public IP access.
2. On web UI->Settings->Network Settings->DDNS Settings, enable DDNS service and configure
username, password and host name.
Figure 31: Register Domain Name on noip.com
Page 67
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 66 of 305
Figure 32: UCM6100 DDNS Setting
3. Now you can use domain name instead of IP address to connect to the UCM6100 web UI.
Figure 33: Using Domain Name to Connect to UCM6100
FIREWALL
The UCM6100 provides users firewall configurations to prevent certain malicious attack to the UCM6100
system. Users could configure to allow, restrict or reject specific traffic through the device for security and
bandwidth purpose. The UCM6100 also provides Fail2ban feature for authentication errors in SIP
REGISTER, INVITE and SUBSCRIBE. To configure firewall settings in the UCM6100, go to Web
UI->Settings->Firewall page.
STATIC DEFENSE
Under Web GUI->Settings->Firewall->Static Defense page, users will see the following information:
Page 68
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 67 of 305
Current service information with port, process and type.
Port
Process
Type
Protocol or Service
7777
Asterisk
tcp/IPv4
SIP
389
Slapd
tcp/IPv4
LDAP
22
Dropbear
tcp/IPv4
SSH
80
Lighthttpd
tcp/IPv4
HTTP
8089
Lighthttpd
tcp/IPv4
HTTPS
69
Opentftpd
udp/IPv4
TFTP
9090
Asterisk
udp/IPv4
SIP
6060
zero_config
udp/IPv4
UCM6100 zero_config service
5060
Asterisk
udp/IPv4
SIP
4569
Asterisk
udp/IPv4
SIP
5353
zero_config
udp/IPv4
UCM6100 zero_config service
37435
Syslogd
udp/IPv4
Syslog
Ping Defense
Enable
If enabled, ICMP response will not be allowed for Ping request. The default
setting is disabled. To enable or disable it, click on the check box for the LAN or
WAN (UCM6102 only) interface.
Ping-of-Death
Defense Enable
Enable to prevent Ping-of-Death attack to the device. The default setting is
disabled. To enable or disable it, click on the check box for the LAN or WAN
(UCM6102 only) interface.
The following table shows a sample current service status running on the UCM6100.
Table 15: UCM6100 Firewall->Static Defense->Current Service
For typical firewall settings, users could configure the following options on the UCM6100.
Table 16: Typical Firewall Settings
Under "Custom Firewall Settings", users could create new rules to accept, reject or drop certain traffic
going through the UCM6100. To create new rule, click on "Create New Rule" button and a new window will
pop up for users to specify rule options.
Right next to "Create New Rule" button, there is a checkbox for option "Reject Rules". If it’s checked, all
the rules will be rejected except the firewall rules listed below. In the firewall rules, only when there is a rule
that meets all the following requirements, the option "Reject Rules" will be allowed to check:
Page 69
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 68 of 305
Action: "Accept"
Rule Name
Specify the Firewall rule name to identify the firewall rule.
Action
Select the action for the Firewall to perform.
ACCEPT
REJECT
DROP
Type
Select the traffic type.
IN
If selected, users will need specify the network interface "LAN" or "WAN"
(for UCM6102 only) for the incoming traffic.
If "Custom" is selected, users will need specify Source (IP and port),
Destination (IP and port) and Protocol (TCP, UDP or Both) for the service.
Please note if the source or the destination field is left blank, it will be used
as "Anywhere".
Type "In"
Destination port is set to the system login port (e.g., by default 8089)
Protocol is not UDP
Figure 34: Create New Firewall Rule
Table 17: Firewall Rule Settings
Page 70
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 69 of 305
Save the change and click on "Apply" button. Then submit the configuration by clicking on "Apply
Dynamic Defense
Enable
Enable dynamic defense. The default setting is disabled.
Periodical Time
Interval
Configure the dynamic defense periodic time interval (in minutes). If the
number of TCP connections from a host exceeds the connection threshold
within this period, this host will be added into Blacklist. The valid value is
between 1 and 59 when dynamic defense is turned on. The default setting is
59.
Blacklist Update
Interval
Configure the blacklist update time interval (in seconds). The default setting is
120.
Connection
Threshold
Configure the connection threshold. Once the number of connections from the
same host reaches the threshold, it will be added into the blacklist. The default
setting is 100.
Dynamic Defense
Whitelist
Configure the dynamic defense whitelist.
For example,
192.168.1.3
192.168.1.4
Changes" on the upper right of the web page. The new rule will be listed at the bottom of the page with
sequence number, rule name, action, protocol, type, source, destination and operation. More operations
below:
Click on to edit the rule
Click on to delete the rule
DYNAMIC DEFENSE
Dynamic defense is supported on the UCM6100 series. It can blacklist hosts dynamically when the LAN
mode is set to "Route" under web GUI->Settings->Network Settings->Basic Settings page. If enabled,
the traffic coming into the UCM6100 can be monitored, which helps prevent massive connection attempts
or brute force attacks to the device. The blacklist can be created and updated by the UCM6100 firewall,
which will then be displayed in the web page. Please refer to the following table for dynamic defense
options on the UCM6100.
Table 18: UCM6100 Firewall Dynamic Defense
The following figure shows a configuration example like this:
Page 71
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 70 of 305
If a host at IP address 192.168.40.7 initiates more than 20 TCP connections to the UCM6100 within 1
Global Settings
Enable Fail2Ban
Enable Fail2Ban. The default setting is disabled. Please make sure both "Enable
Fail2Ban" and "Asterisk Service" are turned on in order to use Fail2Ban for SIP
authentication on the UCM6100.
Banned Duration
Configure the duration (in seconds) for the detected host to be banned. The
default setting is 300. If set to -1, the host will be always banned.
Max Retry Duration
Within this duration (in seconds), if a host exceeds the max times of retry as
defined in "MaxRetry", the host will be banned. The default setting is 5.
minute, it will be added into UCM6100 blacklist.
This host 192.168.40.7 will be blocked by the UCM6100 for 300 seconds.
Since IP address 192.168.40.5 is in whitelist, if the host at IP address 192.168.40.5 initiates more than
20 TCP connections to the UCM6100 within 1 minute, it will not be added into UCM6100 blacklist. It
can still establish TCP connection with the UCM6100.
Figure 35: Configure Dynamic Defense
FAIL2BAN
Fail2Ban feature on the UCM6100 provides intrusion detection and prevention for authentication errors in
SIP REGISTER, INVITE and SUBSCRIBE. Once the entry is detected within "Max Retry Duration", the
UCM6100 will take action to forbid the host for certain period as defined in "Banned Duration". This feature
helps prevent SIP brute force attacks to the PBX system.
Table 19: Fail2Ban Settings
Page 72
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 71 of 305
MaxRetry
Configure the number of authentication failures during "Max Retry Duration"
before the host is banned. The default setting is 10.
Fail2Ban Whitelist
Configure IP address, CIDR mask or DNS host in the whiltelist. Fail2Ban will not
ban the host with matching address in this list. Up to 5 addresses can be added
into the list.
Local Settings
Asterisk Service
Enable Asterisk service for Fail2Ban. The default setting is disabled. Please make
sure both "Enable Fail2Ban" and "Asterisk Service" are turned on in order to use
Fail2Ban for SIP authentication on the UCM6100.
Protocol
Configure the listening port number for the service. Currently only 5060 (for UDP)
is supported.
MaxRetry
Configure the number of authentication failures during "Max Retry Duration"
before the host is banned. The default setting is 10. Please make sure this option
is properly configured as it will override the "MaxRetry" value under "Global
Settings".
CHANGE PASSWORD
After logging in the UCM6100 web UI for the first time, it is highly recommended for users to change the
default password "admin" to a more complicated password for security purpose. Follow the steps below to
change the Web UI access password.
1. Go to Web UI->Settings->Change Password page.
2. Enter the old password first.
3. Enter the new password and re-type the new password to confirm. The new password has to be at
least 4 characters. The maximum length of the password is 30 characters.
4. Click on "Save" and the user will be automatically logged out.
5. Once the web page comes back to the login page again, enter the username "admin" and the new
password to login.
LDAP SERVER
The UCM6100 has an embedded LDAP server for users to manage corporate phonebook in a centralized
manner.
By default, the LDAP server has generated the first phonebook with PBX DN
"ou=pbx,dc=pbx,dc=com" based on the UCM6100 user extensions already.
Page 73
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 72 of 305
Users could add new phonebook with a different Phonebook DN for other external contacts. For
example, "ou=people,dc=pbx,dc=com".
All the phonebooks in the UCM6100 LDAP server have the same Base DN "dc=pbx,dc=com".
Term Explanation:
cn= Common Name
ou= Organization Unit
dc= Domain Component
These are all parts of the LDAP data Interchange Format, according to RFC 2849, which is how the LDAP
tree is filtered.
If users have the Grandstream phone provisioned by the UCM6100, the LDAP directory will be set up on
the phone and can be used right away for users to access all phonebooks.
Additionally, users could manually configure the LDAP client settings to manipulate the built-in LDAP
server on the UCM6100. If the UCM6100 has multiple LDAP phonebooks created, in the LDAP client
configuration, users could use "dc=pbx,dc=com" as Base DN to have access to all phonebooks on the
UCM6100 LDAP server, or use a specific phonebook DN, for example "ou=people,dc=pbx,dc=com", to
access to phonebook with Phonebook DN "ou=people,dc=pbx,dc=com " only.
UCM can also act as a LDAP client to download phonebook entries from other LDAP server.
To access LDAP server and client settings, go to Web GUI->Settings->LDAP Server.
LDAP SERVER CONFIGURATIONS
The following figure shows the default LDAP server configurations on the UCM6100.
Figure 36: LDAP Server Configurations
Page 74
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 73 of 305
The UCM6100 LDAP server supports anonymous access (read-only) by default. Therefore the LDAP client
doesn't have to configure username and password to access the phonebook directory. The "Root DN" and
"Root Password" here are for LDAP management and configuration where users will need provide for
authentication purpose before modifying the LDAP information.
The default phonebook list in this LDAP server can be viewed and edited by clicking on for the first
phonebook under LDAP Phonebook.
Figure 37: Default LDAP Phonebook DN
LDAP PHONEBOOK
Users could use the default phonebook, edit the default phonebook, add new phonebook, import
phonebook on the LDAP server as well as export phonebook from the LDAP server. The first phonebook
with default phonebook dn "ou=pbx,dc=pbx,dc=com" displayed on the LDAP server page is for extensions
in this PBX. Users cannot add or delete contacts directly. The contacts information will need to be modified
via Web GUI->PBX->Basic/Call Routes->Extensions first. The default LDAP phonebook will then be
updated automatically.
Figure 38: Default LDAP Phonebook Attributes
Page 75
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 74 of 305
Figure 39: LDAP Server: LDAP Phonebook
Add new phonebook
A new sibling phonebook of the default PBX phonebook can be added by clicking on "Add" under
"LDAP Phonebook" section.
Figure 40: Add LDAP Phonebook
Configure the "Phonebook Prefix" first. The "Phonebook DN" will be automatically filled in. For example, if
configuring "Phonebook Prefix" as "people", the "Phonebook DN" will be filled with
"ou=people,dc=pbx,dc=com".
Once added, users can select to edit the phonebook attributes and contact list (see figure below), or
select to delete the phonebook.
Page 76
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 75 of 305
Figure 41: Edit LDAP Phonebook
Import phonebook from your computer to LDAP server
Click on “Import Phonebook” and a dialog will prompt as shown in the figure below.
The file to be imported must be a CSV file with UTF-8 encoding. Users can open the CSV file with
Notepad and save it with UTF-8 encoding.
Here is how a sample file looks like. Please note “Account Number” and “Phonebook DN” fields are
required. Users could export a phonebook file from the UCM6100 LDAP phonebook section first and
use it as a sample to start with.
Figure 42: Import Phonebook
Page 77
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 76 of 305
Figure 43: Phonebook CSV File Format
The Phonebook DN field is the same “Phonebook Prefix” entry as when the user clicks on “Add” to
create a new phonebook. Therefore, if the user enters “phonebook” in “Phonebook DN” field in the
CSV file, the actual phonebook DN “ou=phonebook,dc=pbx,dc=com” will be automatically created by
the UCM6100 once the CSV file is imported.
In the CSV file, users can specify different phonebook DN fields for different contacts. If the phonebook
DN already exists on the UCM6100 LDAP Phonebook, the contacts in the CSV file will be added into
the existing phonebook. If the phonebook DN doesn’t exist on the UCM6100 LDAP Phonebook, a new
phonebook with this phonebook DN will be created.
The sample phonebook CSV file in above picture will result in the following LDAP phonebook in the
UCM6100.
As the default LDAP phonebook with DN “ou=pbx,dc=pbx,dc=com” cannot be edited or deleted in
LDAP phonebook section, users cannot import contacts with Phonebook DN field “pbx” if existed in the
CSV file.
Export phonebook to your computer from UCM6100 LDAP server
Select the checkbox for the LDAP phonebook and then click on “Export Selected Phonebook” to
export the selected phonebook. The exported phonebook can be used as a record or a sample CSV
file for the users to add more contacts in it and import to the UCM6100 again.
Figure 44: LDAP Phonebook After Import
Page 78
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 77 of 305
Figure 45: Export Selected LDAP Phonebook
LDAP CLIENT CONFIGURATIONS
The configuration on LDAP client is similar when you use other LDAP servers. Here we provide an
example on how to configure the LDAP client on the SIP end points to use the default PBX phonebook.
Assuming the server base dn is "dc=pbx,dc=com", configure the LDAP clients as follows (case
insensitive):
Server Address: LDAP server IP address
Base DN: dc=pbx,dc=com
User Name: cn= “LDAP server login name”, dc=pbx, dc=com [matching LDAP server format]
Password: “LDAP server login password”
Filter: (|(CallerIDName=%)(AccountNumber=%))
Port: 389
The following figure gives a sample configurations for UCM6100 acting as a LDAP client.
Figure 46: LDAP Client Configurations
Page 79
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 78 of 305
To configure Grandstream IP phones as the LDAP client, please refer to the following example:
Server Address: The IP address or domain name of the UCM6100
Base DN: dc=pbx,dc=com
User Name: Please leave this field empty
Password: Please leave this field empty
LDAP Name Attribute: CallerIDName Email Department FirstName LastName
LDAP Number Attribute: AccountNumber MobileNumber HomeNumber Fax
LDAP Number Filter: (AccountNumber=%)
LDAP Name Filter: (CallerIDName=%)
LDAP Display Name: AccountNumber CallerIDName
LDAP Version: If existed, please select LDAP Version 3
Port: 389
The following figure shows the configuration information on a Grandstream GXP2200 to successfully use
the LDAP server as configured in Figure 36: LDAP Server Configurations.
Figure 47: GXP2200 LDAP Phonebook Configuration
Page 80
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 79 of 305
HTTP SERVER
Redirect From Port 80
Enable or disable redirect from port 80. On the PBX, the default access
protocol is HTTPS and the default port number is 8089. When this option
is enabled, the access using HTTP with Port 80 will be redirected to
HTTPS with Port 8089. The default setting is "Enable".
Protocol Type
Select HTTP or HTTPS. The default setting is "HTTPS". This is also the
protocol used for zero config when the end point device downloads the
config file from the UCM6100.
Port
Specify port number to access the HTTP server. The default port number
is 8089.
TLS Enable
Enable or disable TLS during transferring/submitting your Email to other
SMTP server. The default setting is "Yes".
Type
Select Email type.
MTA: Mail Transfer Agent. The Email will be sent from the configured
domain. When MTA is selected, there is no need to set up SMTP
server for it or no user login is required. However, the Emails sent
from MTA might be considered as spam by the target SMTP server.
Client: Submit Emails to the SMTP server. A SMTP server is required
and users need login with correct credentials.
The UCM6100 embedded web server responds to HTTP/HTTPS GET/POST requests. Embedded HTML
pages allow the users to configure the PBX through a Web browser such as Microsoft IE, Mozilla Firefox
and Google Chrome. By default, the PBX can be accessed via HTTPS using Port 8089 (e.g.,
https://192.168.40.50:8089). Users could also change the access protocol and port as preferred under
Web GUI->Settings->HTTP Server.
Table 20: HTTP Server Settings
Once the change is saved, the web page will be redirected to the login page using the new URL. Enter the
username and password to login again.
EMAIL SETTINGS
The Email application on the UCM6100 can be used to send out alert event Emails, Fax (Fax-To-Email),
Voicemail (Voicemail-To-Email) and etc. The configuration parameters can be accessed via Web
GUI->Settings->Email Settings.
Table 21: Email Settings
Page 81
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 80 of 305
Domain
Specify the domain name to be used in the Email when using type "MTA".
Server
Specify the SMTP server when using type "Client".
Username
Username is required when using type "Client". Normally it's the Email
address.
Password
Password to login for the above Username (Email address) is required
when using type "Client".
Display Name
Specify the display name in the FROM header in the Email.
Sender
Specify the sender's Email address.
For example, pbx@example.mycompany.com.
The following figure shows a sample Email settings on the UCM6100, assuming the Email is using
smtp.gmail.com as the SMTP server.
Figure 48: UCM6100 Email Settings
Once the configuration is finished, click on "Test". In the prompt, fill in a valid Email address to send a test
Email to verify the Email settings on the UCM6100.
TIME SETTINGS
AUTO TIME UPDATING
The current system time on the UCM6100 is displayed on the upper right of the web page. It can also be
found under Web GUI->Status->System Status->General.
Page 82
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 81 of 305
To configure the UCM6100 to update time automatically, go to Web GUI->Settings->Time
Remote NTP Server
Specify the URL or IP address of the NTP server for the UCM6100 to
synchronize the date and time. The default NTP server is
ntp.ipvideotalk.com.
Enable DHCP Option 2
If set to "Yes", the UCM6100 is allowed to get provisioned for Time Zone
from DHCP Option 2 in the local server automatically. The default setting
is "Yes".
Enable DHCP Option 42
If set to "Yes", the UCM6100 is allowed to get provisioned for NTP Server
from DHCP Option 42 in the local server automatically. This will override
the manually configured NTP Server. The default setting is "Yes".
Time Zone
Select the proper time zone option so the UCM6100 can display correct
time accordingly.
If "Self-Defined Tome Zone" is selected, please specify the time zone
parameters in "Self-Defined Time Zone" field as described in below
option.
The configurations under Web GUI->Settings->Time Settings->Time Auto Updating page require
reboot to take effect. Please consider configuring auto time updating related changes when setting up the
UCM6100 for the first time to avoid service interrupt after installation and deployment in production.
If "Self-Defined Time Zone" is selected in "Time Zone" option, users will
need define their own time zone following the format below.
The syntax is: std offset dst [offset], start [/time], end [/time]
Default is set to: MTZ+6MDT+5,M4.1.0,M11.1.0
MTZ+6MDT+5
This indicates a time zone with 6 hours offset and 1 hour ahead for DST,
which is U.S central time. If it is positive (+), the local time zone is west of
the Prime Meridian (A.K.A: International or Greenwich Meridian); If it is
negative (-), the local time zone is east.
M4.1.0,M11.1.0
The 1st number indicates Month: 1,2,3.., 12 (for Jan, Feb, .., Dec).
The 2nd number indicates the nth iteration of the weekday: (1st Sunday,
3rd Tuesday…). Normally 1, 2, 3, 4 are used. If 5 is used, it means the
last iteration of the weekday.
The 3rd number indicates weekday: 0,1,2,..,6 ( for Sun, Mon, Tues, ...
,Sat).
Therefore, this example is the DST which starts from the First Sunday of
April to the 1st Sunday of November.
SET TIME MANUALLY
To manually set the time on the UCM6100, go to Web UI->Settings->Time Settings->Set Time
Manually. The format is YYYY-MM-DD HH:MI:SS.
Manually setup time will take effect immediately after saving and applying change in the web UI. If users
would like to reboot the UCM6100 and keep the manually setup time setting, please make sure "Remote
NTP Server", "Enable DHCP Option 2" and "Enable DHCP Option 42" options under Web
GUI->Settings->Time Settings->Time Auto Updating page are unchecked or set to empty. Otherwise,
time auto updating settings in this page will take effect after reboot.
On the UCM6100, the system administrator can define "office time", which can be used to configure time
condition for extension call forwarding schedule and inbound rule schedule. To configure office time, go to
Web UI->Settings->Time Settings->Office Time. Click on "Create New Office Time" to create an office
time.
Figure 50: Create New Office Time
Page 85
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 84 of 305
Table 23: Create New Office Time
Start Time
Configure the start time for office hour.
End Time
Configure the end time for office hour
Week
Select the work days in one week.
Show Advanced Options
Check this options to show advanced options. Once selected, please
specify "Month" and "Day" below.
Month
Select the months for office time.
Day
Select the work days in one month.
Select "Start Time", "End Time" and the day for the "Week" for the office time. The system administrator
can also define month and day of the month as advanced options. Once done, click on "Save" and then
"Apply Change" for the office time to take effect. The office time will be listed in the web page as the figure
shows below.
Figure 51: Settings->Time Settings->Office Time
Click on to edit the office time.
Click on to delete the office time.
Click on "Delete Selected Office Times" to delete multiple selected office times at once.
HOLIDAY
On the UCM6100, the system administrator can define "holiday", which can be used to configure time
condition for extension call forwarding schedule and inbound rule schedule. To configure holiday, go to
Web UI->Settings->Time Settings->Holiday. Click on "Create New Holiday" to create holiday time.
Page 86
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 85 of 305
Figure 52: Create New Holiday
Name
Specify the holiday name to identify this holiday.
Holiday Memo
Create a note for the holiday.
Month
Select the month for the holiday.
Day
Select the day for the holiday.
Show Advanced Options
Check this option to show advanced options. If selected, please specify
the days as holiday in one week below.
Week
Select the days as holiday in one week.
Table 24: Create New Holiday
Enter holiday "Name" and "Holiday Memo" for the new holiday. Then select "Month" and "Day". The
system administrator can also define days in one week as advanced options. Once done, click on "Save"
and then "Apply Change" for the holiday to take effect. The holiday will be listed in the web page as the
figure shows below.
Page 87
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 86 of 305
Figure 53: Settings->Time Settings->Holiday
Click on to edit the holiday.
Click on to delete the holiday.
Click on "Delete Selected Holidays" to delete multiple selected holidays at once.
The UCM6100 can be used as a NTP server for the NTP clients to synchronize their time with. To
configure the UCM6100 as the NTP server, set "Enable NTP server" to "Yes" under web
GUI->Settings->NTP Server. On the client side, point the NTP server address to the UCM6100 IP
address or host name to use the UCM6100 as the NTP server.
Page 88
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 87 of 305
RECORDINGS STORAGE
The UCM6100 supports call recordings automatically or manually and the recording files can be saved in
external storage plugged in the UCM6100 or on the UCM6100 locally. To manage the recording storage,
users can go to UCM6100 web GUI->Settings->Recordings Storage page and select whether to store
the recording files in USB Disk, SD card or locally on the UCM6100.
If “Enable Auto Change” is selected, the recording files will be automatically saved in the available
USB Disk or SD card plugged into the UCM6100. If both USB Disk and SD card are plugged in, the
recording files will be always saved in the USB Disk.
If “Local” is selected, the recordings will be stored in UCM6100 internal storage.
Figure 54: Settings->Recordings Storage
Page 89
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 88 of 305
If “USB Disk” or “SD Card” is selected, the recordings will be stored in the corresponding plugged in
external storage device. Please note the options “USB Disk” and “SD Card” will be displayed only if
they are plugged into the UCM6100.
Once “USB Disk” or “SD Card” is selected, click on “OK”. The user will be prompted to confirm to copy
the local files to the external storage device.
Figure 55: Recordings Storage Prompt Information
Click on “OK” to continue. The users will be prompted a new dialog to select the categories for the files
to be copied over.
On the UCM6100, recording files are generated and exist in 3 categories: normal call recording files,
conference recording files, and call queue recording files. Therefore users have the following options
when select the categories to copy the files to the external device:
- Recording Files: Copy the normal recording files to the external device.
- Conference: Copy the conference recording files to the external device.
- Queue: Copy the call queue recording files to the external device.
Figure 56: Recording Storage Category
Page 90
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 89 of 305
- All: Copy all recording files to the external device.
LOGIN TIMEOUT SETTINGS
After the user logs in the UCM6100 web UI, the user will be automatically logged out after certain timeout.
This timeout value can be specified under UCM100 web GUI->Settings->Login Timeout Settings page.
The “User Login Timeout” value is in minute and the default setting is 10 minutes. If the user doesn’t make
any operation on web UI within the timeout, the user will be logged out automatically. After that, the web UI
will be redirected to the login page and the user will need to enter username and password to log in.
If set to 0, there is no timeout for the web UI login session and the user will not be automatically logged out.
Figure 57: Login Timeout Settings
Page 91
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 90 of 305
This page intentionally left blank
Page 92
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 91 of 305
PROVISIONING
OVERVIEW
Grandstream SIP Devices can be configured via Web interface as well as via configuration file through
TFTP/HTTP/HTTPS download. All Grandstream SIP devices support a proprietary binary format
configuration file and XML format configuration file. The UCM6100 provides a Plug and Play mechanism to
auto-provision the Grandstream SIP devices in a zero configuration manner by generating XML config file
and having the phone to download it within LAN area. This allows users to finish the installation with ease
and start using the SIP devices in a managed way.
To provision a phone, three steps are involved, i.e., discovery, configuration and provisioning. This section
explains how Zero Config works on the UCM6100. The settings for this feature can be accessed via Web
UI->PBX->Zero Config.
CONFIGURATION ARCHITECTURE FOR END POINT DEVICE
Started from firmware version 1.0.7.10, the end point device configuration in zero config is divided into the
following three layers with priority from the lowest to the highest:
Global
This is the lowest layer. Users can configure the most basic options that could apply to all
Grandstream SIP devices during provisioning via Zero config.
Model
In this layer, users can define model-specific options for the configuration template.
Device
This is the highest layer. Users can configure device-specific options for the configuration for individual
device here.
Each layer also has its own structure in different levels. Please see figure below. The details for each layer
are explained in sections [GLOBAL CONFIGURATION], [MODEL CONFIGURATION] and [DEVICE
CONFIGURATION].
Page 93
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 92 of 305
Figure 58: Zero Config Configuration Architecture for End Point Device
The configuration options in model layer and device layer have all the option in global layers already, i.e.,
the options in global layer is a subset of the options in model layer and device layer. If an option is set in all
three layers with different values, the highest layer value will override the value in lower layer. For
example, if the user selects English for Language setting in Global Policy and Spanish for Language
setting in Default Model Template, the language setting on the device to be provisioned will use Spanish as
model layer has higher priority than global layer. To sum up, configurations in higher layer will always
override the configurations for the same options/fields in the lower layer when presented at the
same time.
After understanding the zero config configuration architecture, users could configure the available options
for end point devices to be provisioned by the UCM6100 by going through the three layers. This
configuration architecture allows users to set up and manage the Grandstream end point devices in the
same LAN area in a centralized way.
AUTO PROVISIONING SETTINGS
By default, the Zero Config feature is enabled on the UCM6100 for auto provisioning. Three methods of
auto provisioning are used.
Page 94
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 93 of 305
Figure 59: UCM6100 Zero Config
SIP SUBSCRIBE
When the phone boots up, it sends out SUBSCRIBE to a multicast IP address in the LAN. The
UCM6100 discovers it and then sends a NOTIFY with the XML config file URL in the message body.
The phone will then use the path to download the config file generated in the UCM6100 and take the
new configuration.
DHCP OPTION 66
This method should be used on the UCM6102 because only the UCM6102 has WAN and LAN port with
LAN port supporting the router function. When the phone restarts (by default DHCP Option 66 is turned
on), it will send out a DHCP DISCOVER request. The UCM6102 receives it and returns DHCP OFFER
with the config server path URL in Option 66, for example, https://192.168.2.1:8089/zccgi/. The phone
will then use the path to download the config file generated in the UCM6100.
mDNS
When the phone boots up, it sends out mDNS query to get the TFTP server address. The UCM6100
will respond with its own address. The phone will then send TFTP request to download the XML config
file from the UCM6100.
To start the auto provisioning process, under Web GUI->PBX->Zero Config->Zero Config Settings, fill in
the auto provision information.
Page 95
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 94 of 305
Figure 60: Auto Provision Settings
Enable Zero Config
Enable or disable the zero config feature on the PBX. The default setting
is enabled.
Enable Automatic
Configuration Assignment
By default, this is disabled. If disabled, when SIP device boots up, the
UCM6100 will not send the SIP device the URL to download the config file
and therefore the SIP device will not be automatically provisioned by the
UCM6100.
Note:
When disabled, SIP devices can still be provisioned by manually sending
NOTIFY from the UCM6100 which will include the XML config file URL for
the SIP device to download.
Automatically Assign Extension
If enabled, when the device is discovered, the PBX will automatically
assign an extension within the range defined in "Zero Config Extension
Segment" to the device. The default setting is disabled.
Zero Config Extension
Segment
Click on the link "Zero Config Extension Segment" to specify the
extension range to be assigned if "Automatically Assign Extension" is
enabled. The default range is 5000-6299. Zero Config Extension
Segment range can be defined in web UI->PBX->Internal Options->General page->Extension Preference section: "Auto Provision
Extensions".
Enable Pick Extension
If enabled, the extension list will be sent out to the device after receiving
Table 25: Auto Provision Settings
Page 96
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 95 of 305
the device's request. This feature is for the GXP series phones that
support selecting extension to be provisioned via phone's LCD. The
default setting is disabled.
Pick Extension Segment
Click on the link "Pick Extension Segment" to specify the extension list to
be sent to the device. The default range is 4000 to 4999. Pick Extension
Segment range can be defined in web UI->PBX->Internal Options->Generalpage->Extension Preference section: "Pick
Extensions".
Pick Extension Period (hour):
Specify the number of minutes to allow the phones being provisioned to
pick extensions.
Please make sure an extension is manually assigned to the phone or "Automatically Assign Extension" is
enabled during provisioning. After the configuration on the UCM6100 web GUI, click on "Save" and "Apply
Changes". Once the phone boots up and picks up the config file from the UCM6100, it will take the
configuration right away.
DISCOVERY
Users could manually discover the device by specifying the IP address or scanning the entire LAN
network. Three methods are supported to scan the devices.
PING
ARP
SIP Message (NOTIFY)
Click on "Auto Discover" under web UI-> PBX-> Zero Config->Zero Config, fill in the "Scan Method" and
"Scan IP". The IP address segment will be automatically filled in based on the network mask detected on
the UCM6100. If users need scan the entire network segment, enter 255 (for example, 192.168.40.255)
instead of a specific IP address. Then click on "Save" to start discovering the devices within the same
network. To successfully discover the devices, "Zero Config" needs to be enabled on the UCM6100 web
GUI->PBX->Zero Config->Auto Provisioning Settings.
Figure 61: Auto Discover
Page 97
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 96 of 305
The following figure shows a list of discovered phones. The MAC address, IP Address, Extension (if
assigned), Version, Vendor, Model, Connection Status, Create Config, Options (Edit/Delete/Update) are
displayed in the list.
Figure 62: Discovered Devices
GLOBAL CONFIGURATION
GLOBAL POLICY
Global configuration will apply to all the connected Grandstream SIP end point devices in the same LAN
with the UCM6100 no matter what the Grandstream device model it is. It is divided into two levels:
Web UI->PBX->Zero Config->Global Policy
Web UI->PBX->Zero Config->Global Templates.
Global Templates configuration has higher priority to Global Policy configuration.
Global Policy can be accessed in web GUI->PBX->Zero Config->Global Policy page. On the top of the
configuration table, users can select category in the "Options" dropdown list to quickly navigate to the
category. The categories are:
Localization: configure display language, data and time.
Phone Settings: configure dial plan, call features, NAT, call progress tones and etc.
Contact List: configure LDAP and XML phonebook download.
Maintenance: configure upgrading, web access, Telnet/SSH access and syslog.
Network Settings: configure IP address, QoS and STUN settings.
Customization: customize LCD screen wallpaper for the supported models.
Select the checkbox on the left of the parameter you would like to configure to active the dropdown list for
this parameter.
Page 98
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 97 of 305
Figure 63: Global Policy Categories
Language settings
Language
Select the LCD display language on the SIP end device.
Date and Time
Date Format
Configure the date display format on the SIP end device’s LCD.
Time Format
Configure the time display in 12-hour or 24-hour format on the SIP end
device’s LCD.
NTP Server
Configure the URL or IP address of the NTP server. The SIP end device
may obtain the date and time from the server.
Time Zone
Configure the time zone used on the SIP end device.
Default Call Settings
Dial Plan
Configure the default dial plan rule. For syntax and examples, please
refer to user manual of the SIP devices to be provisioned for more details.
Enable Call Features
When enabled, “Do Not Disturb”, “Call Forward” and other call features
can be used via the local feature code on the phone. Otherwise, the ITSP
feature code will be used.
Use # as Dial Key
If set to “Yes”, pressing the number key “#” will immediately dial out the
input digits.
The following tables list the Global Policy configuration parameters for the SIP end device.
Table 26: Global Policy Parameters: Localization
Table 27: Global Policy Parameters: Phone Settings
Page 99
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 98 of 305
Auto Answer by Call-info
If set to "Yes", the phone will automatically turn on the speaker phone to
answer incoming calls after a short reminding beep, based on the SIP
Call-Info header sent from the server/proxy.
The default setting is enabled.
NAT Traversal
Configure which NAT traversal mechanism will be enabled on the
endpoint device.
If set to "STUN" and STUN server is configured, the phone system will
periodically send STUN message to the SUTN server to get the public IP
address of its NAT environment and keep the NAT port open. STUN will
not work if the NAT is symmetric type.
If set to “Keep-alive”, the phone system will send the STUN packets to
maintain the connection that is first established during registration of the
phone. The “Keep-alive” packets will fool the NAT device into keeping the
connection open and this allows the host server to send SIP requests
directly to the registered phone.
If it needs to use OpenVPN to connect host server, it needs to set it to
“VPN”.
If the firewall and the SIP device behind the firewall are both able to use
UPNP, it can be set to “UPNP”. The both parties will negotiate to use
which port to allow SIP through.
The default setting is "Keep-alive".
Use Random Port
Configure whether to allow the endpoint device to use random ports for
both SIP and RTP messages. This is usually necessary when multiple
phones are behind the same full cone NAT. The default setting is "No".
Note: This parameter must be set to "No" for Direct IP Calling to work.
General Settings
Call Progress Tones
Configure call progress tones including ring tone, dial tone, second dial
tone, message waiting tone, ring back tone, call waiting tone, busy tone
and reorder tone using the following syntax:
f1=val, f2=val[, c=on1/ off1[- on2/ off2[- on3/ off3]]];
Frequencies are in Hz and cadence on and off are in 10ms).
“on” is the period (in ms) of ringing while “off” is the period of silence.
Up to three cadences are supported.
Please refer to user manual of the SIP devices to be provisioned for
more details
HEADSET Key Mode
Select “Default Mode” or “Toggle Headset/Speaker” for the Headset key.
Please refer to user manual of the SIP devices to be provisioned for more
details.
Page 100
Firmware Version 1.0.9.26
UCM6100 Series IP PBX User Manual
Page 99 of 305
Table 28: Global Policy Parameters: Contact List
LDAP Phonebook
Source
Select "Manual" or "PBX" as the LDAP configuration source.
If "Manual" is selected, the LDAP configuration below will be applied
to the SIP end device.
If "PBX" is selected, the LDAP configuration built-in from UCM6100
web UI->Settings->LDAP Server will be applied.
Address
Configure the IP address or DNS name of the LDAP server.
Port
Configure the LDAP server port. The default value is 389.
Base DN
This is the location in the directory where the search is requested to
begin. Example:
Configure the bind "Username" for querying LDAP servers. The field can
be left blank if the LDAP server allows anonymous binds.
Password
Configure the bind "Password" for querying LDAP servers. The field can
be left blank if the LDAP server allows anonymous binds.
Number Filter
Configure the filter used for number lookups. Please refer to user manual
for more details.
Name Filter
Configure the filter used for name lookups. Please refer to user manual
for more details.
Version
Select the protocol version for the phone to send the bind requests. The
default value is 3.
Name Attribute
Specify the "name" attributes of each record which are returned in the
LDAP search result. Example:
gn
cn sn description
Number Attribute
Specify the "number" attributes of each record which are returned in the
LDAP search result. Example:
telephoneNumber
telephoneNumber Mobile
Display Name
Configure the entry information to be shown on phone's LCD. Up to 3
fields can be displayed. Example:
%cn %sn %telephoneNumber
Max Hits
Specify the maximum number of results to be returned by the LDAP
server. Valid range is 1 to 3000. The default value is 50.
Search Timeout
Specify the interval (in seconds) for the server to process the request and
client waits for server to return. Valid range is 0 to 180. The default value
Loading...
+ hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.