Netborder SS7 VoIP Media Gateway User Manual v1.0.15
Netborder SS7 VoIP Media Gateway User Manual v1.0.15
Netborder SS7 VoIP Media Gateway User Manual v1.0.15
Gateway
&
NetBorder VoIP
Gateway
User Manual
[Type the abstract of the document here. The abstract is typically a short
summary of the contents of the document. Type the abstract of the document
here. The abstract is typically a short summary of the contents of the document.]
v1.15
1
Date: Jan 2013: Version: 1.15
Conventions
This font indicates screen menus and parameters.
<> indicates keyboard keys (<Enter>, <q>, <s>).
NOTE
Notes inform the user of additional but essential information or features.
CAUTION
Cautions inform the user of potential damage, malfunction, or disruption
to equipment, software, or environment.
v1.15
2
This page is intentionally blank.
v1.15
3
Sangoma
v1.15
4
Contents
Sangoma............................................................................................................................................... 4
Netborder SS7 to VoIP GW User Manual (NSG) .................................................................................. 4
Netborder VoIP GW User Manual (NVG) ............................................................................................. 4
1 Product Overview .......................................................................................................................... 10
1.1 Features / Advantages ........................................................................................................... 10
1.1.1 Any to Any Signaling and Media Gateway ...................................................................... 11
1.2 TDM T1/E1 Interfaces ............................................................................................................ 13
1.3 Ethernet Network Interfaces .................................................................................................. 13
1.4 VoIP Protocols ....................................................................................................................... 13
1.4.1 SIP .................................................................................................................................. 13
1.4.2 Megaco/H.248 & MGCP .................................................................................................. 13
1.4.3 H.323............................................................................................................................... 14
1.5 TDM Protocols ....................................................................................................................... 14
1.5.1 SS7 ................................................................................................................................. 14
1.5.2 ISDN................................................................................................................................ 15
1.6 Call Routing ........................................................................................................................... 15
1.7 Media Processing & Transcoding .......................................................................................... 15
1.8 Echo Cancellation & VQE ...................................................................................................... 16
1.9 DTMF Detection and Generation ........................................................................................... 16
1.10 Management and Configuration ......................................................................................... 16
1.11 Monitoring ........................................................................................................................... 16
1.12 Accounting .......................................................................................................................... 16
1.13 Support and Professional Services ..................................................................................... 17
2 NSG Product Information .............................................................................................................. 18
2.1 NetBorder VoIP Gateway Appliance ..................................................................................... 18
2.1.1 Hardware Specifications .................................................................................................. 18
2.2 NSG Shipping Box Contents .................................................................................................. 19
2.2.1 What is included in the box ............................................................................................. 19
2.2.2 Front Panel ...................................................................................................................... 20
2.2.3 Rear Panel 1U ................................................................................................................. 21
2.2.4 Front Panel 2u ................................................................................................................. 22
2.2.5 Rear Panel 2U ................................................................................................................. 23
2.3 NSG T1/E1 Port Identification ................................................................................................ 24
2.3.1 Cable Pinouts: T1/E1 ...................................................................................................... 25
2.4 NSG Appliance Default Configuration .................................................................................... 27
3 User Interface ............................................................................................................................... 28
3.1 WebGUI ................................................................................................................................. 28
3.1.1 WebGUI Structure ........................................................................................................... 29
3.2 Console Structure .................................................................................................................. 32
3.2.1 Connect via SSH ............................................................................................................. 32
3.2.2 Connect via USB Serial ................................................................................................... 33
v1.15
5
3.2.3 Bash Shell ....................................................................................................................... 34
3.2.4 Gateway CLI – nsg_cli .................................................................................................... 35
3.3 Shell/CLI from GUI ................................................................................................................. 36
4 Usage Scenarios ........................................................................................................................... 37
4.1 Signaling Gateway: M2UA .................................................................................................... 37
4.2 Megaco/H.248 Media Gateway: MG + SG ............................................................................. 37
4.2.1 Megaco Quick Configuration ........................................................................................... 38
4.3 SIP/H323 to SS7 ISUP .......................................................................................................... 39
4.3.1 H323 to SS7 ISUP Quick Start Guide ............................................................................. 40
4.4 SIP to ISDN ........................................................................................................................... 41
4.4.1 SIP to ISDN Quick Start Guide ........................................................................................ 41
4.5 SIP to MFCR2 ........................................................................................................................ 43
4.5.1 SIP to MFCR2 Quick Start Guide .................................................................................... 43
4.6 Any to Any Signaling and Media Gateway ............................................................................. 45
5 First Boot/Initial Setup ................................................................................................................... 46
5.1 Power Connection.................................................................................................................. 46
5.1.1 PSU Connection .............................................................................................................. 46
5.1.2 DC PSU Connection........................................................................................................ 47
5.2 Establishing Initial WebGUI Connection ................................................................................ 48
5.3 Change Password.................................................................................................................. 49
5.4 Console SSH Configuration ................................................................................................... 50
5.5 Self Test................................................................................................................................. 52
5.5.1 Running Self-Test............................................................................................................ 52
5.6 NSG License .......................................................................................................................... 54
6 Network Configuration................................................................................................................... 56
6.1 Physical Network Interface Configuration .............................................................................. 58
6.2 Appliance Network Interfaces ................................................................................................ 59
6.3 Selecting Default Route ......................................................................................................... 59
6.4 Network Section ..................................................................................................................... 60
6.5 Interface Section .................................................................................................................... 61
6.5.1 Network Role ................................................................................................................... 61
6.5.2 Types .............................................................................................................................. 62
6.5.3 Ethernet Options ............................................................................................................. 63
6.6 Virtual IP’s.............................................................................................................................. 64
6.7 IP Troubleshooting ................................................................................................................. 64
6.8 Static Routes ......................................................................................................................... 65
6.8.1 Routing Table Status ....................................................................................................... 67
6.9 VLAN ..................................................................................................................................... 68
6.9.1 VLAN Configuration......................................................................................................... 69
6.9.2 VLAN Routes................................................................................................................... 70
6.9.3 Additional VLAN .............................................................................................................. 71
6.9.4 vconfig help ..................................................................................................................... 71
6.9.5 VLAN Status .................................................................................................................... 72
v1.15
6
6.10 Date & Time Service Config ............................................................................................... 74
7 Initial Gateway Configuration ........................................................................................................ 76
7.1 Global Gateway Configuration ............................................................................................... 77
8 Megaco/H.248 Media Gateway Configuration ............................................................................... 79
8.1 Overview ................................................................................................................................ 79
8.1.1 Terminations.................................................................................................................... 79
8.1.2 Contexts .......................................................................................................................... 80
8.2 Commands ............................................................................................................................ 80
8.2.1 Sent from controller to gateway ....................................................................................... 80
8.2.2 Sent from gateway to controller ....................................................................................... 80
8.3 Packages ............................................................................................................................... 81
8.4 Create MG Profile .................................................................................................................. 82
8.5 Create MG Peer Profile.......................................................................................................... 85
8.6 TDM Termination for Media Gateway .................................................................................... 87
8.6.1 Identify ............................................................................................................................. 88
8.6.2 Edit T1/E1 Config ............................................................................................................ 89
8.7 Span Link Type ...................................................................................................................... 92
8.8 Signaling Gateway Overview ................................................................................................. 93
8.8.1 MTP1/2 Link Configuration .............................................................................................. 94
8.8.2 M2UA Interface ............................................................................................................... 96
8.8.3 M2UA Cluster Creation ................................................................................................... 97
8.8.4 M2UA Cluster Peers........................................................................................................ 98
8.8.5 SCTP Interface .............................................................................................................. 100
8.8.6 Binding all components ................................................................................................. 101
8.8.7 Mixed Mode Configuration ............................................................................................ 102
8.8.8 Bind Megaco to TDM..................................................................................................... 103
8.8.9 TDM Termination Complete .......................................................................................... 106
9 SS7 ISUP .................................................................................................................................... 107
9.1 TDM SS7 Configuration Page .............................................................................................. 109
9.2 Port Identification ................................................................................................................. 110
9.3 Edit T1/E1 Config ................................................................................................................. 111
9.3.1 Standard T1/E1 Parameters .......................................................................................... 111
9.3.2 Advanced T1/E1 Parameters ........................................................................................ 113
9.4 Span Link Type .................................................................................................................... 114
9.5 SS7 Network Overview ........................................................................................................ 115
9.5.1 Links .............................................................................................................................. 116
9.5.2 Linksets ......................................................................................................................... 116
9.5.3 Routes ........................................................................................................................... 116
9.6 MTP2 Link Configuration ..................................................................................................... 117
9.7 MTP3 Linkset Configuration ................................................................................................. 120
9.8 MTP3 SS7 Route ................................................................................................................. 123
9.9 ISUP Interface Configuration ............................................................................................... 125
9.10 ISUP CIC Channel Mapping ............................................................................................. 129
v1.15
7
10 Relay: SS7 .............................................................................................................................. 135
10.1 Relay Configuration .......................................................................................................... 136
10.1.1 Configuring the master gateway .................................................................................... 137
10.1.2 Configuring the slave gateway ...................................................................................... 141
10.1.3 Configuring the slave TDM configurations from the master gateway ............................ 145
11 ISDN Configuration ................................................................................................................. 147
11.1 Port Identification .............................................................................................................. 148
11.2 Edit T1/E1 Config ............................................................................................................. 149
11.2.1 Standard T1/E1 Parameters .......................................................................................... 149
11.2.2 Advanced T1/E1 Parameters ........................................................................................ 151
11.3 Span Link Type................................................................................................................. 152
11.4 ISDN Protocol Configuration............................................................................................. 153
11.5 Span Group Configuration ................................................................................................ 154
12 MFC R2 Configuration ............................................................................................................ 155
13 Media Transcoding Configuration ........................................................................................... 156
13.1 Media Hardware ............................................................................................................... 157
14 Applying Configuration ............................................................................................................ 158
15 Dialplan ................................................................................................................................... 160
15.1 Dialplan Reload/Apply ...................................................................................................... 161
15.2 PSTN to SIP Dialplan ....................................................................................................... 162
15.3 PSTN to H323 Dialplan..................................................................................................... 163
15.4 SIP/H323 to PSTN Dialplan .............................................................................................. 164
15.5 Dialplan Syntax................................................................................................................. 165
15.5.1 Context .......................................................................................................................... 166
15.5.2 Extensions ..................................................................................................................... 167
15.5.3 Conditions ..................................................................................................................... 168
15.5.4 Multiple Conditions (Logical AND) ................................................................................. 169
15.5.5 Multiple Conditions (Logical OR, XOR) ......................................................................... 170
15.5.6 Complex Condition/Action Rules ................................................................................... 173
15.5.7 Variables ....................................................................................................................... 175
16 Backup Restore System .......................................................................................................... 177
16.1 Restore a System ............................................................................................................. 178
16.2 Restore to a new System.................................................................................................. 179
17 Factory Reset & Reboot .......................................................................................................... 180
17.1 Factory Reset ................................................................................................................... 180
17.2 Appliance Soft Reboot ...................................................................................................... 180
17.3 Appliance Shutdown ......................................................................................................... 180
18 Upgrade .................................................................................................................................. 181
18.1 WebUI System Update ..................................................................................................... 181
18.2 Console SSH Update ....................................................................................................... 182
19 Operations............................................................................................................................... 183
19.1 Starting the Gateway ........................................................................................................ 183
19.2 Profile Panel ..................................................................................................................... 185
v1.15
8
19.3 Gateway Status ................................................................................................................ 187
19.3.1 Megaco/M2UA TDM ...................................................................................................... 187
19.4 Megaco Status.................................................................................................................. 192
19.5 Gateway Logs ................................................................................................................... 193
19.5.1 Gateway Log Download ................................................................................................ 194
19.6 Advanced Logs ................................................................................................................. 195
19.7 Packet Capture ................................................................................................................. 195
19.7.1 Ethernet Capture Filter Options ..................................................................................... 197
20 Monitoring & Management ...................................................................................................... 198
20.1 SNMP ............................................................................................................................... 198
20.2 SNMP Configuration ......................................................................................................... 199
20.3 SNMP Test ....................................................................................................................... 200
21 Troubleshooting ...................................................................................................................... 202
21.1 Physical Layer .................................................................................................................. 203
21.1.1 NSG TDM Driver related commands ............................................................................. 204
21.1.2 T1/E1 Port Status .......................................................................................................... 205
21.1.3 T1/E1 Port Debugging ................................................................................................... 205
21.2 TDM Signaling Link Debugging ........................................................................................ 209
22 Appendix ................................................................................................................................. 211
22.1 Redundant DC PSU ......................................................................................................... 211
22.1.1 DC PSU Cables............................................................................................................. 212
22.1.2 Hot-swap procedures .................................................................................................... 213
22.1.3 Trouble Shooting ........................................................................................................... 214
23 Theory ..................................................................................................................................... 215
v1.15
9
1 Product Overview
The NetBorder SS7 to VoIP Gateway and NetBorder VoIP Gateway are two families of Sangoma’s
Carrier Class TDM to SIP VoIP Gateway product. For short, it is often referred to as NSG and NVG
v1.15
10
Wide range of narrowband and wideband codecs supported
For any-to-any codec transcoding
o G.711, G.729, AMR
Robust implementation with distribution
Profile Panel, on the fly configuration with no service interruption.
v1.15
11
NOTE:
Limitations exist when running specific signaling combinations at same time.
o Eg: M2UA SG cannot run at the same time as ISUP+MTP3+MTP2
o Some codes such as AMR will reduce session capacity.
o No reduction of capacity for G711, G729, iLBC
v1.15
12
1.2 TDM T1/E1 Interfaces
v1.15
13
H.248.2 – Fax etal Package
H.248.14 – Inactivity Timer Package
Augmented BNF for Syntax Specifications: ABNF, Internet RFC 2324
DTMF support
o RFC 2833/4733 - "RTP Payload for DTMF Digits, Telephony Tones and Telephony
Signals"
o In-band DTMF detection/generation
1.4.3 H.323
Call Handling
H.225.0 : Call signaling protocols and media stream packetization for packet-based multimedia
communication systems
H.245 : Control protocol for multimedia communication
H.235, H.450, H.460
DTMF support
RFC 2833/4733 - "RTP Payload for DTMF Digits, Telephony Tones and Telephony Signals"
In-band DTMF detection/generation
ISUP, MTP3, MTP2, MTP1, M3UA (RFC 3332), M2UA (RFC 3331), Relay
Variants
o ITU, ANSI, Bellcore, UK, China, France Spirou, India and Russian
MTP2
o ITU 88 & 92, ANSI 88 & 92, Peoples Republic of China
MTP3
o ITU 88 & 92 & ETSI, ANSI 88 & 92, 96 & Telcordia (including ANSI MTP3-B), China
ISUP
o ITU 88, 92 & 97, 2000, Telcordia 97, ANSI 88, 92, 95 and ETSI v2,v3
o SPIROU, China, UK, Russia, India
SCTP (RFC 2960)
v1.15
14
1.5.2 ISDN
CCITT 88, User & Network Side PRI/BRI
AT&T 4ESS User Side - PRI, Network Side - PRI
5ESS User Side - PRI/BRI, Network Side - PRI/BRI
DMS-100 User & Network Side - PRI/BRI
ETSI User & Network Side - PRI/BRI
Australian Telecom User Side - PRI/BRI and Network Side - PRI
National ISDN-1 User Side - BRI
NTT User & Network Side - PRI/BRI
National ISDN-2 User & Network Side - PRI
Q.SIG (PRI)
LAPD & TEI Management
Configurable and extendable XML-based dial plan and routing rules XML Dialplan can be used to
create complex routing scenarios between SIP and TDM.
Call routing based on any call parameter present in a SIP or SS7 IAM message.
Deep integration with signaling stacks
Ability to use external applications to build complex routing logic*
G.711 G.729AB
G.723.1 GSM
G.726 G.722
iLBC AMR
G.722.1
v1.15
15
1.8 Echo Cancellation & VQE
Telco grade hardware based echo canceling and Voice processing
1.11 Monitoring
SNMP v1, 2, 3
RTCP
1.12 Accounting
Radius
v1.15
16
1.13 Support and Professional Services
Sangoma Engineers are here to support your success. Whether you need technical support and
software maintenance, training, consultation and installation services, Sangoma can help you. Please
contact your Sales representative for more information.
v1.15
17
2 NSG Product Information
Fully integrated Industrial grade telco appliance running a customized OS, NetBorder VoIP gateway
application and TDM interfaces configured and installed by Sangoma.
NSG Appliance provides a full-featured, carrier-class VoIP deployment while leveraging the flexibility
and cost effectiveness of standard computing platforms.
v1.15
18
2.2 NSG Shipping Box Contents
The first three tasks for installing and operating the Netborder SS7 to VOIP Gateway are
Unpack
Inspect
Power up.
Carefully inspect the NSG Appliance for any damage that might have occurred in shipment.
If damage is suspected, file a claim immediately with the carrier, keep the original packaging for
damage verification and/or returning the unit, and contact Sangoma Customer Service.
v1.15
19
2.2.2 Front Panel
RAID1 SSD
o The RAID1 is NOT Hot Plug
o NSG appliances use industrial grade SSD
o One must power down the machine in order to change SSD/HDD
o Contact Sangoma Support for part replacement.
v1.15
20
2.2.3 Rear Panel 1U
Power button
o Used to turn off the power supply
o Not for Factory Reset
v1.15
21
2.2.4 Front Panel 2u
Fan Filter
USB
o Used for Serial CLI
o Refer to the Serial CLI Section
Power LED
HDD Activity LED
Front Panel Reset/Power button is used for:
o Factory Reset
Press 1 time per second until system beeps and reboots (approx.: 10sec).
A beep will sound to indicate that system has completed factory reset
before system reboots.
o Soft Reboot
Press 1 time every 3 seconds until system reboots. (approx.: 6sec)
There will be no beep on reboot.
o Power on/off
Hold for 10 seconds
o Nothing will happen if pressed once
To avoid accidental restart.
Caution: From NSG SW release 5.0
o Refer to Factory Reset section.
RAID1 SSD
o The RAID1 is NOT Hot Plug
o NSG appliances use industrial grade SSD
o One must power down the machine in order to change SSD/HDD
o Contact Sangoma Support for part replacement.
v1.15
22
2.2.5 Rear Panel 2U
v1.15
23
2.3 NSG T1/E1 Port Identification
Sangoma T1/E1 Interface boards come with two types of RJ45 Connections
v1.15
24
2.3.1 Cable Pinouts: T1/E1
NOTE
There are two LED per RJ45 connector.
Y Cable for A108 connects 2 separate Y Cable for A108 connects 2 separate
T1/E1 (straight). T1/E1 (cross).
This is to connect the A108 board RJ45 ports This is to connect the A108 against another
to Telco Lines. T1/E1 card in back to back mode.
v1.15
25
T1/E1 "Portsplitter" Cable
T1/E1 Split Cable for the Eight Port Board
Standard | ROHS: Yes | Length: 6'
SKU: CABL-630
v1.15
26
2.4 NSG Appliance Default Configuration
v1.15
27
3 User Interface
Netborder SS7 to VoIP media gateway provides the user with two interfaces
WebGUI
o Web GUI is preferred for almost all operations
o Configuration, Operations, Statistics, Reports
3.1 WebGUI
v1.15
28
3.1.1 WebGUI Structure
3.1.1.1 Overview
Control Panel
o Used to control the global gateway operations: start, stop, restart
Profile Panel
o Used to Sync configuration on the fly without Restarting full gateway.
o Allows configuration of the gateway without service interruption.
o Supported from NSG Version v5.0.1
TDM Status
o Provides full overview of gateway utilization and states
SIP Status
o Provides full SIP statistics, call count
MG Status
o Megaco detail call status report per Profile
VLAN Status
o Provides full VLAN statistics, VLAN ID, IP, Netmask for each VLAN.
3.1.1.2 Configuration
Network
o Allows network configuration such as IP, Static IP Routes, VLAN, DNS and Firewall
Gateway
o Core product configuration
o Provides configuration of all Signaling and Media Protocols
SIP, RTP,H.323, Media Processing, Megaco(MG), SS7/Sigtran (TDM), ISDN (TDM)
o Routing Logic / Dialplan
XML based dialplan
Management
o Apply
Write all configurations changed and set in Gateway section.
o Backup
Backup all system configurations into a zip file.
Recover a system from a backup file
Advanced
o File Editor
Allows custom file editing for custom configuration
Troubleshooting
o Command Execution
Instead of logging into a shell
Execute any system command via the WebGUI.
v1.15
29
3.1.1.3 System
Settings
o Date
Set date time and sync to time server
o Password
Change password
o Shutdown
Shutdown or reboot a system
o Update
Software and patch update system
Resources
o Processes
List of currently running process
o Services
List of all available services
SSH service start/stop
Hardware
o Self-Test
Allow for system software and hw components test.
o Firmware Update
Allows for firmware updates
Sangoma TDM boards
Sangoma Media processing boards
Help
o About
Shows system version and version of all important packages.
o PBX Integration
Help documentation
3.1.1.4 Reports
Dashboard
o Overview
Overview of network interfaces
Network
o Network Report
Long term usage charts for each network device
o Protocol Capture
PCAP packet capture with filter support for any network interface
System
o Gateway Logs
Specific gateway logs used to quickly trouble shoot gateway issues
Allows for log download
o Advanced Logs
Full system wide logs with filters
v1.15
30
o Hardware Report
Full hardware overview and description
HDD, Memory and system usage
Device enumeration
o Resource Report
Long term statistics
v1.15
31
3.2 Console Structure
On login prompt
Username: root
Password: <your custom password>
v1.15
32
3.2.2 Connect via USB Serial
v1.15
33
3.2.3 Bash Shell
Once successfully logged into the system, either via ssh or usb serial, user will be offered a bash
prompt.
tcpdump
o Provides network capture to a pcap file
o Can be analyzed using wireshark on Desktop or Laptop.
ethtool
o Provides detail network interface information, like Ethernet link status.
o Run: ethtool <enter> for all the options
o Eg: ethtool eth0 - show Ethernet status
Ifconfig
o Network interface statistics tool
o Shows error counters on Ethernet and TDM interfaces.
o Notice the error and overrun counters on wanpipe w1g1 interfaces.
wanpipemon
o Sangoma TDM troubleshooting tool
o T1/E1 alarms
wanpipemon –i w1g1 –c Ta
nsg_cli
o Provides Gateway low level CLI
v1.15
34
3.2.4 Gateway CLI – nsg_cli
Command Description
status Shows NSG Status
show channels List all active calls
ftdm list Lists Information on all available spans
ftdm ss7 Displays all SS7 Related Commands
mg Displays all Megaco Related Commands
log [debug|error|crit] Set log level to debug loglevel critical
v1.15
35
3.3 Shell/CLI from GUI
Select Command Execution from side/top Configuration Menu
Specify a shell or CLI command. Refer to guide below.
Warning
Do not run shell commands that run indefinitely. Such as “ping <ip>”. In such case the webgui will
get stuck forever executing the command. In such case, user must login via CLI and kill the process.
In case of ping command one can limit number of pings to perform. eg: ping –c 10 <ip>
v1.15
36
4 Usage Scenarios
4.1 Signaling Gateway: M2UA
v1.15
37
4.2.1 Megaco Quick Configuration
v1.15
38
4.3 SIP/H323 to SS7 ISUP
v1.15
39
4.3.1 H323 to SS7 ISUP Quick Start Guide
v1.15
40
4.4 SIP to ISDN
v1.15
41
Perform Media Transcoding Configuration
o Section 11
o Specify supported codecs.
Apply configuration
o Section 12
Dial Plan
o Section 13
Start Gateway
o Section 17
v1.15
42
4.5 SIP to MFCR2
v1.15
43
o Section 11
o Specify supported codecs.
Apply configuration
o Section 12
Dial Plan
o Section 13
Start Gateway
o Section 17
v1.15
44
4.6 Any to Any Signaling and Media Gateway
v1.15
45
5 First Boot/Initial Setup
AC PSU
o AC Single PSU (Default)
o AC Dual-Redundant PSU
DC PSU
o DC Dual-Redundant PSU
v1.15
46
5.1.2 DC PSU Connection
v1.15
47
5.2 Establishing Initial WebGUI Connection
NSG factory settings are not very useful, as the Primary Ethernet port:eth0 is set to a static IP
address. Proceed to connect to the NSG Appliance via Laptop’s web browser.
v1.15
48
5.3 Change Password
v1.15
49
5.4 Console SSH Configuration
v1.15
50
Service Description Status
Samba/Windows NetBIOS Windows NetBIOS server Not used / Not required
MySQL MySQL database Not used / Not required
Samba/Windows Server Windows File server Not used / Not required
Time Server Network Time Protocol Should be configured and
enabled.
Note: There must be internet
access to reach the NTP
service.
Web Server web/httpd server Not used / Not required
Gateway Service NSG VoIP to SS7 gateway Do not configure it here
Use Control Panel
Logging Services Syslog, logging service Should be configured and
enabled.
Samba/Windows Winband Not used/ Not required
Secure Shell SSH server Should be configured and
enabled.
System Scheduler/Cron System scheduler Should be configured and
enabled
System Watch System watch Should be configured and
enabled
v1.15
51
5.5 Self Test
Self-Test page must be run on initial installation or on any hardware upgrade. It will run a battery of
tests on Sangoma TDM and Transcoding hardware.
v1.15
52
WARNING:
All services during the Self-Test will be stopped.
The existing configuration will be restored after Self Test.
Do not run Self-Test in production!
Only run Self-Test during on initial setup or during a maintenance window.
v1.15
53
5.6 NSG License
Each NSG appliance comes with pre-installed license.
In case of upgrades, of expansions please contact Sangoma Sales.
v1.15
54
License Variables Description
Name Customer Name
Email Customer Email
Reseller Reseller Name
License NA
SPC SPC stands for: self point code
It’s used to bind a specific set of point codes to the license.
ANY: is a special value which allows use of an SPC value.
MAC System’s MAC address.
License code checks the MAC address and confirmes if
MAC is correct. One can check vs License Information
section.
CICS Number of TDM channels allowed by the license.
From example above CICs = 600
For RTP to TDM calls: License allows 600 calls
For TDM to TDM calls: License allows 300 calls
v1.15
55
6 Network Configuration
Network configuration section only applies to Physical Network Interfaces: eth0 and eth1. It does not
apply to VLAN IP and route configuration.
Network Setup
Default Route/Gateway
To configure a system default route through the IP Settings section, the appropriate interface
role type to use is “External”. The External interfaces get associated to the default system
route.
CAUTION:
o There can only be ONE External network interface.
o There can only be ONE system default route.
Static Routes
Static routes that apply to physical network interfaces eth0, eth1 should be configured in
Configuration-> Network -> IP Route section.
CAUTION:
o Do not try to configure VLAN routes in this section. .
o route configuration files are only meant to be used for eth0,eth1 interfaces.
v1.15
56
Media Ethernet Interface: Transcoding
NSG comes with optional, media/codec transcoding hardware. The media transcoding
hardware network interface is: eth2. The media transcoding network interface comes
preconfigured with a 10.x.x.x ip address.
CAUTION:
One should take this into account when assigning IP addresses to eth0,eth1 or VLAN
interfaces. Confirm that ip address range set does not conflict with eth2 media transcoding
network interface.
All VLAN related configuration such as IP address, VLAN ID and VLAN routes must be
configured in VLAN configuration section only.
CAUTION:
o Do not use Static IP Route section to create a VLAN routes.
o Static IP Route section is only for physical interfaces eth0 and eth1.
CAUTION:
o Make sure that all physical network interfaces in IP Settings section are configured for
role “LAN”. No physical network interface eth0, eth1 should be configured for role
“External”. This would result in multiple system default routes.
v1.15
57
6.1 Physical Network Interface Configuration
By default the NSG appliance pre-configured with 192.168.168.2/24 address on Primary Port (eth0).
The IP address can be changed based as follows
NOTE
eth2 device is a Sangoma Transcoding device and should be modified.
eth2 device is configured in Configuration -> Media section of the GUI will configure this
device.
v1.15
58
6.2 Appliance Network Interfaces
eth0
o Primary Signaling Port
o By default provisioned as static 192.168.168.2
o By default allows access to ssh and management http
eth1
o Secondary Signaling or Management Port
o By default provisioned as static no IP address
o By default allows access to ssh and management http
eth2
o Sangoma transcoding DSP board
o Provisioned using Media page. Do not modify in this section.
v1.15
59
6.4 Network Section
Name/DNS Servers Domain Name or IP address On DHCP and DSL/PPPoE connections, the DNS servers will
eg. 8.8.8.8 be configured automatically for your IP Settings. In these two
types of connections there is no reason to set your DNS
servers. Users with static IP addresses should use the DNS
servers provided by your Internet Service Provider (ISP). If you
are using Multi-WAN, please review the documentation on the
topic of DNS servers.
v1.15
60
6.5 Interface Section
When configuring a network interface, the first thing you need to consider is the network role in IP
Settings. Will this network card be used to connect to the Internet, for a local network, for a network
with just server systems? The following network roles in IP Settings are supported in NSG and are
described in further detail in the next sections:
v1.15
61
Option Description
External Network interface with direct or indirect access to the Internet
External interface is used as the system default route.
WARNING:
You should have only ONE external network interface.
Usually eth0 is the external interface
Hot LAN Hot LAN (or “Hotspot Mode”) allows you to create a separate LAN network for
untrusted systems. Typically, a Hot LAN is used for:
Servers open to the Internet (web server, mail server)
Guest networks
Wireless networks
A Hot LAN is able to access the Internet, but is not able to access any systems on
a LAN. As an example, a Hot LAN can be configured in an office meeting room
used by non-employees. Users in the meeting room could access the Internet and
each other, but not the LAN used by company employees.
DMZ In NSG, a DMZ interface is for managing a block of public Internet IP addresses.
If you do not have a block of public IP addresses, then use the Hot LAN role of
your IP Settings. A typical DMZ setup looks like:
WAN: An IP addresses for connecting to the Internet
LAN: A private network on 192.168.x.x
DMZ: A block of Internet IPs (e.g from 216.138.245.17 to
216.138.245.31)
NSG GUI has a DMZ firewall configuration page to manage firewall policies on
the DMZ network.
6.5.2 Types
Option Description
DHCP For most cable and Ethernet networks, DHCP is used to connect to the Internet.
In addition, your system will have the DNS servers automatically configured by
your ISP when the Automatic DNS Servers checkbox is set.
Static If you have a static IP, you will need to set the following parameters:
IP
Netmask (e.g. 255.255.255.0)
Gateway (typically ends in 1 or 254)
Ethernet Options (able to force 100MB or 1000mb)
PPPoE DSL For PPPoE DSL connections, you will need the username and password provided
by your ISP. In addition, your system will have the DNS servers automatically
configured by your ISP when the Automatic DNS Servers checkbox is set.
v1.15
62
6.5.3 Ethernet Options
Setting custom Ethernet options such as disabling auto negotiation is done as part of the IP Settings.
v1.15
63
6.6 Virtual IP’s
NSG supports virtual IPs. To add a virtual IP address, click on the link to configure a virtual IP
address and add specify the IP Address and Netmask. You will also need to create advanced firewall
rules if the virtual IP is on the Internet.
6.7 IP Troubleshooting
In most installs, the network cards and IP settings will work straight out of the box. However, getting
the network up the first time can be an exercise in frustration in some circumstances. Issues include;
v1.15
64
6.8 Static Routes
In some cases a static route must be defined for a specific network interface: eth0 or eth1.
The static route support is done via File Editor
NOTE
The IP Route section only allows route add command syntax
v1.15
65
Route File Name Description
Usage Use to create static routes for Primary Signaling Ethernet Port:eth0
Usage:
Example:
v1.15
66
6.8.1 Routing Table Status
v1.15
67
6.9 VLAN
Virtual local area network, virtual LAN or VLAN is a concept of partitioning a physical network, so that
distinct broadcast domains are created. NSG mark’s packets through tagging, so that a single
interconnect (trunk) may be used to transport data for various VLANs.
A VLAN has the same attributes as a physical local area network (LAN), but it allows for end stations
to be grouped together more easily even if not on the same network switch. VLAN membership can
be configured through software instead of physically relocating devices or connections. Most
enterprise-level networks today use the concept of virtual LANs(VLAN). Without VLANs, a switch
considers all interfaces on the switch to be in the same broadcast domain.
v1.15
68
6.9.1 VLAN Configuration
NOTE
The VLAN network interfaces are created over physical network interface. Make sure that the
physical network interface eth0 or eth1 are configured in IP Settings, before attempting to
configure VLAN on top of them eth0 or eth1.
The Save/Apply post processing will display VLAN configuration status.
v1.15
69
Example of sample script that could be copied into the VLAN config startup script:
NOTE
Only routes related to VLAN interfaces are allowed in the VLAN configuration section.
CAUTION
If a system default route needs to go through a VLAN
Confirm that IP Settings interfaces are all set to LAN role.
As there can be only ONE system default route.
v1.15
70
6.9.3 Additional VLAN
If more VLAN’s are needed, proceed to repeat the above steps for all VLANs.
# vconfig
Expecting argc to be 3-5, inclusive. Was: 1
v1.15
71
6.9.5 VLAN Status
v1.15
72
NOTE
Confirm that VLAN Interface contains the correct IP address.
If the IP address is not set, the VLAN configuration has not been set properly.
v1.15
73
6.10 Date & Time Service Config
Note that you need to configure your IP address and default route in order to be able to use a default
time server that is located on the internet.
To configure
Select Date from side/top System menu
Refer below to all available options.
v1.15
74
Option Description
Date/Time The system date, time and time zone information is displayed for informational
purposes. Please make sure it is accurate since it is not unusual to have
computer clocks improperly set on a new installation.
Time Zone It is important to have the correct time zone configured on your system. Some
software (notably, mail server software) depends on this information for proper
time handling.
NTP Time Server An NTP Time Server is built into NSG.
Time Hitting the Synchronize Now button will synchronize the system's clock with
Synchronization network time servers.
v1.15
75
7 Initial Gateway Configuration
NSG by default contains following VoIP/TDM Sections
SIP/RTP
o Configured in Global Gateway section
o SIP profile is always started
MG
o Configured in MG gateway section
o MG Termination ID’s are mapped to TDM channels in TDM gateway section.
o For full MG configuration one must configure MG and TDM sections.
H323
o Single H323 profile, configured in H323 gateway section
o H323 profile is started only if H323 gateway section is saved.
SS7
o Configured in TDM gateway section
o ISUP Termination
o M2UA Signaling Gateway
Media/Transcoding
o Configured in Media gateway section
o Enable and select hw codec support
o Note: HW transcoding is an optional feature.
Dialplan
o Used for SIP to TDM and H323 to TDM mode
o Note: Dialplan is not used in MG/Megaco/H.248 mode.
Apply
o All configuration files are saved to disk at this step.
o Above configuration sections only save information in local database.
o NSG Gateway can be started in Control Panel after this step
o TDM Status can be used to monitor Gateway Status.
v1.15
76
7.1 Global Gateway Configuration
v1.15
77
Field Name Possible Default Value Description
Values
sip_ip Any ip address System IP SIP service, local IP address. By default a local
system eth0 address is taken as default ip
address.
sip_dtmf_type rfc2833 rfc2833 rfc2833
info - DTMF passed via RTP oob message
none info
- DTMF passed via SIP INFO message
none
- DTMF passed via inband media
rfc2833_pt Any number 101 rfc2833 rtp payload type override. Ability to set
the RTP payload type for rfc2833. Use d edge
cases where remote equipment is not per spec.
sip_user_agent Any string Netborder SS7 SIP INVITE user agent name string.
to VoIP Media
Gateway 4.0
rtp_start_port Any port 21000 RTP port starting range value. NSG will pick
RTP ports for each call within this range.
rtp_end_port Any port 31000 RTP port stop range value. NSG will pick RTP
ports for each call within this range
pstn_default_group g1,g2,g3,g4 …. g1 Default pstn dial group number, in case the group
is not specified in the dial string.
radius_auth_host Any ip address:port 10.199.0.3:1812 Location of the Radius server, that will be used to
authenticate incoming calls.
radius_auth_secret Any string testing123 Password of the remote Radius server.
v1.15
78
radius_cdr_host Any ip address:port 10.199.0.3:1812 Location of the Radius server, that will be used to
keep track of billing via CDRs.
radius_auth_secret Any string testing123 Password of the remote Radius server.
8.1 Overview
H.248 or Megaco or Gateway Control Protocol is a recommendation from ITU which defines protocols
that are used between elements of a physically decomposed multimedia gateway. It is an
implementation of the Media Gateway Control Protocol Architecture (RFC 2805). H.248 is also called
Megaco or in IETF domain. It is now known as Gateway Control Protocol.
The H.248/Megaco model describes a connection model that contains the logical entities, or objects,
within the Media Gateways (MGs) that can be controlled by the Media Gateway Controller. The main
entities are Contexts and Terminations.
8.1.1 Terminations
These source or sink one or more media streams or control streams. Terminations may be
physical or ephemeral.
Physical Terminations represent physical entities that have a semi-permanent existence. For
example, a Termination representing ports on the gateway, such as TDM channel or DS0
might exist for as long as it is provisioned in the gateway. Ephemeral Terminations represent
Connections or data flows, such as RTP streams, or MP3 streams, and usually exist only for
the duration of their use in a particular Context.
Terminations have properties, such as the maximum size of a jitter buffer, which can be
inspected and modified by the MGC. A termination is given a name, or Termination ID, by the
MG.
v1.15
79
8.1.2 Contexts
These are star connections created by associating multiple terminations. A Context is a logical
entity on an MG that is an association between a collection of Terminations. A NULL context
contains all non-associated terminations. A Context is a logical entity on an MG that is an
association between a collection of Terminations. A ContextID identifies a Context.
The normal, "active" context might have a physical termination (say, one DS0 in a DS3) and
one ephemeral one (the RTP stream connecting the gateway to the network). Contexts are
created and released by the MG under command of the MGC. A context is created by adding
the first termination, and it is released by removing (subtracting) the last termination.
A termination may have more than one stream, and therefore a context may be a multistream
context. Audio, video, and data streams may exist in a context among several terminations.
8.2 Commands
The commands defined by megaco are very simple, since they can be heavily extended using
packages.
Add
Used to add a termination to a context
Modify
Used to modify an existing termination
Substract:
Used to remove a termination from a context
Move:
used to move a termination to another context (call-waiting is achieved by moving it to the
NULL context, which keeps it opened).
AuditValue
Returns the current values of properties, signals and statistics
AuditCapabilities:
Returns metadata on the current termination (the possible values for all elements)
Notify
v1.15
80
Carries an event defined in one of the packages [P1]
ServiceChange:
Notifies the controller that the gateway is going out of service / back in service. [P1]
A MEGACO-configured NSG starts by sending a Service Change command to its MGC. When an
MGC accepts the NSG registration, the session can start. Subsequently, the NSG responds to MGC
commands. Event notifications are sent only if the MGC requests them specifically.
8.3 Packages
Additional features are provided in packages, which define additional properties, events and signals
that are included in the descriptors used in the protocol’s commands. Packages follow an inheritance
model similar to object oriented programming, with some of those defined as “to be extended only”
providing only an indicative structure for proprietary implementation.
Some properties are read-only and others are read-write, for more information refer to H.248.1
Appendix E.
v1.15
81
8.4 Create MG Profile
Media gateway profile will contains all the required configuration parameters to bring up the Media
gateway stack.
Select MG from the side/top Configuration menu
Select Add New Profile
o Use default profile name, or specify one
Select Create Media Gateway Profile
Configure the MG Profile based on information received from our provider.
Select Update Media Gateway Profile to save
v1.15
82
Followings are the fields, that need to be configured.
Message Type IP-PORT IP-PORT Media gateway message identifier (MID) type
Identifier IP field will be used to build the message identifier
DOMAIN field which Media Gateway will use in all the
originating messages.
For example:
v1.15
83
CNG/CED, thus disabling T.38 faxing. Fax will go
through as G711 stream.
RTP IP any ipv4 addr Same as Signaling Megaco RTP source IP address.
IP. By default it should be set to SIgnaling IP
address, this way both signaling and media
originate from single IP address.
In VLAN scenarios it’s possible to use separate
IP addresses for Signaling and RTP.
any number NA RTP termination id prefix which Media Gateway
Termination-ID Prefix starting from 1 will use while allocating RTP terminations.
This variable is used as a name of RTP
termination. Eg: RTP/1, RTP/2 …
v1.15
84
8.5 Create MG Peer Profile
Each Media gateway profile will associate with one or multiple peers.
NOTE: As of now NSG supports only “one peer per MG profile”.
v1.15
85
Field Name Possible Default Description
values Values
For example:
Once the Media Peer is configured the Megaco configuration section is complete.
Proceed to TDM Termination for Media Gateway
v1.15
86
8.6 TDM Termination for Media Gateway
v1.15
87
8.6.1 Identify
In order to determine which physical T1/E1 port is: Port 1 Card 1
Select Identify button for Port 1 Card 1
The LED light will start flashing on a rear RJ45 T1/E1 port: rear panel.
Look at the rear panel of the appliance and plug in RJ45 cable to the blinking RJ45 T1/E1 port.
Once the Port 1 Card 1 is identified, the subsequent ports for that board are labeled.
Or alternatively keep using the Identify feature for each port.
NOTE
Identify picture of the device is always set to A108D – 8 T1/E1 card. The LED will always bling
port 1. The image is not meant to reflect the real hardware image, nor real port location. User
should always view the rear panel for the flashing LED.
All Sangoma TDM T1/E1 cards Port 1 is closest to the PCI slot.
v1.15
88
8.6.2 Edit T1/E1 Config
Once the port has been identified and plugged into the T1/E1 network.
Select Edit button for Port 1 Card 1 to configure the physical T1/E1 parameters.
Select the port configuration type: T1 or E1
o T1: North American Market and Japan
o E1: Europe and the world
Fill in Physical Configuration T1 or E1 parameters
o Fill in the T1/E1 parameters based on the provider provision document.
8.6.2.1
Standard T1/E1 Parameters
v1.15
89
In case advanced parameters are not necessary proceed
Apply to Port
o Applies the configuration for a single T1/E1 port
o (The one that is currently being edited)
Apply to all Ports
o Apply to all T1/E1 ports on a board.
o Bulk config feature
o (This feature saves time as T1/E1 ports are usually provisioned the same)
v1.15
90
8.6.2.2 Advanced T1/E1 Parameters
NOTE
After T1/E1 configuration, the NSG wizard will request Link Type Configuration.
v1.15
91
8.7 Span Link Type
When configuring TDM Terminations for Megaco Media Gateway there are two possibilities
Voice Mode
o All TDM channels are used for Voice 64kbs G.711
o Example: All channels 1-31 on an E1 line are used for voice
o Link Type = Voice Only
Mix Mode
o Voice 64kbs G.711 channels and SS7 signaling channels.
o Example: Channel 16 is used for SS7 signaling, 1-15,17-31 are used for voice.
o Link Type = Signaling Gateway (M2UA)
NOTE
The rest of this section will continue to document the Signaling Gateway (M2UA) option.
Next page will introduce the Signaling Gateway Overview, followed by the next config section in the
WebGUI.
v1.15
92
8.8 Signaling Gateway Overview
In Signaling gateway mode, NSG will bridge T1/E1 SS7 signaling link to IP and pass it transparently
to the MGC/Softswitch, via M2UA protocol. Looking at the diagram below, NSG Signaling Gateway
will configure:
v1.15
93
8.8.1 MTP1/2 Link Configuration
v1.15
94
Field Name Possible Default Value Description
Values
NOTE
Next section in WebUI will relate to M2UA configuration. Before we proceed however, the M2UA
interface architecture will be introduced in order to provide a big picture to the user.
v1.15
95
8.8.2 M2UA Interface
This section provides in-depth overview on how the M2UA interface is constructed. It should help the
user better understand the WebUI configuration objects for M2UA protocol.
SCTP interfaces are standalone objects on which a peer bind to (regardless of its cluster).
o 1 SCTP binds to 1 or more peers
o 1 peer binds to 1 SCTP
o Thus SCTP are shared across all peers
o SCTP cannot be deleted if used by any peer (even from another cluster).
o Deleting a peer or a cluster does not delete SCTP.
Peers are bound to cluster.
o 1 peer binds to 1 cluster
o 1 cluster binds to 1 or more peer
o Deleting a cluster will delete peers.
Cluster are bound to MTP2 through M2UA binding and nif interface
o 1 cluster binds to 1 or many MTP2 (through M2UA->NIF relationship)
o 1 MTP2 binds to 1 cluster through NIF interface binding
v1.15
96
8.8.3 M2UA Cluster Creation
Traffic Mode Load Share Load Share This parameter defines the mode in which this
Override Cluster is supposed to work.
Broadcast
Load Sharing Round Robin Round Robin This parameter defines the load share
Method Link Specified algorithm which is used to distribute the traffic
Customer
Specified
v1.15
97
8.8.4 M2UA Cluster Peers
v1.15
98
Include Disable Disable Flag used to indicate whether include the
ASP Enable ASP ID in the ASP UP message
Identifier
Initialize Disable Disable Flag used to indicate if M2UA SG has to start SCTP
SCTP Enable association or not.
Association
If Disable means M2UA SG will wait for SCTP association
request from MGC.
v1.15
99
8.8.5 SCTP Interface
v1.15
100
8.8.6 Binding all components
v1.15
101
8.8.7 Mixed Mode Configuration
NOTE
Rest of this section will document the Mixed Mode Configuration
v1.15
102
8.8.8 Bind Megaco to TDM
The last step of the configuration is to bind the TDM voice channels to Megaco Profile.
v1.15
103
Field Possible Values Default Value Description
Name
Media List of Gateways First in the List Select Megaco Profile that will be used to control the TDM
Gateway channels for this span.
Profile
Channels 1-15 and 17-31 are used for Voice and should
be controlled by Megaco
v1.15
104
Channel Map: 1-15,s16,17-31 (signaling on ch 16)
A1: channel 1
A2: channel 2
…
A15: channel 15
…
A16: not used – A16 points to signaling channel 16
A17: channel 17
A18: channel 18
…
A31: channel 31
v1.15
105
8.8.9 TDM Termination Complete
Next step is to repeat the process for the rest of the spans.
In typical configurations there is one or two spans (T1/E1 ports) that contain signaling
channels. The rest of the spans are usually voice only.
In voice only config, there is no Signaling Gateway configuration.
o The configuration jumps directly to “Bind TDM to Megaco” section of the WebUI.
NOTE
The changes made in the Configuration section of the WebUI are only stored one the scratch disk.
User MUST proceed to Apply page in the Management Section to save new configuration.
v1.15
106
9 SS7 ISUP
SS7 is a signaling protocol, it is used to carry call control information such as call start, call progress,
call hang-up etc. The SS7 call control information is used to control arbitrary number of voice
channels that are carried using T1/E1 spans.
In a typical SS7 setup the telco will provide you with SS7 information that will be used to map T1/E1
physical spans and channels into SS7 call control information.
The NSG TDM SS7 configuration page has been designed as bottom up SS7 configuration approach.
f. The Last step is to assign CIC values to each physical T1/E1 timeslot in the span.
Whether the Span carries only voice or it contains the SS7 Link, each timeslot must be
associated with a SS7 CIC value.
This way when an incoming SS7 Call Start message arrives with an arbitrary CIC value.
The NSG system can open the appropriate physical voice channel associated with the
CIC value.
v1.15
107
3. Once all T1/E1 spans are configured you need to Apply the configuration files.
Note that this step does not start the NSG gateway. It just writes the appropriate configuration
files.
4. Proceed to the Control Panel to start the NSG SS7 to VoIP Gateway.
v1.15
108
9.1 TDM SS7 Configuration Page
Select TDM from side/top Configuration menu
The TDM section will display all installed TDM Spans/Ports.
The TDM Configuration page will display to the user every T1/E1 card detected by NSG.
Each card is logically separated into ports, which initially displays the firmware version and the Echo
Cancellation security chip ID. If the echo cancellation security chip ID is 0, then the card installed
does not have echo cancellation. If there is a alert image next to the firmware version, that means the
firmware on the system is out of date, and must be updated in order to have the most up to date and
efficient firmware running.
v1.15
109
9.2 Port Identification
NOTE
Identify picture of the device is always set to A108D – 8 T1/E1 card. The LED will always bling
port 1. The image is not meant to reflect the real hardware image, nor real port location. User
should always view the rear panel for the flashing LED.
All Sangoma TDM T1/E1 cards Port 1 is closest to the PCI slot.
v1.15
110
9.3 Edit T1/E1 Config
Once the port has been identified and plugged into the T1/E1 network.
Select Edit button for Port 1 Card 1 to configure the physical T1/E1 parameters.
Select the port configuration type: T1 or E1
o T1: North American Market and Japan
o E1: Europe and the world
Fill in Physical Configuration T1 or E1 parameters
o Fill in the T1/E1 parameters based on the provider provision document.
v1.15
111
In case advanced parameters are not necessary proceed
Apply to Port
o Applies the configuration for a single T1/E1 port
o (The one that is currently being edited)
Apply to all Ports
o Apply to all T1/E1 ports on a board.
o Bulk config feature
o (This feature saves time as T1/E1 ports are usually provisioned the same)
v1.15
112
9.3.2 Advanced T1/E1 Parameters
NOTE
After T1/E1 configuration, the NSG wizard will request Link Type Configuration.
v1.15
113
9.4 Span Link Type
When configuring TDM Terminations for SIP to ISUP Media Gateway there are two possibilities
Voice Mode
o All TDM channels are used for Voice 64kbs G.711
o Example: All channels 1-31 on an E1 line are used for voice
o Link Type = Voice Only
Mix Mode
o Voice 64kbs G.711 channels and SS7 signaling channels.
o Example: Channel 16 is used for SS7 signaling, 1-15,17-31 are used for voice.
o Link Type = ISUP Termination
NOTE
The rest of this section will continue to document the ISUP Termination option.
In case of Voice Mode – the GUI will skip the ISUP configuration and proceed directly to
Channel Map Section below.
v1.15
114
9.5 SS7 Network Overview
v1.15
115
9.5.1 Links
physical signaling links between the TX board and the adjacent signaling points. One link
configuration must be performed for each physical signaling link. The attributes of a link
include the point code of the adjacent signaling point, protocol variant employed on the link
(ITU-T or ANSI), point code length, maximum packet length, various timer values, membership
in a linkset, and others.
9.5.2 Linksets
are groups of from one to 16 links that directly connect two signaling points. Although a linkset
usually contains all parallel signaling links between 2 SPs, it is possible to define parallel link
sets. Each signaling link defined is assigned membership in exactly one link set.
9.5.3 Routes
specify the destination signaling points (or sub-networks (clusters) when route masks are
employed) that are accessible from the target node. Each route is assigned a direction - up or
down. One up route is required for the actual point code assigned to the signaling point being
configured and for each point code that is to be emulated. Up routes are used to identify
incoming messages that are to be routed up to the applications/user parts. One down route is
required for each remote signaling point/network/cluster that is to be accessible from the SP
being configured.
v1.15
116
9.6 MTP2 Link Configuration
Proceed to configure the SS7 ISUP link that exists on a DS0 timeslot of a T1/E1 port.
The information required for the SS7 Link configuration must be provided by the Telco.
Next screen will confirm if the T1/E1 port contains a signaling link.
Please select YES if the SS7 signaling link exists on current T1/E1 port.
By selecting NO this T1/E1 port would not contain a signaling link, but the voice channels
would still be controlled by the ISUP signaling. Thus channel mapping would still apply.
v1.15
117
The following screen will configure the MTP1 and MTP2 protocol configuration of the SS7 Link.
CAUTION
The SLC configuration value MUST be unique for each SS7 Link, in case all SS7 Links belong
to same Link Set.
v1.15
118
Field Possible Default Description
Name Values Value
Link Any String Link1 Name to identify the SS7 Link. By default the GUI will select a unique
Name name.
Span This is readonly information field. Provides the user with span
number information.
Line This is readonly information field. Provide the user with T1/E1 link
Media type that has previously been configured.
Type
Signaling Single Digit 1-31 User must specify the DS0 location of the SS7 signaling channel. The
Channel timeslot number relates to physical DS0 channel.
Valid options are
E1: 1 to 31
T1: 1 to 24
A usual location of a SS7 signaling channel is 1 or 16.
Error Basic Basic MTP2 error correction type
Type PCR
Two forms of error correction are defined for an SS7 signaling link at
MTP2: the basic method and the PCR method.
Default: Basic
The basic method is generally applied to configurations in which the
one-way propagation delay is less than 40 ms,
Optional: PCR
PCR is applied on intercontinental signaling links in which the one-
way propagation delay is greater than 40 ms and on all signaling links
established via satellite.
The maximum supported signaling link loop (round trip) delay is 670
ms (the time between the sending of a message signal unit [MSU] and
the reception of the acknowledgment for this MSU in undisturbed
operation).
v1.15
119
ETSI
Linkset configuration on NSG GUI is based on Linkset profiles. It is designed so that multiple SS7
signaling links can use the same SS7 Linkset Profile. The term used when attaching links to linksets
in NSG is BIND. You have to bind a link to a linkset in order to proceed.
NOTE
If no Linkset profile exists, user will be directed to the Linkset profile creation page.
If Linkset profile already exists, user will be directed to Link profile list page. Where user will be
able create a Linkset profile or edit existing Linkset profile.
v1.15
120
Click on Create Profile once the configuration is completed.
NOTE
On very fist Linkset profile, the Link will automatically be BINDED to the Linkset.
Profile Any String LS1 Name to identify the SS7 Linkset. By default the GUI will select a
Name unique name.
Adjacent If ITU Point-code is an SS7 address for an element in the SS7 network.
Point integer: 1 to X
Code If ANSI The Adjacent point is the SS7 equipment which the signaling links
three integers terminate on. This equipment will also have a unique point code. This
separated by dash equipment may be either STP equipment or SSP equipment
depending on type of interconnect
v1.15
121
If ITU
Single integer number: eg 500
If ANSI
Three integers separated by dash: eg 100-200-400
v1.15
122
9.8 MTP3 SS7 Route
Route is a collection of linksets to reach a particular destination. A linkset can belong to more than
one route. Service Provider personnel statically maintain signaling endpoint routing tables. The
routing table identifies the links, linksets, primary routes, and alternate routes for each DPC. All links
in the linkset share the traffic load equally.
After a successful Linkset configuration, NSG GUI will present a user with Route Configuration
screen.
If no Route profiles exist, user will be presented with Route create page.
If a Route profile already exists, user will be presented with Route profile list. Where user will
be able to either create new Route or edit existing Route profile.
NOTE
If a new linkset needs to be attached to a route, the user must edit the route, then add the new
linkset to that route.
v1.15
123
The user will only need to edit a route if a new linkset is created on the system. If no new
linksets are created, the user will proceed directly to the channel map and CIC map
configuration
Profile Any String ROUTE1 Name to identify the SS7 Route. By default the GUI will select a
Name unique name.
Destination If ITU Point-code is an SS7 address for an element in the SS7 network.
Point Code integer: 1 to X
If ANSI The Destination Point of the SS7 network defines the switching
three integers equipment within the PSTN network which terminates the TDM
separated by dash interfaces of this interconnect. This point is also allocated a unique
point-code within the SS7 network. If the adjacent point is a SSP or
MSC interconnect the destination point will be the same as the
adjacent point.
Eg:
A-Link = APC differs from DPC
F-Link = APC is equal to DPC
v1.15
124
9.9 ISUP Interface Configuration
ISUP connects, manages, and disconnects all voice and data calls in the PSTN. ISUP sets up and
tears down the circuits used to connect PSTN voice and data subscribers.. ISUP is used in cellular or
mobile networks for trunking connections.
ISUP information is transferred in MTP3 messages similar to the other L4 protocols. The ISUP
section covers the following topics:
Like the linkset configuration and route configuration profiles, the ISUP Interface configuration is also
configured as profiles. It is setup so that 1 SS7 route can be attached to 1 ISUP Interface.
After a successful Route configuration, NSG GUI will present a user with Route Configuration screen.
If no ISUP profiles exist, user will be presented with ISUP create page.
If an ISUP profile already exists, user will be presented with ISUP profile list. Where user will
be able to either create new ISUP Interface Profile or edit existing ISUP Interface profile.
v1.15
125
Field Possible Values Default Description
Name Value
Profile Any String ISUP1 Name to identify the SS7 ISUP Interface profile. By default the GUI
Name will select a unique name.
Self If ITU Point-code is an SS7 address for an element in the SS7 network.
Point integer: 1 to X
Code If ANSI The Self Point Code /Originating Point describes the equipment that is
three integers interconnecting into the SS7 network. The originating point will be
separated by dash provided with a unique point-code by the network provider allowing for
identification of this point with in the SS7 network.
v1.15
126
Sefl Point Code is the address of the NSG SS7 Gateway in the SS7
network.
4-15(ANSI)
v1.15
127
T31 360 360 isup.t31 isup_interface
T33 12-15 12 isup.t33 isup_interface
T34 2-4 4 isup.t34 isup_interface
T35 15-20 15 isup.t35 isup_interface
T36 10-15 12 isup.t36 isup_interface
v1.15
128
9.10 ISUP CIC Channel Mapping
The last step of the configuration is to bind the TDM voice channels to ISUP Profile and map ISUP
CIC’s to the TDM timeslots.
v1.15
129
Field Possible Values Default Description
Name Value
Profile Any String CC1 Name to identify the SS7 Call Control profile. By default the GUI will
Name select a unique name.
ISUP List of existing ISUP Current ISUP Interface points to the list of currently defined ISUP Interface
Interface Interface profiles Profile profiles.
CAUTION
Improper mapping between CIC and Physical T1/E1 DS0 can
result in one way or no audio. Even though the call completes
successfully on SS7 signaling.
Channels 1-15 and 17-31 are used for Voice and should be controlled
by ISUP Interface
v1.15
130
Prefix Letters to signaling channel:
s: ISUP CIC id not used, id mapped to signaling channel
g: ISUP CIC id is used, id mapped to next available
voice channel.
Span Integer 1 Default group number used to dial out over a trunk group.
Group Usually the group number will correspond to the trunk group.
Number
v1.15
131
Field Possible Values Default Description
Name Value
ISUP List of existing ISUP Current ISUP Interface points to the list of currently defined ISUP Interface
Interface Interface profiles Profile profiles.
v1.15
132
Each ISUP profile defines its own Self-Point-Code/Origination Code.
With multiple ISUP profiles, one can configure a system with multiple
Self-Point-Codes.
CAUTION
Improper mapping between CIC and Physical T1/E1 DS0 can
result in one way or no audio. Even though the call completes
successfully on SS7 signaling.
Channels 1-15 and 17-31 are used for Voice and should be controlled
by ISUP Interface
v1.15
133
Channel Map: 1-15,s16,17-31 (signaling on ch 16)
CIC 1: channel 1
CIC 2: channel 2
…
CIC 15: channel 15
…
CIC 16: not used – A16 points to signaling channel 16
CIC 17: channel 17
CIC 18: channel 18
…
CC 31: channel 31
Span Integer 1 Default group number used to dial out over a trunk group.
Group Usually the group number will correspond to the trunk group.
Number
v1.15
134
10 Relay: SS7
NSG SS7 relay enables a single NSG gateway (master) to control multiple NSG gateways (slaves)
with as little as 1 signaling link connected to the master.
You can have up to 8 slave machines that are controlled by a single master gateway. Signaling
messages (MTP2 traffic) are passed over the IP network to the slave machines.
This following section will guide you through the configuration of the Relay mode to enable remote
control of the Slave gateways.
v1.15
135
10.1 Relay Configuration
Select NO if you do not want to enable Relay mode in your installation and proceed to the
next section to resume SS7 configuration.
v1.15
136
10.1.1 Configuring the master gateway
Select the Master option in step 2 and click "Next Step" to continue.
v1.15
137
In Step 3, you will generate an SSH key and download the public key that will be uploaded to all the
slave gateways. This key will enable a secure SSH connection between the master and the slave
machines to push the configurations.
The Relay Master will listen for incoming relay traffic on port 5000.
v1.15
138
Once the SSH key has been generated you will need to click on the "Add New Host" button to add 1
or more slave gateways to the relay configuration.
The listening relay port for all subsequent slave instances will increase by 1 port. Slave on node 2 will
listen on port 5001, Slave on node 3 will listen on port 5002, etc...
v1.15
139
Once you have configured all your slave hosts, you can now configure your slave machine(s)
v1.15
140
10.1.2 Configuring the slave gateway
v1.15
141
Select the SLAVE option in step 2 and click "Next Step" to continue.
v1.15
142
Upload the public key that you downloaded and saved when you configured the master gateway
earlier.
v1.15
143
Once the key has been uploaded, the SSH link will have been enabled.
Repeat these steps for all the slave machines and return to the master WebUI when you are
finished.
v1.15
144
10.1.3 Configuring the slave TDM configurations from the master gateway
The TDM configuration is presented in a tabbed pane, each tab represents a machine to configure.
Select the Slave tab to configure the slave gateway.
v1.15
145
Once you have completed configuring the master and slave(s) TDM configurations, you will click on
the "Generate config" button that will push the configuration to each slave over a secure SSH
connection. All this is done from the convenience of the master server's WebUIgateway’s web gui,
removing the need to log on to each slave server's WebUIgateway’s individually.
v1.15
146
11 ISDN Configuration
ISDN (PRI) is a signaling protocol, it is used to carry call control information such as call start, call
progress, call hang-up etc. The ISDN (PRI) call control information is used to control voice channels
on single T1 or E1. Thus for each T1/E1 span there will be timeslot dedicated for ISDN (PRI)
signaling.
T1 the ISDN signaling timeslot is 24
E1 the ISDN signaling timeslot is 16.
In a typical ISDN setup the telco will provide you with ISDN information that will be used to configure
the NVG gateway.
The NSG TDM ISDN configuration page has been designed as bottom up ISDN configuration
approach.
3. Once all T1/E1 spans are configured you need to Apply the configuration files.
Note that this step does not start the NSG gateway. It just writes the appropriate configuration
v1.15
147
files.
NOTE
Identify picture of the device is always set to A108D – 8 T1/E1 card. The LED will always bling
port 1. The image is not meant to reflect the real hardware image, nor real port location. User
should always view the rear panel for the flashing LED.
All Sangoma TDM T1/E1 cards Port 1 is closest to the PCI slot.
v1.15
148
11.2 Edit T1/E1 Config
Once the port has been identified and plugged into the T1/E1 network.
Select Edit button for Port 1 Card 1 to configure the physical T1/E1 parameters.
Select the port configuration type: T1 or E1
o T1: North American Market and Japan
o E1: Europe and the world
Fill in Physical Configuration T1 or E1 parameters
o Fill in the T1/E1 parameters based on the provider provision document.
v1.15
149
In case advanced parameters are not necessary proceed
Apply to Port
o Applies the configuration for a single T1/E1 port
o (The one that is currently being edited)
Apply to all Ports
o Apply to all T1/E1 ports on a board.
o Bulk config feature
o (This feature saves time as T1/E1 ports are usually provisioned the same)
v1.15
150
11.2.2 Advanced T1/E1 Parameters
NOTE
After T1/E1 configuration, the NSG wizard will request Link Type Configuration.
v1.15
151
11.3 Span Link Type
v1.15
152
11.4 ISDN Protocol Configuration
v1.15
153
11.5 Span Group Configuration
Specify the Span Group number
This option is used by the dialplan to route calls to specific T1/E1 spans.
Single group can contain all T1/E1 links or just a single one.
At this point the ISDN configuration is complete for the T1/E1 Span.
Repeat the configuration for each span, and then proceed to Apply Configuration so save and apply
configuration.
v1.15
154
12 MFC R2 Configuration
MFC R2 is a signaling protocol, it is used to carry call control information such as call start, call
progress, call hang-up etc. The MFC R2 call control information is used to control voice channels on
single E1 line. The MFCR2 protocol works on top of E1 CAS signaling.
E1 the CAS signaling timeslot is 16.
The NSG TDM ISDN configuration page has been designed as bottom up ISDN configuration
approach.
3. Once all T1/E1 spans are configured you need to Apply the configuration files.
Note that this step does not start the NSG gateway. It just writes the appropriate configuration
files.
v1.15
155
13 Media Transcoding Configuration
NSG will enable ALL Media Codec’s by default. There is no extra configuration needed.
Use this configuration page in case you want to limit which codecs should be enabled, or disable
media codec support.
NOTE
At this point the codec selection is over. One can proceed to Media hardware discovery in the
Advanced Options of the Media page.
v1.15
156
13.1 Media Hardware
Once Codec selection has been made, proceed to Advanced Options section of the Media page.
Select SCAN
o This step will auto-detect all NSG transcoding resources
Confirm that GUI detected exact number of transcoding resources as installed.
User has an option of changing the assigned Local IP address of the Media device.
NOTE
At this point the Media configuration is complete.
Proceed to the next section, or
If finished all gateway configuration, proceed to Apply to generate configs.
v1.15
157
14 Applying Configuration
The changes made in the Configuration section of the WebUI are only stored one the scratch disk.
User MUST proceed to Apply page in the Management Section to save new configuration.
CAUTION:
The generate config option will not be offered in case NSG gateway is started. Confirm that
NSG is fully stopped in Control Panel before Applying configuration.
v1.15
158
NOTE
After configuring the NSG endpoint/protocol configuration, proceed to Dialplan to configure the
routing rules.
v1.15
159
15 Dialplan
When a call is received in the NetBorder SS7 Gateway, from SIP,H232 or SS7 the dialplan is fetched
to retrieve the route information to find the outgoing call location.
Note: Dialplan is not used in MG/Megaco/H.248 mode: MGC performs the routing.
v1.15
160
Dialplan is pre-configured for
Note that default dial plans allow for unchallenged SIP INVITEs. Normally this is OK for equipment
that is installed in private networks or behind Session Border Controllers. However, should the SS7
Gateway be installed on a public IP address, the dial plan needs to be modified to block these
requests to mitigate security risks. Note however that NSG is not a security device, it is a VoIP
Gateway. Sangoma recommendeds to use Session Border Controller to secure VoIP Networks.
Note that Dialplan can be modified in real time without the need to restart the gateway.
Once you Save the Dialplan, you will be prompted to Reload the gateway which will apply the
changes without any service interrupt. All the currently established calls will not be affected. Only the
newly established calls will start using the new dialplan rules.
v1.15
161
15.2 PSTN to SIP Dialplan
By default NSG is setup to send an call to a SIP IP address. The remote SIP address must be
configured in Configuration -> Global section.
<context name="from-pstn-to-sip">
<extension name="to-sip">
<!-- handle the case where there might not be destination number at all -->
<condition field="destination_number" expression="^(.{1,})$" break="never">
<action application="set" data="destnumber=$1"/>
<anti-action application="set" data="destnumber=unknown"/>
</condition>
<!-- Dial to the gateway user (it may ring multiple registrations, first answer wins) -->
<condition field="destination_number" expression="^(.*)$">
<action application="set" data="hangup_after_bridge=yes" />
<action application="set" data="tone_detect_hits=1" />
<action application="export" data="fax_enable_t38_request=true" />
<action application="export" data="fax_enable_t38=true" />
<action application="tone_detect" data="faxdisable 1100 r +5000 disable_ec 1"/>
<action application="export" data="execute_on_answer=tone_detect fax_disable_ec 2100 r +5000
t38_gateway 'self nocng'" />
<action application="set" data="sip_contact_user_replacement=${destnumber}"/>
<action application="set" data="hangup_after_bridge=yes"/>
<action application="bridge" data="sofia/internal/${destnumber}@${sip_dest_ip}:${sip_dest_port}"/>
<action application="hangup" data="${originate_disposition}"/>
</condition>
</extension>
</context>
v1.15
162
15.3 PSTN to H323 Dialplan
By default NSG is setup to send a call to an H323 IP address. The remote H323 address must be
configured in Configuration -> Global section.
<context name="from-pstn-to-h323">
<extension name="to-h323">
<!-- handle the case where there might not be destination number at all -->
<condition field="destination_number" expression="^(.{1,})$" break="never">
<action application="set" data="destnumber=$1"/>
<anti-action application="set" data="destnumber=unknown"/>
</condition>
<!-- Dial to the gateway user (it may ring multiple registrations, first answer wins) -->
<condition field="destination_number" expression="^(.*)$">
<action application="set" data="hangup_after_bridge=yes" />
<action application="set" data="tone_detect_hits=1" />
<action application="export" data="fax_enable_t38_request=true" />
<action application="export" data="fax_enable_t38=true" />
<action application="tone_detect" data="faxdisable 1100 r +5000 disable_ec 1"/>
<action application="export" data="execute_on_answer=tone_detect fax_disable_ec 2100 r +5000
t38_gateway 'self nocng'" />
<action application="set" data="sip_contact_user_replacement=${destnumber}"/>
<action application="set" data="hangup_after_bridge=yes"/>
<action application="bridge" data="opal/h323:${destination_number}@${h323_remote_ip}"/>
<action application="hangup" data="${originate_disposition}"/>
</condition>
</extension>
</context>
</include>
v1.15
163
15.4 SIP/H323 to PSTN Dialplan
Note that both SIP and H323 profiles share the same “from-sip” context name name. The from-sip
context will pass all calls to TDM interfaces.
<context name="from-sip">
<extension name="to-pstn">
<!-- check if there is a group and set a default if not present -->
<condition field="${group}" expression="^-g=([a-zA-Z0-9]+)$" break="never">
<action application="set" data="group=$1"/>
<anti-action application="set" data="group=$${pstn_default_group}"/>
</condition>
<!-- check if there is a hunting policy and set a default if not present -->
<condition field="${hunting}" expression="^-h=([a|A])$" break="never">
<action application="set" data="hunting=$1"/>
<anti-action application="set" data="hunting=${pstn_default_hunting}"/>
</condition>
v1.15
164
15.5 Dialplan Syntax
There are several elements used to build an XML dialplan. In general, the dialplan groups logically
similar functions and calling activities into a 'context'. Within a context are extensions, each with
'condition' rules and associated 'actions' to perform when the condition rules match.
The following is a sample dialplan to illustrate these concepts. We have left out the XML "wrapper" to
help make the basic concepts more clear:
<context name="example">
<extension name="500">
<condition field="destination_number" expression="^500$">
<action application="bridge" data="user/500"/>
</condition>
</extension>
<extension name="501">
<condition field="destination_number" expression="^501$">
<action application="bridge" data="user/501"/>
<action application="answer"/>
<action application="sleep" data="1000"/>
<action application="bridge" data="loopback/app=voicemail:default ${domain_name} ${dialed_extension}"/>
</condition>
</extension>
</context>
Each rule is processed in order until you reach the action tag which tells NSG what action to perform.
You are not limited to only one condition or action tag for a given extension.
In our above example, a call to extension 501 rings the extensions. If the user does not answer, the
second action answers the call, and following actions delay for 1000 milliseconds (which is 1 second)
and connect the call to the voicemail system.
v1.15
165
15.5.1 Context
Contexts are a logical grouping of extensions. You may have multiple extensions contained within a
single context.
The context tag has a required parameter of 'name'. There is one reserved name, any, which
matches any context. The name is used by incoming call handlers (like the [Sofia] SIP driver) to
select the dialplan that runs when it needs to route a call. There is often more than one context in a
dialplan.
A fully qualified context definition is shown below. Typically you'll not need all the trimmings, but they
are shown here for completeness.
<?xml version="1.0"?>
<document type="freeswitch/xml">
<section name="dialplan" description="Regex/XML Dialplan">
<!-- the default context is a safe start -->
<context name="default">
<!-- one or more extension tags -->
</context>
<!-- more optional contexts -->
</section>
</document>
v1.15
166
15.5.2 Extensions
Extensions are destinations for a call. This is the meat of NSG routing dialed numbers. They are
given a name and contain a group of conditions, that if met, will execute certain actions.
A 'name' parameter is required: It must be a unique name assigned to an extension for identification
and later use.
For example:
NOTE: Typically when an extension is matched in your dialplan, the corresponding actions are
performed and dialplan processing stops. An optional continue parameter allows your dialplan to
continue running.
v1.15
167
15.5.3 Conditions
Dialplan conditions are typically used to match a destination number to an extension. They have,
however, much more power than may appear on the surface.
NSG has a set of built-in variables used for testing. In this example, the built-in
variable destination_number is compared against the regular expression ^500$.
This comparison is 'true' if <destination_number> is set to 500.
<extension name="500">
<condition field="destination_number" expression="^500$">
<action application="bridge" data="user/500"/>
</condition>
</extension>
Each condition is parsed with the Perl Compatible Regular Expression library. (go here for PCRE
syntax information).
If a regular expression contains any terms wrapped in parentheses, and the expression matches, the
variables $1,$2..$N will be set to the matching contents within the parenthesis, and may be used in
subsequent action tags within this extension's block.
For example, this simple expression matches a four digit extension number, and captures the last two
digits into $1.
A destination number of 3425 would set $1 to 25 and then bridge the call to the phone
at 25@example.com
v1.15
168
15.5.4 Multiple Conditions (Logical AND)
You can emulate the logical AND operation available in many programming languages using multiple
conditions. When you place more than one condition in an extension, all conditions must match
before the actions will be executed. For example, this block will only execute the actions if the
destination number is 500 AND it is Sunday.
Keep in mind that you must observe correct XML syntax when using this structure. Be sure to close
all conditions except the last one with />. The last condition contains the final actions to be run, and is
closed on the line after the last action.
By default, if any condition is false, NSG will move on to the anti-actions or the next extension without
even evaluating any more conditions.
v1.15
169
15.5.5 Multiple Conditions (Logical OR, XOR)
It is possible to emulate the logical OR operation available in many programming languages, using
multiple conditions. In this situation, if one of the conditions matches, the actions are executed.
For example, this block executes its actions if the destination number is 501 OR the destination
number is 502.
This method works well if your OR condition is for the same field. However, if you need to use two or
more different fields then use the new regex syntax
Using this method it becomes easier to match the caller's name OR caller ID number and execute
actions whether either is true.
A slightly more advanced use of this method is demonstrated here:
<condition>
<action application="answer"/>
v1.15
170
<action application="sleep" data="500"/>
<action application="playback" data="ivr/ivr-welcome_to_freeswitch.wav"/>
<action application="sleep" data="500"/>
</condition>
Basically, for this new syntax you can have a condition to have a "regex" attr instead of "field" and
"expression" etc. When there is a "regex" attr, that means you plan to have one or more <regex> tags
that are similar to the condition tag itself that it has field and expression in it.
The value of the "regex" attr is either "all" or "any" or "xor indicating if all expressions must match or
just any expression or only one must match(xor) . If it's set to "any" it will stop testing the regex tags
as soon as it finds one match, if it is set to "all", it will stop as soon as it finds one failure.
From there it will behave like a normal condition tag either executing the actions or anti-actions and
breaking based on the "break" attr.
The basic difference here is once there is a "regex" attr, the <regex> tags parsed for "all" or "any"
take the place of the single "field" and "condition"
NOTE: Also, if any captures are done in the "expression" attrs of a <regex> tag, only the data from
the newest capture encountered will be considered in the $n expansion or FIELD_DATA creation. In
addition, you can set DP_REGEX_MATCH_1 .. DP_REGEX_MATCH_N to preserve captures into
arrays.
<extension name="Inbound_external">
v1.15
171
<condition regex="any">
<regex field="${sip_from_host}" expression="domainA"/>
<regex field="${sip_from_uri}" expression="1234567890@domainB"/>
<regex field="${sip_from_uri}" expression="user@domainC"/>
<regex field="caller_id_name" expression="^(John Smith)$"/>
<regex field="caller_id_number" expression="^(55512341)|(55512342)|(55512343)$"/>
This is another example to show that all regex conditions must be true, then the action will get
executed; otherwise, the anti-action will. This is the same logic as follows:
Basically, the <condition regex="all"> tells the parser, "Hey, execute the <action>'s only if all regexes
PASS, otherwise execute any <anti-action>'s".
<condition regex="all">
<regex field="${sip_gateway}" expression="^${default_provider}$"/>
<regex field="${emergency_call}" expression="^true$"/>
<regex field="${db(select/emergency/autoanswer)}" expression="^1$"/>
<!-- the following actions get executed if all regexes PASS -->
<action application="set" data="call_timeout=60"/>
<action application="set" data="effective_caller_id_name=${regex(${caller_id_name}|^Emerg(_.*)$|Auto%1)}"/>
<action application="set" data="autoanswered=true"/>
<action application="bridge" data="user/1000@${domain_name},sofia/gateway/1006_7217/${mobile_number}"/>
<!-- the following anti-actions are executed if any of the regexes FAIL -->
<anti-action application="set" data="effective_caller_id_name=${regex(${caller_id_name}|^Emerg(_.*)$|NotAuto%1)}"/>
<anti-action application="set" data="call_timeout=30"/>
<anti-action application="set" data="autoanswered=false"/>
v1.15
172
<anti-action application="bridge" data="user/1000@${domain_name},sofia/gateway/1006_7217/${mobile_number}"/>
</condition>
Here is a more complex example, performing time-based routing for a support organization. The user
dials extension 1100. The actual support extension is 1105 and is staffed every day from 8am to
10pm, except Friday, when it is staffed between 8am and 1pm. At all other times, calls to 1100 are
sent to the support after-hours mailbox.
<extension name="Time-of-day-tod">
<!--if this is false, FreeSWITCH skips to the next *extension*.-->
<condition field="destination_number" expression="^1100$" break="on-false"/>
<condition> <!--this is a catch all, sending the call to voicemail at all other times. -->
<action application="voicemail" data="default ${domain} 1105"/>
</condition>
</extension>
In this example, we use the break=never parameter to cause the first condition to 'fall-through' to the
next condition no matter if the first condition is true or false. This is useful to set certain flags as part
v1.15
173
of extension processing. This example sets the variable begins_with_one if the destination number
begins with 1.
<extension name="break-demo">
<!-- because break=never is set, even when the destination does not begin
with 1, we skip the action and keep going -->
<condition field="destination_number" expression="^1(\d+)$" break="never">
<action application="set" data="begins_with_one=true"/>
</condition>
v1.15
174
15.5.7 Variables
Condition statements can match against channel variables, or against an array of built in variables.
v1.15
175
For example:
15.5.7.2
Caller Profile Fields vs. Channel Variables
One thing that may seem confusing is the distinction between a caller profile field (the built-in variables)
and a channel variable.
Caller profile fields are accessed like this:
Please take note of the ${variable_name} syntax. Channel variables may also be used in action
statements. In addition, API functions can be called from inside a condition statement to provide
dynamic data.
This example tests ${my_var}. If it is more than 12, "YES" is returned. Otherwise "NO" is returned.
The condition tests the results for "YES" and logs the resulting message to the NSG log.
v1.15
176
16 Backup Restore System
Appliance configuration can be backed up to a zipped file.
Appliance can be restored from a same file.
v1.15
177
16.1 Restore a System
CAUTION
After a system has been restored via WebGUI a reboot is mandatory.
After a reboot
v1.15
178
16.2 Restore to a new System
It is possible to back-up a working system, and restore the configuration to another target system,
with the intent of quickly provisioning a new target system.
However as backup will duplicate the current system, this is only useful in the case where original
system failed and is being replaced.
License
The license is going to be invalid on a new system. Thus user must update the system with
correct license after the restore from the backup.
IP Settings
IP settings are going to be duplicated and most likely invalid if the original system is still
functioning. Thus user must go into the IP Settings section and update the local IP settings.
VLAN
VLAN IP settings are going to be duplicated and most likely invalid if the original system is still
functioning. Thus user must go into the VLAN Settings section and update to new values.
Megaco/SIP/H323
All IP settings will most likely have to change.
TDM Spans
Target system must have identical T1/E1 spans installed as the source system. If TDM
installation is not identical there could be port mismatches or configuration errors, which will
cause the system to fail.
If provisioning from backing is the goal then user would have to edit the backup files manually to
update above settings before restoring to a target system.
This is not recommended and requires expert level understanding of the backup files and manual
configuration files. Which defeats the purpose of the WebGUI.
NOTE
Sangoma has a product roadmap plan for mass system provisioning.
If this is of interest please contact Sales.
v1.15
179
17 Factory Reset & Reboot
17.1 Factory Reset
CAUTION
If you do not hear the factory reset sound and system reboots, you have triggered a soft reboot
sequence.
o Once system comes back up, re-try the factory reset sequence.
NOTE
A soft reboot can be triggered via WebGUI or USB CLI
WebGUI -> System -> Shutdown.
USB CLI -> reboot command
v1.15
180
18 Upgrade
User has three choices when upgrading NSG system.
v1.15
181
18.2 Console SSH Update
NSG product uses Linux RPM as part of its package management system.
NOTE
Using NSG console to upgrade the system is very powerful, as the process can be scripted
and centralized. This way all NSG appliances in the files can be upgraded from a single
upgrade machine in the NOC.
v1.15
182
19 Operations
v1.15
183
When the Gateway starts successfully the green status bar will appear.
System is now running.
NOTE
Before attempting to pass traffic through the gateway, proceed to TDM Status to check the
state of the NSG gateway. There is no point of attempting calls while the status of the
gateway protocol is down.
v1.15
184
19.2 Profile Panel
Profile Panel is used for on the fly configuration without disrupting gateway service.
The NSG Gateway has to be started in order to use the Profile Panel.
Each MG Profile is grouped with the TDM Spans associated with it.
Sync/Stop actions will only affect the selected MG Profile and Spans that are not in Sync.
Adjacent MG Profiles will not be affected.
Configuration
Select Profile Panel from side/top Overview Menu
Select Sync Button to apply and start new configuration.
v1.15
185
Column Description
In Use Indicates whether the profile is currently running in NSG Gateway
Config Indicates whether the profile configuration in database is in sync with what is currently
running in the gateway.
Sync Button Configure and Start any profile that is In Active or out of Sync.
Sync operation WILL NOT disrupt service of TDM Spans that are in sync.
Sync operation WILL Restart the MG (Megaco) profile in order to update termination
ids.
Stop Button Used to stop the whole MG Profile and associated TDM Spans.
Note
This feature is part of NSG 5.0.1 release and is only supported for MG Profiles.
v1.15
186
19.3 Gateway Status
19.3.1 Megaco/M2UA TDM
The TDM Stats page displays the unified status of all NSG components
v1.15
187
Field Name Description
Port Physical Port number. Identifies the hardware resource and T1/E1 port number.
The T1/E1 port number relates to the T1/E1 board.
v1.15
188
19.3.1.1 Physical T1/E1 Alarms
v1.15
189
19.3.1.2 Data Link MTP2 Alarms
v1.15
190
19.3.1.4 Remote Megaco Alarms
NOTE
For more information on how to debug each section please refer to the Troubleshooting section.
v1.15
191
19.4 Megaco Status
Megaco Status page provides detailed Megaco call statistics per Megaco Profile.
v1.15
192
Reports
NOTE
All error events will be displayed in RED for easy identification.
v1.15
193
Log Description
Driver TDM device driver log.
All errors will be identified in RED
This log will show
TDM Driver startup sequence
TDM T1/E1 connection/disconnection
TDM Driver general errors
System errors
OS Errors
Gateway SS7 to VoIP Gateway log
All errors will be identified in RED
This log will show
Gateway startup sequence
Gateway startup errors
Gateway run time errors and warnings
Media Media Transcoding log
All errors will be identified in RED
This log will show
Media Transcoding server startup sequence
Media startup errors
Media transcoding run time errors and warnings
When working with Sangoma support, you will be asked to download and submit the NSG logs.
Select Download Logs Button
Save the zipped file to your computer
Send the zipped debug package to Sangoma Support
v1.15
194
19.6 Advanced Logs
Detailed historical logs can be found in Advanced Logs Section. This page can be used to determine
historical alarm, events and errors.
Files Description
messages Displays kernel and driver level Filter Description
messages. Including all T1/E1 status
E1 All E1 messages
changes or error messages.
E1.*con All E1 connected & disconnected
messages
: ON All T1/E1 Alarms ON events
: OFF All T1/E1 Alarms OFF events
Error All Error messages
wanpipe All T1/E1 driver messages
nsg/sangomagw.log Display all NSG gateway logs. Filter Description
ERR All Error Messages
WARN All Warning Messages
sngtc_server.log Displays all Media Transcoding logs Filter Description
ERR All Error Messages
WARN All Warning Messages
v1.15
195
v1.15
196
19.7.1 Ethernet Capture Filter Options
For example:
vlan 100 && vlan 200
filters on VLAN 200 encapsulated within VLAN 100, and
vlan && vlan 300 && ip
filters IPv4 protocols encapsulated in VLAN 300
encapsulated within any higher order VLAN.
tcp, udp, icmp True if protocol matches
not <port> | not <ip> Exclude a port/ip/protocol out of the trace
NOTE
Please refer to tcpdump documentation for more info.
v1.15
197
20 Monitoring & Management
NSG Currently offers number of monitoring and management options
SNMP
Web GUI Status
SSH CLI (Scripting)
20.1 SNMP
Simple Network Management Protocol (SNMP) is an "Internet-standard protocol for managing
devices on IP networks." Devices that typically support SNMP include routers, switches, servers,
workstations, printers, modem racks, and more." It is used mostly in network management systems to
monitor network-attached devices for conditions that warrant administrative attention. SNMP is a
component of the Internet Protocol Suite as defined by the Internet Engineering Task Force (IETF). It
consists of a set of standards for network management, including an application layer protocol, a
database schema, and a set of data objects
SNMP Version3 requires user authentication, and is more secure than versions 1 & 2.
v1.15
198
20.2 SNMP Configuration
To configure SNMP proceed to System -> Services from the side/top System menu.
Select SNMP service Configure Button
NOTE: Before configuring SNMP service, the SNMP service must be stopped.
v1.15
199
Select SNMP Version 1&2 or 3
SNMP Version 3 requires user authentication
o Please specify a username and password
Click Apply to save.
In order to confirm NSG responds to SNMP requests, one can use number of standard snmp client
tools to obtain system information.
or
This should show some basic information about the system including:
SNMPv2-MIB::sysDescr.0 = STRING: Linux nsg-nc-43.sangoma.local 2.6.39-4.sng2 #1 SMP Wed Dec 21 17:26:48 EST
2011 i686
SNMPv2-MIB::sysObjectID.0 = OID: NET-SNMP-MIB::netSnmpAgentOIDs.10
DISMAN-EVENT-MIB::sysUpTimeInstance = Timeticks: (176243) 0:29:22.43
SNMPv2-MIB::sysContact.0 = STRING: Root <root@localhost> (configure /etc/snmp/snmp.local.conf)
SNMPv2-MIB::sysName.0 = STRING: nsg-nc-43.sangoma.local
SNMPv2-MIB::sysLocation.0 = STRING: Unknown (edit /etc/snmp/snmpd.conf)
SNMPv2-MIB::sysORLastChange.0 = Timeticks: (0) 0:00:00.00
SNMPv2-MIB::sysORID.1 = OID: SNMPv2-MIB::snmpMIB
SNMPv2-MIB::sysORID.2 = OID: TCP-MIB::tcpMIB
SNMPv2-MIB::sysORID.3 = OID: IP-MIB::ip
SNMPv2-MIB::sysORID.4 = OID: UDP-MIB::udpMIB
SNMPv2-MIB::sysORID.5 = OID: SNMP-VIEW-BASED-ACM-MIB::vacmBasicGroup
SNMPv2-MIB::sysORID.6 = OID: SNMP-FRAMEWORK-MIB::snmpFrameworkMIBCompliance
SNMPv2-MIB::sysORID.7 = OID: SNMP-MPD-MIB::snmpMPDCompliance
SNMPv2-MIB::sysORID.8 = OID: SNMP-USER-BASED-SM-MIB::usmMIBCompliance
…
IF-MIB::ifDescr.2 = STRING: eth0 (Primary Ethernet Port)
IF-MIB::ifDescr.3 = STRING: eth1 (Secondary Ethernet Port)
v1.15
200
IF-MIB::ifDescr.4 = STRING: eth2 (Media Transcoding Port)
IF-MIB::ifDescr.6 = STRING: eth1.1302 (VLAN)
IF-MIB::ifDescr.7 = STRING: eth1.1301 (VLAN)
IF-MIB::ifDescr.8 = STRING: eth1.1300 (VLAN)
IF-MIB::ifDescr.11 = STRING: w1g1 (T1/E1 TDM Port)
Note that all TDM interfaces/spans have the following nomenclature: “w<SPAN>g<CHAN>”
w1g1 translates to SPAN 1
w2g1 translates to SPAN 2
w31g1 translates to SPAN 31
v1.15
201
21 Troubleshooting
In any network troubleshooting it is best to start from the bottom.
wanpipemon options
o -rx rx only
o -tx tx only
o -diff different frames only
v1.15
202
21.1 Physical Layer
The first step in troubleshooting any connectivity issue is troubleshooting the physical layer.
Identifying whether a user has a physical layer issue is by using the TDM Status page and checking
the MTP-1/M2UA column.
If the column is listed as "DOWN" for that particular port, proceed with troubleshooting the physical
layer.
When physical layer is down, all layers above the physical layer will also be in a "DOWN" or
"TRYING" state.
In order to start troubleshooting, the user must proceed to the "Command Execution" page, which is
located under the "Configuration" menu.
The best way to troubleshoot physical layer issues is through the shell command option. Below is a
list of commands that can be run within the shell command section to help diagnose issues:
v1.15
203
21.1.1 NSG TDM Driver related commands
wanpipemon -i wXg1 -c Ta
o where X is the span/port number in question.
o Span number can be found in GUI -> TDM section for each physical T1/E1 port
o Output low level T1/E1 Alarms
wanrouter status
o Output wanpipe physical status statistics
v1.15
204
21.1.2 T1/E1 Port Status
The first step in debugging physical layer issues would be to check whether wanrouter status reports
the line "Connected" or "Disconnected". To do this, within the "Shell Command" textbox, enter the
command "wanrouter status". It will return a result like the one below:
All the devices running on a NSG system will be listed as a "wanpipe" device. In this example,
"wanpipe1" is being reported as "Disconnected", which tells us that the physical layer is in fact in a
"DOWN" state.
In this example, "wanpipe1" is in a disconnected state, therefore the interface name would be "w1g1".
The command returns an output similar to the one below:
-> wanpipemon -i w1g1 -c Ta
v1.15
205
Check for Short or Possibly a bad cable
Open Circuit Try another cable
Possibly a bad T1/E1 port on NSG
Unplug the E1 from NSG and run NSG self-test to confirm
v1.15
206
Check Alarms
RED Indicates the device is in alarm
(Loss of Framing).
Raised after four consecutive frames with FAS error.
LOF
If RAI and AIS alarms are not indicated, verify that you have selected the
proper line framing (i.e T1: ESF, D4, E1:CRC4, NCRC4..etc)
(Remote Alarm Indication): Indicates that the Far end (typically the Telco)
is
in RED alarm state and sending that message over the line.
You will also get this alarm, and only this alarm, if your framing is
incorrect. This setting can be changed in the TDM Section.
The wires in your cable connected to the port are crossed. If you see this
alarm, check the pinouts for the cable you are using.
Short
Circuit
You may also be plugging in the wrong form of cable (straight-through, or
cross-over)
No line plugged into the port. Make sure that your connector is plugged in
Open and the wiring is making a good connection.
Circuit
If this alarm is on, you will also Rx Level='-36'->'-44'.
Loss of Cabling issue. Check the health of the cable plugged into the port, as well
Signal as its connection to the port it is plugged into.
v1.15
207
You will also see the Rx Level either very low, or in a disconnected state: -
36 -> -44. It is typical to have this alarm triggers in combination with 'Open
Circuit' if there is an issue with the physical connection
Line Code
This occurs upon a bipolar violation
Violation
is reported by the upstream end of the PHY (the wire between you and the
switch) on the out-of-band management channel.
Far End
Block This means the other end of the line received bad data from you. Possible
Errors reason are: line noise, corroded wires..etc.
CRC4 This occurs when the CRC polynomial calculation performed before
Errors transmission does not match the CRC calculation done upon reception.
Check Clock Note that NSG will not come out of Alarm state if there is NO clock on the T1/E1 line.
v1.15
208
21.2 TDM Signaling Link Debugging
Check for Rx signaling Proceed to GUI -> Reporting -> Packet Capture
packets. Trace RX only packets on TDM T1/E1 port that contains a signaling link
eg: w1g1 – port 1
eg: w2g1 – port 2
Select RX Only
Start Trace
Wait a minute
Stop Trace
Download and open in Wireshark
Check for Tx signaling Proceed to GUI -> Reporting -> Packet Capture
packets Trace RX only packets on TDM T1/E1 port that contains a signaling link
eg: w1g1 – port 1
eg: w2g1 – port 2
Select TX Only
Start Trace
Wait a minute
Stop Trace
Download and open in Wireshark
Caution: TX trace will only capture different FISU and LSSU due to hw optimization.
Capture all Signaling Proceed to GUI -> Reporting -> Packet Capture
traffic and open in Trace Different only packets on TDM T1/E1 port that contains a signaling link
Wireshark eg: w1g1 – port 1
v1.15
209
eg: w2g1 – port 2
Select Different only packets
Start Trace
Wait a minute
Stop Trace
Download and open in Wireshark
MTP2
Check for LSSU size mismatch
ISUP
Check for wrong OPC/SPC, APC, DPC
v1.15
210
22 Appendix
v1.15
211
EMI NOISE FILTER: FCC CLASS A, CISPR22 CLASS A
SAFETY: UL 1950, CSA 22.2 NO/ 950, TÜV IEC 950
REMOTE ON / OFF CONTROL
THE UNIT SHALL ACCEPT A LOGIC OPEN COLLECTOR LEVEL WHICH WILL
DISABLE / ENABLE ALL THE OUTPUT VOLTAGE (EXCLUDE +5V STANDBY), AS
LOGIC LEVEL IS LOW, OUTPUTS VOLTAGE WERE ENABLE, AS LOGIC LEVEL IS
HIGH, OUTPUTS VOLTAGE WERE DISABED
COOLING : TWO 40 mm DC FANS (MODULE)
AC INLET IN EACH MODULE
v1.15
212
22.1.2 Hot-swap procedures
Locate the defective power module by examining the individual LED (if LED is distinguished, it
indicates the power module is defective).
*** WARNING
please perform the following step carefully; otherwise, it may cause the whole system
shutdown.
*** WARNING
Please do not remove the defective power module until you have worn gloves to keep from
been burned. This is due to the cover of the power module is used as heat sink for cooling.
Usually, its temperature is around 50-60 degree Celsius under full load condition.
*** WARNING
please put aside the power module to wait for cooling down. Keep other people from toughing
it until it is cooled.
Replace a new / GOOD power module. Insert the power module into the power system till to
the end.
Check the LED of the power module, which should be in GREEN.
Check the warning LED indicating the status of total power system, which should be in
GREEN.
Tighten the screws of the power module.
If you want to test this new power module and simulate the defective situation, please refer to
Section 1.7 Installation & Testing.
Remarks: If the DC fan of the power module fails, you have to replace the power module.
Please follow the Hot-Swap Procedures for replacement.
v1.15
213
22.1.3 Trouble Shooting
Check all connection (if pinouts is correct, if any connection loosed, if the direction is
incorrect,… etc.).
Check if any short-circuit or defective peripherals by plugging out the power connector from
each peripheral, one at a time. Shall the system functions again, you have solved the problem.
Once you hear the buzzer sound or see the warning LED in RED, please check,
If the loading is under the minimum or over the maximum load of each channel.
If the power source is well connected and supplied. Shall the above condition is happened,
please disconnect the power source and wait for 2-3 minutes to release the protection status;
then test it again.
If buzzer keeps alarming or LED indicates the power module failure, please locate which
power module is defective. Perform hot-swap procedures (ref. to Sec. 1.8 Hot-Swap
Procedures). Return the defective power module back to your vendor for RMA procedure.
If you cannot fix the problem, please contact your vendor for supporting.
Note:
* The description stated herein is subject to change without prior notice.
* All brand names and trademarks are the property of their respective owners.
v1.15
214
23 Theory
v1.15
215
v1.15
216
v1.15
217
v1.15
218
v1.15
219
v1.15
220
v1.15
221
v1.15
222
v1.15
223
v1.15
224
v1.15
225
v1.15
226
v1.15
227
v1.15
228
v1.15
229
v1.15
230
v1.15
231
v1.15
232
v1.15
233
v1.15
234
v1.15
235
v1.15
236
v1.15
237
v1.15
238
v1.15
239
v1.15
240
v1.15
241
v1.15
242
v1.15
243
v1.15
244
v1.15
245
v1.15
246
v1.15
247
v1.15
248
v1.15
249
v1.15
250
v1.15
251
v1.15
252
v1.15
253
v1.15
254
v1.15
255
v1.15
256
v1.15
257
v1.15
258
v1.15
259
v1.15
260
v1.15
261
v1.15
262
v1.15
263
v1.15
264
v1.15
265
v1.15
266
v1.15
267
v1.15
268
v1.15
269
v1.15
270
v1.15
271
v1.15
272
v1.15
273
v1.15
274
v1.15
275
v1.15
276
v1.15
277
v1.15
278
v1.15
279
v1.15
280
v1.15
281
v1.15
282
v1.15
283
v1.15
284
v1.15
285
v1.15
286
v1.15
287
v1.15
288
v1.15
289
v1.15
290
v1.15
291
v1.15
292
v1.15
293
v1.15
294
v1.15
295
v1.15
296
v1.15
297
v1.15
298
v1.15
299
v1.15
300
v1.15
301
v1.15
302
v1.15
303
v1.15
304
v1.15
305
v1.15
306
v1.15
307
v1.15
308
v1.15
309
v1.15
310
v1.15
311
v1.15
312
v1.15
313
v1.15
314
v1.15
315
v1.15
316
v1.15
317
v1.15
318
v1.15
319
v1.15
320
v1.15
321
v1.15
322
v1.15
323
v1.15
324
v1.15
325
v1.15
326
v1.15
327
v1.15
328
v1.15
329
v1.15
330
v1.15
331