Beruflich Dokumente
Kultur Dokumente
ii
Contacting Quintum Technologies
Quintum Technologies, Inc. Headquarters
Eatontown, N.J.- based Quintum Technologies specializes in Voice-over-IP technologies
that bring the reliability and voice clarity of public telephone networks to Internet
telephony. The Tenor® VoIP MultiPath Switches help businesses of all sizes migrate to
converged networking without risk.
Address Quintum Technologies, Inc.
71 James Way
Eatontown, NJ 07724
USA
Telephone 1-877-SPEAK IP
1-732-460-9000
Fax 1-732-544-9119
World Wide Web http://www.quintum.com
Page 1 of 89
Welcome to the Quintum Call Routing Server
Overview
Welcome to the Quintum Call Routing Server – a more intelligent way to optimize VoIP
networks.
The Call Routing Server provides CLECs, ILECs, ISPs, and next generation service
providers with scalable, centralized network routing, policy enforcement, and
administration. The Call Routing Server provides a bridge between PSTN circuits and
VoIP networks as it supports traditional VoIP call routing and PSTN circuit switching.
The Call Routing Server provides enhanced network-wide routing flexibility, including
QoS-based routing, least-cost routing, and source-based routing. The Call Routing Server
compiles network routing statistics and generates network reports.
The Call Routing Server is managed by an integrated web-based management system, the
Quintum Routing Server Manager. Through this software, you can configure routing
specifications that will be used through the voice network, and view custom or pre-
defined reports. In addition, the Routing Server Manager software enables quick access
and control over several features, including:
• Flexible Routing/Least Cost Routing
• Ingress/Egress capability
• Access Control
• Blocked Number option
• Manual route test capability
• Alarms
• Call Detail Records
This document describes how to configure the Routing Server through software (Routing
Server Manager and the Command Line Interface). Please refer to the ApplicationServer
Users Guide for a description of how to set up the hardware and configure initial network
settings.
Page 2 of 89
Finding Help
This topic gives you an idea where you can find information to lead you through the
installation and configuration of the Call Routing Server.
Looking for? Here it is
High-level look at the features of the Call Routing Server Application Guide,
Call Routing Server Overview section
Unpacking and installing the ApplicationServer Users Guide,
hardware, hardware specifications, Install Hardware section
cabling and connecting the
equipment
Configuring the IP addresses and ApplicationServer Users Guide,
displaying status Configure an IP Address section
Launching the Routing Server Call Routing Server Application Guide,
Manager application and Getting Started with Routing Server
understanding the interface Manager section
More detail on the Routing Server Call Routing Server Application Guide,
Manager interface, including menu Graphical User Interface Reference section
and field descriptions
An exercise to learn how to set up Call Routing Server Application Guide,
basic routing Getting Started section
How to handle some common Call Routing Server Application Guide,
operations Frequent Tasks section
Complete listing of available CLI Call Routing Server Application Guide,
commands, describing how to Command Line Interface Commands
perform configuration and section
operations, and how to obtain
status
Page 3 of 89
Getting Started with Routing Server Manager
The web-based Routing Server Manager enables you to perform all configuration
functions for the Call Routing Server. For example, you can configure data for all
configuration options, such as number directories, trunk groups, and endpoints.
System Requirements
The following minimum requirements are needed to install the Routing Server Manager
software on your PC:
• Pentium III 800MHz processor (minimum)
• 256 MB Memory
• 128 MB free hard disk
• Internet connection
• Microsoft® Windows 2000 or Microsoft® Windows XP
Installation
At any time during the installation process, you can click Cancel to cancel the
installation. If necessary, you can follow the procedure for Add/Remove Programs in
Microsoft® Windows to install/uninstall the software.
No CD or download is required to obtain the Routing Server Manager software – it is
resident on each Routing Server unit. Install the software on your PC as follows:
1. In the Internet Explorer address field, type the following:
http://IP:port
(where IP:Port is the IP address of the applicable Routing Server unit, colon, and
8080 is the port number)
Page 4 of 89
Log in to Routing Server Manager
After installing the Routing Server Manager software, you are ready to log in and get
started configuring the Routing Server.
1. Access the Routing Server Manager menu item from the location you specified
during installation). For example, click on Start > Programs > Quintum Routing
Server Manager > Routing Server Manager. The Address Book window is
displayed. Click Add to display the Add Address dialog.
2. Enter the IP address of the Call Routing Server you want to configure.
3. Enter the Routing Server Port, 8080.
4. Enter login and password (defaults: admin/admin). Click OK.
5. Click Connect at the bottom left of the Address Book window. The Routing
Server Manager main window is displayed.
You are now ready to configure a Call Routing Server. See the rest of this chapter for
more information about moving around the software, using windows, etc.
Import File to Table. Imports a file to a database table. For example, you can import
routing information provided by a service provider.
Page 5 of 89
Display Area
The display window is the main configuration section of the Routing Server Manager.
Once you click on a desired icon from the menu tree, the corresponding configuration
window appears in the display area.
Menu Tree
Each menu tree item represents a configuration window available in the main display
area. If a menu tree option is “label” only, the menu tree expands to offer the sub-menu
options.
• A “+” to the left of the option indicates the immediate menu tree can be expanded to
display sub-menu options;
• A “-” to the left of the option indicates it is at the lowest level of available options
and cannot be expanded.
Also, when you right-click on each menu tree item, a list of commands appears.
The type of menu tree item determines which commands are listed. Not all commands
will be listed under each item. For example, for those menu options that can be added
(e.g., IP Dial Plan), the Add option appears; under those menu options that cannot be
added, the Add option does not appear. All of the possible commands are described
below.
• Refresh. Refreshes the screen.
• Add. Adds a new sub-menu option for the selected menu item.
• Delete. Deletes a sub-menu option from the selected menu item.
• Help. Accesses the Help for that selected menu option.
Common Configuration Controls
This group of buttons is available from each window. These buttons are located in the
lower part of the display window.
Use the following information as a guide:
• Confirm/OK. Confirms the information you configured in the window but does not
save it to a permanent database. A dialog box appears prompting you to confirm.
Click OK to confirm (to cancel, click Cancel).
• Cancel. Cancels the information you have just entered.
• Refresh. Clears the screen back to the default values. If you are on a different tabbed
panel, it will bring you back to the top level window. You can also perform a refresh
by right-clicking on the desired menu option and selecting Refresh from the drop
down menu.
• Help. When you click on Help and then point to the desired fields, field-specific
Help is displayed.
Page 6 of 89
Display Conventions
The Routing Server Manager system requires you to enter information or select field
entries from various field types. These field types are as follows:
• Edit box. The edit box is a field that allows you to enter alphanumeric characters.
The maximum number of digits/letters you can enter depends on the field definition.
• Radio button. Radio buttons enable you to click on the desired field entry from a list
of choices. A checked radio button indicates the option is enabled; unchecked
indicates the option is disabled.
• Drop-down list box. The drop-down list box is a list of entries displayed when you
click on the arrow to the immediate right of the box. To select an entry, choose any
item from the drop-down list and it appears as the selection.
Navigating Through the Software
There are several ways to navigate through the software: Menu Tree, Tool Bar, and
Tabbed Panels. See below for a description of each:
• Menu Tree. To reach any window, select the desired menu item from the menu tree.
The applicable configuration window is displayed.
• Navigation Buttons. Two navigation buttons on the tool bar let you navigate from
one window to the next, or to the previous window.
• Tabbed Panel. If the window has more than one layer, it is arranged as tabbed
panels. Each panel has a label that indicates its contents. Click on the desired panel to
configure.
Page 7 of 89
Change Password
At any time, you can change the password on the unit; the default password is admin.
Change the password as follows:
1. Click on File > Password. The Password Change window is displayed.
2. Enter a login name, old password, new password, and enter the new password
again to confirm.
3. If desired, click on “Remember my Password.”
4. Click OK. The password is changed.
Routing Configurations
Once you have a basic idea about how to move around within the software, you are ready
to configure the Routing Server. All field definitions, tips for getting started quickly, and
frequent tasks are included in this document.
Page 8 of 89
Getting Started Exercise
Introduction
The Call Routing Server is a very powerful and flexible routing platform. It has many
options and ways to configure routing. Most will find it incredibly easy to use, in many
cases much simpler than configuring routing in a Tenor or CMS!
Getting Started Exercise
This section of the Help system contains an exercise that should help you understand the
concepts involved in setting up basic routing. For purposes of this exercise, it is expected
that you have already configured the TCP/IP information, described in the
ApplicationServer Users Guide. It is also expected that you have installed, run, and
logged in to the Call Routing Server with Routing Server Manager, described in the
previous section.
For this exercise, we focus on Endpoints and Route Directories. Follow these steps to set
up simple routing:
1. Create Endpoints
2. Depending on your configuration:
or
or
Page 9 of 89
Create Endpoints
Endpoints are Gateways. They can be either the originating (ingress) or terminating
(egress) Gateways for a call. They can be managed by the Call Routing Server (Quintum
Gateways in your network), or they can be unmanaged (Quintum and non-Quintum
Gateways).
We recommend that you start simply with one ingress and one egress endpoint. This
could even be a single Tenor or CMS. After you learn how to do this, it will be easy to
add the other endpoints later.
The following process sets up one ingress and one egress endpoint.
1. To add a new Endpoint (ingress), right-click on the Endpoints menu option, and
click Add. Enter a descriptive name and press Enter. This creates an Endpoint,
as well as Trunk Group and Route Directory windows with the same name.
2. Select the Endpoint window. The Call Routing Server automatically generates an
Endpoint ID.
Note
Remember this Endpoint ID, as you will need it later when configuring the Gateway.
3. In the Endpoint window, add the IP address of the endpoint. You can skip most
of the other fields for this exercise and adjust them later.
4. The Call Routing Server automatically generates a TrunkGroup under the
Endpoint definition with the same name. Select this window and set the
TrunkGroupType and TrunkGroupID. The TrunkGroupID should be the same as
the Pass Through ID under the TCRG/LCRG (2nd Generation Tenor) or
PSTNTG/PBXTG (1st Generation Tenor) sections.
5. Add a new Endpoint for the egress side by repeating steps 1 through 4 above.
6. Go to the corresponding RouteDirectory that has been automatically generated
for all your egress (terminating) trunk groups.
7. Add the number patterns to terminate on this gateway and trunk group. Repeat
for each trunk group.
8. Select File > Activate Changes.
At this point, you have configured basic routing in the Call Routing Server. You must
now configure your Gateways. Be sure you have noted the Endpoint ID and
TrunkGroupID for each Gateway, as configured above, as you will need them when
configuring this step.
Page 10 of 89
Configure Managed CMS or Call Relay SP
You need version 1-5-x or 2-5-x System Controller code running on your CMS or Call
Relay SP to support routing with the Call Routing Server.
1. Connect to your CMS to use the Command Line Interface (CLI). At the CLI
prompt, type “ri routingserver”.
2. Set the PrimaryServerIPAddress to the IP address of the Routing Server.
3. Set the SharedSecret to the value set as the RadiusSecret on the Routing Server
(the default RADIUS Secret is 123456789).
4. Set the GatewayID to the EndpointID that you noted previously (see Create
Endpoints). It is generated automatically in the Endpoint window when you first
create an Endpoint in Routing Server Manager.
Sample Display
RadiusInfo-RoutingServer :
name : External Routing Server
PrimaryAuthenticationPort : 1812 default
PrimaryServerIPAddr : 111.222.33.44
PrimaryACcountingPort : 1813 default
SecondaryAuthenticationPort : 1812 default
SecondaryServerIPAddr : 0.0.0.0
SecondaryACcountingPort : 1813 default
RetryCount : 3 Retry Count,default
Timeout : 5 5 seconds Time Out
SharedSecret : 123456789 Up to 63 chars
GateWayID : 5 an integer
You can partition your CMS into trunk groups. Some groups may use the Call Routing
Server for routing, while some may be routed using the internal routing (Static Routes,
Hopoffs, etc.) in the CMS. By default, trunk groups are configured to use internal
routing; you must enable each trunk group for which you wish to use external routing.
For this exercise, we recommend that you enable as few as possible so you can get used
to the operation of the Call Routing Server, and leave the other trunk groups for
production.
1. In the CLI, go to the prompt for the TCRG that you wish to enable for external
routing. For example, “tcrg test”.
2. Set the PassThroughID to the TrunkGroupID that you noted earlier (see Create
Endpoints).
3. Set EnableExternalRouting to 1 (enabled).
4. Repeat the last three steps for each TrunkGroup previously created.
Page 11 of 89
Sample Display
TrunkCircuitRoutingGroup-1 :
id : 1
name : tcrg test
OverlapDial : 0 No, default
DIRection : 2 Bi-direction;default
ProgressTone : 1 On
PubOrPrivNumPlan : 0 Public;default
EndOfDial : 1 Enable
EndOfDialDigit : # default;#,*,0-9
AddEndOfDialDigit : 0 No;default
ForcedRoutingNum : <Not Set> A Dialed Number
ForcedRoutingNumType : 0 Public; default
TrunkID : <Not Set> Numeric string
TrunkIDDelivery : 0 No Delivery
TrunkIDDeliveryFormat : <Not Set>
HUNTAlgorithm : 0 Ascending
ModemBypass : 0 Disabled
PassThroughEnable : 0 No; default
PassThroughID : 99 Idx of a LCRG;defaul
MaxHopoffCallsAllowed : 24 default
TwoStageDialing : 0 No
AccessNumber : <Not Set> 0-9*# up to 20 digit
AccessFormat : <Not Set> 0-9*# up to 40 digit
ProvideAutoSwitchProgressTone: 0 No,Default
PIN : 51950 String of 0-9 or x
IVRType : 0 Message before 2nd D
Hairpinning : 0 No,Default
EnableExternalRouting : 1 No; Default
MaxTalkTime : 0 Mins
InBoundAccessLevel : 0 0 to 127
OutBoundAccessLevel : 0 0 to 127
StopAcctID : 0 IP Addr; Default
IVRAllowDID : 1 Yes
Play1700Prompt : 0 No;Default
PrefiXTrunkID : 0 No;Default
AutoSwitchNumberAttached : <unspecified>
HopoffNumberDirAttached[1] : HopoffNumberDirectory-1
HopoffNumberDirAttached[2..32]: <unspecified>
Page 12 of 89
Configure Tenor A400, A800, all Dx00 models
Please contact Support for the latest code.
Configure the Tenor with the information necessary to contact the Call Routing Server.
1. Connect to the Tenor CLI and enter the RADIUS configuration.
config radius routingserver
(default is 123456789)
Sample Display
config radius routeserver# print
print
host p 111.222.33.44
authenticationport p 1812
accountingport p 1813
host s 0.0.0.0
authenticationport s 1812
accountingport s 1813
retry = 3
timeout = 5
sharedsecret *********
4. Set the Gateway ID. This ID is the same as the Endpoint ID generated
automatically in the Endpoint window of Routing Server Manager (see Create
Endpoints). It is configured in the Tenor by setting the "name" at the "config unit
1" prompt.
config unit 1# name 3
config unit 1# print
Unit: 1
IP Address = 207.49.162.89
External IP Address = 0.0.0.0
Name = 3 <<<<<<<
Online = 0
Relay ResetTime = 240
Relay Reset Number = 2
5. Configure each trunk group you wish to be routed using the Call Routing Server.
You need to configure the following parameters in each trunk group (pbxtg or
pstntg):
• Pttrunkid xx (matches TrunkGroupId on corresponding Routing Server
window)
• Enable external routing
Page 13 of 89
Sample Display
PBX Trunk Group: 1
Name = PbxPassThrough1
Pass Through = no(0)
PT Trunk ID = 99
Provide Call Progress Tone = yes(1)
Multipath = no(0)
Hunt Algorithm = ascending(0)
Modem Bypass = yes(1)
Direction = both(2)
DN Used = public
End Of Dial = yes(1)
End Of Dial Digit = #
Add End of Dial Digit = no(0)
Ivr Type = None
Partial TG = no(0)
External Routing Request = yes(1)
Auto Switch Enable = no(0)
Forced IP Routing # = none
Trunk ID(Account Code) = none
Trunk ID Delivery = none
2 Stage Dial = No
Detect Call Type = no(0)
Translate Inbound Caller ID = no(0)
Relay Caller ID = no(0)
Answer Tone = not used
IP Extension = no(0)
Public Number of Digits = 7
Private Number of Digits = 4
Public Hunt Ldn's:
1: 8475551212
Private Hunt Ldn's:
BDN: Index Bdn
Cas Signaling Type = loop start(1)
Cas Orientation = net(2)
Flash-Hook Signaling = yes(1)
Flash-Hook Min = 200
Flash-Hook Max = 700
Supervision = none(0)
Caller Id Generation = yes(1)
dtmf-ontime = 100
dtmf-offtime = 100
Channel:
unit# 1 line# 1: 1,2,3
Page 14 of 89
Configure Tenor AX/AF/AS/BX/DX/CR 60
Configure the Tenor with the information necessary to contact the Call Routing Server.
You can do this via the CLI or the Tenor Configuration Manager software.
Command Line Interface (CLI) Method
1. Connect to the Tenor CLI for the Ingress Endpoint and type “ ri routingserver” to
enter the RADIUS configuration.
2. When the RoutingServer prompt appears, type “show”. You should see
something similar to this:
RadiusInfo-RoutingServer :
name : External Routing Server
PrimaryAuthenticationPort : 1812 default
PrimaryServerIPAddr : 0.0.0.0
SecondaryAuthenticationPort : 1812 default
SecondaryServerIPAddr : 0.0.0.0
RetryCount : 3 Retry Count,default
Timeout : 5 5 seconds Time Out
SharedSecret : <Not Set> Up to 63 chars
GateWayID : 0 an integer
Page 15 of 89
Test Your Configuration
In order to test the basic routing that you have set up, use the Test Route utility.
1. Select Action > Test Route. The Test Route window is displayed.
2. You may choose any one of the following parameters to enter as Test Info. The
Endpoint and Trunk Group fields contain drop-down lists so you can choose
from all existing defined values.
• DNIS - Dialed number
• Endpoint - Egress Endpoint
• Trunk Group - Ingress Trunk Group
• ANI - Calling party number (optional - to describe Subscriber)
• Remote IP - Subscriber's IP Address (optional - to describe Subscriber)
3. Enter your data and click Apply. The utility performs a route lookup and
generates potential egress routes for the simulated call. The Test Result table
provides Destination IP Address, Trunk Group, and Translated Number for three
attempts at making the simulated call.
Page 16 of 89
Frequent Tasks
This section provides background and instructions on the following frequent tasks.
Instructions are provided for Routing Server Manager.
• Use the testroute Utility
• Import CSV Files to the Route Directory
• Import CSV Files to a Trunk Group
• Block Numbers/IP Addresses
• Configure Subscribers
• Access CDR
• Create Reports in PDF format
• Use Regular Expressions
• Replication
Page 17 of 89
Import Procedure
1. Display the Route Directory into which you want to import a file.
2. Select Action > Import File To Table. The Import dialog box appears to help you
to select a data file to import. You are prompted for a file name.
3. Select a file to import. For example, import a file that contains dial codes into a
Route Directory. Typically, a comma-separated file (CSV) is used.
4. In the Import dialog box, indicate the number of columns of data contained in the
selected file, as well as the placement of each data column in the file and the
name of each column. This provides a flexible means to import CSV data.
5. Click OK. Your data is imported into the table.
Import Example
The columns required in the file are explained in the following table. Below the table is a
sample import file for the Route Directory.
Column Explanation
Number pattern Enter the Dialed Number.
Cost Enter the cost to assign to the route, in dollars per minute. Periods
can be used, e.g., 2.02.
Start Time For Start Time and End Time, the valid range for time is 0-2359 –
the first 1 or 2 digits indicate hour and the last 2 digits indicate
End Time minute. DO NOT use a colon to indicate time - use numbers only.
Start Day For Start Day and End Day, the valid days are:
End Day • 0 indicating Sunday
• 24 indicating Monday
• 48 indicating Tuesday
• 72 indicating Wednesday
• 96 indicating Thursday
• 120 indicating Friday
• 144 indicating Saturday
Max Calls Enter the maximum number of calls to allow to this route.
Allowed
Enable For Enable, the valid values are:
• 0 indicating No
• 1 indicating Yes
Sample File
987654321,2,0,2359,0,144,9900,1
876543210,2.02,0,2359,0,144,9000,0
765432109,2,1200,2359,24,144,9900,1
654321*,2,0,2359,0,144,9900,1
543210987,2,1200,2359,72,120,9900,1
4321098*,2,1200,2359,72,120,9900,1
321098765,2,0,2359,0,144,9900,1
210987654*,3,1200,2359,24,144,9900,1
109876543,3,0,2359,0,144,9000,0
Page 18 of 89
Import CSV Files to a Trunk Group
Importing Rules
• Any lines that start with // (with no preceding white spaces) are considered comment
lines and will be skipped. All other lines are treated as import lines.
• Except for comment lines, no empty lines are allowed.
• A comma (,) is used as a separator between columns.
• The Value of each column must be in integer format.
Import Procedure
1. Display the Trunk Group into which you want to import a file.
2. Select Action > Import File To Table. A dialog appears asking you to specify
into which of the three Trunk Group tables the file should be imported: Ingress
Number Translation Table, Egress Number Translation Table, and Egress DID
Table.
3. The Import dialog box appears to help you select a data file to import into the
table. Select a comma-separated file (CSV) file to import.
4. In the Import dialog box, some default values will appear that depend on the type
of table that you selected. Indicate the number of columns of data that are
contained in the selected file, the column separator, and the line separator. You
can also specify the placement of each data column in the file. The drop-down
boxes correspond to the names of the columns.
5. Click OK. Your data is imported into the table.
Import Examples
The columns required in the file are explained in the following tables. After each table is
a sample of the format of the import file.
Page 19 of 89
Column Explanation
Pattern Enter a dialed number that will be translated when the call is originated
by the associated Ingress Trunk Group. Number patterns may be
expressed in one of several formats including explicit, simplified
patterns, and regular expressions, and as a result may represent a
single number, an entire calling area, or a subset of a calling area. The
number translation will occur prior to the call routing by the routing
engine. Ingress Number Translation occurs only on calls entering the
managed voice network from IP. Ingress Number Translation will not
occur on calls entering the voice network from a circuit trunk..
Delete Digits Enter the number of dialed digits to remove from the start of the dialed
number. Delete Digits is an integer number and may be 0 if no digits are
to be deleted. Digits are deleted from the dialed number prior to any
prefix to be added through the use of the Add Prefix configuration.
Add Prefix Enter the number of dialed digits to prepend to the dialed number, after
digits have been removed from the dialed number through the Delete
Digits configuration. Add Prefix is a number string.
TON Enter an integer value representing the Type of Number that identifies
the nature of the dialed number. TON may be used to specify whether
the dialed number is an international or national number. Possible
values are: 0=Unknown, 1=International Number, 2=National Number,
3=Network Specific Number, 4=Subscriber Number, 6=Abbreviated
Number, 7= Reserved.
NPI Enter NPI is an integer value representing the Numbering Plan that
identifies the nature of the dialed number. NPI may be used to specify
whether the dialed number is an E.163/E.164 or a private numbering
plan. Possible values are: 0=Unknown, 1=E.163/E.164, 3=X.121 (Data),
4=F.69 (Telex), 8=National Standard Numbering Plan, 9=Private
Numbering Plan, 15=Reserved.
Page 20 of 89
Column Explanation
NPI Enter an integer for the Numbering Plan to identify the nature of the
dialed number. NPI specifies whether the dialed number is an E.163/
E.164 or a private numbering plan. Possible values are: 0=Unknown,
1=E.163/E.164, 3=X.121 (Data), 4=F.69 (Telex), 8=National Standard
Numbering Plan, 9=Private Numbering Plan, 15=Reserved.
Example
1. Right-click on the Blocked Number Directories and select Add. In the dialog box
that appears, assign a meaningful name to your Blocked Number Directory. Click
OK and a Blocked Number Directory appears with the name that you have
assigned to it.
2. Click Filter. A dialog box appears that allows you to filter out numbers based on
either a number pattern or regular expression.
3. Click Add. A dialog box appears that lets you select a number pattern and assign
a cause code. Confirm the entry to add it to the Blocked Number table.
Page 21 of 89
You can also import a previously created file to bring your blocked numbers into the
Routing Server Manager software.
1. Create a CSV (comma-separated values) text file to hold your numbers. Each
entry should be formatted as Value,Code. Values can be any kind of number
pattern, and the Code is any disconnect cause code.
2. Create a new Blocked Number Directory as described in the Example above.
3. With the directory displayed, select Action > Import File to Table. A dialog box
is displayed in which you can browse to your file and select it.
4. Click OK. Your numbers are imported into the Blocked Number Directory.
Block IP Addresses
In Routing Server Manager, you can set up blocking of IP Address / Subnet Mask pairs.
First, you enter an address in the Access Control Directory. When a number is dialed that
matches that entry, the call is rejected with a user-defined ITU-T Q.850 cause code.
Access Control Directories are associated with Ingress Groups. As a result, a different
Access Control Directory may be used for each of the various Ingress Groups in the
network. Access Control are specified addresses that may represent a single number or
entire calling areas. Access Control Directories are useful if you want to limit the scope
of the service area supported by an Ingress Group.
Example
1. Right-click on the Access Control Directories and select Add. In the dialog box
that appears, assign a meaningful name to your Access Control Directory. Click
OK and an Access Control Directory appears with the name that you have
assigned to it.
2. Enter a Disconnect cause code to be associated with the Directory.
3. Click Add. A dialog box appears that lets you enter an IP Address / Subnet Mask
pair. Click the Barred radio button to disallow the address. When you confirm
the entry, it is added to the table.
You can also import a previously created file to manage IP addresses in the Routing
Server Manager software.
1. Create a CSV (comma-separated values) text file to hold your addresses. Each
entry should be formatted as IP Address,SubnetMask,AccessType. Enter the IP
Address and Subnet Mask pairs in dotted notation. In the AccessType field, enter
0 (the address should be Allowed) or 1 (the address should be Barred). The
following is an example:
192.168.55.10 255.255.255.0 , 0
192.168.55.32 255.255.255.0 , 1
2. Create a new Access Control Directory as described in the Example above.
3. With the directory displayed, select Action > Import File to Table. A dialog box
is displayed in which you can browse to your file and select it.
4. Click OK. Your addresses are imported into the Access Control Directory.
Page 22 of 89
Configure Subscribers
You may use the Subscribers tab to provide different network call routing policies based
upon the individual subscriber. Individual subscribers may be identified by a variety of
methods including ANI, IP Address, MAC Address, and H323 ID. The Subscriber
configuration allows you to isolate a member of an Ingress Group and, based on the
criteria that you specify, assign a new set of configuration parameters to that Subscriber.
The Subscriber Directory is a logical grouping of subscribers or users of the voice
network. Subscriber Directories are attached to Trunk Groups to identify the Subscribers
who have access to the services of the voice network.
1. To create a Subscriber, right-click on the Subscribers tab and select Add. A
dialog box is displayed in which you should enter a meaningful name for the
Subscriber. Click OK and a new Subscriber window is created.
2. In the Subscribers window, enter information under the three tabs.
• General. This tab provides fields for general identification purposes, such as
Name, Phone, Email, etc.
• ID. This tab allows you to configure only one of the hard network settings:
ANI, IP Address, Subnet Mask, MAC Address, or H323 ID.
• Association. This tab allows you to associate the Subscriber with an Ingress
Group. The drop-down list contains all currently configured Ingress Groups.
When an identified subscriber calls into an Ingress Trunk Group configured
to allow subscribers, the associated Ingress Group is used to route the call.
This allows numerous routing policies to be created and associated with
individual subscribers.
3. Add the Subscriber you have just created to a Subscriber Directory. Subscriber
Directories are added in the same manner as Subscribers. When you open a
Subscriber Directory window, you will see all Subscribers that have been created
listed on the right side under Available Subscribers. Highlight a subscriber and
click the left arrow to transfer the Subscriber to the Selected Subscribers list.
Click Confirm/OK.
4. Now you need to attach the Subscriber to an Endpoint for Egress. Select an
existing Endpoint or create a new one. Under Endpoints, select the Trunk Group
window and click the Ingress tab. Set the Subscriber Lookup Type by choosing
an option (ANI, IP Address, MAC Address, and H323 ID) by which the
incoming call will be recognized.
5. In the Advanced tab of the Trunk Group window, set the Associations. This
includes selecting your Subscriber Directory from the drop-down list. Click
Confirm/OK at the bottom of the window.
6. From the top menu line, select File > Activate Changes. When the Subscriber
call is recognized, it will be switched to a different set of routing policies.
Note
If there are multiple matches for Egress for the Subscriber, there may be unpredictable
results in routing.
Page 23 of 89
Access CDR
A Call Detail Record (CDR) provides call information such as origination number,
destination number, call duration, etc. This information can be used to create billing
reports.
Collecting CDR Files
When you use the Routing Server to manage Quintum devices, it collects Call Detail
Records and stores them in the call history log. This log can be managed through the
command line with the calllog command.
To display the calllog, you must first connect to the Command Line Interface (CLI).
Once the Routing Server has been configured with IP address information and connected
to your network, you can connect to the CLI through a standard SSH session from any
PC on your IP network.
Most Unix™ and Linux™ operating systems come with an ssh client such as openssh.
For Windows, there are many ssh clients available. The two most popular are Putty and
SecureCRT. See below.
• Putty (freeware): http://www.chiark.greenend.org.uk/~sgtatham/putty/
• SecureCRT®: http://www.vandyke.com/
Once you have installed the software, follow this procedure.
1. Launch your SSH client to establish an SSH session, using the assigned IP
address of your Routing Server.
2. Enter a login name. The login name is admin.
3. Enter a password. The default password is admin.
4. The Routing Server prompt is displayed. At any time, type ? or help to display a
list of valid CLI commands.
5. From the main prompt, type calllog. This displays the data in the call history log.
See the example below. The log contains Date/Time In, Date/Time Out, IP
Address In, IP Address Out, DNIS or ANI Number, and Disconnect Cause Code.
6. Type calllog -o. This command writes the screen data to a text file located in the
\log directory on the server.
7. Use your FTP client to retrieve the file and use any text editor to review.
In addition, you can generate a log of all route requests, including rejected requests and
unroutable requests.
Page 24 of 89
Create Reports in PDF format
When you select Action > Export table to PDF, the currently viewed table is converted to
a PDF document and your browser is launched to view the output. Examples of tables
that can be saved are Access Control Directory, Blocked Number Directory, Trunk
Groups (Ingress, Egress, and Advanced tabs) and Route Directories.
You can also choose to display the table in your browser as an HTML file.
Digit Matching
0 through 9 Matching specific digit
Matches any digit
.
Matches any digit listed in brackets
[ ] ..
Counting Modifiers
? Zero or one occurrence of previous item
* Zero or more occurrences of previous item
+ One or more occurrences of previous item
{n} Exactly n occurrences of previous item
{n,} n or more occurrences of previous item
{n,m} At least n occurrences, but not more than m occurrence of
previous item
Position Matching
^ Matches the beginning of the number
$ Matches the end of the number
Other
| Alteration matches either expression that it separates
Logical grouping
( ) ..
Page 25 of 89
Examples
The following regular expression pattern will match all 7-digit numbers that begin with
the digits “124” or “134,” and end in any 4 digits. As a result, this pattern will match
“124,” “134,” and “1241111.”
^1(2|3)4.{4} or ^1[23]4.{4}
The following regular expression pattern will match all numbers that begin with the digits
“1847,” “1312,” or “1630.” As a result, this pattern will match “1847,” “131211111,” and
“1630111111.”
^1((847)|(312)|(630)).*
The following regular expression pattern will match all numbers that begin with the digits
“1847” and end in either 1, 2, or 3. As a result, this pattern will match “18471,”
“184700002,” and “18473333."
^1847.*[123]$
The following regular expression pattern will match all numbers that begin with the digits
"9123" and are followed by either 1 or 6 digits. As a result, this pattern will match
"91231," "9123456789," and "91230."
^9123(1,6)
Related Topics
• Mastering Regular Expressions, Powerful Techniques for Perl and other Tools, by
Jeffrey E. F. Friedl (2nd Edition).
Page 26 of 89
Replication
The replication procedure allows you to copy a configuration from one unit to another.
The master unit copies its config to the slave unit.
How to set up Replication (Master/Slave)
Before you start with replication, make sure that the software and database version are
exactly the same on both machines (master as well as slave).
Master
1. Set master mode using the following command:
master mode 1
2. Check it using this command:
master mode
3. Set master id using this command:
master id x
4. Then check it using this command:
master id
Slave
1. Set slave mode using the following command:
master mode 0
2. Check it using this command:
master mode
Page 27 of 89
Graphical User Interface Reference
Routing Server Manager Reference
Through a web-based interface, the Routing Server Manager software enables you to
perform all configuration functions for the Call Routing Server. For example, you can
configure data for all configuration options, such as number directories, trunk groups, and
endpoints.
The Menu Tree at the left of the Main window (under the heading Explore) provides you
the means to configure your equipment.
Each Menu Tree item represents a configuration window available in the main display
area. A “+” to the left of the option indicates the immediate menu tree can be expanded to
display sub-menu options; a “-” to the left of the option indicates it is at the lowest level
of available options and cannot be expanded.
The following topics are covered under the Graphical User Interface Reference section:
• Common Elements
• Menu Options
• EgressGroups
• IngressGroups
• AccessControlDirectories
• BlockedNumberDirectories
• SubscriberDirectory
• Subscriber
• TrunkGroupProfile
• TrunkGroups
• Endpoint
• RouteDirectories
Page 28 of 89
Common Elements
This section covers several common items in the Routing Server Manager software.
Configuration Controls
Confirm/OK Button
The Confirm/OK button allows you to save the changes that have been made to the
fields on the current configuration window. Click Confirm/OK to save changes
permanently to the system configuration.
Important
Saved configuration changes do not take effect until the configuration is Activated by
selecting File > Activate Changes. You may make several configuration changes and
Activate them with the Routing Server at one time.
Cancel Button
The Cancel button allows you to abandon any changes that you are in the course of
making to the fields on the current configuration window. Click Cancel and the window
clears and displays the last saved configuration.
Refresh Button
The Refresh button allows you to discard any changes that have been made to the fields
on the current configuration window. Click Refresh to discard changes, and the window
refreshes and displays the last saved configuration.
About Button
The About button provides version information for the Routing Server Manager
software.
Help Button
Context-sensitive help is available throughout the Routing Server Manager application.
In order to get help on a particular configuration field, click Help at the bottom of the
window once, and your cursor changes to a question mark. Then click in the field for
which you would like to see Help. The associated Help topic opens in a new window.
Example
If you are in the Access Control Directory configuration window and need help on the
Disconnect Cause Codes field, click Help and then click in the Disconnect Cause Code
data entry area. The associated Help topic appears in a new browser window.
Page 29 of 89
Routing Criteria
Each Routing Criterion entry in an Ingress Group may be set to one of the criteria below.
None
No routing criteria specified. Route selection occurs in undefined order.
Note
When all Routing Criteria Entries (1-5) in the Ingress Group are configured to None, then
the default routing rules take effect. Default routing performs Best Match Routing as the
first criterion, followed by Load Balancing as the second criterion.
Lowest Cost
Select routes that have the lowest cost as determined by the cost information supplied in
each route entry contained in Route Directories.
Highest Quality
Select routes that have the highest quality level as determined by the quality rating in the
Route Directory.
Circuit Routing
Select routes that are TDM-switched. That is, they are circuit-switched from the Ingress
Trunk Group to the Egress Trunk Group, and do not get converted to VoIP. This requires
that both the Ingress and Egress Trunk Groups reside on the same Gateway.
Example
Given Dialed Number : 18475551212
Given Route Entry 1: 1847555*
Given Route Entry 2: 1847*
Route Entry 1 is selected since it matches more of the pattern than Route Entry 2.
Domain Priority
Select routes based on the priority level of Selected Egress Groups attached to this
Ingress Group.
Load Balancing
Select routes so that the trunk group usage is balanced among potential Egress Routes,
based on the percentage trunk availability.
Page 30 of 89
Worst Answer Seizure Rate
Select routes with the Worst Egress Trunk Group Answer Seizure Rate. This option may
be used in conjunction with Best Answer Seizure Rate to provide two classes of service
based on ASR.
Note
Selected routes must still meet minimal acceptable Trunk Group ASR criteria to be
included in the routing decision.
Route Priority
Select routes that have the highest priority level as determined by the priority rating in the
Route Directory.
Number Patterns
The Routing Server will often be required to select an appropriate set of actions
depending upon a set of input; such as a dialed number. A dialed number is matched
against known number patterns to find, for example, the associated route or number
translation rule for a dialed number.
Number patterns may be expressed in one of several formats: explicit, simplified
patterns, and regular expressions. The number pattern format used depends on the type
of number you wish to match. If the intent is to match only a specific number, then the
explicit format is the most appropriate. If the intent is to match all the numbers in a given
country code, for example, a simplified pattern is probably the most appropriate. If you
need more sophisticated pattern matching, regular expression format may be useful. In
the Routing Server, you may freely switch between the three number pattern formats for
each number entry you configure, depending on which is the most appropriate for the
application.
Example
The following example only matches the number “1231234.”
“1231234“
Page 31 of 89
Examples
The following simplified pattern will match all numbers of any length which begin with
the digits 123. As a result, this pattern will match “123," “1231,” and “1231111111.”
123*
The following simplified pattern will match all 7 digit numbers which begin with “123.”
123????
The following simplified pattern will match all numbers of any length that begin with a
“1,” followed by any digit, followed by “23,” followed by zero or more digits. As a
result, the pattern will match “1123,” “1223,” “1323,” “1423,” “172311111.”
1?23*
Digit Matching
0-9 Matching specific digit
Counting Modifiers
? Zero or one occurrence of previous item
* Zero or more occurrences of previous item
+ One or more occurrences of previous item
{n} Exactly n occurrences of previous item
{n,} n or more occurrences of previous item
{n,m} At least n but not more than m occurrences of previous item
Position Matching
^ Matches the beginning of the number
$ Matches the end of the number
Other
| Alteration matches either expression that it separates
Page 32 of 89
Examples
The following regular expression pattern will match all 7 digit numbers that begin with
the digits “124” or “134,” and end in any 4 digits. As a result, this pattern will match
“124,” “134,” and “1241111.”
^1(2|3)4.{4}” or “^1[23]4.{4}
The following regular expression pattern will match all numbers that begin with the digits
“1847,” “1312,” or “1630.” As a result, this pattern will match “1847,” “131211111,” and
“1630111111.”
^1((847)|(312)|(630)).*
The following regular expression pattern will match all numbers that begin with the digits
“1847” and end in either 1, 2, or 3. As a result, this pattern will match “18471,”
“184700002,” and “18473333.”
^1847.*[123]$
The following regular expression pattern will match all numbers that begin with the digits
"9123" and are followed by either 1 or 6 digits. As a result, this pattern will match
"91231," "9123456789," and "91230."
^9123(1,6)
Page 33 of 89
Type of Number (TON)
Type of Number values as defined by ITU-T Q.931 are as follows:
Value Definition
0 Unknown
1 International Number
2 National Number
3 Network Specific Number
4 Subscriber Number
6 Abbreviated Number
7 Reserved
Page 34 of 89
Menu Options
The Main Menu of Routing Server Manager offers the following options:
• File Menu
• Action Menu
• Configure Menu
• Help Menu
File Menu
The File Menu allows you to connect to a new Routing Server, activate any changes you
make to configuration, change your password, and exit the system.
Connect
When you select File > Connect, an Address Book window appears in which you can
enter the IP address of a different Routing Server. Click Connect to make the connection.
Note
Before connecting to a different Routing Server, be sure that you have activated all
changes made to the currently connected Routing Server by selecting File > Activate
Changes.
Activate Changes
When you select File > Activate Changes, a window appears asking you to confirm that
you want to activate all changes that have been made to the Routing Server configuration.
Click OK to confirm.
Exit
When you select File > Exit, a window appears asking you to confirm that you wish to
leave Routing Server Manager. Click OK to exit.
Action Menu
The options available from the Action Menu allow you to initiate actions that will test
routes and import/export data from Routing Server Manager.
Test Route
When you select Action > Test Route, the Test Route dialog box provides you a
mechanism to display potential egress routes for a given set of ingress parameters.
Essentially, this simulates a test call arriving at an ingress trunk group.
DNIS
DNIS represents the number that was dialed in the simulated call.
Endpoint
The Endpoint field specifies the Ingress Endpoint to use for the simulated call.
Trunk Group
The Trunk Group field specifies the Ingress Trunk Group to use for the simulated call.
Page 35 of 89
ANI
ANI represents the calling party number in the simulated call.
Remote IP
Remote IP represents the Subscriber's IP address in the simulated call.
Test Route Table
This table shows the results of the simulated call, and provides columns for Destination
IP Address, Trunk Group, and Translated Number.
Page 36 of 89
Columns
Each of the columns of data in the imported file needs to be associated with a field in the
table, so that the data is imported correctly. The Column field provides a drop-down list
of the fields contained in the current table. Select the appropriate field name for each
column of data contained in the selected file.
OK Button
Click OK to use the currently configured settings to import data from the selected file.
Cancel Button
Click Cancel to exit the Import function without importing data from the selected file.
Help Button
Click Help to open the Help system for the Import dialog box.
Admin Email
When you select Configure > Admin Email, the Configure Admin Email window is
displayed.
Email Address 1 and 2
These fields allow you to enter a primary and secondary email address for alerts to be
sent when the Call Rejection Rate and Calls Per Second exceed the threshold.
Email Alert Threshold
Set the thresholds for the Call Rejection Rate and Calls Per Second. The default for the
Call Rejection Rate is 248, and the default for Calls Per Second is 250.
Page 37 of 89
Double-click on a row of the table, and you can edit the contents. You must confirm or
discard your intended changes.
This ITU-T Recommendation defines the format, encoding, and semantics of cause
information elements/parameters and the usage of the location field.
The following table lists standard Q.850 Cause codes used for PRI and H.323.
Cause
Code Definition
1 Unallocated number
3 No route to destination
6 Channel unacceptable
7 Call awarded and being delivered in an established channel
16 Normal call clearing
17 User busy
18 No user responding
19 No answer from user
21 Call rejected
22 Number changed
26 Non-selected user clearing
27 Destination out of order
28 Invalid number format
29 Facility rejected
30 Response to a status enquiry
31 Normal, unspecified
34 No channel available
38 Network out of order
41 Temporary failure
42 Switching equipment congestion
43 Access information discarded
44 Request channel not available
47 Resource not available
49 Quality of service unavailable
50 Requested facility not subscribed
57 Bearer capability not authorized
58 Bearer capability not presently available
63 Service or option not available
65 Bearer capability not implemented
66 Channel type not implemented
Page 38 of 89
Cause
Code Definition
69 Request facility not implemented
70 Only restricted digital information bearer capability is available
79 Service or option not implemented, unspecified
81 Invalid call reference value
82 Identified channel does not exist
83 Suspended call exists, but call identity does not
84 Call identity in use
85 No call suspended
86 Call with the specified call identity is cleared
88 Incompatible destination
91 Invalid transit network selection
95 Invalid message, unspecified
96 Mandatory information element is missing
97 Message type non-existent or not implemented
98 Message not compatible with call state or message type non-
existent
99 Information element non-existent or not implemented
100 Invalid information element contents
101 Message not compatible with call state
102 Recovery on timer expiry
111 Protocol error, unspecified
127 Internetworking, unspecified
Color
Select Configure > Color to change the default color scheme for Routing Server
Manager. You can configure both Edge and Back colors (window frame and
background), using RGB numbers.
Help Menu
The options available from the Help Menu allow you to search for information and
provide feedback to Quintum.
Help
Select Help > Help to launch the online Help system.
Feedback
Select Help > Feedback to display a feedback email form that you can fill in and send to
Quintum Technical Support.
Page 39 of 89
About
Select Help > About to display version information for Client, Server, and DB.
EgressGroups
Egress Groups allow you to group Egress trunk groups logically for routing purposes. An
Egress Group may represent one or more Egress trunk groups. Ingress Group routing
policy allows for the specification of one or more Egress Groups as potential egress
destinations used to perform routing decisions. Egress Groups may be used for various
purposes, but are typically created to separate Egress points logically in the voice
network. This separation allows you to create multiple service offerings.
By default, an Egress Group is created by the system called Default. Any created Ingress
Group or Trunk Group is initially assigned to the Default Egress Group. This creates a
flat voice network where all Ingress Groups may route calls to all Egress Trunk Groups.
You may partition the voice network by creating additional Egress Groups and
associating them appropriately with the Ingress Groups and Egress Trunk Groups.
Egress Group Configuration Parameters
Name
Name is a text string that you associate with the Egress Group. We recommend that the
Name field contain a descriptive phrase, since you will associate Egress Groups to
Ingress Groups based on it.
Example
"Asia Priority Terminations"
"Enterprise A"
Description
Description is a text string that you associate with the Egress Group. This field is purely
for your convenience to provide additional information to describe the Egress Group, and
may be used in generated reports. The Description field does not affect the behavior of
the Routing Server.
Page 40 of 89
Egress Group Controls
IngressGroups
Ingress Groups provide a set of common routing policies used by the Routing Server
routing engine. Ingress Trunk Groups and Subscribers may be assigned to Ingress Groups
that indicate the criteria used to route calls. One or more Ingress Groups may exist in the
Routing Server. Each may be configured to route calls by different criteria. Access
Control Directories and Blocked Number Directories may also be associated with Ingress
Groups.
Routing Criteria
Routing criteria are constraints that are applied to the potential egress routes by the
Routing Server routing engine.
When selecting potential egress routes for each call, the Routing Server routing engine
inspects several criteria dictated by the Ingress Group associated with the call.
For a given Ingress Group and dialed number (DNIS), the routing engine performs the
following:
• Obtains the set of associated Egress Groups
• Obtains the set of Egress Trunk Groups associated with these Egress Groups
The routing engine limits the set of Egress Trunk Groups by several criteria:
• An enabled termination Route Directory entry must match the dialed number.
• They must be part of a trunk group that is enabled for Egress.
• They are enabled based on current time at the egress endpoint physical location.
• They must not have exceeded the maximum number of calls per Egress Trunk Group.
• They have not exceeded the maximum number of calls per Egress Route.
• They are part of an Endpoint operating in acceptable IP QOS criteria.
• They are part of an Egress Trunk Group operating with an acceptable Answer Seizure
Rate.
Once the above criteria are applied to the potential egress routes, the remaining routes are
ordered by a set of user-defined criteria specified in the Ingress Group.
Page 41 of 89
Ingress Group Configuration Parameters
General Tab
Name
Name is a text string that you associate with the Ingress Group. We recommend that the
Name field contain a descriptive phrase, since you will associate Egress Groups to
Ingress Groups based on it.
Example
"Free Call Network"
"Enterprise A"
Minimum Acceptable ASR
The Minimum Acceptable Answer Seizure Rate (ASR) specifies the lowest acceptable
ASR that a given Egress Trunk Group must have in order to be considered as a potential
egress route. Routes to Trunk Groups that have an ASR less than this are not allowed to
terminate traffic from this Ingress Group.
Routing Criteria
Selects the highest priority routing criteria to be used to select Egress Trunk Groups to
send a call. You may specify five different criteria to apply to order the potential Egress
routes. Routing criteria choices that can be considered are as follows:
• None - No routing criteria specified. Route selection occurs in undefined order.
Note
When all Routing Criteria Entries (1-5) in the Ingress Group are configured to None, then
the default routing rules take effect. Default routing performs Best Match Routing as the
first criterion, followed by Load Balancing as the second criterion.
• Lowest Cost - Select routes that have the lowest cost as determined by the cost
information supplied in each route entry contained in Route Directories.
• Highest Quality - Select routes that have the highest quality level as determined by
the quality rating in the Route Directory.
• Circuit Routing - Select routes that are TDM-switched; that is, they are circuit-
switched from the Ingress Trunk Group to the Egress Trunk Group, and do not get
converted to VoIP. This requires that both the Ingress and Egress Trunk Groups
reside on the same Gateway.
• Best Number Match - Select routes that have the longest pattern match with the
dialed number (DNIS).
Example
Given Dialed Number : 18475551212
Given Route Entry 1: 1847555*
Given Route Entry 2: 1847*
Route Entry 1 is selected since it matches more of the pattern than Route Entry 2.
Page 42 of 89
• Domain Priority - Select routes based on the priority level of Selected Egress
Groups attached to this Ingress Group.
• Load Balancing - Select routes so that the trunk group usage is balanced among
potential Egress Routes, based on the percentage trunk availability.
• Best Answer Seizure Rate - Select routes with the best Egress Trunk Group Answer
Seizure Rate. This option may be used in conjunction with the Worst Answer Seizure
Rate setting to provide two classes of service based on ASR.
• Worst Answer Seizure Rate - Select routes with the Worst Egress Trunk Group
Answer Seizure Rate. This option may be used in conjunction with Best Answer
Seizure Rate to provide two classes of service based on ASR.
Note
Selected routes must still meet minimal acceptable Trunk Group ASR criteria to be
included in the routing decision.
• Route Priority - Select routes that have the highest priority level as determined by
the priority rating in the Route Directory.
Access Control Directory Button
The Access Control Directory button provides convenient access to the associated
Access Control Directory. The button contains the name of the associated Access Control
Directory, and when you click the button, the associated Access Control Directory
configuration window is displayed.
Blocked Number Directory Button
The Blocked Number Directory button provides convenient access to the associated
Blocked Number Directory. The button contains the name of the associated Blocked
Number Directory, and when you click the button, the associated Blocked Number
Directory configuration window is displayed.
Advanced Tab
Access Control Directory
The Access Control Directory drop-down box allows you to select an Access Control
Directory to associate with this Ingress Group. Once associated, all calls using this
Ingress Group will be bound by the Access policy configured in the selected Access
Control Directory.
Blocked Number Directory
The Blocked Number Directory drop-down box allows you to select a Blocked Number
Directory to associate with this Ingress Group. Once associated, all calls using this
Ingress Group will be bound by the Blocked Number policy configured in the selected
Blocked Number Directory.
Selected Egress Groups Table
The Selected Egress Groups table contains a list of Egress Groups that have been
associated with this Ingress Group. By associating an Egress Group to an Ingress group,
all of the Trunk Groups and Routes associated with the selected Egress Group become
available to terminate calls from this Ingress Group.
Page 43 of 89
Available Egress Groups Table
The Available Egress Groups table contains a list of all of the Egress Groups defined in
the Routing Server. By associating an Egress Group to an Ingress group, all of the Trunk
Groups and Routes associated with the selected Egress Group become available to
terminate calls from this Ingress Group.
Page 44 of 89
AccessControlDirectories
Access Control Directories let you control the Endpoints permitted to use the services of
the voice network. The Routing Server may block access to the voice network services by
certain IP Endpoints, or only provide access to voice services from certain IP Addresses.
Access Control Directories are associated with Ingress Groups. As a result, different
Access Control Directories may be used for each of the various Ingress Groups in the
network. Access to the voice network may be controlled by the originating IP Address.
This control may be limited to individual IP Addresses or to entire networks through the
use of subnet masks. In the event that an endpoint is disallowed access to the voice
network, the call will be disconnected with a user-defined cause code. Applicable
disconnect cause codes are typically defined by ITU-T Recommendation Q.850, which
defines PRI and H.323 disconnect reasons.
To create an Access Control Directory, right-click on the Access Control Directories
item in the tree-view at the left of the main window, and select Add. Enter a name for the
Directory, and it will be added and displayed in the tree-view. You may edit any Access
Control Directory by clicking on the name of the Directory to display the configuration
window. Similarly, right-click on an Access Control Directory name to delete entries.
You may import the contents of a CSV text file into your Access Control Directory.
Access Control Directory Configuration Parameters
Name
Name is a text string that you associate with the Access Control Directory. We
recommend that the Name field contain a descriptive phrase, since you will associate
Access Control Directories to Ingress Service Groups based on it.
Example
"Allow only Enterprise A"
"Allow only Local LAN"
"Disallow Enterprise B"
Example
A user configures an Access Control Directory to restrict calls from endpoints with IP
address 192.168.2.0, Subnet Mask 255.255.255.0, and Disconnect Cause code 3 (No
Route to Destination). The appropriate Ingress Service Group is configured to use this
newly created Access Control Directory. Any call attempt from an endpoint with an IP
address in the range 192.168.2.0 - 192.168.2.255 will be rejected with a cause code of 3.
Page 45 of 89
Address and IP Subnet Mask pair, in addition to an indication of whether to allow or
disallow the specified Endpoint or Network.
Note
It is not possible to modify the system-generated Allow all Endpoints directory entry. If
you want to do this, you should create a new Access Control Directory with a similar
configuration to the Allow all Endpoints entry, with a new name. You can then apply the
desired changes to the newly created Directory.
Delete Policy Button
Click Delete to delete or remove the selected Access Control policy entry from the
current directory. Before you click Delete, select a specific Access Control policy entry
to remove by clicking an entry in the table so that it is highlighted.
Edit Policy Button
Click Edit to edit or modify the selected Access Control policy entry from the current
directory. Before you click Edit, select a specific Access Control policy entry to modify
by clicking an entry in the table so that it is highlighted.
Previous Button
The Previous button appears when the number of Access Control policy entries exceeds
100. Click Previous to navigate through the entire list of policies in groups of 100.
Next Button
The Next button appears when the number of Access Control policy entries exceeds 100.
Click Next to navigate through the entire list of policies in groups of 100.
Access Control Policy Dialog
IP Address
The IP Address field contains the IP Address portion of an Access Control policy entry.
The specific endpoint or network is further identified by the Subnet Mask. The
combined IP Address / Subnet Mask pair identifies the source endpoint to which this
policy applies. IP Addresses are entered in dotted decimal notation.
Subnet Mask
The Subnet Mask field contains the IP Subnet Mask portion of an Access Control policy
entry. The combined IP Address / Subnet Mask pair identifies the source endpoint to
which this policy applies. Subnet Masks are entered in dotted decimal notation.
Page 46 of 89
Access Type Allowed
Each Access Control policy entry has an associated type that describes the behavior of
the policy. The allowed type indicates that any endpoint that matches the policy's IP
Address / IP Subnet Mask pair will be allowed access to the voice network. If an Access
Control directory is comprised exclusively of allowed policies, then all other endpoints
(not explicitly allowed) will be barred or rejected from accessing the voice network.
BlockedNumberDirectories
Blocked Number Directories allow you to block dialed numbers (DNs). These numbers
are checked before any number translation.When a number is dialed that matches an
entry in the Blocked Number Directory, the call is rejected with a user-defined ITU-T
Q.850 cause code. Blocked Number Directories are associated with Ingress Groups. As a
result, a different Blocked Number Directory may be used for each of the various Ingress
Groups in the network.
Blocked Numbers are specified by number patterns and may represent a single number or
entire calling areas. Blocked Number Directories are useful if you want to limit the scope
of the service area supported by an Ingress Group. You may import the contents of a
CSV text file to populate your Blocked Number Directory.
Note
It is not possible to modify the system-generated Allow all Calls directory entry. If you
wish to do this, you should create a new Blocked Number Directory with similar
configuration as the Allow all Calls entry, with a new name. The desired changes may
then be applied to the newly created Directory.
Blocked Number Directory Configuration Parameters
Name
Name is a text string that you associate with the Blocked Number Directory. We
recommend that the Name field contain a descriptive phrase, since you will associate
Blocked Number Directories to Ingress Service Groups based on it.
Example
"Block 900 Numbers"
"Block Cell Phone Calling Codes"
Page 47 of 89
Blocked Number Table
The Blocked Number Table contains a list of Blocked Number Entries. Each entry is a
set of parameters that define a Blocked Number policy. Each policy is comprised of a
Number Pattern and Disconnect Cause Code pair, in addition to an indication of whether
to allow or disallow the specified Endpoint or Network.
Note
It is not possible to modify the system-generated Allow all Calls directory entry. If you
wish to do this, you should create a new Blocked Number Directory with similar
configuration as the Allow all Calls entry, with a new name. The desired changes may
then be applied to the newly created Directory.
Previous Button
The Previous button appears when the Blocked Number policy entries exceed 100. Click
Previous to navigate through the entire list of policies in groups of 100.
Next Button
The Next button appears when the Blocked Number policy entries exceed 100. Click
Next to navigate through the entire list of policies in groups of 100.
Blocked Number Dialog Configuration Parameters
Number Pattern
Blocked Numbers are specified by number patterns and may represent a single number or
entire calling areas that will be blocked from service. Any dialed number that matches a
Number Pattern entry in an associated Blocked Number Directory will be rejected.
Page 48 of 89
Example
A User configures a Blocked Number Directory to restrict calls to 1900* with a
Disconnect Cause code "3" (No Route to Destination). The appropriate Ingress Service
Group is configured to use this newly created Blocked Number Directory. Any call
attempt from an Ingress Service Group associated with this Blocked Number Directory to
a 1900xxxxxx number will be rejected with a cause code of 3.
SubscriberDirectory
The Subscriber Directory is a logical grouping of subscribers or users of the voice
network. Subscriber Directories are attached to Trunk Groups to identify the Subscribers
who have access to the services of the voice network. Subscriber Directectories may be
used to provide different network call routing policies based upon the individual
subscriber. Individual subscribers may be identified via a variety of methods including
ANI, IP Address, and MAC Address.
Subscriber Directory Configuration Parameters
Name
Name is a text string that you associate with the Subscriber Directory. We recommend
that the Name field contain a descriptive phrase, since you will associate Subscriber
Directory to Trunk Groups based on it.
Example
"Category A Subscribers"
"Enterprise B Subscribers"
Description
Description is a text string that you associate with the Subscriber Directory. This field is
purely for the convenience of providing any additional information that you wish to
describe the Subscriber Directory, and may be used in generating reports. The
Description field does not affect the behavior of the Routing Server.
Page 49 of 89
Subscriber Table
Subscriber Table contains a list of subscribers that are members of this Subscriber
Directory.
<< Button
The << button associates the selected Subscriber in the Available Subscribers table with
the current Subscriber Directory. Click << to add the selected Subscriber to the Selected
Subscribers table.
>> Button
The >> button disassociates the selected Subscriber in the Available Subscribers table
from the current Subscriber Directory. Click >> to remove the selected Subscriber from
the Selected Subscribers table.
Go to Button
The go to button allows you to jump to the associated Subscriber. Before you click go to,
select a Subscriber name from either the Selected Subscribers or Available Subscribers
table.
Subscriber
Subscribers are individual users of the voice network. Subscribers may be associated with
one or more Subscriber Directories to identify individual users of the voice network.
Subscriber may be used to provide different network call routing policies based upon the
individual subscriber. Individual subscribers may be identified via a variety of methods
including ANI, IP Address, and MAC Address.
Subscriber Configuration Parameters
General Tab
Name
Name is a text string that you associate with the Subscriber. We recommend that the
Name field contain a descriptive phrase, since you will associate Subscribers to
Subscriber Directory based on it.
Example
"China Tenor CMS #36"
"Enterprise A New Jersey Tenor D3200"
Phone
Phone is a text string that you associate with the Subscriber. This field is purely for your
convenience to provide additional information to associate with the Subscriber, and may
be used in generated reports. This field does not affect the behavior of the Routing
Server.
E-mail
E-mail is a text string that you associate with the Subscriber. This field is purely for your
convenience to provide additional information to associate with the Subscriber, and may
be used in generated reports. This field does not affect the behavior of the Routing
Server.
Page 50 of 89
Fax
Fax is a text string that you associate with the Subscriber. This field is purely for your
convenience to provide additional information to associate with the Subscriber, and may
be used in generated reports. This field does not affect the behavior of the Routing
Server.
Address
Address is a text string that you associate with the Subscriber. This field is purely for
your convenience to provide additional information to associate with the Subscriber, and
may be used in generated reports. This field does not affect the behavior of the Routing
Server.
Ingress Group Button
The Ingress Group button provides convenient access to the associated Ingress Group.
The button contains the name of the associated Ingress Group. Click the button to jump
to the associated Ingress Group configuration window.
ID Tab
ANI
ANI is the calling party number associated with a subscriber. ANI Pattern is one of the
attributes that may be used to identify a subscriber when a call arrives at an Ingress Trunk
Group.
IP Address
IP Address is the IP identifier associated with a subscriber. IP Address is one of the
attributes that may be used to identify a subscriber when a call arrives at an Ingress Trunk
Group.
Subnet Mask
Subnet Mask is the mask to associate with the IP Address to identify a subscriber.
Association Tab
Ingress Group
Ingress Group specifies the group to associate with this Subscriber. Select a defined
Ingress Group from the drop-down box. When an identified subscriber calls into an
Ingress Trunk Group configured to allow subscribers, the associated Ingress Group is
used to route the call. This allows numerous routing policies to be created and associated
with individual subscribers.
TrunkGroupProfile
Trunk Group Profiles describe IP characteristics that are used for Ingress or Egress Calls.
Parameters such as Codec selection, audio gain, PacketSaver, and voice activity detection
are set in the Trunk Group Profile.
Page 51 of 89
Trunk Group Profile Configuration Parameters
General Tab
Name
Name is a text string that you associate with the Trunk Group Profile. We recommend
that the Name field contain a descriptive phrase, since you will associate Trunk Group
Profiles to Trunk Groups based on it.
Example
"Trunk Group A"
"Low Bit Rate Settings"
Maximum Egress Talk Time
Maximum Egress Talk Time selects the maximum length (in seconds) of any call that
uses this Trunk Group Profile. Calls greater than this length will be disconnected by the
gateway.
IP Tab
Digit Relay
Digit Relay sets how the gateways send DTMF tones during a VoIP call. This applies to
both H.323 and SIP. Sending DTMF tones in-band (the same path as the voice) over IP is
extremely unreliable. It is common for these tones to be misinterpreted as a different digit
than what was entered. Digit Relay helps prevent distortion of DTMF tones in the voice
path. Digit Relay encodes the DTMF tones into digitized packets and sends the packets
over IP. The destination gateway converts the digit back to a tone and inserts it on to the
correct voice path. This provides a high degree of accuracy when receiving the DTMF
tones. Some devices, such as NetMeeting, do not support this method.
VAD Enable
Voice Activity Detector Enable. Used to enable or disable the voice activity detector.
This is the silence suppression feature of the gateways. When enabled (default), the
gateways do not send any packets during periods of silence. The gateways create "white
noise" back to the local user to simulate the connection. If this feature is disabled, then
the gateways always send packets during a call, even if there is no voice signal. With this
feature enabled you will not be congesting your network unnecessarily, since most voice
calls have a large amount of silence. You can vary the level of "white noise" sent back by
configuring the Idle Noise Level.
Force Progress IE Alert
This setting forces a Progress IE in the Alerting message sent out on this routing group
towards the IP network. This enables the circuit connection in the PSTN network so that
users are able to hear the tones provided by the switches in the network. The requirement
to enable this is rare.
Packet Saver Enable
Enables or disables the Quintum PacketSaver feature. PacketSaver multiplexes multiple
individual VoIP sessions into consolidated IP packets, significantly reducing the total
amount of bandwidth needed to support voice calls over IP networks.
Page 52 of 89
Relay ANI
Enables or disables the Relay ANI feature. This controls whether the ANI of a call
outbound on this routing group has a value that is relayed or suppressed.
Default ANI
This sets a default ANI to be used. When populated, calls outbound through this routing
group always have this value, regardless of whether ANI is present on the inbound call.
Rx Gain
Receive Gain. Used to raise or lower the gain (volume) of signals that come in from the
IP and are sent to the line-side or trunk-side interface. The Rx Gain dB level may be set
in 1db increments from -14dBm to 14dBm.
Tx Gain
Transmit Gain. Used to raise or lower the gain (volume) of signals that go out to the IP
from the line-side or trunk-side interface. The Tx Gain dB level may be set in 1db
increments from -14dBm to 14dBm.
Idle Noise Level
Idle Noise Level (in dBm units) specifies the level of comfort noise to be played out.
Reasonable values for this parameter are between -50dBm and -70dBm. Degraded voice
quality may result from settings higher than -50dBm.
Codec Preference
Codec preference contains the desired codec and voice payload size. Multiple codec
preferences may be selected and will be attempted in priority order, starting with codec 1
as the highest priority and ending with codec 5 as the lowest priority. Voice Codec
preferences (and corresponding Voice Payload Sizes) can be set as follows:
• No Codec (No Voice Payload Size)
• G.711 A-law 64 Kbps (10 or 20 ms)
• G.711 Mu-law 64 Kbps (10 or 20 ms)
• G.729AB 8.0 Kbps (10, 20, 30, 40 or 80 ms)
• G.723.1 6.3 Kbps (30 or 60 ms)
• G.723.1 5.3 Kbps (30 or 60 ms)
Endpoint
Endpoints are physical devices between which routing is performed by the Routing
Server. Ingress Endpoints are devices through which voice traffic enters a given voice
network, and Egress Endpoints are devices through which voice traffic leaves a given
voice network. Endpoints may be both Ingress and Egress Endpoints and may be both
Gateways or Gatekeepers. Attributes associated with these physical devices are specified
in the Endpoint window.
Endpoint Configuration Parameters
General Tab
Endpoint ID
Endpoint ID is automatically generated when you create an ingress or egress endpoint.
Page 53 of 89
Endpoint Type
Endpoint Type indicates whether this endpoint is a Gateway or a Gatekeeper. This
configuration affects how calls will be completed to the endpoint. Calls can be directly
sent to the Egress Endpoint by the originating Gateway, if it is configured as a Gateway.
If however the Egress Endpoint is configured to be a Gatekeeper, the Routing Server will
instruct the originating gateway to perform an ARQ and LRQ to the Egress Endpoint.
The following options can be selected as the Endpoint Type:
• H323 Only Gateway
• H323 Gatekeeper
• H323 Only Call Relay
• H323 GW Proxied by Call Relay
• H323 Preferred Call Relay
• H323 Preferred Gateway
• SIP Preferred Gateway
• SIP Only Gateway
• SIP Proxy
• SIP Only Call Relay
IP Address
IP Address is the IP Address associated with this Endpoint. It is the address that other
gateways will use when routing calls to the Egress Trunk Groups that are associated with
this Endpoint.
IP Addresses are entered in dotted decimal notation.
Example
192.168.2.10
Hardware Model
The Hardware Model field specifies the physical hardware model of the Endpoint.
Options are Tenor Gateway and Non-Quintum Gateway. This field is purely for your
convenience to provide any additional information to describe the Endpoint, and may be
used in generated reports. This description field does not affect the behavior of the
Routing Server.
Time Zone
Time Zone is the time zone where the Endpoint is physically located. Endpoints may
reside around the world in various time zones. The Routing Server automatically
accounts for such events as daylight savings time for all time zones. The Routing Server
requires this information to perform least-cost routing throughout the voice network.
There are 71 time zones around the world that uniquely describe the local time zone and
daylight savings time criteria. From the drop-down list, select the appropriate time zone
that matches the endpoint's physical location.
Page 54 of 89
Supported time zones include:
• (GMT-12:00)Eniwetok,Kwajalein
• (GMT-11:00)Midway Island,Samoa
• (GMT-10:00)Hawaii
• (GMT-9:00) Alaska
• (GMT-8:00) Pacific Time (US & Canada)
• (GMT-7:00) Arizona
• (GMT-6:00) Mountain Time
• (GMT-6:00) Central America
• (GMT-6:00) Central Time
• (GMT-6:00) Mexico City
• (GMT-6:00) Saskatchewan
• (GMT-5:00) Bogota,Lima,Quito
• (GMT-5:00) Eastern Time (US &CA)
• (GMT-5:00) Indiana (East)
• (GMT-4:00) Atlantic Time (CA)
• (GMT-4:00) Caracas,La Paz
• (GMT-4:00) Santiago
• (GMT-3:30) Newfoundland
• (GMT-3:00) Brasilia
• (GMT-3:00) Buenos Aires,Georgetown
• (GMT-3:00) Greenland
• (GMT-2:00) Mid-Atlantic
• (GMT-1:00) Azores
• (GMT-1:00) Cape Verde Is.
• (GMT) CasaBlanca,Monrovia
• (GMT) Greenwich Mean Time
• (GMT+1:00) Amsterdam,Berlin,Rome..etc
• (GMT+1:00) Belgrade,Bratislava,Budapest
• (GMT+1:00) Brussels,Copenhagen,Paris
• (GMT+1:00) Sarajevvo,Skopje,Sofija
• (GMT+2:00) Athens,Istanbul,Minsk
• (GMT+2:00) Bucharest
Page 55 of 89
• (GMT+2:00) Cairo
• (GMT+2:00) Harare,Pretoria
• (GMT+2:00) Helsinki,Riga,Tallinn
• (GMT+2:00) Jerusalem
• (GMT+3:00) Baghdad
• (GMT+1:00) Kuwait,Riyadh
• (GMT+1:00) Moscow,St.Petersburg
• (GMT+1:00) Nairobi
• (GMT+1:00) Tehran
• (GMT+4:00) Muscat,Abu Dhabi
• (GMT+4:00) Bku,Tbilisi,Yerevan
• (GMT+4:30) Kabul
• (GMT+5:00) Ekterinburg
• (GMT+5:00) Islamabad,Karachi,Tashkent
• (GMT+5:30) India
• (GMT+5:45) Kathmandu
• (GMT+6:00) Almaty,Novosibirsk
• (GMT+6:00) Astana,Dhaka
• (GMT+6:30) Rangoon
• (GMT+7:00) Bangkok,Hanoi,Jakarta
• (GMT+7:00) Krasnoyarsk
• (GMT+8:00) Beijing,Hong Kong,Urumqi
• (GMT+8:00) Irkutsk,Ulaan Bataar
• (GMT+8:00) Kuala Lumpur,Singapore
• (GMT+8:00) Perth
• (GMT+8:00) Taipei
• (GMT+9:00) Osaka,Sapporo,Tokyo
• (GMT+9:00) Seoul
• (GMT+9:00) Yukutsk
• (GMT+9:30) Adelaide
• (GMT+9:30) Darwin
• (GMT+10:00) Brisbane
• (GMT+10:00) Canberra,Melbourne,Sydney
Page 56 of 89
• (GMT+10:00) Guam,Port Moresby
• (GMT+10:00) Hobart
• (GMT+10:00) Vladivostok
• (GMT+11:00) Megadan,Solomon Is.,
• (GMT+12:00) Auckland,Wellington
• (GMT+12:00) Fiji,Kamchatka,Marshall Is.
Enable QOS (Stop Call Routing) When
Enables or disables implementation of the "Maximum Acceptable" criteria. When you
click this checkbox, the next two "Maximum Acceptable" fields are displayed, as well as
the QOS Thresholds are Exceeded field at the bottom of the window.
Maximum Acceptable Round Trip Delay (RTD) Exceeds
When you click on the Enable QOS checkbox, this field is displayed. The Maximum
Acceptable Round Trip Delay field allows you to specify IP QOS criteria for this
Endpoint. New calls will continue to be routed to this Endpoint as long as the Round Trip
delay between the Routing Server and this endpoint remains below this specified setting.
The Routing Server may be configured to generate an Alarm and E-mail notification if
this Endpoint fails to meet this criteria.
The Maximum Acceptable Round Trip Delay is expressed in milliseconds and may be set
to the values 0-1000, inclusive.
Note
Calls must meet several additional criteria to route to an Endpoint, such as matching a
dial number pattern. However, IP round trip delay exceeding the specified value will
remove the Endpoint from routing consideration.
Maximum Acceptable Packet Loss Exceeds
When you click on the Enable QOS checkbox, this field is displayed. The Maximum
Acceptable Packet Loss field allows you to specify an IP QOS criteria threshold for this
Endpoint. New calls will continue to be routed to this Endpoint as long as the Packet
Loss between the Routing Server and this Endpoint remains below this specified criteria.
The Routing Server may be configured to generate an Alarm and E-mail notification if
this Endpoint fails to meet this criteria.
The Maximum Acceptable Packet Loss is expressed as a percentage and may be set to the
values 0-100, inclusive.
Note
Calls must meet several additional criteria to route to an Endpoint, such as matching a
dial number pattern. However, IP Packet Loss exceeding the specified value will remove
the Endpoint from routing consideration.
Send Email Alert To __ When The Following Conditions Are Met
Enter an email address so that an email can be sent automatically when conditions
defined in the next four fields are met.
Page 57 of 89
Answer Seizure Rate
When you click on the checkbox, a text entry box appears. Enter the percentage that the
Answer Seizure Rate must drop below in order to generate an email alert.
Average Call Duration
When you click on the checkbox, a text entry box appears. Enter the number of seconds
that the Average Call Duration must drop below in order to generate an email alert.
Average Post Dial Delay
When you click on the checkbox, a text entry box appears. Enter the number of
milliseconds that the Average Post Dial Delay must rise above in order to generate an
email alert.
QOS Thresholds are Exceeded
When you click on the Enable QOS checkbox (above), this field is displayed. Enables an
email alert when QOS thresholds defined under Enable QOS exceed their defined values.
Example
"China Tenor CMS #36"
"Enterprise A New Jersey Tenor D3200"
Contact
Contact is a text string that you associate with the Endpoint. This field is purely for your
convenience to provide any additional information to associate with the Endpoint, and
may be used in generated reports. This description field does not affect the behavior of
the Routing Server.
Description
Description is a text string that you associate with the Endpoint. This field is purely for
your convenience to provide any additional information to describe the Endpoint, and
may be used in generated reports. This description field does not affect the behavior of
the Routing Server.
Address
Address is a text string that you associate with the Endpoint. This field is purely for your
convenience to provide any additional information to associate with the Endpoint, and
may be used in generated reports. This description field does not affect the behavior of
the Routing Server.
TrunkGroups
Trunk Groups are logical entities in Endpoints. Calls originate from Ingress Trunk
Groups and are routed to an Egress Trunk Group. A Trunk Group consists of one or more
Telco interfaces logically grouped together as a single entity for routing purposes.
Page 58 of 89
Trunk Groups Configuration Parameters
General Tab
Name
Name is a text string that you associate with the Trunk Group. We recommend that the
Name field contain a descriptive phrase, since you will associate Egress Group to Trunk
Groups based on it.
Example
"Carrier A Trunk Group"
"Enterprise A Trunk Group"
Trunk Group ID
The Trunk Group ID is a number that is automatically generated by the system.
Trunk Group Type
Trunk Group Type indicates the type of Egress Trunk Group. In the case of managed
gateways, this parameter must match what is configured in the Endpoint itself . The
Trunk Group Type may also be used to specify the method by which to send an Egress
call, if the Trunk Group endpoint is a Gatekeeper. In this case, either ARQ or LRQ may
be used to request a route lookup. Possible values for the Trunk Group Type are as
follows:
• Unmanaged
• Line Circuit Routing Group
• Trunk Circuit Routing Group
• IP Routing Group (ARQ)
• IP Routing Group (LRQ)
• IP Routing Group (SIP)
Maximum Call Capacity
Maximum Call Capacity specifies the actual hardware capacity of the Trunk Group in
calls. This parameter is used to limit the number of calls that will be allowed to egress
through an Endpoint, and also to implement load balancing. You may further limit the
amount of allowed calls on a Trunk Group through the Maximum Allowed Active Calls
parameter.
Description
Description is a text string that you associate with the Trunk Group. This field is purely
for your convenience to provide any additional information to associate with the Trunk
Group, and may be used in generated reports. The Description field does not affect the
behavior of the Routing Server.
Page 59 of 89
Route Directory
The Route Directory button provides convenient access to the associated egress routes.
The button contains the name of the associated Route Directory. Click the button to jump
to the associated Route Directory configuration window.
Subscriber Directory
The Subscriber Directory button provides convenient access to the associated
subscribers for this Trunk Group. The button contains the name of the associated
Subscriber Directory. Click the button to jump to the associated Subscriber Directory
configuration window.
Trunk Group Profile
The Trunk Group Profile button provides convenient access to the associated trunk
group profile. The button contains the name of the associated Trunk Group Profile. Click
the button to jump to the associated Trunk Group Profile configuration window.
Egress Tab
Minimum Acceptable Egress ASR
Minimum Acceptable Egress ASR allows a limit to be placed on the Answer Seizure
Ratio for Egress calls on this Trunk Group. ASR is the number of successfully completed
calls divided by the total number of Egress call attempts over a sliding window. If the
Egress Trunk Group ASR performance falls below the specified rate, an Alarm indication
is generated. Further, the Trunk Group may be configured to be removed from service if
this level were to be reached. In this event, the Trunk Group would need to be manually
re-activated to be placed into service again.
Egress Enable
Egress Enable allows calls to terminate to this Trunk Group. When disabled, calls will
not be routed to this Egress Trunk group.
Egress Number Translation Table
The Egress Number Translation table displays the egress translation policies contained
in the current Trunk Group. All translation policies or a subset may be displayed,
depending on whether or not the filtering mechanism has been enabled. See Import CSV
files to a Trunk Group for instructions on populating this table by importing an external
CSV text file.
Egress DID Table
The Egress DID table displays the Direct Inward Dialing number defined for this Trunk
Group. All DIDs or a subset may be displayed, depending on whether or not the filtering
mechanism has been enabled. See Import CSV files to a Trunk Group for instructions on
populating this table by importing an external CSV text file.
Page 60 of 89
Add Number Translation Button
Click Add to add a new Number Translation to the current directory. A dialog box
appears in which you may enter the translation policy.
Delete Number Translation Button
Click Delete to remove an existing Number Translation from the current directory.
Before you click Delete, select a specific translation policy to remove by clicking an
entry in the table so that it is highlighted.
Edit Number Translation Button
Click Edit to edit or modify an existing translation policy from the current directory.
Before you click Edit, select a specific translation policy to modify by clicking an entry
in the table so that it is highlighted. A dialog box appears in which you may modify the
translation policy.
Previous Number Translation Button
The Previous button appears when the number of translation policies exceeds 100. Click
Previous to navigate through the entire list of translation policies in groups of 100.
Next Number Translation Button
The Next button appears when the number of translation policies exceeds 100. Click
Next to navigate through the entire list of translation policies in groups of 100.
Filter DID Button
Click Filter to specify a subset of the DID entries to be displayed. This is useful if there
is a large number of entries in the DID Table. You may specify the subset of DIDs to
include in the display based upon number patterns.
Add DID Button
Click Add to add a new DID to the current directory. A dialog box appears in which you
may enter the DID.
Delete DID Button
This button removes an existing DID from the current directory. Select a specific DID to
remove by clicking an entry in the table so that it is highlighted, then click Delete.
Edit DID Button
This button allows you to edit or modify an existing DID entry from the current directory.
Select a specific DID entry to modify by clicking an entry in the table so that it is
highlighted, then click Edit. A dialog box appears in which you may modify the DID.
Previous DID Button
The Previous button appears when the number of DID entries exceeds 100. Click
Previous to navigate through the entire list of DID entries in groups of 100.
Next DID Button
The Next button appears when the number of DID entries exceeds 100. Click Next to
navigate through the entire list of DID entries in groups of 100.
Page 61 of 89
several formats including explicit, simplified patterns, and regular expressions, and as a
result may represent a single number, an entire calling area, or a subset of a calling area.
Delete Digits
Delete Digits specifies the number of dialed digits to remove from the start of the number
before dialing by the terminating gateway. Delete Digits is an integer number and may be
0 if no digits are to be deleted. Digits are deleted from the dialed number prior to any
prefix to be added through the use of the Add Prefix configuration.
Example
The user dials "18475551212," which terminates to a Trunk Group with Egress Number
Translation enabled. The dialed number matches an Egress Number Translation Number
Pattern that has Delete Digits set to 4. The resulting number dialed by the terminating
gateway is "5551212" unless numbers are to be added with the Add Prefix option.
Add Prefix
Add Prefix specifies the number of dialed digits to prepend to the start of the dialed
number before dialing the number by the terminating gateway. Add Prefix is an integer
number and may be 0 if no digits are to be deleted. Digits are deleted from the dialed
number by the Delete Digits configuration prior to any prefix to be added through the use
of the Add Prefix configuration.
Example
The user dials "18475551212," which terminates to a Trunk Group with Egress Number
Translation enabled. The dialed number matches an Egress Number Translation Number
Pattern that has Delete Digits set to 4, and Add Prefix set to 1. The resulting number
dialed by the terminating gateway is "15551212."
TON
TON is an integer value representing the Type of Number of the dialed number. TON
may be used to specify whether the dialed number is an international or national number.
TON values are defined by recommendation ITU-T Q.931.
NPI
NPI is an integer value representing the Numbering Plan that identifies the nature of the
dialed number. NPI may be used to specify whether the dialed number is an E.163/E.164
or a private numbering plan. NPI values are defined by recommendation ITU-T Q.931.
Page 62 of 89
Add Egress DID Dialog Configuration Parameters
Number Pattern
Number Pattern specifies a dialed number that will be treated as a Direct Inward
Dialing (DID) number in the voice network. Number patterns may be expressed in one
of several formats including explicit, simplified patterns, and regular expressions, and as
a result may represent a single number, an entire calling area, or a subset of a calling area.
DID entries take precedence over Route Directory entries. As a result, when a DID
number matches a dialed number, the associated Egress Trunk Group will always be
chosen as the termination point, regardless of the Routing Criteria specified in the Ingress
Group.
Note
DID entries may be used to implement IP local loop applications.
Ingress Tab
Ingress Enable
Ingress Enable allows calls to ingress to the managed voice network from this Trunk
Group. When disabled, ingress calls from this Trunk Group are rejected.
Subscriber Lookup Type
Subscriber Lookup Type indicates the method used to identify subscribers who
generate Ingress calls to the Trunk Group. This parameter is associated with the
Subscriber Directory, which contains a list of subscribers or users of the voice network.
Subscriber Lookup Type indicates which of the four methods should be used to make
this subscriber or user identification: ANI, IP Address, MAC Address, or H323 ID.
Ingress Number Translation Table
The Ingress Number Translation table displays the ingress translation policies for the
current Trunk Group. All translation policies or a subset may be displayed, depending on
whether or not the filtering mechanism has been enabled. See Import CSV files to a
Trunk Group for instructions on importing an external CSV text file.
Page 63 of 89
Delete Button
Click Delete to remove an existing translation policy from the current directory. Select a
specific translation policy to remove by clicking an entry in the table so that it is
highlighted, then click Delete
Edit Button
Select a specific translation policy to modify by clicking an entry in the table so that it is
highlighted, then click Edit. A dialog box appears in which you may modify the
translation policy.
Filter Button
Click Filter to specify a subset of the Ingress Number Translation entries to be displayed.
This is useful if a large number of entries exist with the Ingress Number Translation
Table. You may specify the subset of Number Translations to include in the display
based upon number patterns.
Previous Button
The Previous button appears when the number of translation policies exceeds 100. Click
Previous to navigate through the entire list of translation policies in groups of 100.
Next Button
The Next button appears when the number of translation policies exceeds 100. Click
Next to navigate through the entire list of translation policies in groups of 100.
Page 64 of 89
Note
Ingress Number Translation entries may be used to remove IP technology prefixes prior
to call routing.
Delete Digits
Delete Digits specifies the number of dialed digits to remove from the start of the dialed
number. Delete Digits is an integer number and may be 0 if no digits are to be deleted.
Digits are deleted from the dialed number prior to any prefix to be added through the use
of the Add Prefix configuration.
Example
The user dialed 18475551212, which entered the voice network on an IP Trunk Group
that has Ingress Number Translation enabled. The dialed number matches an Ingress
Number Translation Number Pattern that has Delete Digits set to 4. The resulting dialed
number presented to the routing engine will be 5551212,unless numbers will be added
with the Add Prefix option.
Add Prefix
Add Prefix specifies the number of dialed digits to prepend to the dialed number, after
the number of digits have been removed from the dialed number through the Delete
Digits configuration. Add Prefix is a number string.
Example
The user dialed "18475551212," which entered the voice network on an IP Trunk Group
that has Ingress Number Translation enabled. The dialed number matches an Ingress
Number Translation Number Pattern that has Delete Digits set to 4, and Add Prefix set
to 1. The resulting dialed number presented to the routing engine will be "15551212."
TON
TON is an integer value representing the Type of Number that identifies the nature of the
dialed number. TON may be used to specify whether the dialed number is an
international or national number. TON values are defined by recommendation ITU-T
Q.931.
NPI
NPI is an integer value representing the Numbering Plan that identifies the nature of the
dialed number. NPI may be used to specify whether the dialed number is an E.163/E.164
or a private numbering plan. NPI values are defined by recommendation ITU-T Q.931.
Page 65 of 89
Help Button
Click Help to open the Help system for the Ingress Number Translation policy.
Advanced Tab
Ingress Group
The Ingress Group drop-down box lets you select an Ingress Group to associate with
this Trunk Group. Once associated, ingress calls on this Trunk Group use the associated
Ingress Group to specify the routing policy, unless overridden by a Subscriber profile.
Route Directory
The Route Directory drop-down box lets you select a Route Directory to associate with
this Trunk Group. Once associated, this Egress Trunk Group uses the associated Route
Directory to specify potential Egress routes that may terminate on this Trunk Group.
Subscriber Directory
The Subscriber Directory drop-down box lets you select a Subscriber Directory to
associate with this Trunk Group. Once associated, ingress calls on this Trunk Group use
the associated Subscriber Directory. When ingress calls arrive at the Trunk Group, the
associated Subscriber Directory is used to identify subscribers or users. If a Subscriber is
identified, the Ingress Group specified in the Subscriber profile is used to specify the
routing policy rather than the default Ingress Group specified in the Trunk Group.
Note
Subscriber Directories allow for the creation of different routing policies on a per
Subscriber basis.
Trunk Group Profile
The Trunk Group Profile drop-down box lets you select a Trunk Group Profile to
associate with this Trunk Group. Once associated, calls on this Trunk Group use the
associated Trunk Group Profiles to specify call characteristics on the Trunk Group.
Parameters such as Codec and Maximum Talk time are configured in the associated
Trunk Group Profile.
Selected Egress Group Table
The Selected Egress Groups table contains a list of Egress Groups that have been
associated with this Trunk Group. By associating an Egress Group to a Trunk Group,
calls may terminate to this Trunk Group from all Ingress Groups that are configured to
send voice traffic to the Egress Group.
Available Egress Group Table
The Available Egress Groups table contains a list of all of the Egress Groups defined in
the Routing Server. By associating an Egress Group to a Trunk Group, calls may
terminate to this Trunk Group from all Ingress Groups that are configured to send voice
traffic to the Egress Group.
Page 66 of 89
RouteDirectories
Route Directories are used to specify Egress routes for the voice network. Route
Directories contain one or more Route entries that have the information necessary to
specify each route. Each Route entry contains the number pattern, time-based routing
information, and least-cost routing information.
By default, a Route Directory is created for each Trunk Group in the Routing Server. The
system-generated Route Directory is then associated with its Trunk Group. Although this
one-to-one relationship exists between the Trunk Groups and Route Directories by
default, it is also possible to associate a single Route Directory to multiple Trunk Groups.
This is useful as multiple Trunk Groups may be used as Egress points for the same
routes.
Route Directory Configuration Parameters
General Tab
Name
Name is a text string that you associate with the Route Directory. It is recommended that
you use a descriptive phrase for the Name, since you will associate Route Directories to
Trunk Groups based on it.
Example
"China Routes"
"Enterprise A Routes"
Priority
Priority is a user-defined metric assigned to all of the routes contained in the Route
Directory. The Priority field may be used by the Routing Server route engine as one of
the criteria for prioritizing potential egress routes for a given call.
Quality Rating
Quality Rating is a user-defined metric assigned to all of the routes contained in the
Route Directory. The Quality Rating field may be used by the Routing Server route
engine as one of the criteria for prioritizing potential egress routes for a given call.
Partner
The fields on this panel are text strings that you associate with the Route Directory. This
is purely for your convenience to provide additional information to associate with the
Route Directory, and may be used in generated reports. This field does not affect the
behavior of the Routing Server. This panel contains the following items: Partner Name,
Partner Description, Partner Contact, Partner Email Address, Partner Phone
Number, Partner Fax Number, and Partner Address.
Page 67 of 89
Route Table
The Route Table displays the routes contained in the current Route Directory. The list
box may display either the entire set of routes or a subset, if the filtering mechanism has
been enabled.
Page 68 of 89
Note
Time is always expressed in local Egress Trunk Group time. Route Directories may be
used by one or more Trunk Groups, which may reside in multiple physical locations
which may reside in different time zones. The Routing Server routing engine is aware of
the time zones and will implement time-based routing according to the time configuration
information in the Route entry as will as physical Trunk Group time zone.
Start Time
Start Time represents the time at which the route entry will become enabled. Each route
entry may be enabled continuously or time-based routing may be implemented. Time-
based routing allows for certain routes to be disabled during certain periods of time, or
different costs to be associated with routes at different times. The Start Time field may
be used by the Routing Server route engine when selecting potential egress routes for a
given call. When a new Route entry is created, the Start Time field defaults to enabling
the route at all times (0 Start Time to 2359 End Time).
End Time
End Time represents the time at which the route entry will become disabled. Each route
entry may be enabled continuously, or time-based routing may be implemented. Time-
based routing allows for certain routes to be disabled during certain periods of time, or
different costs to be associated with routes at different times. The End Time field may be
used by the Routing Server route engine when selecting potential egress routes for a
given call. When a new Route entry is created, the End Time field defaults to enabling
the route at all times (0 Start Time to 2359 End Time).
Start Day
Start Day represents the day on which the route entry will become enabled. Each route
entry may be enabled continuously, or time-based routing may be implemented. Time-
based routing allows for certain routes to be disabled during certain periods of time, or
different costs to be associated with routes at different times. The Start Day field may be
used by the Routing Server route engine when selecting potential egress routes for a
given call. When a new Route entry is created, the Start Day field defaults to enabling
the route at all times.
End Day
End Day represents the day at which the route entry will become disabled. Each route
entry may be enabled continuously, or time-based routing may be implemented. Time-
based routing allows for certain routes to be disabled during certain periods of time, or
different costs to be associated with routes at different times. The End Day field may be
used by the Routing Server route engine when selecting potential egress routes for a
given call. When a new Route entry is created, the End Day field defaults to enabling the
route at all times.
Max. Calls Allowed
Max Calls Allowed allows a limit to be placed upon the number of calls that may be
connected to a particular Egress Route at any given time. Since it may be possible to
associate the Route Directory to multiple Trunk Groups, this limit would represent the
maximum number of calls between all of the Trunk Groups.
Page 69 of 89
Note
The Routing Server also allows calls to be limited on a per Egress Trunk Group basis.
For example, calls to a particular trunk group may be limited to the number of channels
available on the Trunk Group. This feature is enabled by the Maximum Allowed Active
Calls parameter in the Trunk Group configuration.
Enable
Enable allows you to temporarily disable an Egress Route entry from being used by the
routing engine. This parameter is manually configured, and must be manually re-enabled
to allow calls once again to complete to the Egress Route.
Example
1847*
Regular Expression Filtering Button
Select Regular Expression Filtering to enable filtering by regular expression. When
selected, only those table entries that match the Regular Expression text field are
displayed. Such filtering may be used to display a subset of entries.
If you choose to filter the table entries based on a regular expression, enter the
expression in the Regular Expression text field. Only those table entries that match the
string contained in the Regular Expression text field are displayed. This may be used to
display a subset of table entries for easy viewing.
Page 70 of 89
Example
^1847.*
Apply Button
Click Apply to implement any modifications made to the Filter.
Cancel Button
Click Cancel to cancel the editing of a Filter. Changes made in the Filter dialog box will
not take effect. Click Cancel to discard any modifications made to the Filter.
Help Button
Click Help to open the Help system for the Filter dialog box.
Page 71 of 89
Command Line Interface Commands
To access the CLI, you must first connect through a standard ssh session from any PC on
your IP network. Most Unix™ and Linux™ operating systems come with an ssh client
such as openssh. For Windows, there are many ssh clients available. The two most
popular are Putty and SecureCRT. See below.
• Putty (freeware): http://www.chiark.greenend.org.uk/~sgtatham/putty/
• SecureCRT®: http://www.vandyke.com/
Configuration Commands
The Command Line Interface (CLI) has several commands related to configuration.
• ether
• gateway
• ntpserver
• passwd
• radius
• radiusport
• radiussecret
• subscriber
• ipcache
• nameserver
• fromaddr
ether
Description Enables you to configure the Ethernet Port IP configuration, Ethernet Port IP
Address, and Ethernet Port Subnet Mask. You can also display the current
Ethernet Port IP address and Subnet Mask already configured.
When the unit is initially shipped, the IP address is set to 0.0.0.0.
Syntax • ether. Displays Ethernet statistics for the given Ethernet port.
• ether ip {ipaddress}. Standard IP address for the Ethernet port.
• ether netmask {netmask}. Standard subnet mask for the given
netmask port.
Examples Routing Server> ether
Ethernet Port 0 Configuration
IP Address : 192.168.2.20
Subnet Mask: 255.255.255.0
Routing Server> ether ip 192.168.8.29
Page 72 of 89
gateway
Description Enables you to configure and display the address for the default IP gateway.
When the unit is shipped, the IP address is set to 0.0.0.0.
Syntax • gateway. Displays the current default IP gateway.
• gateway {ipaddress}. Sets the default gateway IP address.
Examples Routing Server> gateway
Displays as follows:
Default Gateway IP Address : 192.168.2.1
Routing Server> gateway 192.170.8.20
Sets the default IP gateway IP address to 192.170.8.20.
ntpserver
Description Enables you to configure and display the Network Time Protocol (NTP)
Server IP address. When the unit is shipped, the default is set to 0.0.0.0.
Syntax • ntpserver. Displays the current NTP Server IP address.
• ntpserver {ipaddress}. Sets the default NTP Server IP address.
Examples Routing Server> ntpserver
Displays as follows:
Network Time Protocol (NTP) Server: 130.126.24.24
Network Time Protocol (NTP) Server: 140.221.9.20
Routing Server> ntpserver 192.170.8.20
passwd
Description To prevent unauthorized access to the Routing Server, a password is
included when you first log into the system. The default password is admin.
The passwd command enables you to change the default password.
Syntax passwd {password}.
Enter a password.
Examples Routing Server> passwd test1
radius
Description Displays RADIUS configuration, including IP port and RADIUS secret.
Syntax radius. The RADIUS IP port and RADIUS secret are displayed.
Examples Routing Server> radius
Routing Server Radius IP port: 1812
Routing Server Radius secret : 123456789
Page 73 of 89
radiusport
Description Identifies the port number for the RADIUS host server.
Syntax radiusport {port}. Configures the RADIUS IP port. Valid entry: 0-65535.
Examples Routing Server> radiusport 1812
radiussecret
Description Sets the RADIUS key. As a security measure, the radiussecret enables the
Tenor Routing Server to share encrypted data with the RADIUS server. This
value must be identical to the value configured on the RADIUS server.
Syntax radiussecret {secret}. Optional, but must match what is configured on the
RADIUS Server as the sharedsecret. This alphanumeric value can be up to
65 characters in length.
Examples Routing Server> radiussecret 1a2b3c
subscriber
Description Sets the subscriber information for a specific IP local loop application. You
should check with Support before using this command.
Syntax subscriber { -m, -n, -p, -s, -i id, -e, -r id, -D 1, -E, -I }
• subscriber -m. Specifies subscriber macaddress.
• subscriber -n. Specifies subscriber phone number
• subscriber -p. Specifies primary call relay IP address.
• subscriber -s. Specifies secondary call relay IP address.
• subscriber -i id. Modifies information for specified index number.
• subscriber -e. Enables specified subscriber.
• subscriber -r id. Removes subscriber with specified index number.
• subscriber -D 1. Dumps all subscriber information to screen.
• subscriber -E. Exports data in file to specified filename.
• subscriber -I. Imports data from specified filename.
Examples Routing Server> subscriber -m 0a0b0c0d0e0f -n 18475551212 -p
192.168.2.1 -s 192.168.2.2
This will create a new analog Gateway with macaddress 0a0b0c0d0e0f and
number 18475551212, primary call relay 192.168.2.1 and secondary call
relay 192.168.2.2.
Routing Server> subscriber -E data.txt
This exports data in the file /backup/data.txt, where you can FTP it.
Page 74 of 89
ipcache
Description Updates the dynamic IP entry for a specific IP local loop application. You
should check with Support before using this command.
Syntax ipcache { -m, -i, -r }
• ipcache -m. Specifies the macaddress for the entry.
• ipcache -i. Specifies the ipaddress for the entry.
• ipcache -r. Removes the specified entry.
Examples Routing Server> ipcache -m 0a0b0c0d0e0f -i 192.168.2.1
nameserver
Description Sets the DNS name server. Used in cases where you wish to identify the
DNS address for a specific application.
Syntax nameserver {ipaddress}
Examples Routing Server> nameserver 192.168.2.20
fromaddr
Description Sets the "from address," to be used as the return address in emails to help
identify and group them together.
Syntax fromaddr {ipaddress}
Examples Routing Server> fromaddr 192.168.2.20
Page 75 of 89
Maintenance Commands
The Command Line Interface (CLI) has several commands related to maintenance.
• backup
• ping
• restore
• update
• routeserver
• shutdown
• tgasrreset
• factorydefault
• logout
• clear
backup
Description Performs a backup of Routing Server data, which includes all the
information configured via CLI or with Routing Server Manager. The backup
file is stored in the backup directory, under a filename you specify.
Syntax backup {filename.enc}
Guidelines The backup file is saved as the filename you specify; the default directory is
c:\backup\. After you type the filename, the .enc extension is added. An
example backup filename is db.monday.enc. Upon successful backup, a
message is displayed: “Backup file stored at \backup\db.monday.enc.”
The backup command overwrites the previous backup file.
For backup purposes, we recommend you FTP to the Routing Server and
then FTP the backup file to another machine.
Once the backup is completed, a message is displayed.
Examples Routing Server> backup db.monday.enc
Page 76 of 89
ping
Description Ping Command. Used to perform a standard ping test between the Routing
Server and the IP host at the specified IP address.
Syntax ping {ipaddress}
Guidelines Very useful for testing the IP route between 2 locations.
Examples Routing Server> ping 192.168.1.1
restore
Description Restores the backup file you created using the backup command.
Syntax restore {filename}
Guidelines Before issuing a restore command, you must ensure the latest backup file is
stored in the backup directory with the original filename (such as
/backup/db.monday.enc).
The backup file will be restored to the same directory in which the file was
created. Upon successful restore, a message is displayed.
Examples Routing Server> restore db.monday.enc
update
Description Performs an automatic software update check on the Quintum website, and
downloads new software.
Syntax update
Guidelines If new software is available from Quintum, this command will automatically
download the most recent software. Note that any software downloaded
from Quintum will be activated at the next restart.
Examples Routing Server> update
Performs automatic update check/download.
Page 77 of 89
routeserver
Description Sets the operating state of the Routing Server. You can start, stop, or restart
the Routing Server.
Note This command is used for debugging purposes. Use care with this
command; the routeserver command should be used for debug purposes
only.
Syntax routeserver {start|stop|restart}
• routserver start. Starts the Routing Server.
• routeserver stop. Stops the Routing Server
• routeserver restart. Restarts the Routing Server; equivalent to
performing a routeserver stop and subsequent routeserver start.
Examples Routing Server> routeserver stop
shutdown
Description Turns off the Routing Server.
Syntax shutdown
Examples Routing Server> shutdown
tgasrreset
Description Resets the ASR (Answer Seizure Rate) statistics for the specified trunk
group.
Syntax tgasrreset {trunk id}
Examples Routing Server> tgasrreset 2hl78
Resets the ASR stats for trunk group with trunk ID 2hl78.
factorydefault
Description Resets the Routing Server to factory defaults.
Syntax factorydefault
Examples Routing Server> fatorydefault
logout
Description Logs out from the system.
Syntax logout
Examples Routing Server> logout
Page 78 of 89
clear
Description Clears all information. Only the Routing Server> prompt is displayed.
Syntax clear
Examples Routing Server> clear
Page 79 of 89
Monitoring Commands
The Command Line Interface (CLI) has several commands related to monitoring.
• alarms
• calllog
• calls
• ipstats
• ev
• rejectlog
• routelog
• status
• tgstats
• time
• date
• unroutablelog
• version
alarms
Descriptio A monitoring command used to display alarm statistics.
n
Syntax alarms {-h, -a, -l, -o}
• alarms -h. Displays help.
• alarms -a. Displays active alarms.
• alarms -l. Displays alarm history.
• alarms -o. Generates log file on server.
Examples Routing Server> alarm -l
Displays an alarm history for the system.
Page 80 of 89
Sample alarms -a
Display Id Time Type Severity IP
Address TGId Description
==========================================================================
===========
1 2003-03-01 03:38:27 2003-03-01 03:38:57 1 1 2
192.168.2.16 9 None Excessive Packet Loss
2 2003-03-01 04:10:44 2003-03-01 04:11:44 1 1 2
192.168.2.16 9 None Excessive Packet Loss
alarms -l
Id Time Clear Time Clear Type Type Severity IP
Address TGId Description
==========================================================================
===========
1 2003-03-01 03:38:27 2003-03-01 03:38:57 1 1 2
192.168.2.16 9 None Excessive Packet Loss
2 2003-03-01 04:10:44 2003-03-01 04:11:44 1 1 2
192.168.2.16 9 None Excessive Packet Loss
3 2003-03-01 04:13:14 2003-03-01 04:15:14 1 1 2
192.168.2.16 9 None Excessive Packet Loss
4 2003-03-05 16:57:54 2003-03-05 17:12:24 1 1 2
192.168.2.16 9 None Excessive Packet Loss
5 2003-03-05 17:22:25 2003-03-05 17:23:25 1 1 2
192.168.2.16 9 None Excessive Packet Loss
calllog
Description Displays the data in the call log.
Syntax calllog {-h, -c, -s, -r, -l, -o)
• calllog Displays the data in the call history log.
• calllog -h. Displays help.
• calllog -c. Clears the calls from the buffer.
• calllog -s{IP}. Identifies the call source endpoint IP address. Enter
the desired IP address. Enter a valid IP address.
• calllog -d{IP}. Identifies the call destination endpoint IP address.
Enter the desired IP address. Enter a valid IP address.
• calllog -r{rec}. Displays specific calllog record by record number.
Enter a valid record number.
• calllog -l{num}. Limits the number of displayed log entries displayed
on the screen. A valid entry is 1-5,000.
• calllog -o. Writes the screen data to a text file to the \log directory on
the server. You can FTP the file and use any applicable editor to
review.
Examples Routing Server> calllog
Page 81 of 89
Sample Call History Log Example
Display Conn Time Disc Time Duration Src IP
Dst IP DNIS ANI Disc Code
2003-03-07 14:53:46 2003-03-07 14:54:46 60 192.168.2.169
192.168.2.169 184 72220169 16
2003-03-07 14:53:46 2003-03-07 14:54:46 60 192.168.2.169
192.168.2.169 184 72220169 16
2003-03-07 14:53:45 2003-03-07 14:54:45 60 192.168.2.169
192.168.2.169 184 72220169 16
2003-03-07 14:53:45 2003-03-07 14:54:45 60 192.168.2.169
192.168.2.169 184 72220169 16
2003-03-07 14:53:45 2003-03-07 14:54:45 60 192.168.2.169
192.168.2.169 184 72220169 16
2003-03-07 14:53:46 2003-03-07 14:54:45 59 192.168.2.169
192.168.2.169 184 72220169 16
2003-03-07 14:53:43 2003-03-07 14:54:44 61 192.168.2.169
192.168.2.169 184 72220169 16
calls
Description A monitoring command to display a log of incoming/outgoing calls, which
includes call source endpoint IP address and destination IP address.
Syntax calls
Examples Routing Server> calls
Page 82 of 89
ipstats
Description Displays IP QOS statistics (roundtrip) for each endpoint.
Syntax ipstats -i{id}. Displays the specific endpoint IP QOS history. Enter the
specific ID.
Examples Routing Server> ipstats -i1
ev
Description Displays Event Log. The built-in Event Log is an extremely useful and
powerful troubleshooting tool. With it you are able to watch the actual call
flow and routing events as they occur.
Syntax ev help Displays all the available command modifiers.
ev {1,2,3,4,5,6} Sets the verbosity level for event logging from 1-6, 1 being
the least verbose, 6 being the most. 5 is the default and is the
recommended setting. Levels are as follows:
• 1 - Alert
• 2 - Critical
• 3 - Errors
• 4 - Warning
• 5 - Notice
• 6 - Info
ev d An event dump of this type screen prints the entire Event Log Buffer
as it stands at the moment, at the levels that are currently specified.
ev c Clears the Event Log Buffer. It often makes it easier to view,
particularly on a slow link, if you clear out the contents of the buffer prior to
any troubleshooting.
ev qu Leaves the prompt and enters Observation/Continuous mode to
view the real-time Event Log Trace. To return to the prompt from
Continuous mode, type Ctrl-C.
Examples Routing Server> ev 2
Page 83 of 89
rejectlog
Description Displays a history log of rejected calls.
Syntax rejectlog {-h, -c, -s, -r, -l, -o)
• rejectlog. Displays a history log of rejected calls.
• rejectlog -h. Displays help.
• rejectlog -c. Clears the calls from the buffer.
• rejectlog -s{IP}. Identifies the call source endpoint IP address.
Enter the desired IP address. Enter a valid IP address.
• rejectlog -r{rec}. Displays specific record by record number. Enter
a valid record number.
• rejectlog -l{num}. Limits the number of displayed log entries. A
valid entry is 1-5,000.
• rejectlog -o. Writes the screen data to a text file to the \log directory
on the server. You can FTP the file and use any applicable editor to
review.
Examples Routing Server> rejectlog
Displays a history log of rejected calls.
routelog
Description Displays a history of successfully routed calls. You can also define the list
by the IP address, limit the number of log entries, and generate a log file on
the server.
Syntax routelog {h,c, s, r, l, o)
• routelog. Displays a list of successfully routed calls.
• routelog -h. Displays help.
• routelog -c. Clears the calls from the buffer.
• routelog -s{IP}. Identifies the call source endpoint IP address.
Enter the desired IP address.
• routelog -r{rec}. Displays specific record by record number. Enter a
valid record number.
• routelog -l{num}. Limits the number of displayed log entries. Valid
entry: 1-5,000.
• routelog -o. Writes the screen data to a text file to the \log directory
on the server. You can FTP the file and use any applicable editor to
review.
Examples Routing Server> routelog
Page 84 of 89
status
Description Displays Routing Server statistics, such as call requests and the status of
the Calls Per Second, including current, max, and average Calls per Second
(CPS). The information provided includes:
• Total Requests: The total number of call requests coming into the
Routing Server.
• Dropped Requests: The number of calls dropped because the
number exceeded the CPS defined in the license.
• Current CPS: The CPS of the previous second. This field is
updated every second.
• Max. CPS: When the CPS does not reach the CPS number set in
the license, this field documents the maximum CPS for actual
number reached.
• Average CPS: The average CPS for the total number of requests
per uptime.
• Uptime:The amount of time the system is up.
Syntax status
Examples Routing Server> status
Displays the status of the call request is and Calls Per Second.
Sample Total Requests: 0
Display
Dropped Requests: 0
Current CPS: 0
Max CPS: 0
Average CPS: 0.000000
Uptime: 2 day(s),16 hour(s),17 min(s)
tgstats
Description Displays the Trunk Group details for each call, including IP address, trunk
group ID, and Min/Max allowed calls.
Syntax • tgstats. Displays details for each call.
• tgstats -h. Displays help.
Examples Routing Server> tgstats
Displays the status of the call requests and Calls Per Second.
Id IP Address TGID % ASR Min Allowed ASR Active Calls Max Allowed
Sample Calls % TG Loading
Display == ============= ==== ====== =============== ============
================= ============
1 192.168.2.169 0 100.0 0 92 99999
0.0
2 192.168.2.169 10 100.0 0 0 99999
0.0
Page 85 of 89
time
Description Displays the current time on the Routing Server.
Syntax time
Examples Routing Server> time
date
Description Displays the current date on the Routing Server.
Syntax time
Examples Routing Server> date
unroutablelog
Description Displays a list of calls that could not be routed.
Syntax unroutablelog {help, c, s, r, l, o)
• unroutablelog -h. Displays help.
• unroutablelog -c. Clears the calls from the buffer.
• unroutablelog -s{IP}. Identifies the call source endpoint IP
address. Enter the desired IP address.
• unroutablelog -r{rec}. Displays specific record by record number.
Enter a valid record number.
• unroutablelog -l{num}. Limits displayed log entries: 1-5,000.
• unroutablelog -o. Writes screen data to a text file in the \log
directory on the server. You can FTP the file and review.
Examples Routing Server> unroutablelog
version
Description Displays Routing Server Manager version, as well as the CLI version.
Syntax version
Examples Routing Server> version
Page 86 of 89
License Commands
The CLI has two commands related to licenses.
showlicense
Description Displays the information for the Routing Server license. You may obtain the
license from Quintum Customer Support and FTP it to your unit. Types of
license information displayed include:
• Route Server License ID: License ID.
• CPS: Calls Per Second. Average network load defined as calls per
second. A valid range is 0-200.
• QMS: QOS Monitoring System. Universal monitoring system. QMS
is supported as part of the license agreement from Quintum
Customer Support (if applicable). This will be displayed as Licensed
or Not Licensed.
• ERA: External Routing API. This support is shown as part of the
license agreement from Quintum Customer Support (if applicable).
This will be displayed as Licensed or Not Licensed.
Syntax showlicense
showlicense -h. Displays help.
Guidelines Shows Routing Server license information, such as ID, CPS, QMS, and
ERA.
Examples Routing Server> showlicense
Displays license information.
Sample Route Server LicenseID :91036284
Display CPS License: :100 Expiry:NO EXPIRY
QMS License: :Not Licensed Expiry:NOT AVAILABLE
ERA License: :Not Licensed Expiry:NOT AVAILABLE
updatelicense
Description Updates the license information. Once you contact Customer Support to
access the license.dat file, and you FTP the file to your unit, you can use the
updatelicense command to update your license information on the unit.
Syntax updatelicense
Examples Routing Server> updatelicense
Updates license information to match the latest file you received from
Customer Support.
Page 87 of 89