You are on page 1of 158

SANSAY VSX

VOICE SESSION EXCHANGE


USER S GUIDE
RELEASE 7.05

Important Notices
Warnings!

Before connecting a VSX


softswitch
to a data
to a data
communications or telecommunications network,
have a qualified professional verify that the unit
is connected to a safety/earth ground, either
through the AC mains connector or directly
through the terminal at the rear of the chassis.

These are Class B products. In a domestic environment, these products may


cause radio interference, in which case the user may be required to take
adequate measures. The domestic environment is an environment where
the use of broadcast radio and television receivers may be expected within
a distance of 10 meters of the apparatus concerned.

Sansay, Inc.
4650 Lusk Blvd. Suite 204, San Diego, CA 92121 (858) 678-0200; FAX (858) 678-0203

S-VSX-301-TP-1B

Sansay VSX
Voice Session Exchange
Users Guide

Sansay, Inc.
May, 2006

Fourth Edition (May, 2006)


This edition applies to the Sansay, Inc. VSX product line. The licensed product described in this document
and all licensed materials that are available for it are provided by Sansay under terms of the agreement for
Sansay licensed products. Sansay periodically makes additions, deletions, or changes to the information in
this document. Before you use this document, consult Sansay or your distributor for the most recent edition.
The author and publisher have made reasonable efforts to ensure the accuracy and timeliness of the information in this book. However, neither the author nor the publisher shall have any liability with respect to
loss or damage caused or alleged to be caused by reliance on any information in this book.
Sansay may have patents or pending patent applications covering material in this document. Furnishing
this document does not of itself constitute a grant of any license or immunity under any patents, patent
applications, trademarks, copyrights, or other rights of Sansay, or of any third party, or any right to refer to
Sansay in any advertising or other marketing activities. Sansay assumes no responsibility for any infringement of patents or other rights of third parties that may result from use of the material in this document or
for the manufacture, use, lease, or sale of machines or software programs described herein, outside of any
responsibilities assumed in the original or subsequent purchase or lease agreements.
This document may contain information about, or make reference to, Sansay products, programming, or services that are not available in your country. This information must not be construed to mean that Sansay
intends to make available such products, programs, or services in your country.
A form for your comments is provided at the back of this document. If the form has been removed, address
your comments to: Sansay, Inc., Information Development Group, 4650 Lusk Blvd. Suite 204, San Diego, CA
92121.
Sansay may use or distribute any of the information you supply in any way it believes appropriate without
incurring any obligation to you.
No part of this publication may be reproduced in any manner without the written permission of Sansay, Inc.
For information, write to: Sansay, Inc., Legal Office, 4650 Lusk Blvd. Suite 204, CA 92121.
2006 by Sansay, Inc.
All rights reserved
Printed in the United States of America

TABLE OF CONTENTS
About This Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii
Who Should Use This Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii
How To Use This Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii
Textual Callouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviii
Getting Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviii
Service and Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xix
Chapter 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
VSX Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Session Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Border Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Protocol Interworking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Gatekeeper Interconnect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SIP Proxy Connect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
VSX OS and Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Redundancy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
High Availability Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Media Switch VMX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
VMX Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
VSX Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1
1
1
2
3
4
5
5
6
7
7
8
8

Chapter 2. Setting up the VSX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9


Unpacking the VSX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Installing the VSX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Rack Mounting the VSX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Making External Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Connecting the Local Area Network Port. . . . . . . . . . . . . . . . . . . 11
Connecting the Power Cable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Applying System Power . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Chapter 3. Before You Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
System Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Resources Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Routes Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Users Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

13
13
14
14
15
15
15

Chapter 4. Initial Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


Logging In . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Changing Passwords. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Editing Network Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Setting System Date and Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Submitting the Changes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

17
17
18
18
20
21

ix

Sansay VSX Users Guide

Configuring Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Routes Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Adding Users. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Chapter 5. Adding and Configuring Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Opening the Resource Add Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Adding Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
General Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Resource Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Digit Translation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Ingress Action Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Egress Action Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Codecs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Resource Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

25
26
28
28
31
33
36
36
36
37

Chapter 6. Adding and Configuring Routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


Opening the Add Route Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring a Route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Proportional Routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring Route Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Placing Test Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Importing Routes and Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Exporting Routes and Tables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

39
39
41
43
44
45
45
47

Chapter 7. Digit Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49


Digit Mapping List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Digit Matching Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Chapter 8. Managing Users. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Opening the Users Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Adding a User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Editing and Deleting Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Editing Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Deleting Users. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

55
55
56
57
57
58

Chapter 9. Viewing Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


Opening the Statistics Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Viewing Route Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Viewing System Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

59
59
60
61

Chapter 10. Editing and Deleting Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


How Resources Are Edited. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Editing Gateways . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Deleting Gateways . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Editing Routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Deleting Routes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

63
63
64
64
64
65

Chapter 11. Managing the VSX System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67


System Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Edit System Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
x

Table of Contents

Editing Network Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


Advanced Control Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Restoring A Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Saving a Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Upgrading VSX Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Rebooting the System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Restarting the VSX Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Taking the VSX Offline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Upgrading the VSX System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Editing Load Balance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using Radius Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Collecting Call Detail Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

72
73
74
74
75
76
76
77
78
79
80
81

Chapter 12. The VSX Configurator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


Logging In . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configurator GUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
System Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
System Page Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Radius Server Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
System Page Field Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . .
Resources Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Routes Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Users Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Monitoring Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Trace Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

83
83
84
85
85
86
87
87
89
91
93
94
96

Chapter 13. Sansay SOAP Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


XML Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Editing XML Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SOAP Client Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

97
97
97
98

Chapter 14. Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


Failing Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Tracing Calls. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Viewing Call Sessions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
H323 Protocol Log. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SIP Protocol Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced Trace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration Problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Retrying the Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Information about the Installation . . . . . . . . . . . . . . . . . . . . . . .
Troubleshooting the VSX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Basic Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Frequently Asked Questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Getting Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contacting TAC. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contacts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

101
101
103
104
106
107
108
109
109
109
110
110
111
113
113
114
114

xi

Sansay VSX Users Guide

Appendix A. Call Detail Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Call Detail Record Body . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Detail Field Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Release Causes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Sample CDR record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CDR File Storage/Retrieval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
File Storage Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
File Naming Convention . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
File Retrieval Procedure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

115
115
116
119
122
125
126
126
126
127

Appendix B. VSX Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129


Environmental Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

xii

LIST OF FIGURES
Figure 1. VSX Session Controller Application Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Figure 2. VSX Border Gateway Application Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Figure 3. VSX Protocol Support Application Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Figure 4. Gatekeeper Interconnect Application Diagram . . . . . . . . . . . . . . . . . . . . . . . . . 4
Figure 5. SIP Proxy Connect Application Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Figure 6. VSX 1U and 2U Chassis. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Figure 7. NEBS Compliant VSX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Figure 8. High Availability Node. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Figure 9. VMX Cluster Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Figure 10. VSX Front Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Figure 11. VSX Rear Panel External Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Figure 12. VSX Default IP Address. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Figure 13. VSX Login Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Figure 14. Edit Network Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Figure 15. Edit System Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Figure 16. VSX Resources Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Figure 17. Resource Add Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Figure 18. VSX Routes Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Figure 19. Add Route Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Figure 20. VSX Import Form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Figure 21. VSX Save Route Table Form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Figure 22. Digit Mapping List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Figure 23. Digit Mapping Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Figure 24. Digit Mapping Call Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Figure 25. VSX Users Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Figure 26. Add User Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Figure 27. Edit User Form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Figure 28. VSX Gateway Statistics Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Figure 29. VSX Route Statistics Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Figure 30. VSX System Statistics Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Figure 31. System Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Figure 32. Edit System Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Figure 33. Edit Network Connections Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Figure 34. VSX Advanced System Control Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Figure 35. Restore System Configuration Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Figure 36. VSX Save System Configuration Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Figure 37. VSX Upload Code Upgrade Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Figure 38. VSX Reboot System Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Figure 39. VSX Restart Software Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Figure 40. System Offline Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Figure 41. Generate System Key Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Figure 42. Radius Server Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Figure 43. Edit Radius Servers Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Figure 44. VSX Login Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

xiii

Sansay VSX Users Guide

Figure 45. System Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85


Figure 46. VSX Resources Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Figure 47. VSX Routes Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Figure 48. VSX Users Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Figure 49. VSX Gateway Stats Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Figure 50. Sansay VSX Trace Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Figure 51. VSX Trace Window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Figure 52. Call Sessions Trace Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Figure 53. H.323 Trace Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Figure 54. SIP Protocol Trace Log. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Figure 55. Advanced Trace window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

xiv

LIST OF TABLES
Table 1. Possible Problem Solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Table 2. CDR Header Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Table 3. Call Detail Record Body. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Table 4. Detail Field Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Table 5. Release Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Table 6. 1St Release Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Table 7. Release Codes from Stack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Table 8. Release Messages from VSX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Table 9. VSX Internal Release Causes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Table 10. VSX Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Table 11. VSX Server Environmental Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . .

111
115
116
119
122
123
123
124
124
129
130

xv

Sansay VSX Users Guide

xvi

ABOUT THIS BOOK


This book is designed to help you receive, install, configure
and operate your Sansay VSX. It provides information that
enables you to configure and operate your VSX within your
network and billing system.

Who Should Use This Book


This book is for product distributors, systems integrators,
systems analysts, and network administrators who design,
install, configure, and maintain communications applications. You can use this book alone if your network is already
functional.
If you require information to help you integrate a VSX into
your network, refer to the manuals that support your network components.

How To Use This Book


If the Sansay product family or the Sansay VSX is new to
you, you should read all the chapters in this book sequentially to familiarize yourself with all of the product features
and functions.

xvii

Sansay VSX Users Guide

Textual Callouts
This book uses two distinct symbols displayed in the textual
margins to call your attention to information that is of particular interest.
These call-outs are:
Note

Caution

This callout indicates that the information presented may be


of particular use when operating a Sansay VSX or accompanying devices.

This callout indicates that the information presented may


prevent damage to a Sansay VSX or accompanying devices
when operating the equipment or may prevent personal
injury when installing, operating, or maintaining a Sansay
VSX or accompanying devices.

Getting Help
If a problem occurs, a message normally displays on the system monitor. These messages belong to one of the following
categories:

xviii

Message Type

Displays

Informational

Current operating condition

Error

Messages about errors that occur


during operation of a Sansay VSX.

About This Book

Service and Support


If you try all of the suggestions that are given in this book
and you still need help, you can get assistance directly from
the Sansay Technical Assistance Center (TAC) at 1-858-6780200, Extension 809. Customers outside of the United
States of America should contact their local distributor or
Regional Support Center at support@sansay.com for assistance.

xix

Sansay VSX Users Guide

xx

CHAPTER 1

INTRODUCTION
This chapter describes the functionality of a Sansay VSX
and describes how the VSX operates within a network environment.

VSX Applications
The VSX can be implemented to provide the following services:

Session Controller Controls switching and routing


between VoIP endpoints

Border Gateway Protects internal network topology

Protocol Interworking Provides protocol conversion

Gatekeeper Interconnect

SIP Proxy

Session Controller
When implemented as a session controller, the VSX:

Controls routing in VoIP networks

Centralizes routing tables

Centralized & accurate CDRs

Simplifies Gateway configurations

Sansay VSX Users Guide

Intelligent Route Hunting enhances ASRs

Is secure and scalable

Provides real-time performance monitoring

Figure 1 shows the interconnection of the VSX as a session


controller.

Figure 1. VSX Session Controller Application Diagram

Border Gateway
When implemented as a border gateway, the VSX:

Protects all internal IP addresses

Eliminates load on Softswitches & GWs

Routes VoIP partner calls

Originates Media & signaling

Advertises only one address

Figure 2 on page 3 shows the interconnection of the VSX as


a border gateway.

Introduction

Figure 2. VSX Border Gateway Application Diagram

Protocol Interworking
The VSXs versatile protocol compatibility supports:

Unification of the voice network

Any-to-any call flow through network

Handles switching of methods

H.323 Fast-Start to Slow-Start

H.245 tunneling conversion

Full SIP method support

Any H.323 to SIP

Figure 3 on page 4 shows the interconnection of the VSX as


a protocol converter.

Sansay VSX Users Guide

Figure 3. VSX Protocol Support Application Diagram

Gatekeeper Interconnect
The VSXs gatekeeper interconnect supports:

Partner configuration as H.323 gatekeeper address

Gateway addresses added as resources

Figure 4 shows the interconnection of the VSX as a gatekeeper.

Figure 4. Gatekeeper Interconnect Application Diagram

Introduction

SIP Proxy Connect


The VSXs SIP Proxy connect supports:

Configuration of Proxy as SIP Proxy

No Gateway configuration necessary

Figure 2 shows the interconnection of the VSX with a SIP


Proxy.

Figure 5. SIP Proxy Connect Application Diagram

VSX OS and Hardware


The VSX unit features:

Customized Micro-Linux-based Intel platform

Micro kernel with enhanced network I/F

Dual Gigabit and 10/100base-T ethernet interface

1U Server for lower end apps

1000 active calls (H.323 or SIP with media)

Non-redundant. AC only

2U for high end apps

5000 active calls (H.323 or SIP with media) per chassis

Redundant power, fans, drives. AC only

Sansay VSX Users Guide

2U NEBS for Central Office apps

Same performance but NEBS-3 certified

Redundant. AC or DC power supply option

Figure 6. VSX 1U and 2U Chassis

Redundancy
Multiple VSX servers can be implemented to provide:

Non-stop call routing

Mirroring of call state between servers

Hot swappable load sharing power supplies and fans

2 hot-swappable hard drives

Dual Gigabit Ethernet interfaces

Full compatibility with HSRP

Figure 7. NEBS Compliant VSX

Introduction

High Availability Node

HA is a fault tolerant, non-stop cluster

System processes poll each other constantly

In a failure the backup assumes IP address of failed


system

Active calls cleared and logged in redundant CDR file

Software ensures 99.999% uptime

MTBF for servers are 36,000 hours

Active VSX System

Processes and states


mirrored in real time

Standby VSX
Figure 8. High Availability Node

Media Switch VMX


A VMX unit functions as a high-capacity media router. It
requires a VSX unit to control it as shown in Figure 9 on
page 8. A VMX implementation can provide:

A separate media processor for large applications

Redundancy on system wide level

Clustered low cost hardware

N:1 redundant media paths

Hitless failover for active calls

Sansay VSX Users Guide

Scalability up to 8 VMX units per cluster

Over 1,000 calls per VMX

VMX Cluster
To handle call media requirements, multiple VSX units can
be implemented in a VMX cluster configuration (Figure 9) to
provide:

Redundant pair for signaling

VMX cluster for media


VSX Redundant Pair
for Signaling

VMX Cluster for Media

Call Signaling

Call Media

Figure 9. VMX Cluster Configuration

VSX Integration
The Sansay VSX can be deployed singularly or in pairs to
provide maximum network reliability. In the latter configuration, VSXs are interconnected and synchronized through
dedicated, 100Base-T LAN interfaces.
A single VSX can support a large network of gateways; however, VSXs can also be deployed regionally and operate
together to provide the call processing and switching structure for multiple proprietary networks.

CHAPTER 2

SETTING UP THE VSX


This chapter presents information to guide you through
receipt and basic installation of the Sansay VSX.

Unpacking the VSX


The VSX unit is shipped in a cardboard shipping container
with all required accessories. The contents include:

VSX Unit

Accessory Kit

User Documentation on CD

Sansay VSX Users Guide

Installing the VSX


The Sansay VSX unit is shipped with all required hardware
and software installed. See Figure 10 for a front view of the
VSX chassis.

Figure 10. VSX Front Panel

Rack Mounting the VSX


The VSX unit can be free standing or mounted in a rack or
on shelves. The compact VSX chassis is designed to occupy a
single (1 EIA) rack unit in a standard 19-inch rack. The VSX
is also available in a 2 EIA form factor. A VSX chassis is
light enough to be installed by one person. The VSX needs to
have an Intel rack mount kit in order to install properly, but
other systems can be used. If the unit is to be mounted into a
rack on a shelf, you will need the appropriate hand tools to
accomplish this task. The following tools and supplies are
recommended:

A set of hand tools (such as cordless screwdriver, #2 Phillips screwdriver, 5/16 flat blade screwdriver)

Four #10-24 rack mounting screws

The VSX only needs to be supported by the 4 bolts which go


through the rack ears in the front of the system. Make sure
the bolts are tight and that system is flush with the rack
itself.

10

Setting Up the VSX

Making External Connections


All external connections to the VSX are made through the
rear panel of the unit. The types of connections available on
the server are as follows:

10/100/1000Base-T auto-sensing Ethernet

Power cord

See Figure 11 for the locations of the above-mentioned ports.

LAN Port

120/250 VAC

Figure 11. VSX Rear Panel External Connections

Connecting the Local Area Network Port


Connect the 100Base-T ethernet port on the VSX unit to
your ethernet by using an RJ-45 ethernet cable. The Ethernet cable should be plugged into a switch or a hub for Internet access.
The Ethernet port is 10/100/1000 Base-T auto sensing. It is
recommended to use a 100 Base-T full duplex switch for the
highest performance. The port in use is the one on the left
hand side of the two Ethernet ports when looking at the system from the rear. This is the port that is farthest from the
power supply cable.

Connecting the Power Cable


The VSX must be plugged into an AC power supply, which
can be either 120 VAC or 220 VAC. It is highly recommended that an Uninterruptible Power Supply be used for
the system in order to protect the system from power outages. Connect the power cord to the AC receptacle on the
VSX unit and then to a grounded AC outlet.

11

Sansay VSX Users Guide

Applying System Power


After all cable connections to the VSX unit are made, apply
AC power by pushing the front panel power button.
The system can be powered off by pushing and holding down
the power button for 3 seconds. If power is cut off while the
unit is operating it will automatically power up when AC
power is reapplied.

12

CHAPTER 3

BEFORE YOU START


Before installing one or more VSXs into your system, make
sure that in addition to this guide, you have planned your
network topology and are familiar with the necessary:

System IP Addresses

Gateway/Resource Address

Protocols

The entire system should be configured by the web based


GUI. To do this you must connect a system (PC or Unix system) on the same LAN segment (ie, with no routers in
between) and open a browser program on the system. The
system must be configured to be on the same IP network
address as the default IP address of the VSX. The default IP
address of the VSX is 192.168.0.100 with a subnet mask of
255.255.255.0. The default gateway is 192.168.0.1. Therefore, any other address on the 192.168.0.0 C-class network
would work for the local system.

Configuration Overview
This section presents a high-level approach for initially configuring the VSX. This information is presented in the recommended logical sequence.

13

Sansay VSX Users Guide

Configuration Sequence
This section presents the recommended process flow you
need to initially configure a VSX. Access the following
screens in the order below:

System Page

Resources Page (add gateways)

Routes Page

Users Page

System Page
The System page enables you to specify the initial required
configuration parameters for the VSX system. See "System
Page" on page 85 for more information.
Access the System page by clicking on the System tab on the
user interface. From this page you will need to set:

14

System FQDN/IP Address

Alias Name

System Mode

Time Zone, Time Server(s) and System Clock

Call Detail Record ID and Number of Seconds for each


CDR file write

CDR User Password used to retrieve CDR files

Default Router

Subnetwork Mask

Local Payload Port Base Address

UDP Ports for both SIP and H.323 signaling

Before You Start

Resources Page
The Resources page enables you to add, edit, and delete
gateways, softswitches, and IP phones. See "Resources
Page" on page 89 for more information. See also Adding and
Configuring Resources on page 25.
Access the Resources page by clicking on the Resources tab
on the user interface. From this page you will need to:

Add and edit network sources

Routes Page
The Routes page enables you to add, edit, and delete routes
accessible to the VSX system. You can establish a primary
route and up to seven alternate routes. See "Routes Page" on
page 91 for more information. See also Adding and Configuring Routes on page 39.
Access the Routes page by clicking on the Routes tab on the
user interface. From this page you will need to specify:

Alias name

Digit match sequence

Trunk IDs

Users Page
The Users page enables you to add, edit, and delete users
authorized to access the VSX system. In addition, you can
establish access priveleges for each user. See "Users Page"
on page 93 for more information.
Access the Users page by clicking on the Users tab on the
user interface. From this page you will need to:

Access the system as superuser

15

Sansay VSX Users Guide

16

Add and edit users, set access rights and passwords

Examine User status

CHAPTER 4

INITIAL CONFIGURATION
The Sansay Session Controller features a comprehensive,
easy to use graphical user interface that enables you to configure and manage the VSX. Using a standard Internet
browser you can access this interface by entering the default
IP address of the VSX.

Logging In
Open a standard web browser and enter the default IP
address of the VSX unit (see below). The default IP address
is HTPPS://192.168.0.100:8888/.

HTPPS://192.168.0.100:8888/

Figure 12. VSX Default IP Address

After entering the default IP address of the VSX unit, a welcome screen should display enabling you to login to the system. If the browser cannot locate the page, refer to the
troubleshooting tips in Troubleshooting the VSX on
page 110. The welcome screen is shown below in Figure 13.

17

Sansay VSX Users Guide

Figure 13. VSX Login Screen

Enter your user name and password and click the Login button to proceed to the configuration screens. The default user
name is superuser and the default password is sansay. The
System Statistics screen displays by default. Click the Users
tab to begin to edit the user settings.

Changing Passwords
For security reasons the username and password should be
changed from the defaults. These should be easily memorized and stored in a secure place. This is done under the
Users tab by clicking on the edit link next to the superuser
name. Enter the new username and passwords and then
click Submit. Log out and then back in to the VSX in order
to test the changes.
In order to allow Sansay technical support access to your
system please add a user name of your choice with superuser privilege and send email to support@sansay.com with
the username and password of their login.

Editing Network Settings


Click the System tab to begin to edit the system settings.
Click the Edit Network Connections tab to set the initial network
configuration for the VSX. The Edit Network Connections
page is shown in Figure 14.

18

Initial Configuration

Figure 14. Edit Network Connections

You will need to specify the following fields:


Lan Interface FQDN/IP
Specify the fully-qualified domain name (IP address) of the
VSX system for both the public and private LAN. This will
enable you to manage the VSX from any remote system.
Subnet Mask
Specify the ethernet subnetwork mask of the VSX system
for both the public and private LAN. If you are not sure of
these addresses, check with your network administrator.
Net Mask
The net mask is used to separate the private IP address
range from the public range. Commonly the Netmask value
is 8, 16, or 24 dependent on the number of networks in use
on the private network side.
Specify the net mask for the VSX system. If you are not sure
of this value, check with your network administrator.
Gateway
Specify the IP address of the default and private gateways
(or the router for the LAN segments) that the VSX will use.
If you are not sure of this address, check with your network
administrator.

19

Sansay VSX Users Guide

Setting System Date and Time


Click the Edit System tab to set the system date and time for
the VSX. The Edit System page is shown in Figure 15.

Figure 15. Edit System Page

You will need to specify the following field:


Current Time/ Time Zone/Date/Time
Set the system internal time clock/calendar to the current
time and date. The date/time stamps are used in the CDR
records so the time should be set to the time zone where the
VSX is located.

20

Initial Configuration

Submitting the Changes


At this point it is recommended that you submit the new
configuration by clicking Submit from the Edit System form.
When the System page returns, click Reboot System. The
VSX will restart with the new IP address or FQDN.
You can now reconfigure your local system to the proper IP
address for the local LAN. When finished you should be able
to browse to the VSX via its IP address, but you must
append :8888/ to the address. You can then login with the
new username and password to set the remaining system
parameters as described below.
Once you are logged in again, access the System tab to configure the remaining system parameters as described below.
Alias
Specify the alias name for the VSX system. The alias
name can be up to 40 characters in length and can
include commas, semicolons, spaces, periods, hyphens,
underscores, the @ symbol, and question marks.
NTP Server1/2
Specify the IP addresses for up to two network time protocol servers used for reference to external time standards. These are optional fields.
The values entered are valid and highly accurate Network Time Protocol servers. Due to internal clock drift it
is highly recommended that these values be left alone in
order to most accurately record CDR information.
CDR File Interval
Specify the number of seconds that will transpire
between CDR file writes.
Local Payload Port Start
Specify the base (starting) address for UDP ports to be
used by the VSX system. This value is chosen as a multi-

21

Sansay VSX Users Guide

ple by 4 of the VSXs call capacity. The default UDP port


base address is 10000.
SIP Port Address
Specify the SIP port address for the VSX system. The
default value is 5060.
H323 Port Address
Specify the H323 port address for the VSX system. The
default value is 1720.
When you have finished editing the system settings, click
Submit to assert the changes.

Note

When submitting changes to the VSX FQDN, Default Gateway, Subnet Mask, or Local Payload Port Start settings, the
system will restart.

Configuring Resources
You are now ready to configure the system to send and
receive calls. Any device which will be either sending you
calls (originating) or receiving your calls (terminating) is
considered a resource.
After setting the initial system parameters, use the
Resource screen to configure gateways, IP phones/clients,
soft switches, and proxies. For more information, see Adding and Configuring Resources on page 25.

Routes Tab
After adding the resource gateways, use the Routes screen
to add new routes, or view and edit existing routes. For more
information, see Adding and Configuring Routes on
page 39.

22

Initial Configuration

Adding Users
From here, you will need to access the Users page. The
Users page enables you to enter all users authorized to
access the VSX system. Initially, the superuser entry displays by default. For more information, see Managing
Users on page 55.

23

Sansay VSX Users Guide

24

CHAPTER 5

ADDING AND CONFIGURING RESOURCES


A Resource is any device that will send or receive calls
to/from the VSX. It could be an IP gateway as small as a single analog port, a PC softclient, or a gateway as large as
Cisco 5850 or Sonus GSX9000. If a device is not configured
into the VSX as a resource it will not be able to generate or
receive calls from the VSX.
A Resource can also be a range of IPs, specified using an IP
address and a mask range. It is possible to allow calls from
an entire B-Class network using an IP address such as
69.63.193.187/16. This Trunk ID would encompass all IPs
between 69.63.0.0 - 69.63.254.254.
Read this chapter to learn how to configure gateways, IP
phones/clients, soft switches, and proxies.

25

Sansay VSX Users Guide

Opening the Resource Add Dialog


Access the Resources screen shown below in Figure 16. Click
the Add button on the Resources screen to access the
Resource Add form shown in Figure 17 on page 27.

Figure 16. VSX Resources Screen

26

Adding and Configuring Resources

Figure 17. Resource Add Form

27

Sansay VSX Users Guide

Adding Resources
When configuring a new resource, the essential parameters
are the resource Name (an alias for your convenience), the
FQDN or IP address, the VoIP protocol used, the Trunk ID
(TID), and the digit stripping or prepending method.

General Info
You will need to configure the following fields and controls:
Trunk ID
Specify the desired trunk ID for the resource. This will
be the default trunk ID. For numbering purposes, the
TID range for Resources can be 1-49,999.
Name
Use this field to specify the resource's alias name. You
can enter a name of up to 40 alphanumeric characters,
including periods and hyphens. This field is optional.
Company Name
Use this field to enter a label to identify the gateway's
owner. You can enter a company name of up to 40 alphanumeric characters, including periods and hyphens. This
field is mandatory.
FQDN
Enter the fully-qualified domain name or a unique IP
address of the new resource (for example,
192.168.0.1). If you do not know the FQDN or the IP
address of the resource, check with your network administrator. This field is mandatory.
A range of addresses can be entered using a syntax such
as 192.168.0.2 /32. If an FQDN is entered it must be

28

Adding and Configuring Resources

resolvable in the host table which is uploaded through


the System Page.
FQDNs should not be used for inbound TIDs. The reason
for this is that the inbound calls arrive from a particular
IP address. It is very difficult to "reverse-resolve" the IP
address into an FQDN name in order to associate it with
the proper TID. As such, inbound TIDs need to use fixed
IP addresses.
R.7 resolves it from a DNS server configured in the system page. If the primary DNS server does not reply the
VSX query the secondary configured DNS server. If the
primary DNS servers responds with a no such host message the secondary will not be queried.
CPS Limit
Resources can be controlled on a calls-per-second basis.
CPS limiting measures the CPS (inbound and outbound)
on the TID and rejects calls that exceed that value. Any
value from 1 to 1000 can be entered. Inbound calls that
exceed the CPS range are rejected, while outbound calls
roll over this route selection and are rerouted if an alternate route is configured.
On routes which are commonly overutilized during peak
periods it is beneficial to limit the CPS to a reasonable
number. This will prevent the VSX from overrunning the
terminating resource as well as wasting resources sending large quantities of calls to devices which cannot
accept them.
Call Number Translation
This field identifies which Digit Mapping Table (DMT) is
used by the resource. The DMT is used to translate ANI
and DNIS numbers when they are conditionally
matched. These are viewed and configured under the
Digit Mapping tab.

29

Sansay VSX Users Guide

Radius Billing and Authentication


The TID can support both Radius billing records and
authentication checking by configuration. Radius billing
messages use the Cisco Vendor Specific Attributes
(VSAs) in the messages and each call attempt will generate messages whether or not it is successful.
A call which is Authorized in the Radius process may
specify the time duration for the call to last. This is
sometimes used for IVR systems providing a prepaid
calling platform.
T38
T.38 is used to indicate whether the attached devices can
support T.38. This is used to generate the proper signaling on the outbound call leg for calls which are received
on this TID.
RFC 2833
RFC 2833 is used to indicate whether the attached
device uses RFC2833 for inbound DTMF Relay.
Payload Type
Payload types refers to the RTP payload type used if
RFC2833 is enabled.
RTP TOS/Diffserv
RTP TOS indicated the Diffserve bit settings on RTP
traffic outbound to this TID.

Note

30

When adding a new resource, you must specify the resource


name, FQDN, and TID.

Adding and Configuring Resources

Resource Type
Resource Type fields enable you to select the resource protocol type and set operational parameters such as Service
State, directional properties, network address translation
(NAT) and media handling.
Protocol
The protocol selection is used to control the outbound
call request protocol. All calls sent to this resource will
use the configured protocol. However, inbound calls are
accepted with either SIP GW, SIP Proxy, H.323 GW,
H.323 GK, or ENUM Server protocols.
SIP GW will generate invites with the DNIS@ip address
of the configured FQDN. SIP Proxy will do the same.
H.323 GK will send LRQs to the configured FQDN.
When the ARQs are returned the VSX will generate
H.323 GK protocol to the returned FQDN. The VSX does
not need to know the addresses of the GWs for outound
calls. However on H.323 GKs used for inbound traffic the
VSX needs to be configured with the GW addresses
unless the configured GK is used in "routed mode".
Port Address
Use this field to specify the port address for the resource.
If you do not know the port address of the resource,
check with your network administrator.
Service State
Determine the operational state for the gateway. Select
In Service to bring the gateway online, Block to disable
access to/from the gateway, or Trace to enable the tracing function.

31

Sansay VSX Users Guide

Note

Only trace 1 resource or route at a time. This will ensure that


the call being traced will be from the desired resource. The
VSX will only trace 1 call at a time, so if many resources are
being traced, it is not predictable which call will be traced.

Direction
Determine if the gateway will send calls to the VSX,
receive calls from the VSX, or both. Select In to designate the gateway as an ingress gateway to the VSX.
Select Out to designate the gateway as an egress gateway from the VSX. Select Both for bidirectional operation.
The VSX determines inbound calls based on the IP
Address and Tech Prefix. If Tech Prefixes are not used,
inbound calls will find the first TID that matches the IP
address in order or ascending TID number. If you have
inbound TIDs, they should be numbered lower than the
outbound TIDs.
NAT
Indicate whether or not the gateway is located behind
NAT (network address translation). When accessing a
network through a firewall, address translation can be
necessary. To indicate address translation is required,
select One. Select None to indicate that no network
address translation is necessary.
This feature requires the Firewall to be configured to
send to the SIP (UDP 5060) messages to the specified
gateway. Otherwise traffic we send to the gateway may
not reach it. The function of this setting is to ignore the
provided SDP and to auto-learn the ports being used on
each call.

32

Adding and Configuring Resources

Allow Direct Media


Use this field to enable and disable a direct payload path
from gateway to gateway that effectively bypasses the
VSX. Select Yes to enable; No to disable direct media
support.
In order for the media to bypass the VSX, this setting
has to be set to No on both call legs. If one call leg is set
to Yes and the other to No, the media is brought back
through the VSX.
For greater control of this parameter you can set up several TIDs that point to the same resource, but with different media-handling characteristics.

Digit Translation
Digit Translation fields enable you to enter the number of
digits (ie., how many) that you want to strip. The Digit
Prepending (or Appending) fields, enable you to enter the
exact (literal) digits to be added. It is important to consider
your routing table design for it to be flexible and extensible.
The VSX system provides to options for both ingress and
egress traffic.
The most common approach is to route based on the country
code, so you need to consider this when configuring how
many digits to strip. You will need to configure the following
fields and controls:
Match
Use this field to specify your digit matching requirements for both ingress and egress traffic. Digit matching
is used to determine if the call should use this translation rule or not. If the leading digits on the DNIS do not
match the digits entered here, the call will not use the
translation values entered. Use All in order to force all
calls to use this rule.

33

Sansay VSX Users Guide

If the match is not met, the call will attempt to match


the second translation line. If the match is not met there,
the call will go through untranslated.
Action 1
Specify the first action to be performed on incoming
dialed digits for Ingress 1 and Ingress 2. Select None for
no action, Left Strip or Right Strip to mask a specified
number of digits, or Prepend to add literally-specified
leading digits to the incoming number. For an example,
see Ingress Action Example on page 36.
Action 2
Specify the second action to be performed on resultant
incoming digits processed by Action 1 for Ingress 1 and
Ingress 2. Select None for no action, Left Strip or Right
Strip to mask a specified number of digits, or Prepend to
add literally-specified leading digits to the resultant
number. For an example, see Ingress Action Example
on page 36.

34

Adding and Configuring Resources

Digits 1
Specify the number of digits to be operated on by the
Action 1 setting for both Ingress 1 and Ingress 2.
Digits 2
Specify the number of digits to be operated on by the
Action 2 setting for both Ingress 1 and Ingress 2.
Action 1
Specify the first action to be performed on outgoing digits for both Egress 1 and Egress 2. Select None for no
action, Left Strip or Right Strip to mask specified digits,
or Prepend to add specified leading digits to the outgoing
number. For an example, see Egress Action Example
on page 36.
Action 2
Specify the second action to be performed on outgoing
digits processed by Action 1 for both Egress 1 and Egress
2. Select None for no action, Left Strip or Right Strip to
mask a specified number of digits, or Prepend to add
specified leading digits to the outgoing number. For an
example, see Egress Action Example on page 36.
Digits 1
Specify the number of digits to be operated on by the
Action 1 setting for both Egress 1 and Egress 2.
Digits 2
Specify the number of digits to be operated on by the
Action 2 setting for both Egress 1 and Egress 2.
When you have finished making your selections, click Submit to save the configuration. Repeat this process for each
new resource. To abandon the changes, click Cancel.

35

Sansay VSX Users Guide

Ingress Action Example


Suppose the VSX received digits 123 456 7890 from an
ingress gateway. If In Action 1 is set to Left Strip, and In
Digits 1 is set to 3, the resultant number is 4567890.
If In Action 2 is set to Prepend, and In Digits 2 is literally
specified as 234, the resultant number is 2344567890. This
resultant number is then processed by digit matching to
determine its route. For more information about digit
matching, see "Digit Match" on page 41.

Egress Action Example


After digit matching occurs, the outgoing number is then
processed by Out Action 1 and Out Action 2, if any. The
resultant number is then used for an access code for the
international or domestic route, or for adding a carrier prefix that identifies the carrier to the terminating partner.
Suppose Out Action 1 were set to Left Strip, and Out Digits
1 were set to 2 (digits). After processing, the resultant number would be 44567890. If Out Action 2 were set to Prepend,
and Out Digits 2 were literally specified as 56, the resultant
number would be 5644567890.

Codecs
Codec Policy allows you to advertise a specific codec or group
of codecs to a resource. This allows you to tailor the codec
choices used on each resource and to limit the selection process of the terminating endpoint.
To use this feature change the setting from transparent to
enforced. Then use the pull down menus to select Codec 1,
Codec 2 Codec 8. Codec 1 is advertised as the preferred
codec on all calls setup to that resource, Codec 2 is the sec-

36

Adding and Configuring Resources

ond choice, etc. If the Codec Policy is set to Transparent then


the other setting have no effect.

Note

The codec selected for a call is negotiated between endpoints.


The originating device advertises the codec choices it would
support for that call, and the receiving device chooses from
that selection. If there is no overlap between the terminating
device's preferences and the originating device's offering,
then the call will be rejected.
The VSX normally is transparent to this negotiation but this
setting allows it to become an active participant. This setting
has no effect on the inbound call attempts for the resource,
only the outbound. The route selection will take place normally but the VSX will check the inbound codec offer with
the outbound selection if programmed. If there is no match
then the call will be rejected. If there is a match then the outbound call will be placed advertising the codecs that are common.

Note

Some gateways have problems handling call requests with


more than one codec offered. For these systems you should
only advertise one codec, which will permit the call the work
properly for that codec. Early version of Quintum VoIP Gateways have this problem.

Resource Groups
A Resource Group is a collection of gateways which are not
in a contiguous range, but are part of the same TID. In this
configuration you can have up to 64 IP addresses in a single
TID. It is not possible to use IP ranges within Resource
Groups. For numbering purposes the TID range for
Resource Groups can be from 50,000-99,9999.

37

Sansay VSX Users Guide

38

CHAPTER 6

ADDING AND CONFIGURING ROUTES


Once you have added Gateways and their Trunk IDs to your
configuration you can then create Routes which will direct
calls to these Trunk IDs. This chapter describes how to use
the Add Route dialog to add a new route.

Opening the Add Route Dialog


To access the Add Route dialog, click the Routes tab from the
VSX main menu. The Routes page is shown below in Figure
18.

Figure 18. VSX Routes Screen

Click Add Route to open the Add Route dialog shown below
(Figure 19).

39

Sansay VSX Users Guide

Figure 19. Add Route Dialog

40

Adding and Configuring Routes

Configuring a Route
A route is designated by an Alias, Digit Match, and the
Route Table it applies to. To set up a route, you will need to
configure the following:
Alias
Assign an alias name to the new route. You can enter up
to 40 alphanumeric characters.
Digit Match
Enter an access code for the route under configuration.
You can enter up to 10 characters that range from 09,
including *, #, +, A, B, C, and D. For example, you can
enter 011 (leading digits) for international long-distance
routing. Incoming leading digits are first parsed for leading digits 011; then 01; then 0. Calls that match one or
more specified leading digits are routed appropriately. If
no digit match occurs, the call fails.
Note: The # character is not adviseable to use in VoIP
phone calls. The SIP protocol uses URL specifications for
phone numbers, and the # symbol is treated differently
by various vendors.
The SPX will accept either type of # character in a SIP
URL. However it will use the IETF-specified control
character (%23) when generating an Invite with the #.
Some devices will not recognize this as a # on incoming
calls.
Route Table
This control enables you to select an alternate route
table. Route tables are configured by using the Route
Table List tab on the Routes List page.
Trace
Use this control to enable or disable tracing.

41

Sansay VSX Users Guide

Start/Stop Time of Day


Use these fields to configure routing based on time of day.
The time of day (TOD) is set to start on Monday 00:00 and
go through Sunday 24:00. This is based on the System time,
which needs to be considered before configuring. If you are
adding a specific TOD route you do not need to stop the regular routing configuration. In other words the times may
overlap, and the Route Star Time which is closest to the call
time is the one which takes precedence. If you have a TOD
Route which starts on Monday 00:00 and another which
starts on Monday 06:00, and a call arrives at Monday 06:30
the Route which starts at 06:00 will be used. This means you
can leave the normal week long routes in place and create
TOD Routes which will supersede them.
Route Group
This control enables you to select an alternate route
group. Route groups are configured by using the Route
Groups List tab on the Routes List page. For more information, see Configuring Route Groups on page 44.
Policy
Routes can be selected from the list on either a top-down
basis, or a percentage-based scenario. The policy by default
is Top-Down which means that the call attempts will procedure Route 1, 2, 3, 4, 5, 6, 7, and 8. The call will routeadvance when the call attempt does not reach the Ring (or
Alerting) phase. For more information about percentagebased routing, see Proportional Routing on page 43.
Trunk ID 1-8
Assign a primary route and up to seven alternate routes.
You can select trunk IDs from the list of assigned gateways.
Submit
Click the Submit button to assert the route configuration
you entered. Click Cancel to abandon the route configuration. Repeat this process for each new route.

42

Adding and Configuring Routes

Proportional Routing
Proportional Routing is used to divide up calls for a route
between several termination resources (TIDs). Proportional
routing divides the calls on a percentage basis between the
various termination options. To select this option use the
pull down menu to select Percentage.
Once this is selected you are required to enter a Load Percentage figure for each route. The percentage of the load for
that route will be shared among the resources based on the
percentage entered. A setting of 50% for each of 2 resources
for example, will split the call evenly between them. The
percentage total of all routes shown on the page must equal
100%.
For example, 50% of the calls can start at Route 1, and the
other 50% could start at Route 2. This gives the VSX ability
to load-share the initial call request across up to 8 outbound
carriers. The percentage-based routing will still alternateroute when a call attempt fails. If the initial call goes to
Route 2 and fails, it will still alternate-route to Route 1. This
call attempt will not effect the percentage of the calls that
are assigned to Route 1. The percentage is only calculated
on the first outbound call attempt.
Routes also indicate the alternate routes taken when the
outbound call attempts fail, and lets you control the alternate routing. The Continuous Routing Yes or No setting
enables you to set a Route number to cease alternate calling.
This works well with percentage based routing because you
can divide up the calls into groups of routes without worrying about calls alternate routing between them. Thus you
can have 50% of your calls attempt Routes 1,2, and 3 and
50% attempt Routes 4,5,6,7, and 8.
Proportional routing determines the initial call attempt for
the outbound calls. If the call fails it will alternate route
through the remaining TIDs as configured.

43

Sansay VSX Users Guide

Note

This feature is based on a statistical model. It does not


ensure that the percentages are matched on every call. For
instance in a 50%, 50% model, the calls will not alternate
between the two resources. It may be that the calls do not
alternate every time, but over time the calls will be evenly
split.

Configuring Route Groups


The Route Group List option under the Routes List tab
enables you to group your routes together in order to make
changes across many routes simpler and easier. If you have
several routes that are all treated equally, "Mexico Cellular
1" for example, you can add them as a Route Group. In the
case that Mexico Cellular 1 has several different digit
matches you can add them as routes but use the Route
Group tab. You must first configure a Route Group under
the Routes>Route Groups>Add. Here you would specify the
routes you would like to use for the Mexico Cellular 1 numbers. You would first specify a Group ID number which you
choose. Then enter the alias you would like to use. "Mexico
Cellular 1" in our example case. Then specify the Trunk IDs
you want these numbers routed to for termination using the
same logic as a single route.
Next you add the specific routes associated with "Mexico
Cellular 1" numbers. An example might be 5266431,
55266433, etc. When adding them with the Add Route page
you chose the "Mexico Cellular 1" route group. These will
reference that routing setup for those calls. So if you need to
change the termination partner on those routes you simply
need to modify the Route Group instead of the individual
routes. As soon as the Route Group is modified the calls to
those matches will be routed to the new termination points.

44

Adding and Configuring Routes

Placing Test Calls


Once you have legitimate gateways and routes established,
the calls should be able to flow through your system. You
can monitor the calls through the Statistics tab. The Show
Route Statistics button will show you all of your outbound
routes and the ASRs associated with each route. For more
information, see Viewing Statistics on page 59.
You can also test a destination TI before you add it to the
routing table by using the Test Call option on the system
page. You can directly dial the TID bypassing the routing
process by entering 0000 and then the TID (which must be 5
digits, and may require leading zeros). This allows you to
send a number of test calls to the resource to test configuration and call quality before adding it to the route table.

Importing Routes and Tables


The Routes page provides controls that enable you to
import:

Routes

TOD Routes

Route Groups

Route Tables

Digit Matching Tables

45

Sansay VSX Users Guide

These options can be imported in XML or CSV formats. The


VSX Import form is shown in Figure 20.

Figure 20. VSX Import Form.

From the Import form, you can import a file by name, or by


navigating to it by using the Browse button. Use the Select
the Table Type dropdown to choose the route or table to
import. Specify the file format for importing. Select either
CSV, or XML.
Select the appropriate import options from the dropdown.
Select Update, Delete, or Replace. The Update option adds
and updates the routes or tables specified in the imported
file in the VSX database. The Delete option removes the
routes or tables specified in the imported file from the VSX
database. The Replace option deletes existing routes and
tables from the database and inserts the routes and tables
specified in the imported file into the daatabase.
When all your selections are complete, click Import to
upload the file to the VSX.

46

Adding and Configuring Routes

Exporting Routes and Tables


The Routes page provides controls that enable you to export:

Routes

TOD Routes

Route Groups

Route Tables.

Digit Matching Tables

These options can be exported in XML or CSV formats. The


VSX Export form is shown in Figure 21 on page 47.

Note

If you are exporting your routes in order to provide a back up


configuration you should use the Backup Config option in the
System>Advanced page in order to save the entire configuration in a smaller file.

Figure 21. VSX Save Route Table Form.

From the Export form, use the Select which Table to export
dropdown to choose the route or table to export. Specify the
file format for exporting. Select either CSV, or XML.
When all your selections are complete, click Export to download the file from the VSX to a workstation.

47

Sansay VSX Users Guide

48

CHAPTER 7

DIGIT MAPPING
The Digit Mapping page gives access to the Digit Mapping
List and Digit mapping Table pages. The digit mapping
entries are configurable with the GUI or with XML commands.
Sansay offers a SOAP/XML client for use with the VSX or
SPX, but any XML client can be used for this task. For more
information, see Sansay SOAP Client on page 97.

Digit Mapping List


The Digit Mapping List form shown in Figure 22 displays a
list of the configured Digit Mapping values. In addition,
enables you to add, edit, import and export digit maps.

Figure 22. Digit Mapping List

49

Sansay VSX Users Guide

To add a DMT value you must first create the table itself.
This is done on the Digit Mapping Table List subtab.
The Digit Mapping List performs actions based upon the
matching DNIS/ANI combination. For either the DNIS or
the ANI you can enter Match, Passthrough, or All. These
actions imply:
Match - The values which are used to match the number
are replaced by the translated numbers. If there are no
numbers in the translated field, the matched digits are
stripped.
Passthrough - The entire DNIS or ANI is maintained with
no changes.
All - The entire DNIS or ANI is replaced by the value in the
translated field.
If a call arrives which does not match the ANI and DNIS in
the DMT is will go through the table unchanged and then
enter the route selection process.

Digit Matching Table


The Digit Mapping table (DMT) function enables you to
manipulate the DNIS or ANI numbers based upon their
relationship. This means a specific action can be taken when
the DNIS and ANI match the specified values. This gives
total control of the outbound numbers for any call. The DMT
modification of the digits is done on inbound calls prior to
the call being routed. Therefore, if configured to do so, the
routing of any call can be done based on the relationship of
the DNIS and ANI, not just the DNIS number itself. The
Digit Mapping Table is shown in Figure 23 on page 51.

50

Digit Mapping

Figure 23. Digit Mapping Table

The VSX supports up to 1000 different DMT tables which


can be assigned independently to the resources. This indicates that the calls coming in from that TID will be routed
after using the configured DMT. The default is DMT 0 which
means no translations will be applied to the call. The maximum number of entries in all of the DMTs is 1,000,000.
It is important to understand that the Ingress Translation
functions take place prior the DMT function, so the digits
stripped in the resource configuration do not need to be part
of the DMT. Only ingress calls on a TID are translated by
the DMT; not egress calls. Figure 24 shows the call flow:

51

Sansay VSX Users Guide

Figure 24. Digit Mapping Call Flow

The DMT entries are only configurable with the GUI or with
XML commands. Sansay offers a SOAP/XML client for use
with the VSX or SPX, but any XML client can be used for
this task.
Two steps must be taken when configuring the DMT. Initially you must add the target table, and secondly you must
populate the entries within the DMT. For more information,
see Sansay SOAP Client on page 97.
In order to add DMTs you need to first create the Table to be
populated. Click on the ADD button and simply assign a
Table ID and an Alias.

52

Digit Mapping

After the tables are created and populated, assign them to


the inbound TIDs using the Digit Mapping List option on
the Resource page. For more information, see Adding
Resources on page 28.
The DMTs provide the following actions based upon the
matching DNIS/ANI combination. For either the DNIS or
the ANI you can enter Match, Passthrough, or All.

53

Sansay VSX Users Guide

54

CHAPTER 8

MANAGING USERS
Read this chapter to learn how to add users and manage
their ability to access the VSX resources.

Opening the Users Dialog


The Users page enables you to enter all users authorized to
access the VSX system. Initially, the superuser entry displays by default. The Users page is displayed in Figure 25.

Figure 25. VSX Users Page

55

Sansay VSX Users Guide

To access the Add User form (Figure 26), click the Add User
button on the Users screen.

Figure 26. Add User Form

Adding a User
As the superuser, you will need to configure the following
fields and controls:
Login User ID
Use this field to specify the new user's login name. You
can enter a user ID name of up to 20 alphanumeric characters, including periods and hyphens. This field is
required.
Authorization
Use this field to specify access priveleges for the user.
Select one of the following access levels:

Super User

Read Only

Admin

Select Superuser to allow the new user unlimited access


to the VSX configuration.

56

Adding Users

Select Read Only to limit access to viewing existing configuration, user information, and statistics.
It is useful to have a read-only user in case you want to
doublecheck the configuration or to examine the status
of routes.
Select Admin to allow access to manage resources and
routes.
Password
This field stores the password of the newly-added user.
Enter a unique password for the user. You can enter up
to 20 characters including letters, numbers, periods and
hyphens. Re-enter the password in the password verification field. Both fields are required.
First/Last Name
Enter the first and last name of the user. This information is displayed when user status is queried. Both fields
are required.
Click Submit to upload the user information to the VSX.
Repeat this procedure for each new user.

Editing and Deleting Users


In addition to adding users, the Users page enables you to
modify the list of authorized users, or to delete users.

Editing Users
To edit a users personal information, or to adjust access
rights, select a single user listing from the Users page (Figure 25 on page 55) and click its respective Edit link. The
Edit User form displays as shown in Figure 27.

57

Sansay VSX Users Guide

Figure 27. Edit User Form

The fields in this form appear identical to those on the Add


User dialog. Make the necessary changes and click Submit.
A confirmation dialog displays to verify the new information. Confirm the information, or click Cancel to abandon
the changes. Repeat this procedure for additional users.

Deleting Users
To delete one or more users, select a user from the Users
page (Figure 25 on page 55) by checking its respective selection checkbox. Multiple users can be selected in this way.
Click Select All to select all listed users.
Click the Delete button. A Confirmation dialog displays to
verify the deletion(s). If you change your mind, click Cancel
to abandon the delete operation. The Confirmation dialog
clears without changing the selected user settings.
Sansay strongly recommends deleting or changing the
default username to something unique for each customer.
This greatly reduces the security risk with remote access.

58

CHAPTER 9

VIEWING STATISTICS
This chapter describes how to use the Statistics viewer to
assess system traffic and performance for the VSX system,
its gateways, and routes.

Opening the Statistics Dialog


To access the Statistics dialog (Figure 28), click the Statistics tab from the VSX main menu. The Gateway Statistics
page displays by default.

Figure 28. VSX Gateway Statistics Dialog

59

Sansay VSX Users Guide

From this page you can view inbound and outbound Call
Attempts (CA), Answer Sieze Ratio (ASR), Failed Call Ratio
(FCR), and Average Call Duration (ACD) statistics over 15minute, one-hour, and 24-hour intervals. ACD is the average time between when an answer message is received and
the time the call is disconnected. This is often the same
value used for billing.
The Refresh button asserts an immediate update to the
Gateway Statistics page. Select the auto-refresh interval by
clicking the appropriate radio button.

Viewing Route Statistics


To access the Route Statistics dialog (Figure 29), click the
Statistics tab from the VSX main menu. The Gateway Statistics page displays by default. Click Route Stats to display
the Route Statistics page.

Figure 29. VSX Route Statistics Window

From this page you can view Call Attempts (CA), Answer
Sieze Ratio (ASR), and Fail Call Ratio (FCR) statistics over
15-minute, one-hour, and 24-hour intervals for each table,
digit match, route alias, and trunk ID. The Refresh button
asserts an immediate update to the Route statistics page.
Select the auto-refresh interval by clicking the appropriate
radio button.

60

Wiewing Statistics

Viewing System Statistics


VSX System statistics reflect overall system traffic and performance. To access the System Statistics page (Figure 30),
click the Statistics tab from the VSX main menu. The Gateway Statistics page displays by default. Click System Statistics to display the System Statistics page.

Figure 30. VSX System Statistics Page

61

Sansay VSX Users Guide

The System Statistics page displays the:

Number of sessions in progress

Total number of session attempts

Peak number of concurrent sessions

Maximum cuncurrent sessions allowed

Number of times maximum exceeded

Time remaining (for demo licences)

Resource allocations

Available system space

The Refresh button asserts an immediate update to the System Statistics page. Select the auto-refresh interval by clicking the appropriate radio button. Click Clear to clear the
page and begin collecting new statistics.
This page should be checked regularly to ensure that system
performance is as expected. The LAN ports should be
checked to ensure that errors are not being generated over
time. All LAN connections should be Full Duplex to minimize transmission errors. Disk space should never fall
below 15 GB. If it does, contact Sansay support.

62

CHAPTER 10

EDITING AND DELETING RESOURCES


Read this chapter to understand how to edit and delete the
following resources in a VSX environment:

Gateways

Routes

How Resources Are Edited


The Resource screen enables you to delete routes and gateways from the set of managed resources. The VSX management software displays warnings when resources to be
deleted can affect call traffic. Therefore, you should ensure
that any resources to be deleted are carrying no traffic.

63

Sansay VSX Users Guide

Editing Gateways
To edit a gateways configuration, you must first ensure that
the gateway is brought out of service. Use the following procedure:
1. Select a gateway from the resource screen. Click the
selected gateways Edit button.
2. From the Edit Gateway screen, change the gateways
service state to Provision.
3. From the Edit Gateway screen, change the configuration
settings as necessary. When the new settings are complete, Click Submit to assert the changes. A Confirmation dialog displays to verify the changes.
4. If you change your mind, click Cancel to abort the edits.
The Confirmation dialog clears without changing the
selected gateway settings.

Deleting Gateways
To delete a gateway from the resource list, use the following
procedure:
1. Select a gateway from the resource screen by checking
its selection checkbox.
2.

Click Delete to delete the Gateway from the resource


gateway list. A Confirmation dialog displays to verify the
deletion.

3. If you change your mind, click Cancel to abort the deletion. The Confirmation dialog clears without changing
the selected gateway.

Editing Routes
Use the following procedure to edit a route:
1.

Select a route from the Routes screen. Click its respective Edit button. The Edit Route screen displays.

2. From the Edit Route screen, change the configuration

64

Editing and Deleting Resources

settings as necessary. When the new settings are complete, Click Submit to assert the changes. A Confirmation dialog displays to verify the changes.
3. If you change your mind, click Cancel to abandon the
edits. The Confirmation dialog clears without changing
the selected route settings.

Deleting Routes
Use the following procedure to delete a route:
1.

Select a route from the Routes screen by checking its


selection checkbox. Multiple routes can be selected in
this way. Click Select All to select all configured routes.

2.

Click the Delete button. A Confirmation dialog displays


to verify the deletion(s).

3. If you change your mind, click Cancel to abandon the


delete operation. The Confirmation dialog clears without
changing the selected route settings.

65

Sansay VSX Users Guide

66

CHAPTER 11

MANAGING THE VSX SYSTEM


This chapter describes how to use the VSX System Page
options to modify system settings, manage configurations,
and upgrade VSX code.

67

Sansay VSX Users Guide

System Tab
The System page displays read-only information specific to
the systems native hardware and software configuration.
The System page is shown in Figure 31.

Figure 31. System Page

The information displayed on the System page is specified


by using the Edit System dialog. This must be done when
initially configuring the system or when moving the VSX to
a different network. For more information, see Initial Configuration on page 17.

68

Managing the VSX System

The System page displays the following fields and controls:

Edit System

Edit Network Connections

Edit Load-Balance Config

Edit System Page


The Edit System screen is shown in Figure 31. It enables
you to change the settings displayed on the System page.

Figure 32. Edit System Page

69

Sansay VSX Users Guide

From this page you can add or edit the following fields:
Alias Name
This field specifies the alias name for the VSX system. The
alias name can be up to 128 alphanumeric characters in
length and can include commas, semicolons, spaces, periods,
hyphens, underscores, the @ symbol, and question marks.
CDR System Name
The call detail record (CDR) system name parameter specifies the CDR filename prefix used for the VSXs internal file
naming convention. Up to eight characters are supported for
this filename prefix.
CDR File Interval
Specify the number of seconds that will transpire between
CDR file writes. The default value is 600 seconds (10 minutes). The value range is 180 to 86,400 seconds.
CDR Password
The CDR password enables access to collect call detail
records. CDR retrieval can be done by using FTP, SFTP,
or SCP. For more information about accessing CDRs, see
Collecting Call Detail Records on page 81.
Local Payload Port Start
This field displays the base (starting) address for UDP
ports used by the VSX system. This value is chosen as a
multiple by 4 of the VSXs call capacity. The default UDP
port base address is 10000.
SIP Port Address
Specify the SIP port address for the VSX system.
H323 Port Address
Specify the H323 port address for the VSX system.

70

Managing the VSX System

Gatekeeper ID
When using Gatekeeper-to-Gatekeeper protocol, the VSX
must provide the other gatekeeper it's ID. This field is a
global gatekeeper ID which will be used for all gatekeeper messages sent from the VSX. This needs to be
coordinated with any partners using gatekeeper control
for their network.
RAS Port Address
RAS port is used to control what UDP port we send the
Radius messages to on the Radius Server. The Shared
Secret is the password used for accessing the Radius
server.
NTP Server1/2
These fields display IP addresses for up to two network
time protocol servers used for reference to external time
standards.
DNS Server 1/2
The VSX can use either a host file or a DNS server to
resolve the Fully Qualified Domain Names (FQDNs) to
IP addresses. The IP addresses of the DNS servers are
entered into these fields.
SIP Reinvite Timer
The VSX can send out a periodic reinvite message to poll
the status of the call on the SIP call legs. If the reinvite
is not acknowledged the call will be disconnected. This
setting controls how frequently the reinvite will be sent
out on the call legs. The default value is 11 minutes. The
value range is 1 to 180 minutes.
Trace Unauthorized Call
The VSX can automatically log unauthorized calls into
the Session Trace file which is viewable in the Trace >
Show Session Trace tab. Only one call at a time will be
traced, so the file will not get too large or occupy too
much processor time. An unauthorized call is one origi-

71

Sansay VSX Users Guide

nating at an IP address which is not configured in the


Resource or Resource Group TIDs.
Current Time/ Time Zone/Date/Time
These fields display the current system internal time
clock/calendar.

Note

When changing the VSX FQDN, Default Gateway, Subnet


Mask, or Local Payload Port Start settings, the system will
prompt you to restart it.

Editing Network Connections


The Edit Network Connections form (Figure 33) enables
you to edit FQDN/IP addresses, default gateway
addresses, and subnet masks for access networks.

Figure 33. Edit Network Connections Form

LAN Interface FQDN/IP


This field displays the fully-qualified domain name (IP
address) of the LAN 1 (public) and LAN2 (private) ethernet
ports on the VSX system. This address is specified during
initial configuration of the VSX system.

72

Managing the VSX System

Subnet Mask
This field displays the ethernet subnetwork mask for the
VSX system. This address is specified during initial configuration of the VSX system. The subnet mask controls the
boundary between the public and private network address
spaces. It indicates how many network addresses are used
for the private network; all others are considered public.
The default value is 16. The value range is 1-24.
Default Gateway
This field displays the IP address of the default gateway
that the VSX will use. This address is specified during initial configuration of the VSX system.
After editing these fields, click Submit to assert the changes
or click Cancel to abandon the process.

Advanced Control Panel


Click the Advanced button to access the Advanced System control panel shown in Figure 34.

Figure 34. VSX Advanced System Control Panel

From this panel you can:

Restore a Configuration

Save a Configuration

Upgrade Code

Reboot the System

73

Sansay VSX Users Guide

Restart VSX Software

Take the System Offline

Upgrade the System

Restoring A Configuration
The Restore Config button opens the Restore System
Configuration form (Figure 35) that enables you to
restore the previously-saved configuration after configuration changes are made. You can enter the name of the
configuration file, or click Browse to navigate to the file
you want. After selecting the file, click Submit to reinstate the configuration.

Figure 35. Restore System Configuration Form

Saving a Configuration
The Save Config button opens the Save System Configuration dialog (Figure 36) that enables you to save the
current configuration to a configuration file.

74

Managing the VSX System

Figure 36. VSX Save System Configuration Dialog

Clicking the active area of the screen opens a browser


dialog that enables you to name and store the configuration file. It should be noted that the downloaded zip file
is not useable for any other purpose than uploading to a
VSX. It will not be opened by any other program. The
default name is config.zip but should be renamed during
the download to a more relevant name. There is also a
security issue with some Internet Explorer browsers
which can cause the file not to download properly. It is
recommended that you use a different browser such as
Opera or Firefox if this problem is encountered.

Upgrading VSX Code


The Upgrade Code button opens the Upload Code
Upgrade form (Figure 36) that enables you to upgrade or
change the system capacity.

Figure 37. VSX Upload Code Upgrade Form

Enter the filename for the code upgrade, or click Browse to


navigate to the location of the upgrade file. Click Submit to
copy the file.

Note

The code upload file size is approximately 10 Mbytes and


may take over a minute to upload. Please be patient and wait
for the upload to finish.

75

Sansay VSX Users Guide

Rebooting the System


The Reboot System button opens the Reboot System dialog (Figure 38 on page 76). Click Reboot Now to issue an
explicit command that completely reinitializes the VSX
system. This action is service-affecting.

Figure 38. VSX Reboot System Dialog

Note

This action will interrupt service. The VSX code restart is


very quick and the downtime should be less then 15 seconds.

Restarting the VSX Software


The Restart Software button opens the Restart Software
dialog (Figure 39). Click Restart Now to issue an explicit

76

Managing the VSX System

command that restarts the VSX system software. This


action is service-affecting.

Figure 39. VSX Restart Software Dialog

Note

This action will interrupt service.

Taking the VSX Offline


This action forces the VSX to begin refusing calls. It enables
you to drain the calls from the VSX prior to a restart/reboot.
All calls that arrive following the execution of this command
are replied to with an H.323 "34" or a SIP 503 message. As
the existing calls hang up it is possible to wait for all calls to
be normally cleared prior to restarting the system. It is particularly useful when load balancing is used in a cluster.

77

Sansay VSX Users Guide

The System Offline button opens the System Offline dialog


(Figure 40). Click Offline Now! to take the VSX offline. This
action is service affecting.

Figure 40. System Offline Dialog

Note

This action will interrupt service.

Upgrading the VSX System


The Upgrade System button opens the Generate System
Key (Figure 41 on page 79). This dialog enables you to
adjust call capacity, system type, redundancy, and
license type for the VSX system. Click Generate System

78

Managing the VSX System

Key to enable the system upgrade. Click Apply Upgrade


to update the VSX system.

Figure 41. Generate System Key Dialog

Editing Load Balance


The Load Balancing configuration is used to create a cluster
of identically configured systems which share the licenses of
a single system. The goal is to establish a redundant configuration whereby all the origination and termination partners are able to send to any VSX in the cluster. This creates
an N:1 redundant system that can support multiple fail-over
scenarios.

Note

This button is only viewable if the system has a Load Balancing license.

The configuration involves setting up a Master system and


up to 8 Slave systems. The Master is in charge of the configurations, and the Slave systems are not enabled to edit any
parameters. When the configuration on the Master system
is changed it is propagated to the Slave systems automatically.
The system function is either Master or Slave in the pull
down menu. The Slave only inputs the Master IP address,
on the Master you need to enter all the Slave's IP address.

79

Sansay VSX Users Guide

If the databases become out of sync it is could be necessary


to execute the "Reset Slave" command which brings the two
databases back into lock step.

Using Radius Servers


The VSX System Page allows you to configure the Radius
Servers if they are being used. You can configure up to 4
Radius servers for redundancy. Each radius message is sent
to the 4 servers in numerical order. Each server will be
attempted multiple times set by the Radius Max Resend.
The Radius Server page is shown in Figure 42.

Figure 42. Radius Server Page

The Radius Server Shared secret has to be coordinated with


the radius system, as well as the UDP used for Authorization and Accounting. Usually the defaults for the UDP ports
are fine. The Radius Resend time can be programmed as
well. Depending on the load on the server the resend timer
of 3 seconds should be sufficient.
The VSX has a special Radius Recovery feature which
increases the reliability of the radius feature. If a specific
Radius message is not Acknowledged by any of the programmed radius severs, the VSX will store the message in
an error file and will automatically resend the messages to
the radius server when it is available again.

80

Managing the VSX System

To edit Radius server settings, click the Edit button. The


Edit Radius Server page displays (Figure 43).

Figure 43. Edit Radius Servers Dialog

Use the Radius Server dropdown to enable or disable Radius


servers. Click Update to assert your selection.

Collecting Call Detail Records


In order to bill for calls going through the VSX you can
retrieve the call detail records (CDRs) by using the Secure
Copy Protocol (SCP). The SCP procedure requires a defined
user login name with a password. The CDR username and
password are configured on the Edit System page. Open an
SCP session using one of the following commands:
SCP user@ <IP address>:/CDR/20060401*.cdr
This command will retrieve all the CDR files created on
04/01/2006.

81

Sansay VSX Users Guide

82

CHAPTER 12

THE VSX CONFIGURATOR


The Sansay VSX features a comprehensive, easy to use
graphical user interface that enables you to configure and
manage the VSX. Using a standard Internet browser you
can access this interface by entering the default IP address
of the VSX. The default IP address is 192.168.0.100:8080/.

Logging In
After entering the default IP address of the VSX unit, a welcome screen displays that enables you to login to the system.
The welcome screen is shown below in Figure 44.

Figure 44. VSX Login Screen

Enter your user name and password and click the Login button to proceed to the configuration screens. The default user
name is superuser and the default password is sansay.

83

Sansay VSX Users Guide

Configurator GUI
The VSX configurator consists of six pages that are accessed
by clicking their respective tabs. These pages are:

84

System

Resources (default)

Routes

Statistics

Trace

Users

Digit Mapping

Accessing the Configurator

System Page
The System page displays read-only information specific to
the systems native hardware and software configuration.
The Basic System page is shown in Figure 45.

Figure 45. System Page

System Page Controls


The System page displays the following fields and controls:
Edit System
Invokes the Edit System form that enables you to change
the settings displayed on the System page. For more
information, see Edit System Page on page 69.

85

Sansay VSX Users Guide

Edit Network Connections


The Edit Network Connections form enables you to edit
FQDN/IP addresses, default gateway addresses, and
subnet masks for access networks. For more information, see Editing Network Connections on page 72.
Edit Load-Balance Config
The Load Balancing configuration is used to create a cluster
of identically configured systems which share the licenses of
a single system. This button is only viewable if the system
has a Load Balancing license. For more information about
configuring load balancing, see "Editing Load Balance" on
page 79.

Advanced Tab
Click the Advanced tab to access the Advanced System
control panel. From this panel you can:

Restore a Configuration

Save a Configuration

Upgrade Code

Reboot the system

Restart VSX software

For more information, see Advanced Control Panel on


page 73.
Restore Config
The Restore Config button opens the Restore System
Configuration form that enables you to restore the previously-saved configuration after configuration changes
are made. For more information, see Restoring A Configuration on page 74.
Save Config
The Save Config button opens the Save System Configuration dialog that enables you to save the current configuration to a configuration file. For more information, see
Saving a Configuration on page 74.

86

Accessing the Configurator

Upgrade Code
The Upgrade Code button opens the Upgrade Code form
that enables you to upgrade or change the system capacity. For more information, see Upgrading VSX Code on
page 75.
Reboot System
The Reboot System button opens the Reboot System dialog. Click Reboot Now to issue an explicit command that
completely reinitializes the VSX system. This action is
service-affecting. For more information, see Rebooting
the System on page 76.
Restart Software
The Restart Software button opens the Restart Software
dialog. Click Restart Now to issue an explicit command
that restarts the VSX system software. This action is
service-affecting. For more information, see Restarting
the VSX Software on page 76.

Radius Server Tab


The Radius Server tab enables you to configure Radius
Servers if they are being used. You can configure up to 4
Radius servers for redundancy. For more information
about Radius servers, see "Using Radius Servers" on
page 80.

System Page Field Descriptions


Alias Name
This field specifies the alias name for the VSX system.
The alias name can be up to 128 alphanumeric characters in length and can include commas, semicolons,
spaces, periods, hyphens, underscores, the @ symbol,
and question marks.
System Mode
This field specifies the type of server the VSX will function as. The default value is Call Server. The Media
Server function will be supported in a future release.

87

Sansay VSX Users Guide

Current Time/ Time Zone/Date/Time


These fields display the current system internal time
clock/calendar.
NTP Server1/2
These fields display IP addresses for up to two network
time protocol servers used for reference to external time
standards.
CDR System Name
The call detail record (CDR) system name parameter
specifies the CDR filename prefix used for the VSXs
internal file naming convention. Up to eight characters
are supported for this filename prefix.
CDR File Interval
This parameter specifies the number of seconds that will
transpire between CDR file writes.
System FQDN 1
This field displays the fully-qualified domain name (IP
address) of the VSX system. This address is specified
during initial configuration of the VSX system.
Default Gateway
This field displays the IP address of the default gateway
that the VSX will use. This address is specified during
initial configuration of the VSX system.
Subnet Mask
This field displays the ethernet subnetwork mask for the
VSX system. This address is specified during initial configuration of the VSX system.
Local Payload Port Start
This field displays the base (starting) address for UDP
ports used by the VSX system. This value is chosen as a
multiple by 4 of the VSXs call capacity. The default UDP
port base address is 10000.

88

Accessing the Configurator

SIP Port Address


This parameter specifies the SIP port address for the
VSX system.
H323 Port Address
This parameter specifies the H323 port address for the
VSX system.
The information displayed on the System page is specified
by using the Edit System dialog. This must be done when
initially configuring the system or when moving the VSX to
a different network. For more information, see Edit System
Page on page 69.

Resources Page
After login, the Resource page displays by default. It displays existing connected gateways, IP phones/clients, soft
switches, and proxies. In addition, it enables you to add
additional gateways and edit existing access parameters.
The Resources page is shown in Figure 46.

Figure 46. VSX Resources Page

89

Sansay VSX Users Guide

The Resources page provides the following fields and controls:


Add Gateway
Invokes the Add Resource Gateway dialog. For more
information about adding gateways, see Adding and
Configuring Resources on page 25.
Search Control
Sorts and lists gateway entries using the first letter of
the Company Name field.
Check All
Selects all entries on the Resources page.
Delete
Deletes the selected resources.
Trunk ID
Displays the gateways configured Trunk ID.
Company Name
Displays the owner of the configured gateway/resource.
Alias
Displays the alias name given to the gateway/resource.
FQDN/IP
Displays the fully-qualified domain name/IP address for
the managed resource.
Protocol
Displays the signaling protocol assigned to the resource.
Port
Displays the port address used by the resource.

90

Accessing the Configurator

Edit
Invokes the Edit Resource Gateway dialog. For more
information, see Editing and Deleting Resources on
page 63.
Help
Displays online help for the Resources screen.
Logout
Logs out the user and dismisses the Resources screen.

Routes Page
The Routes page enables you to add new routes, or view and
edit existing routes. The Routes page is shown in Figure 47.

Figure 47. VSX Routes Page

The Routes page provides the following fields and controls:


Add Route
Invokes the Add Route dialog. For more information
about adding routes, see Adding and Configuring
Routes on page 39.

91

Sansay VSX Users Guide

Upload Route Table


Enables you to upload the Route table in XML or CSV
file format. For more information about uploading route
tables, see Importing Routes and Tables on page 45.
Download Route Table
Enables you to download the Route table in XML or CSV
file format. For more information about uploading route
tables, see Exporting Routes and Tables on page 47.
Search Control
Sorts and lists route entries using the first letter of the
Alias field.
Check All
Selects all entries on the Routes page.
Delete
Deletes the selected routes.
Digit Match
Displays digit matching criteria for route selection based
on the dialed number.
Alias
Displays the alias name assigned to a route.
Route #1-8
Displays the routing table associated with each route
entry. A primary route and up to seven alternate routes
are supported.
Edit
Invokes the Edit Route dialog. For more information
about editing routes, see Editing and Deleting
Resources on page 63.
Logout
Logs out the user and dismisses the Routes screen.

92

Accessing the Configurator

Users Page
The Users page displays all users authorized to access the
VSX system. Initially, the superuser entry displays by
default. The Users page is displayed in Figure 48.

Figure 48. VSX Users Page

The Users screen provides the following fields and controls:


Add User
Invokes the Add User dialog. For more information
about adding users, see Managing Users on page 55.
Search Control
Sorts and lists User entries using the first letter of the
User ID field. Click All to list all users.
Check All
The checkbox next to the User ID column selects all
entries on the Users page.
Delete
Deletes the selected users.

93

Sansay VSX Users Guide

User ID
Displays a hyperlinked reference number for the listed
user. Clicking this link displays information specific to
the selected user.
Authorization
Displays the access priveleges granted to the user by the
superuser. Access rights can be Superuser, Admin, or
Read Only.
Last Login Date/Time
Displays the most-recent session the listed users were
engaged in.
Remote Host
Displays the IP address of the remote host associated
with a listed user.
Edit
Invokes the Edit User dialog. This dialog is used to modify individual user information. For more information,
see Managing Users on page 55.

Monitoring Page
The VSX Monitoring page is shown in Figure 49 on page 95.
Inbound or outbound statistics are collected for in-service
trunks at 15- minute, 1-hour, and 24-hour intervals. The
Gateway Stats page displays by default.

94

Accessing the Configurator

Figure 49. VSX Gateway Stats Page

For trunks that are in service, the following statistics are


displayed:

CA (Inbound/Outbound calls Attempted)

ASR (Inbound/Outbound Answer Sieze Ratio)

FCR (Inbound/Outbound Failed Call Ratio)

ACD (Inbound/Outbound Average Call Duration)

For More Information, see See "Viewing Statistics" on page


59.

95

Sansay VSX Users Guide

Trace Page
If calls are failing you may need to enable tracing for the
problem gateway or routes. The Trace page enables you to
perform traces for troubleshooting purposes.

Figure 50. Sansay VSX Trace Dialog

The Trace page provides the following fields and controls:

View Call Sessions

View H323 Protocol

View SIP Protocol

Advanced

For more information, see See "Failing Calls" on page 101.

96

CHAPTER 13

SANSAY SOAP CLIENT


This section describes the usage of XML and the SOAP client used to control the VSX configuration. The SOAP client
is not required to use XML with the VSX but it is a convenient way to do so. This section discusses how to use the
SOAP client but much of it is relevant to systems using
direct XML without the Sansay SOAP API.

XML Schema
The SOAP client includes a number of files which are XML
schema. These represent the format of the database structure which can be updated on the VSX using XML. It is
important to note that the database structure changes as
new features are added to the VSX system. If you upgrade a
version of software it may include new features which are
not in the SOAP client's XML file schema. As such it is
worthwhile to Export the new configuration in the GUI
using the Export > XML button on the Resource or Route
tabs on a new system or after a significant version change.

Editing XML Files


Many companies have an automated system for generating
XML files. This might be a billing application, or a specialized Least Cost Routing application. XML files can also be
generated manually. The files can be modified by a number
of application such as MS Word or MS Excel. A good free

97

Sansay VSX Users Guide

XML editor is XML SPY Home Edition and can be found at


Altova.
Most of the parameter values in the XML files are explained
in other parts of the VSX User Guide for the version of software in use. The option descriptions will not be repeated
here, please refer to the relevant pages for detailed usage.

SOAP Client Functions


The XML interface supports the following functions:

Add

Delete

Upload

Download

Update

These functions can be applied to the following database


structures:

Resource

Resource Group

Route

Route Table

Route Group

Digit Map Table

Digit Map Entry

SOAP is a Java application and requires JRE 2.3 or newer.


It is designed to run on any OS that supports this environment. In a windows workstation the application can be run
from a DOS window inside the directory where the client
resides. For a list of variables option you can simply run:
run.bat -?. This will present you the proper syntax for the
XML commands which you can use to direct your commands.

98

Sansay SOAP Client

An example command is c:\soap\run.bat -a192.168.1.2 usuperuser -psansay upload newroutes.xml route


This will direct the client to login to the VSX at 192.168.1.2
with username superuser, password sansay, and upload the
route file newroutes.xml. Keep in mind that an upload will
replace the existing route table with the one being uploaded.
This means that every route must exist in the table to be
uploaded.
An update to the route table will change routes that are in
the XML file but not affect ones which are not in the XML
file. If there are entries in the XML file that are not in the
route table, it will add those entries to the route table.

Centralizes routing tables

Centralized & accurate CDRs

Simplifies Gateway configurations

Intelligent Route Hunting enhances ASRs

Is secure and scalable

Provides real-time performance monitoring

99

Sansay VSX Users Guide

100

CHAPTER 14

TROUBLESHOOTING
Read this chapter for information on solving problems you
may encounter when using the VSX Configurator and session controller.

Failing Calls
If calls are failing within your network you can verify this by
using the Statistics tab. This will show you the percentage of
answered calls as well as the percentage of failed calls
within the VSX. You can monitor either all the calls inbound
from a resource or just the calls outbound to a specific route.
To monitor the Inbound calls, select the Statistics tab and
then click the Show Gateway Statistics button. This will
show you the calls inbound from each Gateway or partner.
The first column is the Trunk ID associated with the
resource, the company name, and the gateway alias. The
display can be sorted by clicking on the heading for each of
these headings. Each TID will show the Inbound Call
Attempts (CA), the Answered Sieze Ratio (ASR), and the
Failed Call Ratio (FCR).
The ASR is the ratio of the answered calls on the TDM side
of the GW versus call attempts. It will normally indicate
below 100% because not all calls are answered. If the ASR is
100%, most likely the end gateway is providing you answer
supervision on all calls whether they are answered or not.

101

Sansay VSX Users Guide

This would indicate an unreliable network, and you should


recognize the limitations of such a route.
It is important to realize that the statistics displayed are
valid only after a statistically valid sample is taken. For
example, four successful calls out of five calls is not significant in terms of long-term percentages. Only when you have
above 15-20 calls can you draw any meaningful comparison.
An exception is when the FCR is at 100%. This means that
every call has returned a failed call setup. If you have made
a change or if this is a recent addition, an FCR of 100%
points to a problem. However, when you see the FCR drop
below 100%, or when the ASR is above zero, at least some
calls are going through. This would indicate a probable correct configuration.
Failed calls occur normally within a VoIP network and are
not necessarily a sign of misconfiguration. A failed call can
be the result of insufficient capacity, or a misdialed number
from the caller. Ideally, the administrator will develop a
sense of what the Failed Call Ratio (FCR) is on a particular
resource or route and monitor it for change.
The Average Call Duration (ACD) is useful on Outbound
Route Statistics. This parameter, shown in seconds, is the
average talk time associated with all answered calls. It is
the period of time from the Call Answer to the Call Disconnect messages. If this number is low ( less than 60 seconds)
it may reflect bad voice quality. If this is very low (less than
10 seconds) it may reflect a signaling problem or some type
of broken audio path. The ACD on international long distance calls over TDMs is approximately 180 seconds. VoIP
calls should be in the same range, given a large enough sample.

102

Troubleshooting

Tracing Calls
If the calls are failing you may need to enable tracing for the
problem gateway or routes. Tracing is enabled by editing the
route or gateway and changing the Service State to Trace.
You can then select the Trace tab and use the menu selections.

Figure 51. VSX Trace Window

The Trace dialog provides the following fields and controls:

View Call Sessions

View H323 Protocol

View SIP Protocol

Advanced

Once you have determined that you may have a routing


issue in your network the best place to start is the Trace tab.
Normally you have to enable tracing for calls to be traced
but there are some exceptions. If a SIP or H.323 message
experiences a parsing problem, it will automatically be written into the trace file for that protocol. Likewise, all calls
that use the TID Direct Dialing method of call routing are
automatically traced in the View Call Session log as well as
the protocol trace on both the inbound and outbound legs.
This helps you bring up new routes and observe performance with test calls to that route.

103

Sansay VSX Users Guide

Viewing Call Sessions


To view a call session, select the Trace tab and click on the
View Call Sessions button. The Call Session trace log (Figure 52) displays basic information about each call which you
can verify against expectations.

Figure 52. Call Sessions Trace Log

The View Call Sessions is a very concise and easy to read


display of each session that originates or terminates on a
traced route or resource. Keep in mind when looking at the
trace that calls are not viewable in any of these pages until
the call is torn down. An active call is not displayed.
The View Call Session is broken into four parts. The top part
shows the session ID number and the overall VSX disconnect (or release) cause. Hopefully the release cause is a
"Normal" which means that the originator or terminator
hung up the answered call. This part also shows the Start

104

Troubleshooting

time for the session, the Answer time (if empty it means it
was unanswered), and the Release time. One line shows the
Stack Cause for either the Originating (O) or Terminating
(T) side of the call. These are in accordance with either the
IDSN Cause Code (H.323) or the SIP message type. Please
see the appendix for cause code listings in Release Causes
on page 122.
The second portion of the sesson trace shows the Origination
TID and the protocol used on this session. The ANI and the
DNIS are shown as they arrived to the VSX (untranslated).
The IP/UDP for the signaling and media are also shown as is
the CODEC list provided on the incoming calls.
The third portion of the trace shows essentially the same
information on the Termination side of the call. In this case
the information is exactly as it leaves the VSX, ie., post
translation. The codec list here should reflect the CODEC
used on the call.
The fourth portion shows the media packets that were sent
and received on the call. The Orig line shows the voice packets inbound from the origination gateway (Pkt In) and the
packets outbound toward the origination gateway (Pkt Out).
The bottom line shows the voice packets sent and received
from the terminating gateway.

105

Sansay VSX Users Guide

H323 Protocol Log


For H.323 protocol issues click on the View H.323 Protocol
button for further information. The H.323 trace log displays
as shown in Figure 53.

Figure 53. H.323 Trace Log

When you have finished examining the trace, click Done to


exit the trace log.

106

Troubleshooting

SIP Protocol Log


For SIP protocol issues click on the View SIP Protocol button for further information. The SIP trace log displays as
shown in Figure 54.

Figure 54. SIP Protocol Trace Log

When you have finished examining the trace, click Done to


exit the trace log.

107

Sansay VSX Users Guide

Advanced Trace
Advanced tracing gives a detailed view of Call sessions, Protocol tracing and VSX System processes. Advanced tracing
tools should only be used under the guidance of the Sansay
technical support staff. They are used for detailed debugging
of system software. They are not needed for normal troubleshooting or diagnostics. Large amounts of data are created
and these traces should not be left enabled for any length of
time.

Figure 55. Advanced Trace window

When you have finished examining the trace, click Hide


Advanced to exit the Advanced trace log.

108

Troubleshooting

Configuration Problems
This section presents a summary of the common causes of
configuration errors and suggestions to troubleshoot each:
1. A conflict with a selected protocol.

Ensure that the proper protocol is selected for SIP or


H.323 devices.

2. A routing error.

Ensure that the routing rules are consistent with the


call destination. Inspect the routing table entries.

Retrying the Configuration


After eliminating the possible causes of the problem
described above, verify connectivity.
If the problem continues, gather the information listed
below, record the information and contact Sansay Technical
Support.

Information about the Installation


1. Configuration parameters for the gateway in question
2. Routing parameters for the route in question
3. The number of gateways the problem is occurring on:
(All / Many / Some / Few / One) gateway(s).
4. How frequently the problem occurs: (All / Many / Some /
Few) installation attempts.
5. What custom resources, if any, are in the network?

109

Sansay VSX Users Guide

Troubleshooting the VSX


If problems occur with the VSX, there are a number of steps
you can take to resolve the issue. The list below contains
troubleshooting ideas and suggestions.

Basic Steps

110

Keep detailed configuration records. Having


records always helps track down problems. Be sure to
include the names and IP addresses of each resource
gateway and softswitch in your network, and where
these units are physically located. This list will be an
invaluable reference when performing diagnostics.

Verify the integrity of the network. Make sure you


can reach every softswitch and gateway on the network.
This can be done through a number of network diagnostic tools. One good tool is the ping utility. Ping sends out
packets to a remote site, which then returns the packets
if the site is up and running properly. Ping is available
on DOS and LINUX. The command is: ping <hostname>. You can use an IP address or hostname with
ping.

Verify that the gateways are functioning properly.


Make sure the resource gateways in your network are
running properly, and are not reporting alarms. Also
check the individual configuration of each gateway to
ensure that there are no errors or conflicts. Check the
Statistics|System page and verify the Ethernet connection is working properly. In general it is expected to be
100 BT FD (full duplex).

If your VSX is at a remote site, verify that the site


is reachable over the network. Make sure the VSX
server is running properly. Access the System page of
the VSX configurator. This page lists all the events from
the event server that have occurred in log form. Examine
the log for any anomalies that could point to the symptoms or cause of a problem. It also lists the VSXs processes that are currently running. If a process is down,
rebooting the server might bring it back up.

Troubleshooting

Frequently Asked Questions


This section lists the most common questions raised while
installing and configuring the VSX and related components.
If you have encountered a problem, check here to see if your
issue is addressed.
Table 1. Possible Problem Solutions
Description

Corrective Action

How often is the VSX's status updated?

The VSX polls the gateway every 20 seconds if it


senses no gateway activity.

How do I temporarily disable a trunk


without deleting it?

Change its Service State to Provision or Block.

I have configured a gateway and a


route. However, I keep getting a busy
tone when I dial the outgoing number.
How can I pinpoint the problem?

First, check the In/Out Action rule to ensure that applying the In/Out Action will produce dialed digits that
match the configured route.

What happens if a cable is inadvertently


disconnected?

Reconnect the cable and re-organize the operating


environment surrounding the server(s).

Make sure that the prefix and DNIS are the correct ones
the terminating partner is expecting.

If the Network cable was disconnected, the VSX will


attempt to reconnect within 5 seconds.
If the power cable was disconnected, then the system
will come back up after power is re-applied, assuming
there were no corruption/damage done to the file system(s). If the filesystem was damaged, Contact Sansay
TAC for assistance on how to recover.

111

Sansay VSX Users Guide

Table 1. Possible Problem Solutions

Description

Corrective Action

What In Action/Out Action rule should I


use?

In/Out Action rules define how dialed digits are parsed


before a route search begins. It is used for speeding up
route searches. In a PSTN, telephone numbers are provisioned such that an EO switch for the dialed number
can be efficiently located as digits are dialed.
In North America, telephone numbers (dialing plans) are
ten digits in length and use the following format: NPANXX-XXXX. NPA is also known as area code, NXX the
EO code, and XXXX the subscriber's number. At each
level of the PSTN's switch, only a certain number of digits in the dialed number are examined to figure out the
next switch to pass the phone call to.
In the current PSTN, because switches are organized in
a level structure (Class 5, Class 4, etc.), each switch
only needs to know how to parse digits at its own level.
Within the VSX, the level structure no longer applies.
The VSX can have its trunks connected to all levels and
across a diverse set of dialing plans (North America,
India, etc.).
In/Out Action rules are used to help process different
dial plans. Because each trunk group is connected to
one switch which has only one dial plan, a In/Out Action
rule can be configured for the trunk group that informs
the VSX about the dial plan of the incoming call. In/Out
Action rules should be used in conjunction with the dial
plan in the route table.
For example, in the route table, suppose that one has a
route going into the 408 area code as 1 408. Trunks that
have a route to area code 408 should have a In/Out
Action rule established as 1 3, which means if the first
dialed digit is 1 then take the next 3 digits and see if a
route can be found. If the caller dials 1-408-555-1234
then the route is selected. If one dials 1-303-555-1234
then no route is found because no 1 303 route exists in
the route table.

Power fail and restart procedure

The system should recover by itself without user intervention.


If the system cannot initialize, error messages would
display on the terminal/console screen. Contact Sansay
TAC for assistance on how to identify the problem.

What aids do I have for Fault Detection,


Isolation and Recovery?

There are currently no automated procedures for this


purpose. Contact Sansay TAC for assistance.

How do I measure CPU utilization?

Access the VSX Configurator System page from a standard web browser.

112

Troubleshooting

Getting Help
If after installing and configuring your Sansay equipment,
you cannot establish communications to or from the unit,
carefully review the information in this book prior to calling
Sansays Technical Assistance Center (TAC).

Checklist
Ensure that you have checked the following possibilities:

Reset the equipment. When cycling power, be sure to


leave the power off for a minimum of 30 seconds before
reapplying power to the unit.

Check your software version. To ensure that all our customers have the latest enhancements and product features, Sansay ships every new or factory-upgraded unit
with the latest software version.
Therefore, whenever you are installing units into your
system, check each unit to verify that all units are
equipped with identical software versions.

113

Sansay VSX Users Guide

Contacting TAC
If, after carefully reviewing the information in this book
your problem persists, contact either your product representative or a service representative at Sansays Technical
Assistance Center. Prior to calling, ensure that you have
assembled all the pertinent data that will assist in resolving
your problem. These items include:

A detailed description of your problem

A complete listing of your system components and configuration. Include your units serial number and the
software version number it is running

A narrative of the actions you performed prior to the


problem

A list of all system messages posted by your unit

Your Sansay service representative will advise you as to the


appropriate course of action.

Contacts
Address:
Sansay, Inc.
4650 Lusk Blvd. Suite E204
San Diego, CA 92121 USA

Telephone:
1-858-678-0200

114

APPENDIX A

CALL DETAIL RECORDS


This chapter defines the content and structure of Sansay's
call accounting recordscall detail recordsin ASCII format,
which is applicable to the Sansay VSX. In addition, the functional requirements for the VSX are also listed along with
the assumptions for the external billing systems.

Introduction
Call detail records (CDRs) are an integral part of the VSX as
they contain the usage information to bill your customers.
Therefore, you should review the CDR formats in this chapter for complete information on the CDR fields. .
Table 1. CDR Header Structure
Parameter

Max ASCII
Characters

Description

Notes

Record Sequence Number

Unique identification of this record

Version Number

Format version number of records


to follow

Record Type

Type of CDR being generated

Record Data

Variable

Parameters as defined in File


Retrieval Procedure on page 127.

Notes:
1. Current version: V1.8
2.

Type: R - Normal CDR record, A - Audit

115

Sansay VSX Users Guide

CDR fields that contain no data will contain the string NA.
The semicolon character (;) is used as a delimiter to separate
the fields of a CDR record. Each CDR record in the file is
separated by a line feed character (\n).

Call Detail Record Body


The call record parameters shown in Table 2 contain relevant information related to a call.
Table 2. Call Detail Record Body
Parameter

Max ASCII
Characters

Description

Notes

ConnectionType

16

Type of connection

SessionID

32

Unique ID assigned to the call by


SSM subsystem

Release Cause

See Release Causes on


page 122.

Start Time of Date

32

Indicates Time of Date when the


call entered the system

Answer Time of Date

32

Indicates TOD when the call was


answered

Release TOD

32

Indicates the TOD when the call


was disconnected

Minutes West of Greenwich Mean Time

32

Minutes West of Greenwich Mean


Time. Used to calculate the time
zone.

Release Cause from Protocol Stack

32

Release cause string from either


H323 or SIP protocol stack

New in v1.1

Binary Value of Release


Cause from Protocol stack

Binary value of the protocol release


cause

New in v1.1

First release dialogue

O: origination, T: termination

New in v1.1

Trunk ID -- Origination

Trunk ID for origination GW


(resources)

use previous value

VoIP Protocol - Origination

VoIP protocol for origination dialogue

Origination Source Number

128

Source Number in Origination Dialogue

Origination Source Host


Name

128

FQDN or IP address for Source


GW in Origination Dialogue

116

Call Detail Records

Table 2. Call Detail Record Body


Parameter

Max ASCII
Characters

Description

Origination Destination
Number

128

Destination Number in Origination


Dialogue

Origination Destination
Host Name

128

FQDN or IP address for Destination


GW in Origination Dialogue

Origination Call ID

128

Unique ID for the origination dialogue (leg)

Origination Call ID

128

Unique ID for the origination dialogue (leg)

Origination Remote Payload IP Address

16

Remote Payload IP address for


origination dialogue

Origination Remote Payload UDP Address

Remote Payload UDP address for


origination dialogue

Origination Local Payload


IP Address

16

Local (VSX) Payload IP address for


origination dialogue

Origination Local Payload


UDP Address

Local (VSX) Payload UDP address


for origination dialogue

Origination Codec List

128

Supported Codec list (separated by


comma) for origination dialogue

Origination Ingress Packets

10

Number of Ingress (into Sansay


system) payload packets in origination dialogue

Origination Egress Packets

10

Number of Egress (out from Sansay system) payload packets in


origination dialogue

Origination Ingress Octets

10

Number of Ingress (into Sansay


system) payload octets in origination dialogue

Origination Egress Octets

10

Number of Egress (out from Sansay system) payload octets in origination dialogue

Origination Ingress Packet


Loss

10

Number of Ingress (into Sansay


system) payload packet loss in
origination dialogue

Origination Ingress Delay

10

Average Ingress (into Sansay system) payload packets delay ( in ms)


in origination dialogue

Origination Ingress Packet


Jitter

10

Average of Ingress (into Sansay


system) payload packet Jitter ( in
ms) in origination dialogue

Notes

117

Sansay VSX Users Guide

Table 2. Call Detail Record Body


Parameter

Max ASCII
Characters

Description

Notes

Trunk ID -- Termination

TrunkID for termination GW


(resources)

VoIP Protocol - Termination

VoIP protocol from termination GW

Termination Source Number

128

Source Number in Termination Dialogue

Termination Source Host


Name

128

FQDN or IP address for Source


GW in Termination Dialogue

Termination Destination
Number

128

Destination Number in Termination


Dialogue

Termination Destination
Host Name

128

FQDN or IP address for Destination


GW in Termination Dialogue

Termination Call ID

128

Unique ID for the termination dialogue (leg)

Termination Remote Payload IP Address

16

Remote Payload IP address for termination dialogue

Termination Remote Payload UDP Address

Remote Payload UDP address for


termination dialogue

Termination Local Payload


IP Address

16

Local (VSX) Payload IP address for


termination dialogue

2.00,2.10

Termination Local Payload


UDP Address

Local (VSX) Payload UDP address


for termination dialogue

C,2.00,2.10

Termination Codec List

128

Supported Codec list (separated by


comma) for termination dialogue

C,2.00,2.10

Termination Ingress Packets

10

Number of Ingress (into Sansay


system) payload packets in termination dialogue

I,2.00,2.10

Termination Egress Packets

10

Number of Egress (out from Sansay system) payload packets in termination dialogue

f,C,2.00,2.10

Termination Ingress
Octets

10

Number of Ingress (into Sansay


system) payload octets in termination dialogue

d,2.00,2.10

Termination Egress Octets

10

Number of Egress (out from Sansay system) payload octets in termination dialogue

g,2.00,2.10

Termination Ingress
Packet Loss

10

Number of Ingress (into Sansay


system) payload packet loss in termination dialogue

i,2.00,2.10

118

Call Detail Records

Table 2. Call Detail Record Body


Parameter

Max ASCII
Characters

Description

Notes

Termination Ingress Delay

10

Average Ingress (into Sansay system) payload packets delay ( in ms)


in termination dialogue

f,C,2.00,2.10

Termination Ingress
Packet Jitter

10

Average of Ingress (into Sansay


system) payload packet Jitter ( in
ms) in termination dialogue

d,2.00,2.10

Final Route Indication

F: Final Route Selection, I: Intermediate Route Attempts

New in V1.3

Routing Digits

64

Routing Digit (Digit after Inbound


translation, before Outbound
Translation).

New in 1.4

Call Duration in Second

Call Duration in Seconds. 0 if this is


a failed call

New in 1.5

Post Dial Delay in Seconds

Post dial delay (from call attempt to


ring). 0 if this is a failed call

New in 1.6

Ring Time in Second

Ring Time in Seconds. 0 if this is a


failed call

New in 1.6

Duration in mini-seconds

10

Call duration in mini-seconds

New in 1.8

Conf_ID

36

Conference ID

New in 1.9

Detail Field Information


Table 3. Detail Field Information
Field name

Size in Bytes

ConnectionType

16

SessionID

32

Release Cause

Start Time of Date

32

Answer Time of Date

32

Release TOD

32

Minutes West of Greenwich Mean Time

32

Release Cause from Protocol Stack

32

Binary Value of Release Cause from Protocol stack

First release dialogue

119

Sansay VSX Users Guide

Table 3. Detail Field Information


Field name

Size in Bytes

Trunk ID - Origination

VoIP Protocol - Origination

Origination Source Number

128

Origination Source Host Name

128

Origination Destination Number

128

Origination Destination Host Name

128

Origination Call ID

128

Origination Remote Payload IP Address

16

Origination Remote Payload UDP Address

Origination Local Payload IP Address

16

Origination Local Payload UDP Address

Origination Codec List

128

Origination Ingress Packets

10

Origination Egress Packets

10

Origination Ingress Octets

10

Origination Egress Octets

10

Origination Ingress Packet Loss

10

Origination Ingress Delay

10

Origination Ingress Packet Jitter

10

Trunk ID -- Termination

VoIP Protocol - Termination

Termination Source Number

128

Termination Source Host Name

128

Termination Destination Number

128

Termination Destination Host Name

128

Termination Call ID

128

Termination Remote Payload IP Address

16

Termination Remote Payload UDP Address

Termination Local Payload IP Address

16

Termination Local Payload UDP Address

Termination Codec List

128

120

Call Detail Records

Table 3. Detail Field Information


Field name

Size in Bytes

Termination Ingress Packets

10

Termination Egress Packets

10

Termination Ingress Octets

10

Termination Egress Octets

10

Termination Ingress Packet Loss

10

Termination Ingress Delay

10

Termination Ingress Packet Jitter

10

Final Route Indication

Routing Digits

64

Call Duration

PDD

Ring Time

Call Duration in ms

10

Conf-ID

36

121

Sansay VSX Users Guide

Release Causes
This Section provides a list of the Sansay VSX Call Release
causes. The CDR records generated by the Sansay VSX contains four fields that can be used to determine the exact
cause of a call termination.
1. Session Release Causes: ( Field #3 in CDR body)
This is mainly for successful calls ( answered, ring no
answer) calls. All session release causes of 00x indicates the
call is not failed ( Field #3 in CDR body). For all the failed
calls, the released stack and stack release cause can provide
more information.
Table 4. Release Codes

122

Cause Code

Description

01

Normal answered call

02

No Answer, tear down by originator

03

No answer, tear down by the termination

04

NORMAL_NO_ANSWER, tear down by system

402

Service Not Available

403

Termination capability incompatible

404

Outbound digit translation failed

405

Termination rejected for some other reason

406

Termination Route is blocked

500

Originator is not in the Authorized list (source verification failed)

501

Origination digit translation failed

502

Origination direction is not bi-directional or inbound

503

Origination is not in service state

600

Max system call handling reached

601

System reject call

602

System outbound digit translation error (maybe invalid


configuration)

603

System inbound digit translation error (maybe invalid


configuration)

Call Detail Records

2. 1st Release Dialogue (Field #10 in CDR) a one character value identifying the side of the call that initiated the
teardown.
Table 5. 1St Release Codes
Cause Code

Description

Origination initiated the teardown.

Termination initiated the teardown

The VSX internally initiated the teardown

3. Release Cause from Stack (Field # 9 in CDR0) an


integer value based on the releasing dialogue's protocol. For
a H.323 call leg originated release, it will be the real Q.931
value received from the far side.
Q.931 release causes include the following:
Table 6. Release Codes from Stack
Cause Code

Description

No route to destination

16

Normal clearing

17

User Busy

19

No answer from user

21

Call rejected

28

Address incomplete

34

No circuit channel available

For a SIP call leg originated release, it's a RFC 3261 release
cause value received from the far side.

123

Sansay VSX Users Guide

The following is the list that of messages the VSX generates


when a specific event occurs:
Table 7. Release Messages from VSX
Cause Code

Description

400 Parse Failed

Malformed message

405 Method Not


Allowed

Unsupported method

415 No valid codec

No valid codec could be supported between orig


and term call legs.

480 Temporarily
Unavailable

Overload Throttle Rejection, Max Sessions


Exceeded, Demo License Expired, Capacity
Exceeded on Route, Radius Server Timeout

481 Transaction
Does Not Exist

Unknown transaction or dialog

487 Transaction Terminated

Origination cancel

488 ReInvite
Rejected

Relay of ReInvite was rejected

500 Sequence Out of


Order

CSeq counter violation

504 Server Time-out

Internal VSX failure

For a VSX system-originated release, an internal release


cause for teardown occurs. If the VSX initiates a call teardown, the following cause values and strings are written
into the CDR:
Table 8. VSX Internal Release Causes

124

Cause Code

Description

987 Termination Capacity


Exceeded

Termination capacity exceeded

987 Origination Capacity


Exceeded

Origination Capacity Exceeded

987 Term CPS Capacity Exceeded

Term CPS Capacity Exceeded

987 Orig CPS Capacity Exceeded

Orig CPS Capacity Exceeded

987 Max H323 Legs Exceeded

Max H323 Legs Exceeded

999 "Demo Licence Expired!"

Demo Licence Expired!

999 VSX Capacity Exceeded"

VSX Capacity Exceeded

999 VSX Operator Reset"

VSX Operator Reset

Call Detail Records

Table 8. VSX Internal Release Causes


Cause Code

Description

999 Route Rejected"

Route Rejected

999 Radius Rejected"

Radius Rejected

999 Radius Access Timeout"

Radius Access Timeout

999 Gatekeeper Reject"

Gatekeeper Reject

999 Enum Server Reject"

Enum Server Reject

999 Enum Server Timeout"

Enum Server Timeout

999 DNS Server Reject"

DNS Server Reject

999 DNS/GK Timeout"

DNS/GK Timeout

999 Could not allocate media"

Could not allocate media

999 No Response to INVITE"

No Response to INVITE

999 Ring No Answer Timeout"

Ring No Answer Timeout

999 200 OK Timeout"

200 OK Timeout

999 Maximum Duration Exceeded"

Maximum Duration Exceeded

4. Release Cause String (Field #8 in CDR)- a string of


text further identifying the teardown circumstance.

Sample CDR record


An example Call Detail Record is provided below:

002452502;V1.2;R;WithMedia;181-1071459514@192.188.0.28;0001;Mon Dec 15
11:38:34 2003;Mon Dec 15 11:38:41 2003;Mon Dec 15 11:38:48 2003;480;
EndedByRemoteUser;3;T;000200;H323;;192.188.0.38;9001;192.188.0.28;f0faf
f54-2e6c-11d8-8c4bbd4d562c2265;192.188.0.38;18044;192.188.0.28;10756;G.729b;240;460;6066;
14060;0;0;0;000200;H323;;192.188.0.28;8811;192.188.0.38;e83af3d3-1d2dd811-9f98003048424934;192.188.0.38;19236;192.188.0.28;10758;G.729b;460;240;14060
;6066;0;0;0; F;9001;
Example VSX Call Detail Record

125

Sansay VSX Users Guide

CDR File Storage/Retrieval


This section describes the methods used to store and
retrieve Sansay CDRs.

File Storage Policy


By default, all CDR files are kept on the system for at least
360 hours. CDR files which are older than 240 hours will be
deleted by the VSX system automatically in order to save
disk space.
The CDR file is generated in a configurable time interval.
The time interval can be configured from 60 seconds to
99,999 seconds.

File Naming Convention


All CDR files are stored on the VSX system at the default
directory (/CDR) with the following naming convention:
The file name is assembled using the format YearMonthDate-HHmm-BeginCDRSeq-EndCDRSeg.xxx, where the
Year is 4 digits in length; the Month, Date, Hour field is 2digits each; the CDRSeq is 9-digits in length. The
Hour/Minute field is always in 24-hour format, which
ranges in value from 00 through 23. The .xxx suffix/extension indicates the file was completed when .cdr displays.
The working CDR file is named cdr.tmp, which has the most
current working CDRs before the CDR file interval expired.
For example, the CDR file 20060327-0515-70001800000.cdr indicates the file was created on 03/27/2006 at
5:15am and contains the CDR records sequence numbers
from 70,001 to 80,000.
The CDRSeq is a 9-digit number that wraps when the value
exceeds 999,999,999.
Integer fields that contain no data are set to 0; Non-integer
fields that contain no data are simply left empty or will con-

126

Call Detail Records

tain the string NA. The semicolon character (;) is used as a


delimiter to separate the fields of a CDR record.

File Retrieval Procedure


CDR files can be retrieved using the secure file copy (SCP)
or file transfer protocol (FTP) procedure. The SCP procedure
requires a defined user login name with a password. The
CDR user name and password can be obtained through the
VSX Web GUI using a system administrator login. A simple
procedure for retrieving CDR files from the VSX system is
provided below:
1. Obtain the IP address or the host name of the VSX system.
2. Open an SCP ( or FTP) session using one of the following
command:
SCP user@ <IP address>:TBD-directory/ 20060327*.cdr

This command will retrieve all cdr files created in


03/27/2006
3. Repeat Step 2 if necessary.

127

Sansay VSX Users Guide

128

APPENDIX B

VSX SPECIFICATIONS
This appendix provides product information regarding the
server that is used by Sansays VSX. All VSX specifications
are subject to change without notice. For additional information regarding VSX servers, contact a Sansay representative
or visit the Sansay web site.
Table 9 lists the available VSX servers and their Sansay
part numbers.
Table 9. VSX Servers
Sansay Part Number

Description

nnn-nnn-nnn

VSX 1 Rack Unit, 1000 call capacity

nnn-nnn-nnn

VSX 1 Rack Unit, 2000 call capacity

nnn-nnn-nnn

VSX 2 Rack Unit, 2000 call capacity

nnn-nnn-nnn

VSX 2 Rack Unit, 5000 call capacity

129

Sansay VSX Users Guide

Environmental Specifications
Table 10 shows the environmental specifications for the
VSX servers.
Table 10. VSX Server Environmental Specifications
Electromagnetic Interference

Complies with FCC Rules and Regulations, part 15, as a


Class B digital device. Manufacturer's Declaration to EN
55022, EN 60555-2, EN 60555-3, EN 50082-1.

AC Input Power

110/ 220 VAC 50/60Hz per voltage selector switch

Maximum Current Requirements

x.x Amps at 110VAC

Maximum Power Dissipation

xxx Watts

Physical Dimensions

Depth: 387mm (15.25 in)


Width: 482mm (19.0 in)
Height: 52.6mm (2.1 in)/1 EIA units
Weight: 6.8kg (15lb)

Operating Temperature

+5 to 35C (41 to 95F)

Non-Operating Temperature

-40 to 65C (-40 to 149F)

Maximum Rate of Temperature Change

20C/hour

Operating Relative Humidity

15% to 80%, noncondensing, max. wet bulb = 26C

Non-Operating Relative Humidity

5% to 90%, noncondensing

Operating Altitude

To 3.0km (10,000 ft) above sea level

Non-Operating Altitude

To 4.5km (15,000 ft) above sea level

For information on and an illustration of the rear panel connectors, see Chapter 2, Setting up the VSX.

130

Sansay VSX Users Guide

S-VSX-301-TP-1B

Readers Comment Form


This book is part of a library that serves as a reference for network communications
managers and systems integrators who want to incorporate advanced technology and
data transmission over H.323/SIP networks. If you have any comments regarding this
book (including its content, organization, and format), print and use this form to communicate them directly to Sansay. You can also send your comments by e-mail to Sansay at
publications@sansay.com. If you have received any revision pages to update this book,
please identify them.
Your comments will be reviewed and appropriate action taken, as necessary. Sansay may
use or distribute the information you supply without incurring any obligation to you.
If you would like additional information regarding the Sansay product line, please contact our marketing department at the following address:
Sansay, Inc.
4650 Lusk Blvd. Suite 204
San Diego, California 92121
U.S.A. 1-(858) 678-0200

131

Fold along dotted lines and tape. Please do not staple

Place
Postage
Here

Sansay, Inc.
Information Development
4650 Lusk Blvd. Suite 204
San Diego, CA 92121

Fold along dotted lines and tape. Please do not staple

WARRANTY
Please take a few minutes to complete the product warranty card found at the back of
this book and return it to Sansay, Inc. In addition, if you have any comments or questions regarding Sansay product features, we would appreciate hearing from you. Contact our marketing department directly at:
Sansay, Inc.
Marketing Department
4650 Lusk Blvd. Suite 204

San Diego, CA 92121


Tel.: (858) 678-0200
FAX (858) 678-0203

If you have any comments or questions regarding publications for Sansay products,
please direct them to the Technical Publications Department at the above address or
to publications@sansay.com. Be sure to specify the book and section to which your
comment refers.

YOUR SANSAY WARRANTY


IMPORTANT - READ CAREFULLY: By opening the software and/or hardware
package and using the product, you agree to be bound by the terms of this license
agreement. If you do not agree to the terms of this agreement, promptly return this
package to the place from which you obtained it for a full refund.
If this product should fail due to defects in materials or workmanship, Sansay Communications, Inc. will, at its sole option, repair or replace it with new or rebuilt parts,
free of charge, for one (1) year from the date of its shipment from the Sansay factory.
This warranty is extended to only the original purchaser and covers only failures due
to defect in materials and workmanship that occur during normal use during the
period of warranty. It does not cover damage that occurs in shipment, failures caused
by products not supplied by Sansay, or failures resulting from accident, misuse,
neglect, mishandling, alteration, or modification of the product outside of its published electrical or environmental specifications, or any other causes other than ordinary use. Expendable components are not covered by this warranty.
In order to exercise your rights to repair under this warranty, you must first contact
Sansay to obtain a repair authorization (RA) number. If you must return the unit to
Sansay for repair while the unit is under warranty, Sansay will pay the cost of shipping it to and from Sansay.

Sansay VSX Users Guide

No express warranties exist except as listed above. IN NO EVENT SHALL SANSAY


BE LIABLE FOR SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
ARISING FROM THE USE OF THIS PRODUCT, OR ARISING OUT OF ANY
BREACH OF THIS WARRANTY. ALL EXPRESS AND IMPLIED WARRANTIES,
INCLUDING THE WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE, ARE LIMITED TO THE APPLICABLE WARRANTY
PERIOD SET FORTH ABOVE. NO EMPLOYEE OR REPRESENTATIVE OF SANSAY IS AUTHORIZED TO MODIFY THIS WARRANTY OR SANSAYS STANDARD
WARRANTY FOR ANY PRODUCT.
Some states do not allow the exclusion or limitation of incidental or consequential
damages, or limitations on how long an implied warranty lasts, so the above exclusions or limitations may not apply to you.
This warranty gives you specific legal rights. You may also have other rights with
respect to this product that vary from state to state.

SOFTWARE LICENSE AGREEMENT


Any software product, including any documentation relating to or describing such
software (hereafter collectively called Software), provided by Sansay is furnished to
you for installation and use on a single computer. The Software may not be copied, in
whole or in part, except for archival purposes, to replace a defective copy, or for program error verification.
You may not reverse engineer, decompile, or disassemble the Software, except to the
extent such foregoing restriction is expressly prohibited by applicable law.
Unless earlier terminated by Sansay as herein provided, the term of each paid-up
license shall expire at such time as you discontinue use of the applicable Software on
the single processor specified above but otherwise shall be without restriction as to
time.
The Software (including any images, applets, photographs, animations, video, audio,
music, and text incorporated into the Software) is owned by Sansay or its suppliers
and is protected by United States copyright laws and international treaty provisions.
Therefore, you must treat the Software like any other copyrighted material (for
example, a book or musical recording) except that you may either (a) make one copy
of the Software solely for backup or archival purposes, or (b) transfer the Software to
a single hard disk provided you keep the original solely for backup or archival purposes. You may not copy the printed materials accompanying the Software.
You may not rent or lease the Software, but you may transfer the Software and
accompanying written materials on a permanent basis provided you retain no copies
and the recipient agrees to the terms of this Agreement. If the Software is an
upgrade, any transfer must include the most recent upgrade and all prior versions.

Warranty

SANSAY WARRANTY REGISTRATION


By returning the warranty card, the Buyer simultaneously registers the warranty for
the Sansay products listed hereunder, and indicates acceptance of the software
license agreement printed above. Please take a moment to complete this card and
mail it immediately. With a record of your ownership on file in the Sansay customer
database, we can process any requests for warranty service with the greatest possible
speed and accuracy. Thank you.

Sansay, Inc., 4650 Lusk Blvd. Suite 204, San Diego, CA 92121

Sansay VSX Users Guide

S-VSX-301-TP-1B
Sansay, Inc.
4650 Lusk Blvd. Suite 204, San Diego, CA 92121 (858) 678-0200; FAX (858) 678-0203

You might also like