Академический Документы
Профессиональный Документы
Культура Документы
GSX9000 and
GSX4000 Series
Open Services Switch
Operations Guide
Warranties
THIS INFORMATION IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, OR NON-INFRINGEMENT.
REFERENCES TO CORPORATIONS, THEIR SERVICES AND PRODUCTS, ARE PROVIDED “AS IS” WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED. IN NO EVENT SHALL SONUS NETWORKS BE LIABLE FOR ANY
SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES WHATSOEVER
RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE,
AND ON ANY THEORY OF LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
INFORMATION.
Descriptions of, or references to, products, services or publications within Sonus Networks' documentation do not imply
endorsement of that product, service or publication. Sonus Networks makes no warranty of any kind with respect to the subject
matter included herein, the products listed herein, or the completeness or accuracy of the information. Sonus Networks specifically
disclaims all warranties, express, implied or otherwise, including without limitation, all warranties of merchantability and fitness for a
particular purpose.
THIS PUBLICATION COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES MAY BE
PERIODICALLY MADE TO THE INFORMATION HEREIN.
Trademarks
Sonus, the Sonus logo, Open Services Architecture, Insignus, SMARRT, Sonus Insight, IMX, GSX9000, GSX4000, and GSX4010
are either registered trademarks or trademarks of Sonus Networks, Inc. —Open Services Partner Alliance and SonusCARE are
service marks of Sonus Networks, Inc.
The Sonus Networks, Inc. trademarks may not be used in connection with any product or service that is not Sonus Networks’ in any
manner that is likely to cause confusion among customers or in any manner that disparages or discredits Sonus Networks, Inc.
Third-Party Trademarks
Apache is the http server, and Tomcat is the Servlet/JSP container developed by the Apache Software Foundation. — Rapid
Service Introduction (RSI) System is a trademark of BayPackets, Inc. — Borland is a registered trademark, and AppServer is a
trademark of Borland Software Corporation. — Dot Hill and SANnet are trademarks of Dot Hill Systems Corp. — Eclipse is a
trademark of Eclipse Foundation, Inc. — GoAhead and SelfReliant are registered trademarks of GoAhead Software, Inc. — IBM,
Netcool, and WebSphere are registered trademarks of International Business Machines Corporation in the United States, other
countries, or both. — Intel, Xeon, and Pentium are registered trademarks of Intel Corporation in the United States and/or other
countries. — Macromedia is a registered trademark, and JRun is a trademark of Macromedia, Inc. in the U.S. and/or other
countries. — DataDirect is a registered trademark of Progress Software Corporation. — Linux is a registered trademark of Linus
Torvalds in the United States and/or other countries. — Microsoft, Microsoft Internet Explorer logo, Windows, Windows NT,
Windows XP, and/or other Microsoft products referenced herein are either registered trademarks or trademarks of Microsoft
Corporation in the U.S. and/or other countries. — MySQL is a registered trademark of MySQL AB in the United States, the
European Union and other countries. — Netscape is a registered trademark of Netscape Communications Corporation in the U.S.
and other countries. — Nokia is a registered trademark of Nokia Corporation. — Oracle, JD Edwards, PeopleSoft, and Siebel are
registered trademarks of Oracle Corporation and/or its affiliates. — Palm OS and Palm Powered are registered trademarks, and
Palm is a trademark owned by or licensed to Palm, Inc.. — Red Hat, RPM, JBoss, and all Red Hat-based trademarks are
trademarks or registered trademarks of Red Hat, Inc. in the United States and/or other countries. — Sage Instruments is a
copyright of Sage Instruments, Inc. — Service Availability and the Service Availability logo are trademarks used with the
permission of their owner. — SnowShore, SnowShore Networks, and N20 are trademarks of Cantata Technology Inc. — SSH is an
IETF protocol and OpenSSH is a derivative of the original and free ssh 1.2.12 release by Tatu Ylonen. SSH Secure Shell is a
trademark of SSH Communications Security, Ind. — Sun, Sun Microsystems, Java, JumpStart, Netra, Solaris, Solstice DiskSuite,
and all trademarks that contain Sun, Solaris, or Java are trademarks, registered trademarks, or service marks of Sun
Microsystems, Inc. in the United States and other countries. — iPlanet is a division of Sun Microsystems, Inc. — All SPARC
trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. in the U.S. and other
countries. Products bearing SPARC trademarks are based upon an architecture developed by Sun Microsystems, Inc. — Telcordia
is a registered trademark and LERG is a trademark of Telcordia Technologies, Inc. in the United States, other countries, or both. —
Signalware is a registered trademark of Ulticom, Inc. — UNIX is a registered trademark in the United States and other countries,
exclusively licensed through X/Open Company, Ltd. — VeriSign is a registered trademark, and Thawte Consulting is a wholly
owned subsidiary of VeriSign, Inc. — Veritas is a trademark of Symantec Corporation or its affiliates in the U.S. and other
countries. — WebLogic is a registered trademark of BEA Systems, Inc.
All other product names mentioned herein are trademarks, service marks, registered trademarks, or registered service marks of
their respective owners.
EN 55022 Notice
This is to certify that this digital apparatus is shielded against the generation of radio interference in accordance with the application
of Council Directive 89/336/EEC, Article 4a. Conformity is declared by the application of EN 55022 Class A (CISPR 22).
Caution: This is a Class A product. In a domestic environment this product may cause radio interference in which case the user
may be required to take corrective action.
Deutsch
Vorsicht: Dieses ist ein Kategorie A Produkt. In einem inländischen Klima kann dieses Produkt Funkstörung verursachen, in
diesem Fall der Benutzer erfordert werden kann, Korrektur-Maßnahme zu nehmen.
Français
Attention: C'est un produit de la classe A. Dans un environnement domestique ce produit peut causer l'interférence par radio dans
ce cas l'utilisateur peut être requis de prendre la modalité de reprise.
Español
Precaución: Esto es un producto de la clase A. En un ambiente doméstico este producto puede causar interferencia de radio en
qué caso puede ser requerido el usuario para tomar la acción correctiva.
Português
Cuidado: Este é um produto da classe A. Em um ambiente doméstico este produto pode causar a interferência de rádio em que
caso o usuário pode ser requerido para fazer exame da ação corretiva.
Embedded Software
Oracle Enterprise Edition is an embedded part of the Sonus product line. The programs included herein are subject to a restricted
use license and can only be used in conjunction with this application. You are not allowed to navigate or modify the underlying
database schema unless explicitly authorized in writing by Sonus.
CONTENTS
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxv
Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxv
What’s in This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxvi
Documentation Updates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxvi
Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxvii
Contacts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xxviii
Technical Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xxviii
Technical Publications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xxviii
GETS Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xxviii
Chapter 1 Introduction
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Network Components and Topology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Overall Network Topology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
GSX Open Services Switch Management Network Topology . . . . . . . . . . . . . . . . . 1-4
Network Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
Installation Sequence Using Softswitch Control Elements. . . . . . . . . . . . . . . . . . . . . . . 1-8
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Using the CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
Management Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
MIBs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
Accessing the CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
CLI Command Line Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
Command Line Verbs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
Upper Versus Lower Case . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
Abbreviations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
CLI Command Restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
Clearing a Parameter String Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
Required Versus Optional Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Typographical Conventions in This Chapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
Management Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4
User Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4
User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-10
Node Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-14
Slot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-16
Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-17
Server Flash. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-32
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Contents
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Contents
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Contents
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Contents
T3 Circuits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-648
T3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-648
System Timing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-667
System Timing Shelf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-668
System Timing MTA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-672
System Timing Framer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-675
System Timing Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-678
System Timing Reference Clock Binding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-682
Circuit Service Group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-685
Circuit Service Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-685
Packet Service Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-690
Packet Service Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-690
Packet-to-Packet Call Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-693
Packet-to-Packet Route Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-720
Voice Packet Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-721
Media Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-721
Packet Assembler Disassembler (PAD) Resources . . . . . . . . . . . . . . . . . . . . . . 3-726
Media Performance Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-730
Echo Canceller Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-743
ISUP Service Group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-746
ISUP Service Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-746
ISUP Signaling Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-763
ISUP Information Request INF Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-821
ISUP Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-826
ISUP Circuit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-848
ISUP Signaling Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-862
BT Service Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-870
BT Service Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-870
BT Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-878
BT Circuit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-890
ISDN Service Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-901
ISDN Service Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-901
ISDN Switch Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-911
ISDN Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-916
ISDN Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-946
ISDN B-channel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-948
Show Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-959
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Contents
Announcements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-961
Announcements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-961
Announcement Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-965
Call and Performance Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-968
Call Counts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-968
Performance Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-984
Traffic Control Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-993
RTCP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-996
Sonus Optical Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1001
Optical Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1002
SONET Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1052
Automatic Protection Switching (APS) Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1064
APS Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1064
CAS Service Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1079
CAS Service Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1080
CAS Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1092
CAS Signaling Sequence Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1112
CAS Signaling Condition Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1114
CAS Signaling Sequence. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1116
CAS Signaling Condition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1136
CAS Channel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1144
CAS Collection Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1150
CAS R2 Translation Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1157
Call Disconnect Treatment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1162
Disconnect Treatment Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1162
Disconnect Signaling Sequence Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1165
Disconnect SignalSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1167
Call Crankback Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1171
Call Monitor Endpoint and Monitor Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1179
Tone Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1183
Tone Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1183
Digit Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1184
Tone Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1189
Tone Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1199
Tone Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1201
SIP DTMF Trigger Detection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1203
Manual Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1206
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Contents
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
GSX Local Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
Input Call Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Routing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Output Call Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
CLI Commands for GSX Local Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9
IP Signaling Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10
Signaling Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19
Dial Plan. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-21
Local Policy Trunk Group Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-23
IP Signaling Peer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-26
Routing Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-28
Standard Route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-31
Configuring the GSX for Local Policy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-33
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
H.248 Media Gateway Model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3
H.248 Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5
H.248 Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-8
H248 Call Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-10
H248 Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12
H248 Service Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-13
Media Gateway Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-15
Media Gateway Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-20
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
Configuring Timing for Circuit Network Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
Configuring the SPS70 and SPS80 High Density Signal Processing Server. . . . . . 6-9
Access Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-22
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Contents
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Contents
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Contents
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Contents
Additional Configuration Information for SENDTL and CMT Test Packages . . . . 6-215
Outgoing Trunk Test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-219
Incoming Trunk Test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-220
PSX Configuration Test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-221
Configuring Test Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-222
Determining Test Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-227
CNS71, CNS81, and CNS86 Path Testing Overview . . . . . . . . . . . . . . . . . . . . . . . . 6-229
CLI Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-229
SIP P-Charging Vector Header Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-233
NBS Behavior and PSX Provisioning. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-233
CDR Processing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-233
SIP Path and Service-Route Header Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-234
PSX Provisioning Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-234
Path Header Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-234
Service-Route Header Processing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-234
Provisioning GSX Support for Path and Service-Route Headers . . . . . . . . . . . . 6-235
Support for Government Emergency Telecomunications Service (GETS)
and Wireless Priority Service (WPS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-237
High Probability of Completion (HPC) Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-237
Office-Wide Call Queuing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-238
SIP Resource Priority Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-239
Type of Service (TOS) Byte Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-239
Cause Code and Message Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-240
Configurable Precedence of RPH or ISUP-MIME . . . . . . . . . . . . . . . . . . . . . . . . 6-240
Precedence Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-241
Reject Non-ETS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-241
Final Treatment on 486 Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-241
High Probability of Completion Call Prioritization. . . . . . . . . . . . . . . . . . . . . . . . . 6-241
Call Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-243
Call Monitoring Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-243
SIP over TCP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-245
SIP Transport Type Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-245
Connection Reuse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-245
Keepalive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-245
Billing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-246
Provisioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-246
Secure RTP/RTCP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-247
Provisioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-247
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Contents
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1
Accounting Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
Stream-Based Logging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
Selectable CDRs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
File Name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
File Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
Number of Coexisting Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
Sequence Number in File Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
File Header. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
File Footer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7
Accounting Records. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-8
Timestamps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-8
Accounting Records Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9
Accounting Records for Call-Specific Records. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9
Accounting Records for System Level Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-21
Accounting Record Field Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-22
START Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-22
STOP Field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-22
ATTEMPT Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-22
INTERMEDIATE Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-22
REBOOT Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-22
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Contents
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Contents
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Contents
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Contents
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Contents
Ingress Release Link Trunking (RLT) Feature Specific Data Field. . . . . . . . . . . . 7-122
Two B-Channel Transfer Feature Specific Data Field . . . . . . . . . . . . . . . . . . . . . 7-122
Calling Party Business Unit Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-123
Called Party Business Unit Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-123
Redirect Feature Specific Data Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-123
PSX Index Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-130
PSX Congestion Level Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-130
PSX Processing Time Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-131
Ingress External Accounting Data Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-132
Egress External Accounting Data Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-132
Ingress Maximum Packet Outage Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-132
Egress Maximum Packet Outage Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-133
Ingress Packet Playout Buffer Quality Field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-133
Egress Packet Playout Buffer Quality Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-134
Call Supervision Type Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-135
Script Name Field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-136
Ingress SIP Refer & Replaces Feature Specific Data Field . . . . . . . . . . . . . . . . . 7-136
Egress SIP Refer & Replaces Feature Specific Data Field . . . . . . . . . . . . . . . . . 7-138
Network Transfer Feature Specific Data Field . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-139
Call Condition Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-140
Toll Indicator Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-141
Generic Number Number Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-142
Generic Number Presentation Restriction Indicator Field . . . . . . . . . . . . . . . . . . 7-142
Generic Number Numbering Plan Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-143
Generic Number Nature of Address Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-144
Generic Number Type Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-149
Final ATTEMPT Indicator Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-150
Originating Trunk Type Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-151
Terminating Trunk Type Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-151
Remote GSX Billing Indicator Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-151
Extra Disconnect Reason Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-152
VPN Calling Private Presence Number Field. . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-152
VPN Calling Public Presence Number Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-152
External Furnish Charging Info Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-153
Ingress Policing Discards Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-154
Egress Policing Discards Field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-154
Announcement ID Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-154
Source Information Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-155
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Contents
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Contents
Chapter 8 Troubleshooting
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
Frequently Asked Questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Is the SS7 Gateway Interacting Properly with the GSX? . . . . . . . . . . . . . . . . . . . . . 8-2
Is the Policy Server Interacting Properly with the GSX? . . . . . . . . . . . . . . . . . . . . . 8-2
Solutions to Frequently Encountered Problems. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3
Unable to Log on to the MNS Firmware from Craft Port . . . . . . . . . . . . . . . . . . . . . 8-3
Unable to Connect Successfully to a Router . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3
Unable to Telnet to the GSX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-8
Can’t Remember Admin Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-8
Replacing Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-9
To Replace a Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-9
Reporting Problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-10
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-1
Command Line Interface Inline Editing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-2
EMACS Edit Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-2
VI Edit Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-4
Command Syntax Assistance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-9
<enter> Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-9
<tab> Key. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-9
Administrator Command Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-10
Shell Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-11
CLI Prompt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-11
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B-1
CLI Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B-2
New CLI Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B-2
Removed CLI Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B-16
Accounting Records Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B-17
New Accounting Records. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B-17
Changes to Accounting Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B-18
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Index-1
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
About This Guide
Overview
The GSX9000 and GSX4000 Series Open Services Switch Operations Guide describes how to use
the CLI to configure and manage the GSX9000™ and GSX4000™ Series switches. This document
is based on the latest release of the Sonus Networks GSX products.
Audience
This guide is intended for use by network engineers responsible for provisioning, maintaining, and
administering the GSX9000 and GSX4000 Series Open Services Switches. You should have a
working knowledge of the Public Switched Telephone Network (PSTN), the UNIX operating
system, and packet networking. This guide also requires specific knowledge of the GSX Open
Services Switches and their configuration.
Chapter 1, "Introduction", provides basic information about the network components and topology
required for successful operation of the Sonus GSX9000 and GSX4000 Series Open Services
Switches and their associated infrastructure.
Chapter 2, "Using the CLI to Configure Objects", provides an overview of the command line
interface (CLI) as well as information on configuring the GSX using both the configuration
models. A basic approach to the configuration process is suggested and explained by example.
Chapter 3, "CLI Reference", presents a description of each management object and the CLI
commands that you may use to create, configure, and view information about it.
Chapter 4, "Using the GSX in Local Policy Mode" provides information for using the GSX in
Local Policy mode, an enhanced version of the GSX, capable of executing basic call routing and
simple policy decisions and storing the required configuration data without a need for an external
routing node or policy server node.
Chapter 5, "Using the GSX as a Border Gateway Function (BGF)" provides information for using
the GSX as a TISPAN Border Gateway Function (BGF), controlled by the H.248 protocol.
Chapter 6, "Managing the GSX", discusses how to manage day-to-day GSX operations through
the CLI.
Chapter 7, "Call Accounting", provides information on the Call Accounting Manager (CAM),
along with accounting files and records.
Chapter 8, "Troubleshooting", answers some frequently asked questions about the GSX9000 and
presents some solutions to common problems that Sonus personnel have encountered.
Appendix A, "CLI Facilities", lists many important features that will assist your use of the CLI
application.
Appendix B, "Summary of 7.1 Changes", summarizes CLI and Accounting Record changes since
the previous version of the GSX9000 and GSX4000 Series Open Services Switch Operations Guide.
Documentation Updates
For updates to documents produced by Sonus Technical Publications, navigate to the Support
section of http://www.sonusnet.com and login under Documentation Updates.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
About This Guide Conventions
Conventions
This document uses the following text conventions to convey instructions and information:
NOTE
Notes provide additional information or helpful suggestions that may apply to the
subject text, or in special cases — for example, memory limitations, equipment
configurations, or details that apply to specific versions of a product.
CAUTION
Cautions advise the reader that failure to take or avoid a specified action could
result in equipment damage or data loss.
WARNING
Warnings advise the reader that failure to take or avoid a specific action could
result in physical injury or harm.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
About This Guide Contacts
Contacts
Technical Support
For problems or questions, contact the Sonus Technical Assistance Center (TAC):
Technical Publications
Customer comments are welcome. If you have questions or comments about this document, please
address your feedback as follows:
• E-mail: TechnicalPublications@sonusnet.com
• Address:
Sonus Networks, Inc.
Attn: Technical Publications
7 Technology Park Drive
Westford, MA 01886
USA
GETS Software
This release supports the High Probability of Completion (HPC) network capability intended to
provide enhanced probability of call completion to authorized Government Emergency
Telecommunication Service (GETS) and Wireless Priority Service (WPS) users during times of
network stress and/or congestion. HPC features include GETS Call Routing, Office-Wide Call
Queuing, and SIP Resource Priority Header.
The use of the GETS SOFTWARE is restricted in the U.S. and U.S. TERRITORIES to NS/EP
users authorized by the Office of the Manager, National Communications System (OMNCS).
Telecommunications deployment of GETS SOFTWARE must be coordinated with the OMNCS at
the following address:
Office of the Manager
National Communications System
Attn: GETS Program Office
701 South Courthouse Rd.
Arlington, VA 22204-2198
E-mail: gets@ncs.gov
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
CHAPTER 1 Introduction
Overview
This chapter provides basic information about the network components and topology required for
successful operation of the Sonus GSX9000 and GSX4000 Series Open Services Switches and
their associated infrastructure. An overview of the installation sequence is also provided. Sections
include:
This section describes the network topology and required components of a packet network that
includes a Sonus GSX Open Services Switch.
Because most telephones, faxes, and other devices are connected to the existing Public Switched
Telephone Network (PSTN) and to Private Branch Exchanges (PBXs), converged network carriers
must have some means of interconnecting them across a packet infrastructure. The device that
provides this interconnection is called a Packet Telephony Gateway.
The Sonus GSX Open Services Switches are carrier-class packet telephony gateways that provide
all of the capabilities required for world-class telephony service on a packet backbone. The
GSX9000 Open Services switch is a high density switch, while the GSX4000 series of Open
Services Switches are low- to mid-density switches based on GSX9000 technology. The GSX4000
series extends a service provider’s network by creating more broadly distributed IP-to-TDM and
IP-to-IP network connections.
As illustrated in Figure 1–1 on page 1–3, the GSX switches can support the following connection
types:
• PSTN-to-PSTN: PSTN devices (like telephones and fax machines) can interconnect through
a packet network. In these connections, the GSX provides intra-LATA (tandem) or inter-
LATA (toll or long-distance) service.
• PBX-to-PSTN/PBX: A PBX can connect to the GSX through a direct PRI or CAS
connection, bypassing the PSTN. Devices attached to these PBXs can interconnect with any
other compatible device in the network.
• Packet-to-PSTN/PBX: There are a growing number of telephones and other devices that
connect directly to the packet network without using the PSTN: premises packet gateways,
cable telephony devices, xDSL, packet PBXs, etc. The GSX allows these devices to
interconnect with devices on the PSTN or on PBXs.
• Services Mediation: The GSX can identify internet modem calls and immediately switch
them to a Remote Access Server (RAS) for packet conversion.
• Packet-to-Packet: There are a number of different scenarios in which the GSX may be used
to transport traffic packet to packet. Often signaling protocols need to be translated so traffic
may be sent through the GSX to perform this function. The GSX may also be used to provide
security at the edge of a carrier's network when that carrier is exchanging VoIP traffic with
some other company over an IP network.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Components and Topology Introduction
RAS
H.323 IP Application
GK/GW Device Server
PBX
Within this network diagram, the boxes labeled GSX actually include a number of GSXs and their
associated management network. A diagram of this network and descriptions of its components
appear in the next two sections.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Introduction Network Components and Topology
Figure 1–2 illustrates the network topology required for successful operation of the GSX Open
Services Switch and its associated infrastructure.
SGX
SS7 SS7 Sonus
Gateway Insight
DSI
10/100M Ethernet
NFS NTP
PSX Policy
Server (DSI
(H.323 GK) Level 0)
BITS or
SETS GSX
Timing
T1 Source H.323
T3 GK/GW
PSTN IP
E1 SONET/
Ethernet
GSX Application
Server
GSX GSX
This guide describes the provisioning commands and administrative procedures in the diagram
above.
NOTE
A single PSX Policy Server, SGX SS7 Gateway, Sonus Insight, NFS (DSI Level 0),
NTP server, DataStream Integrator (DSI), or BITS/SETS timing source may support
multiple GSX switches. In addition, you can configure multiple platforms for each
of these management network functions to provide redundancy.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Components and Topology Introduction
Network Components
The components of the GSX Open Services Switch management network are described below.
The GSX Open Services Switches provide connectivity between circuit-switched and packet
environments for voice, data, and fax transmission. The GSX9000 provides SONET and Ethernet
interfaces to the packet environment. The GSX4000 series provides Ethernet interfaces to the
packet environment. A BITS or SETS timing source may be configured to provide circuit module
timing.
This guide describes the configuration procedures for the GSX Open Services Switches. For the
GSX9000, the hardware components and general installation procedures are described in the
GSX9000 Open Services Switch Installation and Upgrade Guide. The adding and replacing of
hardware components is defined in the appropriate GSX Field Replaceable Unit (FRU)
documents.
For the GSX4010 Switch, this information is combined in the GSX4010 Open Services Switch
Hardware, Installation, and Upgrade Guide.
The PSX Policy Server provides a central database of service, routing, and call treatment
information for one or more GSX.
Software installation of the PSX Policy Server is defined in the PSX Policy Server Installation
Guide.
Operation, including configuration, of the PSX Policy Server is defined in the PSX Policy Server
Provisioning Guide.
The SGX SS7 Gateway provides connectivity between one or more GSXs and the Signaling
System 7 (SS7) network for circuit switched call routing and services.
Integrated SS7 link termination allows the GSX to serve as the physical interface point connecting
the GSX directly to the SS7 signaling network.
Software installation and maintenance operations for the SGX SS7 Gateway are defined in the
SGX SS7 Signaling Gateway Installation and Upgrade Guide and the SGX SS7 Signaling Gateway
Operations Guide.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Introduction Network Components and Topology
MGCP Softswitch
An MGCP softswitch may replace the PSX Policy Server and SGX SS7 Gateway elements of a
GSX network. Instructions for configuring the GSX9000 when it is being used with an MGCP
softswitch are given in the Media Gateway Operations Guide.
NOTE
MGCP is not supported in this release for GSX4000 series switches.
Sonus Insight
Sonus Insight provides a Network Operations Center (NOC) facility for administration of the GSX
network. Sonus Insight requires that the Softswitch control elements, rather than an MGCP
softswitch, be deployed in the network.
Installation and operation of this system is defined in the Insight Element Management System
Installation Guide and the Insight Element Management System User Guide.
NTP Server
In order to operate properly, the network must include a Network Time Protocol (NTP) server.
The NTP server provides a synchronized date and time for all components of the network. This
clock assures accurate date/time stamps on event records and accounting records.
GSX4000 series switches are equipped with a local CompactFlash card (referred to as the “Local
Disk”) which can be utilized as a mass storage device. You can use either the local disk or the NFS
(DSI Level 0) server(s) for storage of the GSX File System or a combination of both.
NOTE
Calls will not be properly processed if an NTP server is absent from the GSX
operating environment.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Components and Topology Introduction
DataStream Integrator
DataStream Integrator (DSI) is an advanced data translation engine that is used to collect,
correlate, and produce a standards compliant billing stream according to customer specific
services and billing usage criteria, founded on the raw call accounting records produced by Sonus
network elements. DSI also provides a standards based service for delivery of the billing stream to
3rd party billing systems specified by Sonus’ customers.
DSI supports generation of AMA standard billing streams from the GSX network element.
DSI Level 1 provides the NFS function as well as FileServices support. FileServices allows the
customer to distribute the call accounting files to another location.
Call Data Record (CDR) streaming allows CDRs to be sent directly to accounting applications
bypassing GSX event-based logging. This provides an alternative to an NFS/DSI-based logging
server for accounting records.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Introduction Installation Sequence Using Softswitch Control Elements
Figure 1–3 shows the installation sequence for a network that uses PSX Policy Server and SGX
SS7 Gateway control. This is a high level overview of this process. The information in this manual
pertains to boxes 17-20 in this process. For upgrading previously installed software, refer to the
Installation and Upgrade guide for each product for the appropriate software release.
Install NFS
Install Install SGX Install PSX
Install GSX server
Hardware SS7 Gateway Policy Server
(if necessary)
4 5 6 7
Install Insight
server
(if necessary)
8
Install/ Install/
Install/
Install Configure Configure SGX Install NFS
Configure PSX
Software Sonus Insight SS7 Gateway server
Policy Server
9 10 (if necessary)11 12
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
CHAPTER 2 Using the CLI to Configure
Objects
Overview
This chapter provides an overview of the command line interface (CLI) as well as information on
configuring the GSX using both the configuration models. Sections include:
Before you can access the GSX Command Line Interface (CLI), you must load, initialize, and boot
the GSX software as discussed in the GSX9000 Open Services Switch Installation, and Upgrade
Guide or the Hardware, Installation, and Upgrade Guide for your GSX4000 series switch. After
these steps are complete, you use the CLI to customize your GSX configuration.
You can also configure your GSX through a GUI interface, using the Sonus Insight EMS (Element
Management System), if you have purchased Sonus Insight. For more information, see the Insight
Element Management System Installation Guide and the Insight Element Management System
User Guide.
You will be introduced to the CLI and to certain CLI commands. A basic approach to the
configuration process is suggested and explained by example. See Chapter 3, "CLI Reference" for
command details.
Management Objects
Management objects are the collection of software objects that comprise the standard and Sonus
Enterprise Management Information Bases (MIBs). Each management object defines a software
component of the GSX. Together, these management objects model all GSX components, and
their properties and attributes. The properties and attributes control the actions and interactions of
the GSX components.
The CLI provides commands that act upon these objects. You configure the GSX by precisely
specifying these objects, their properties, and attributes. Chapter 3, "CLI Reference", provides a
comprehensive list of all management objects, command syntax, command parameters, and
command examples.
MIBs
Sonus utilizes standard MIBs and supplements these through the Sonus Enterprise MIB.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the CLI Using the CLI to Configure Objects
• Using a telnet connection on the Management Adaptor (MNA) module on the GSX9000 or the
GNA module on a GSX4000 series switch.
• Using the craft port located on the server module panel in the front of the GSX. This RS232
DCE interface supports a local asynchronous terminal.
1. Use one of the above methods to connect to GSX firmware, preferably a telnet
connection.
2. Enter your User ID and password.
The CLI returns the % prompt character. You are now ready to enter CLI commands,
which are discussed in the sections that follow. You may enter commands
individually from the keyboard or you may submit a script file that contains a batch of
commands.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the CLI to Configure Objects CLI Command Line Structure
A command line is comprised exclusively of keywords and parameters and structured as follows:
<Verb> <Object> <Parameters>
The action defined by the Verb is performed on the Object, using configuration values specified by
the Parameters. Objects are the management objects listed and described in Chapter 3, "CLI
Reference". Parameters are variables that may take numeric, string, or enumerated values.
CREATE is the verb, USER is the object, and guest is a parameter that takes a string value.
Keywords are CREATE and USER. In this example, the name guest is assigned to the object
USER.guest thereafter becomes a named management object.
Enumerated values are sets of values. The parameter table in Chapter 3, "CLI Reference" precisely
describe each parameter, its use, and the valid values that it may take.
• CREATE – allows you to name and define an object. For example, the following command
line creates an Integrated Services Digital Network User Part (ISUP) service for use by ISUP
circuits:
% CREATE ISUP SERVICE isupsg1
• DELETE – allows you to remove objects. For example, the following command line removes
an ISUP service:
% DELETE ISUP SERVICE isupsg1
• CONFIGURE – allows you to modify the characteristics of objects in the GSX. For example,
the following command activates an ISUP service:
% CONFIGURE ISUP SERVICE isupsg1 STATE enabled
• SHOW – allows you to view the current system status. Using this command, you can display
administrative and operational views of the management object, and display counters and/or
statistics for the management object. An example of the command syntax to show this
information for an ISUP service is:
% SHOW ISUP SERVICE isupsg1 ADMIN
• MONITOR – functions the same as SHOW but the screen displays continuously until you
intervene by typing CTRL-C.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Command Line Structure Using the CLI to Configure Objects
Throughout this guide, command keywords are displayed in upper case and command parameters
are displayed in lower case. This is intended to clarify the presentation. It is not a requirement of
the CLI. All commands are case insensitive. You may mix and change case without effect.
Abbreviations
Command keywords are unvarying strings that may be abbreviated as long as they remain unique.
For example,
% CONFIGURE SERVER SHELF...
• Reserved Keywords – the reserved keywords ALL, NONE, and SUMMARY may not be used to
name a management object. The CLI will reject these names.
• Special Characters – the following special characters should not be used in the names of
entities (for example, in trunk group names) because they cannot be recognized by the EMS
GSX Navigator:
$ & +, / . = ? @
To clear a parameter string value, enter a pair of double quotes by themselves. For example,
% CONFIGURE CAS COLLECTIONPROFILE cpf1 TONEPROMPT ““
clears the value of the string previously specified by the TONEPROMPT keyword.
The default value for every parameter is indicated in the Parameter Description tables in
Chapter 3, "CLI Reference". Whenever you do not configure a parameter, it takes the default
value. (If a profile is specified but the parameter is not, then your parameter is instead set to the
value specified for that parameter in your profile. If your profile did not specify that parameter,
then the parameter will take the default value. See the discussion of profiles in the previous
chapter.) Otherwise stated, every CLI parameter is required and none are optional. When you do
not explicitly assign a value to a parameter, you implicitly assign the default value to it.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the CLI to Configure Objects CLI Command Line Structure
When you change the value of a parameter, its new value becomes effective in one of three time
frames:
• Immediately - The set value is applied upon validation of the parameter by the CLI.
• On next instance - The set value is not applied to existing instances of the object but is applied
to any new instance that is created. For example, if you changed parameter values in a profile
that had been used to configure currently activated objects, the configured values in those
activated objects would not be changed. However, any new objects that are created and
configured using the profile will take the new profile parameter values in their corresponding
parameters (see "Configuration Profiles" on page 2–12).
• On enable - The set value is applied the next time the object’s administrative state is enabled.
If the parameter is changed while the object’s administrative state is enabled, the current
value remains effective until the object’s administrative state is disabled and then enabled.
Then and only then does the new value become effective. If the object’s administrative state
was disabled when the change took place, the new value is installed immediately but cannot
become effected until the object is re-enabled. Some parameters cannot be changed at all while
the object’s administrative state is enabled, but rather only while it is disabled. For
instance, changing the T1 interface line coding from AMI to B8ZS is only permitted when the
object’s administrative state is disabled.
These conditions are listed for each individual object in the command descriptions in Chapter 3,
"CLI Reference".
Confirming Commands
Some commands require a confirmation by the operator that they are intended, before they take
effect. For example, commands to change an object’s operational state to outofservice (or the
equivalent) require an affirmation. The CLI offers different confirmation options depending on the
environment in which the command is issued:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Command Line Structure Using the CLI to Configure Objects
If you are typing commands interactively, you will be prompted to confirm the request by entering
a lower case ‘y’ or ‘n’.
the network interface will be placed into the outofservice operational state. If you respond no,
% CONFIGURE NIF enet-1-3-2 MODE outofservice ..
CONFIGURE NIF enet-1-3-2 MODE ...
Confirm (y/n):n
If you have invoked a CLI script, you are given the opportunity to confirm either the immediate
command or the immediate command plus all confirmation-requiring commands that remain in the
script. To respond yes to this and all subsequent commands, type an upper case Y. To respond no
to this and all subsequent commands, type an upper case N.
the network interface will be placed into the outofservice operational state, the script will be
continued, and all confirmation-requiring commands in the remainder of the script will be silently
issued a “yes.” If you respond “No,” the command will be aborted and the script will be exited. In
those instances where no is a viable response that does not abort the command, it is silently issued
to all confirmation-requiring commands in the remainder of the script.
The CLI Startup File executes in the background and does not have an associated user or user
console. Interaction, including confirmation requests, is meaningless in this environment.
Commands in this file that require confirmations are silently affirmed.
Notice that this scenario is applicable when the GSX is booted. If you interactively invoke the
sysinit.tcl script, then the Scripted Commands scenario is applicable.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the CLI to Configure Objects Administrative Versus Operational States
Management objects have a configured (administrative) value and optionally an operational value
that is dependent on the administrative value as discussed below. The CLI procedures to change
and view these values are presented in Chapter 3, "CLI Reference".
Administrative Values
The administrative value is the configured value of the object or the value of all of the object’s
parameters. The administrative state of the object is one such parameter, usually taking the
value enabled or disabled (on or off). The administrative state of an object determines whether
the object is currently available in the GSX configuration (enabled, or active) or not available
(disabled, or inactive).
Operational Values
Operational values represent the current status of a management object. This is typically the
“readiness” of the enabled object. If an enabled object is ready or operational, it is available for
immediate use according to its configured parameter settings. Operational values are read-only
and are not persistent.
Complex objects require an operational state parameter in addition to their administrative state
parameter. In general this parameter provides a mechanism to maintain differing state information
about the object. For example, the administrative state of a Service Group might be enabled, but
the Service Group may be “down” due to a protocol state.
Whereas an object’s administrative state is always enabled or disabled, its operational state
may be inservice, outofservice, active, standby, blocked, unblocked, or others. In
all cases the operational state specifies the level of service that is being rendered while the
administrative state designates the object’s presence or absence in the configuration.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Administrative Versus Operational States Using the CLI to Configure Objects
The NTP Server is an example of an object that does not require an operational state parameter. In
the command sequence,
% CREATE NTP SERVER ntp1
% CONFIGURE NTP SERVER ntp1 IPADDRESS 128.1.2.3
% CONFIGURE NTP SERVER ntp1 STATE enabled
the NTP server ntp1 is defined, given an IP address, and activated with default parameter values.
One default parameter value is the 10 second minimum client polling interval (see "NTP Server"
on page 3–71). To change this interval to five seconds, it is not necessary to take ntp1 “out of
service” or even to disable its administrative state. By merely issuing the command,
% CONFIGURE NTP SERVER ntp1 MINPOLL 5
The T1 interface is an example of a complex object that does require an operational state
parameter. In the command sequence,
% CONFIGURE T1 T1-1-3-1 STATE enabled
% CONFIGURE T1 T1-1-3-1 MODE outofservice
% CONFIGURE T1 T1-1-3-1 LOOPBACK NEAREND lineloop
% CONFIGURE T1 T1-1-3-1 LOOPBACK NEAREND noloop
% CONFIGURE T1 T1-1-3-1 MODE inservice
the T1 interface T1-1-3-1 is activated and its operational state is set to inservice by default.
By changing the operational state to outofservice (while the administrative state remains
enabled), the interface is taken “down” for testing. Next a loop back is set up (lineloop), then
removed (noloop), and the interface is returned to service (inservice). This example illustrates
typical usage of the operational state parameter to perform routine equipment maintenance. In the
sections that follow, the rules for transitions between operational and administrative states are
presented for each object in Chapter 3, "CLI Reference".
Parameter Files
The GSX utilizes a binary parameter file to provide persistent storage of all administrative values.
The parameter file captures a snapshot of the current configuration. The parameter file is used to
restore a GSX’s configuration during reboot
There is one binary parameter file for each GSX, and a backup of that file. The binary parameter
file and the backup is written to the mass storage device for that GSX and stored in the GSX
System Tree (see Figure 6–15, GSX System Tree on page 6–91). This constitutes, in effect, the
“archive” of the GSX configuration.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the CLI to Configure Objects Administrative Versus Operational States
Parameter file loading is in effect when the PARAMETER MODE parameter of the NVS
Parameters object is set to binaryFile. This setting ensures that the current configuration is
restored whenever the active MNS module on the GSX9000 (or GNS module on GSX4000 series
switch) is booted. The NVS values are always be copied to the standby MNS or GNS module. See
"Non-Volatile Storage (NVS) Parameters" on page 3–62 for more information on parameter file
loading.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Scripting Language Using the CLI to Configure Objects
The CLI is derived from the Tool Command Language (TCL) shell. This structuring yields a
flexible, easily extendable CLI. You submit script files with the TCL source command. The TCL
core command:
% source <file>
allows you to process CLI commands from an ASCII file rather than typing each command
interactively in order to process it. The default CLI Startup Script File, sysinit.tcl, is one
example of a script file. This file is invoked by default whenever the GSX is booted. To execute it
from the base subdirectory of the GSX system tree, you type the TCL command:
% source cli/sys/sysinit.tcl
By specifying the “force” (-f) option to this command, you prevent a script from aborting if an
error occurs while evaluating a Sonus Management command. For example:
% source -f cli/sys/sysinit.tcl
NOTE
Some TCL core commands have been removed because they are not currently
required by the CLI. To view the commands that are supported, issue the
command: % info command
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the CLI to Configure Objects Configuration Profiles
Configuration Profiles
All management objects have one or more parameters that define their characteristics. For
example, a T1 interface has the following characteristics:
A profile allows you to create a specific set of characteristics different from the standard GSX
defaults. Then, when you define a new instance of one of these objects, you can use the profile to
quickly set the values as you would like them. For example, the command sequence:
% CREATE T1 PROFILE myt1profile
% CONFIGURE T1 PROFILE myt1profile LINETYPE D4
% CONFIGURE T1 PROFILE myt1profile CODING AMI
creates a profile named myt1profile and configures it with D4 framing and Alternate Mark
Inversion (AMI) line coding characteristics. These differ from the GSX defaults for these
parameters (see "T1 Circuits" on page 3–576). When you configure a specific T1 interface, T1-1-
3-1, using the command:
you assign the non-default D4 LINETYPE and AMI LINE CODING characteristics from your
profile, myt1profile, without needing to explicitly type these values for this span.
In this example, the following command creates an ISUP service called isupsg1 with the
characteristics specified in the profile named myisupprofile.
% CONFIGURE ISUP SERVICE isupsg1 PROFILE myisupprofile
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Configuration Profiles Using the CLI to Configure Objects
Supported Profiles
The GSX supports profiles for the following PSTN configuration objects:
• Trunk groups
• T1 and E1spans
• CLI users
• Packet services
• Circuit services
• ISDN services
• ISDN switch
• MGCP services
• ISUP services
• ISUP signaling
• BT services
NOTE
When you create a new instance of a GSX management object, even if you have
already created a profile for that object, the profile is not used automatically. To
create the object using the values in the profile, rather than the default values in
the binary parameter file, you must specify it with the PROFILE option in the
CONFIGURE command for that object.
You can use the CREATE and CONFIGURE commands in the CLI to create and configure profiles
for any of the objects listed in the above section.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the CLI to Configure Objects Configuring the GSX
Configure NIFs
ConfigureT3 Ports
Configure T1 Ports
You configure your GSX by defining management objects with the CLI commands discussed
previously. Once properly defined, these objects are used by the GSX run-time software to direct
its behavior.
Your configuration approach depends on the type of control elements that you are configuring
with your GSX:
• Sonus PSX Policy Server and SGX SS7 Gateway (hereafter abbreviated PSX)
• MGCP softswitch
The model in effect at your site will determine your configuration approach. Instructions for
configuring the GSX9000 when it is being used with an MGCP softswitch are given in the Media
Gateway Operations Guide
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Configuring the GSX Using the CLI to Configure Objects
In both models, the GSX hardware modules and external interfaces must be configured first. In the
PSX model, the PSX Policy Server and the SGX SS7 Gateway support the GSX software. The
management objects associated with that support need to be identified and configured as do the
signaling ports that are used for call control between GSXs. Finally, the PSTN interfaces must be
specified in detail.
In the MGCP softswitch model, the MGCP softswitch manages interconnection to the SS7
network and call routing. By configuring the MGCP softswitch properly you ensure that the GSX
will be correctly supervised to carry out these functions.
The basic configuration approach for each model is discussed in the sections that follow. This
summary will show you the objects to consider in each model. CLI commands will also be
presented. These will provide examples of the subject under discussion. See Chapter 3, CLI
Reference, for the precise syntax and parameter description of every CLI command.
Whether you use a PSX or an MGCP softswitch, when you configure the GSX you must specify
all node objects, IP network interfaces (NIFs), T3, and T1 circuit interfaces first. These are the
basic hardware and software resources utilized by the GSX regardless of usage model.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the CLI to Configure Objects Configuration Using the PSX Softswitch Model
Each section below explains a major step in configuring a GSX. Follow the steps below in the
order in which these sections appear below to configure the GSX.
This step requires that you define and configure the node objects:
• Node name
• Hardware modules
• Event logs
• NTP server
• NVS parameters
• NFS parameters
This step may in addition include defining and configuring these node objects:
• Users
• Management clients
• Traps
• Notifications
These objects collectively specify the node to which this GSX shelf belongs. None of these objects
depends on other objects, but in many cases these objects must be defined prior to configuring
other objects. (For example, on a GSX9000, you must specify a CNS10 server module in order to
configure the T1 circuits that are driven by it.) For this reason, Sonus recommends that you
configure these objects at the beginning of the process.
Some of these objects take default parameter values and do not need to be explicitly configured if
these default values are satisfactory. These include NVS parameters, NFS parameters, and event
logs. Formal explanations of each object and its command syntax are presented in Chapter 3, "CLI
Reference"
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Configuration Using the PSX Softswitch Model Using the CLI to Configure Objects
The GSX does not generate configuration information for empty slots. When you configure the
GSX, you must configure the slots containing modules, and any empty slots you plan to use. If you
would like to pre-configure an empty slot, you can use the CREATE SERVER SHELF command.
This command allows you to define the type of server module in a particular shelf and slot. For
example, the command:
% CREATE SERVER SHELF 1 SLOT 4 HWTYPE pns10
tells the GSX software to assume that the server module in the fourth slot of the first shelf is a
Packet Network Server (PNS10) module.
You may configure up to three NTP (Network Time Protocol) servers. An NTP server is an
Internet standard time server which sets and maintains UNIX system time-of-day. If one NTP
server you configured is unavailable, the GSX will attempt to contact another.
You must give each NTP server a name using the CREATE NTP SERVER command. Then you use
the CONFIGURE NTP SERVER command to provide its IP address. You can also specify its NTP
mode, version number, and minimum and maximum polling intervals (for details, see "NTP
Server" on page 3–71).
For example, the commands:
% CREATE NTP SERVER ntpbos
% CONFIGURE NTP SERVER ntpbos IPADDRESS 168.124.55.1
define an NTP server named ntpbos and specify its IP address. The NTP server ntpbos is given
the default values for other configuration parameters.
Each GSX has a name that is used to refer to it. You specify the GSX name using the CONFIGURE
NODE NAME command.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the CLI to Configure Objects Configuration Using the PSX Softswitch Model
This step requires the definition and configuration of the NIF objects:
1. PNA NIF (GSX9000 only) - an Ethernet or IP over ATM interface on a Packet Network
Adapter (PNA) module. This interface is used for telephony traffic.
2. GNA NIF (GSX4000 only) - an Ethernet interface on a Gateway Network Adapter (GNA)
module used for telephony traffic.
3. MNA or Management NIF - an Ethernet interface on a Management Network Adapter (MNA)
module on a GSX9000 or GNA on a GSX4000 series switch. This interface is used only for
management traffic.
4. Debug NIF - an Ethernet interface on any GSX hardware server module. This interface is for
the use of Sonus authorized personnel only for system debugging.
5. Static Route - a designation of the router to which you want to direct traffic from one of the
above NIFs.
All NIFs must be physically identified by shelf, slot, and port number. A NIF name is
automatically defined when the underlying PNS server module is added to the system through the
CLI. This name may be changed, but cannot be deleted except by deleting the underlying PNS
server module through the CLI. PNA NIFs may be arbitrarily placed in or out of service. See
"PNS30, PNS40, MNS20/MNA21/MNA25 Network Interface (Gigabit Ethernet NIF)" on
page 3–155 for more detail. Management NIFs are always configured as a redundant pair so that
the Management Network can be configured without bringing down the GSX. See "Management
Packet Interface (Management NIF)" on page 3–172 for more detail.
The configuration of the subnets that connect to NIFs may vary. See "Network Configuration
Considerations" on page 6–49 for more detail on this subject.
If you are running the MGCP softswitch model, the Ethernet NIFs may be managed by either the
softswitch or the GSX software. See "MGCP Continuity Tests" on page 6–97 for more detail on
this subject.
All NIFs must be configured with their IP address, and a subnet mask.
define an Ethernet NIF named ENET-1-3-2 to the second port of the PNA10 in slot 3 of shelf 1,
and assign it an IP address of 10.2.1.2 and a subnet mask of 255.255.255.0.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Configuration Using the PSX Softswitch Model Using the CLI to Configure Objects
NOTE
T3 circuits are not available on GSX4000 series switches in this release.
This step requires you to specify the T3 circuits, if any, that are connected to the Circuit Network
Adaptors (CNA30) on the GSX9000, or the Gateway Network Adapters (GNAx) on the GSX4000
series. You must specify the T3 circuits before you can configure their underlying T1 spans.
A T3 Port is the physical interface to which you connect a T3 circuit. One T3 circuit may be
connected to one CNA30. You define each T3 circuit and automatically assign it a name when you
add the CNS30 server module to the CLI using the CREATE SERVER SHELF .. CNS30
command. (You may subsequently change the name.) You can specify T3 circuit characteristics
such as:
For details on these and other parameters, see "T3 Circuits" on page 3–648.
The T3 circuit is made up of 28 underlying T1 circuits, or spans. These spans are also
automatically created and named when you issue the CREATE SERVER SHELF .. CNS30
command. Each span is assigned default values for the underlying T1 characteristics such as:
• Line buildout (default 110-220 ft.)
• Line type (default ESF)
• Line coding (default B8ZS)
• Facilities data link type
• Available channel number range (default 1-24)
For details on these and other T1 parameters, see "T1 Circuits" on page 3–576.
The example segment below illustrates a progression that configures one T1 span that underlies a
T3 circuit:
% CREATE SERVER SHELF 1 SLOT 3 HWTYPE CNS30
% CONFIGURE T3 T3-1-3-1 AVAILABLE T1 1-28
% CONFIGURE T1 T1-1-3-1-1 CODING ami
% CONFIGURE T3 T3-1-3-1 STATE enabled
% CONFIGURE T3 T3-1-3-1 MODE inservice
In this segment, the T1 span T1-1-3-1-1 is the automatically named first T1 span of the T3
circuit T3-1-3-1, that is driven by the CNS30 in slot 3 of shelf 1. The T1 line coding mechanism
of ami is a non-default parameter value applied to the underlying T1 span. The T1 span and the T3
circuit are activated when the T3 is enabled and put into service.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the CLI to Configure Objects Configuration Using the PSX Softswitch Model
This step requires you to name and specify the T1 links that are connected to the GSX Circuit
Network Adapters (CNA10) on the GSX9000 or Gateway Network Adapters (GNA10) on a
GSX4010. One CNA10 accommodates twelve T1 spans; the GSX4010 supports up to 24 T1 or E1
spans.
Before configuring T1 circuits on a GSX4010 switch, you configure the DS1 port to specify which
circuit type will be used (T1 or E1). See the "DS1 Ports" on page 3–574 object on for more
information.
For details on these and other T1 parameters, see "T1 Circuits" on page 3–576.
You can override any of the default values now or later through the CONFIGURE T1 command.
Using this command, you can either assign individual parameter values or assign a series of values
by specifying a T1 profile.
give the name T1-1-3-2 to the second T1 span on the CNA10 in the third slot of the first shelf,
and then assign it the values in a T1 profile named myt1profile. For details on creating a T1
profile, see "T1 Profile" on page 3–576.
If you are configuring a GSX to run with the PSX, continue with the next section immediately
below.
If you are using an MGCP softswitch, skip to the section “Configuration Using the MGCP
Softswitch Model,” later in this chapter.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Configuration Using the PSX Softswitch Model Using the CLI to Configure Objects
A PSX Policy Server may be configured to supply policy and routing information to the GSX.
This configuration represents the “standard” Sonus model. In this configuration, the GSX uses the
following external management systems to support its operation as shown in Figure 2–2 below.
• A Network Time Protocol (NTP) server to provide an accurate date and time. This server is
common to both models. It’s configuration was discussed in “Configuring the NTP Server” on
page 2-17.
• An SGX SS7 Gateway for interchanging Signaling System 7 (SS7) messages with the PSTN.
• A Gateway Signaling Port, an IP interface that the GSX uses for setting up calls with other
GSXs and with other IP Telephony devices.
• The PSX Policy Server, a database system that contains information on how calls should be
routed.
Configuring this model requires defining management objects that allow the GSX, SGX, and PSX
to interact as peers.
A/F-Links A/F-Links
PSX NTP
SS7 GWA
Softswitch Server
SS7 GWB
ss7nya ss7nyb psdenver ntpbos
ss7gwny
GSX
gsxhfd
You must define the characteristics of each interface as part of the standard model GSX
configuration.
You can define one or more SGX SS7 Gateways that the GSX can use to interoperate with SS7.
An SGX SS7 Gateway can execute on a single host system or on redundant host systems, one
primary and one secondary.
You must assign each SGX SS7 Gateway a name using the CREATE SS7 GATEWAY command,
and then must use the CONFIGURE SS7 GATEWAY command to associate a name with the primary
SS7 Gateway host and provide its IP address. If the SS7 Gateway has a redundant secondary host,
you must also use the CONFIGURE SS7 GATEWAY command to associate a name with that host
and provide its IP address.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the CLI to Configure Objects Configuration Using the PSX Softswitch Model
The Gateway Signaling Port is used for call control processing on the IP network. You may define
up to two Gateway Signaling Ports.
Each Gateway Signaling Port is identified by a number (1 for the first port, 2 for the optional
second port). You must use the CREATE GATEWAY SIGNALING PORT command to establish the
port and then use the CONFIGURE GATEWAY SIGNALING PORT command to provide its IP
address. By default, the Gateway Signaling Port(s) use the Management NIFs, but you can
override this on the CONFIGURE GATEWAY SIGNALING PORT command. You can also specify
certain timers (for details, see "Gateway Signaling Link" on page 3–390).
You may configure up to two (10) PSX Policy Servers for route lookups. A route lookup occurs
when a called number is presented to the PSX by the GSX and the (IP or circuit) route to complete
the call is returned to the GSX. See the PSX Policy Server Provisioning Guide for additional detail
on the PSX Policy Server.
If the active PSX becomes unavailable, the GSX will utilize the standby PSX while continuing to
try to reestablish the link to the original active PSX. You must give each PSX a name using the
CREATE SONUS SOFTSWITCH command and then use the CONFIGURE SONUS SOFTSWITCH
command to provide its IP address. You can also specify its operational state, transaction timeout
intervals, and recovery policies (for details, see "Sonus PSX" on page 3–279).
define a PSX Policy Server named sonuserv1 and specify its IP address. The PSX sonuserv1 is
given default values for the other configuration parameters.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Configuration Using the PSX Softswitch Model Using the CLI to Configure Objects
The PSTN configuration process for a GSX consists of the following steps:
ss7gyny
A/F-Links ansi SS7 GW
SS7
Stack
SS7 Node:
ansiSig
0
rt 1
rt 1
Slo
Slo
2
Slo
5
t3
t6
Slo
Slo
rt
ort
, Po
, Po
t1
Por
Por
t1
Po
t7
t3
t6
3, P
4,
2P
,P
,P
,P
t 12
t 3,
t 12
t 5,
t 4,
Po
ort
ort
ort
ort
t
Slo
Slo
Slo
Slo
rt 7
Slo
Slo
9
4
3
West East
Circuit Switch X Circuit Switch Y
3-4-5 6-7-8
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the CLI to Configure Objects Configuration Using the PSX Softswitch Model
When you configure an SGX SS7 Gateway, you create one or more SS7 Nodes. Each SS7 Node
has a unique SS7 Point Code (PC) and supports a particular variant of the SS7 protocol. As part of
the GSX configuration, you must define each of these SS7 nodes and describe its characteristics.
Use the CREATE SS7 NODE command to define an SS7 Node and give it a name, and then use the
CONFIGURE SS7 NODE command to identify its SS7 Point Code and the SS7 Gateway in which it
resides. For a discussion of other parameters, see "SS7 Node" on page 3–311.
define an SS7 Node named ansiSig in the SS7 Gateway named ss7gwny and provide its SS7
Point Code (1-4-6). Note that the SS7 Gateway must have already been defined as described in
"Configure the SS7 Gateway" on page 2–21.
Each Carrier is assigned a carrier identification code. The GSX configuration allows you to assign
a name to the four-digit carrier code, making it easier to remember. Carrier name is a parameter for
trunk groups, trunk group profiles, and destination trunks.
You use the CREATE CARRIER command to define a carrier name and assign it a code. For
example, the command:
% CREATE CARRIER att CODE 0288
Circuit switches in the PSTN group the circuits between them into Trunk Groups. The circuit
switches at both ends of a Trunk Group must have the same definition as to which circuits make up
that Trunk Group.
From the viewpoint of PSTN circuit switches, the GSX is another circuit switch. For this reason, it
must handle Trunk Groups in the same fashion as a circuit switch. In the example shown in
Figure 2–3, PSTN Configuration Relationships on page 2–23, Trunk Group 1 is between the GSX
and two other circuit switches, one with SS7 point code 3-4-5 and another with SS7 point code 6-
7-8. Trunk Group 2 is between the GSX and the second circuit switch (SS7 point code 6-7-8).
You use the CREATE TRUNK GROUP command to define a Trunk Group and give it a name, then
use the CONFIGURE TRUNK GROUP command to specify the SS7 Node that supports SS7
signaling for the Trunk Group. For other possible parameters, see "Trunk Group" on page 3–538.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Configuration Using the PSX Softswitch Model Using the CLI to Configure Objects
define a Trunk Group named tg1 and associate it with the Carrier Code for ATT and the SS7 Node
named ansisig. Note that the Carrier Code and the SS7 Node must have already been defined.
Once you have defined the Trunk Groups, you must define the details of the SS7 signaling to be
used on these trunk groups. ISDN User Part (ISUP) messages are used to carry call control
information over SS7 signaling networks. A set of SS7 signaling characteristics is called an ISUP
Service.
You must define an ISUP Service for each connected remote switch within each Trunk Group. In
the example in Figure 2–3 on page 2–23, "PSTN Configuration Relationships" there are three
ISUP Services:
• S1, defining the SS7 signaling characteristics used on TG1 between gsxhfd and West (where
West is a circuit switch from a particular vender)
• S2, defining the SS7 signaling characteristics used on TG1 between gsxhfd and East (where
East is a circuit switch from another particular vender)
• S3, defining the SS7 signaling characteristics used on TG2 between gsxhfd and East
You use the CREATE ISUP SERVICE command to define an ISUP Service and give it a name,
then use the CONFIGURE ISUP SERVICE command to specify the trunk group to which the
service applies and the Destination Point Code of the far-end switch. For details of other
parameters, see "ISUP Service" on page 3–826.
For example, the following commands define the ISUP Services described above:
% CREATE ISUP SERVICE s1
% CONFIGURE ISUP SERVICE s1 TRUNK GROUP tg1 DPC 3-4-5 SWITCHTYPE 5ess
% CREATE ISUP SERVICE s2
% CONFIGURE ISUP SERVICE s2 TRUNK GROUP tg1 DPC 6-7-8
SWITCHTYPE dms250
% CREATE ISUP SERVICE s3
% CONFIGURE ISUP SERVICE s3 TRUNK GROUP tg2 DPC 6-7-8
SWITCHTYPE dms250
Note that the Trunk Groups referred to in the CONFIGURE ISUP SERVICE command must
already be defined.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the CLI to Configure Objects Configuration Using the PSX Softswitch Model
A Circuit Service Profile defines a set of services to be used on a particular set of circuits. For
example, Circuit Service Profiles are used in defining ISUP Circuits, described below. Examples
of the services that can be specified are:
For details on these and other Circuit Service Profile parameters, see "Circuit Service Profile" on
page 3–685.
You use the CREATE CIRCUIT SERVICE PROFILE command to define a Circuit Service Profile
and give it a name, and then use the CONFIGURE CIRCUIT SERVICE PROFILE command to
specify values other than the GSX defaults.
define a Circuit Service Profile called csprofile and modify the frames-per-packet parameter of
that profile to be 2.
ISUP circuits between switches are identified by Circuit Identification Codes (CICs). CICs are
numbers in the range 0 to 16,384.
CICs may be grouped into ISUP Circuits. An ISUP Circuit is a group of CICs that belongs to a
single ISUP service and has a common set of characteristics such as direction (two-way, one-way
in, one-way out). In the example in Figure 2–3, PSTN Configuration Relationships on page 2–23,
there are three ISUP Circuits defined, corresponding to CIC ranges 1-144, 201-248, and 300-396.
You use the CREATE ISUP CIRCUIT SERVICE command to define and name an ISUP Circuit,
and you use the CONFIGURE ISUP CIRCUIT SERVICE command to assign it a Circuit Service
Profile. For other parameters, see "ISUP Circuit" on page 3–848.
define CIC range 1-24 for a ISUP Circuit named s1 as corresponding to the channels on the T1
circuit T1-1-3-1.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Configuration Using the MGCP Softswitch Model Using the CLI to Configure Objects
The MGCP softswitch model allows you to configure a GSX to communicate with a softswitch
that uses the Media Gateway Control Protocol (MGCP) protocol.
In the MGCP model, a Media Gateway softswitch performs all call control functions, and directly
controls one or more GSX Media Gateways. With MGCP, the softswitch handles all call control
functions and uses MGCP commands to:
Figure 2–4 shows a basic MGCP configuration. In this model, the Call Agent(s) may be part of
any softswitch that supports MGCP.
SoftSwitch
Call Agent 3
Call
Call Agent 2 Control
Call Agent 1 Call
Media
IP
GSX9000 GSX9000
Media Gateway Media Gateway
GSX9000
Media Gateway
A softswitch may be composed of multiple Call Agents. These Call Agents may be used for load
sharing or redundancy. The specific use of each Call Agent is determined by the MGCP softswitch
vendor.
Configuring the GSX9000 Media Gateway for the MGCP model requires defining management
objects that allow the GSX9000 to be managed by the MGCP softswitch.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the CLI to Configure Objects Configuration Using the MGCP Softswitch Model
NOTE
Before performing this configuration step, you must do Steps 1 through 4,
described in "Common Configuration Steps in Both Models" on page 2–15.
• An MGCP Session, which represents MGCP control of the GSX MG resources. The Session
also has the Service Profile object, which is used to provide connection defaults for the
session.
• One or more Call Agents, which can be bound to the session. The Call Agent object specifies
the softswitches that are authorized to control the GSX. Requests from all other softswitches
are ignored by the GSX.
• One or more MGCP Connections for each Call Agent object. Each connection defines the
address and port to which the GSX will send MGCP messages and from which the GSX will
accept MGCP messages from the softswitch.
Together these objects identify and configure an MGCP softswitch to control the GSX.
The following example shows a summary of the sequence in which you would create the Session,
the Call Agent(s), and the Connections, and then enable the Connections, the Call Agent(s), and
lastly, the Session. This example is for MGCP.
% CREATE MGCP SESSION mgsession
% CREATE MGCP CALL AGENT callAgent1 SESSION mgsession
% CREATE MGCP CONNECTION IPADDRESS 10.150.254.198 PORT 2727 CALL ..
AGENT callAgent1
% CONFIGURE MGCP CONNECTION IPADDRESS 10.150.254.198 PORT 2727
STATE enable
% CONFIGURE MGCP CALL AGENT callAgent1 STATE enable
% CONFIGURE MGCP SESSION mgsession MODE inservice
% CONFIGURE MGCP SESSION mgsession STATE enable
You must first name and specify the MGCP Session. The following example is for MGCP.
% CREATE MGCP SESSION mgsession1
% CONFIGURE MGCP SESSION mgsession1 MODE inservice
% CONFIGURE MGCP SESSION mgsession1 STATE enabled
This example shows the CLI commands you would use to create the MGCP Session
mgsession1, put it into service, and enable it.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Configuration Using the MGCP Softswitch Model Using the CLI to Configure Objects
NOTE
In setting up a GSX softswitch configuration, you should create the MGCP Session
first but leave it in a disabled state. Then create and configure all the other
required media gateway objects. Only when you have created and configured all
the required objects, should you then enter a CONFIGURE MGCP SESSION
sessionname STATE enabled command.
If you enable the MGCP Session as the very last step in your configuration procedure, you ensure
that no turn-up or call activity will occur before all components of the system are ready to handle
calls. For a complete example of the proper MGCP configuration sequence, see "Show Alarms" on
page 3–959.
You must next name, bind, and specify the MGCP Call Agent (the softswitch). The following
example is for MGCP.
% CREATE MGCP CALL AGENT callagent1 SESSION mgsession1
% CONFIGURE MGCP CALL AGENT callagent1 STATE enabled
In this example, the MGCP Call Agent callagent1 is created and bound to the MGCP Session
mgsession1. The Call Agent is then enabled and put in service.
Next you must define at least one connection to the Call Agent. The following example is for
MGCP.
% CREATE MGCP CONNECTION IPADDRESS 10.1.1.1 PORT 2727 ..
CALL AGENT callagent1
% CONFIGURE MGCP CONNECTION IPADDRESS 10.1.1.1 STATE enabled
In this example, the GSX will send MGCP messasges for callagent1 to address 10.1.1.1, port 2727.
The GSX will accept MGCP messages for 10.1.1.1:2727. The Call Agent (softswitch) is then
enabled and put into service.
Next, you must define a Media Gateway service that is bound to the MGCP Session. Finally the
Media Gateway circuits are defined by assigning channels to the service. The example below is for
MGCP.
% CREATE MEDIA GATEWAY SERVICE mgsrv
% CONFIGURE MEDIA GATEWAY SERVICE mgsrv CONTROLLER mgcpsession1 ..
TYPE mgcp
% CONFIGURE MEDIA GATEWAY SERVICE mgsrv STATE enabled
% CONFIGURE MEDIA GATEWAY SERVICE mgsrv MODE unblocked
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the CLI to Configure Objects Configuration Using the MGCP Softswitch Model
In this example, the service mgsrv is defined and the T1 span T1-1-3-1 is bound to it. The
circuit is assigned all 24 channels, enabled, and put into service (unblocked).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
CHAPTER 3 CLI Reference
Overview
This chapter presents a description of each management object and the CLI commands that you
may use to create, configure, and view information about it. This chapter also provides
conventions and organization by which the objects and their CLI commands are specified. Topics
include:
In addition to the typographical conventions listed in "About This Guide", the following
typographic and related conventions are used in this chapter.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Management Objects CLI Reference
Management Objects
Each management object in this chapter is explained according to its operational function. The
configuration commands for each management object are ordered as follows:
1. Command Syntax - all valid commands and command permutations are listed.
2. Parameter Table - each parameter is described in detail and its valid values are listed.
3. Command Examples - typical command sequences for manipulating the object are listed.
Each Management objects falls into the following categories, and can be found on the pages listed
below:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Node
User Profile
This object creates a template (or profile) for USER accounts. A template may be used to ease the
configuration of similar USER accounts. You link the template to the USER account by:
% CONFIGURE USER username PROFILE NAME profilename
You may selectively pass each parameter value in the USER PROFILE to the associated USER
account. You make each selection through the APPLY parameter. When you enable the APPLY
parameter, the associated USER PROFILE parameter value is passed on. When you disable the
APPLY parameter, the associated USER PROFILE parameter value is not passed on. When you
change a USER PROFILE parameter value, you do not change the underlying USER parameter
value. To apply changed USER PROFILE content, you must repeat the CONFIGURE command
shown above.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Command Parameters
Field
Parameter Length Description
userprofilenam 1-15 The name of the profile that may be assigned to a user account.
e
password 4-16 The alphanumeric password string that enables you to
password- successfully log on to the GSX. The minimum length of this string
state-apply is 4 characters. The default value is gsx9000.
When a PROFILE NAME is CONFIGUREd to a USER, the value of
password-state-apply specifies whether or not the value of
PASSWORD will be applied to this USER:
• disabled (default) - The current value of PASSWORD is not
applied to USER.
• enabled - The current value of PASSWORD is applied to USER.
APPLY essentially acts as a mask on the value of PASSWORD. If
the mask is on (enabled), the value is applied. If the mask is off
(disabled), the value is not applied.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Field
Parameter Length Description
access-type N/A The type of access available to the user account that applies this
access-apply profile.
• readOnly (default) - User may read but may not write into
GSX memory.
• readWrite - User may read and write into any GSX memory
that is not marked as requiring admin privileges.
• admin - User may read and write into any GSX memory and
also change the value of the password and access-type
parameters of all other users.
When a PROFILE NAME is CONFIGUREd to a USER, the value of
access-apply specifies whether or not the value of ACCESS will
be applied to this USER:
• disabled (default) - The current value of ACCESS is not
applied to USER.
• enabled - The current value of ACCESS is applied to USER.
APPLY essentially acts as a mask on the value of ACCESS. If the
mask is on (enabled), the value is applied. If the mask is off
(disabled), the value is not applied.
comment-text 1-31 An alphanumeric string that describes the USER to whom this
comment-apply profile is assigned.
When a PROFILE NAME is CONFIGUREd to a USER, the value of
comment-apply specifies whether or not the value of COMMENT
will be applied to this USER:
• disabled (default) - The current value of COMMENT is not
applied to USER.
• enabled - The current value of COMMENT is applied to USER.
APPLY essentially acts as a mask on the value of COMMENT. If the
mask is on (enabled), the value is applied. If the mask is off
(disabled), the value is not applied.
admin-state N/A Specifies the administrative state of the USER to whom this profile
admin-state- is assigned:
apply • disabled (default) - USER is not active.
• enabled - USER is active.
When a PROFILE NAME is CONFIGUREd to a USER, the value of
admin-state-apply specifies whether or not the value of
STATE will be applied to this USER:
• disabled (default) - The current value of STATE is not applied
to USER.
• enabled - The current value of STATE is applied to USER.
APPLY essentially acts as a mask on the value of STATE. If the
mask is on (enabled), the value is applied. If the mask is off
(disabled), the value is not applied.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Field
Parameter Length Description
pathrsh N/A Specifies the maximum number of days for which a password is
pathrsh-apply valid. Must be 0-999, default is 0. A value of 0 disables password
aging.
When a PROFILE NAME is CONFIGUREd to a USER, the value of
pathrsh-apply specifies whether or not the value of
PASSWORD AGE THRESHOLD will be applied to this USER:
• disabled (default) - The current value of PASSWORD AGE
THRESHOLD is not applied to USER.
• enabled - The current value of PASSWORD AGE THRESHOLD
is applied to USER.
APPLY essentially acts as a mask on the value of PASSWORD AGE
THRESHOLD. If the mask is on (enabled), the value is applied. If
the mask is off (disabled), the value is not applied.
aathrsh N/A Specifies the maximum number of days for which an account is
aathrsh-apply valid. Must be 0-999, default is 0. A value of 0 disables account
aging.
When a PROFILE NAME is CONFIGUREd to a USER, the value of
aathrsh-apply specifies whether or not the value of ACCOUNT
AGE THRESHOLD will be applied to this USER:
• disabled (default) - The current value of ACCOUNT AGE
THRESHOLD is not applied to USER.
• enabled - The current value of ACCOUNT AGE THRESHOLD is
applied to USER.
APPLY essentially acts as a mask on the value of ACCOUNT AGE
THRESHOLD. If the mask is on (enabled), the value is applied. If
the mask is off (disabled), the value is not applied.
llthrsh N/A Specifies the number of invalid login attempts that can be made
llthrsh-apply before the account is locked. Must be 0-15, default is 0. A value
of 0 disables login lockout.
When a PROFILE NAME is CONFIGUREd to a USER, the value of
llthrsh-apply specifies whether or not the value of LOGIN
LOCKOUT THRESHOLD will be applied to this USER:
• disabled (default) - The current value of LOGIN LOCKOUT
THRESHOLD is not applied to USER.
• enabled - The current value of LOGIN LOCKOUT
THRESHOLD is applied to USER.
APPLY essentially acts as a mask on the value of LOGIN
LOCKOUT THRESHOLD. If the mask is on (enabled), the value is
applied. If the mask is off (disabled), the value is not applied.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Field
Parameter Length Description
lldura N/A Specifies the number of minutes that login is locked out after the
lldura-apply invalid login threshold is exceeded. Must be 0-360, default is 1
(minute).
When a PROFILE NAME is CONFIGUREd to a USER, the value of
lldura-apply specifies whether or not the value of LOGIN
LOCKOUT DURATION will be applied to this USER:
• disabled (default) - The current value of LOGIN LOCKOUT
DURATION is not applied to USER.
• enabled - The current value of LOGIN LOCKOUT DURATION
is applied to USER.
APPLY essentially acts as a mask on the value of LOGIN
LOCKOUT DURATION. If the mask is on (enabled), the value is
applied. If the mask is off (disabled), the value is not applied.
cli_idle_to N/A Specifies the number of minutes of user interface inactivity that
cli_idle_to- may occur before the user is automatically logged off by the GSX
apply software.
When a PROFILE NAME is CONFIGUREd to a USER, the value of
cli_idle_to-apply specifies whether or not the value of CLI
IDLE TIMEOUT will be applied to this USER:
• disabled (default) - The current value of CLI IDLE
TIMEOUT is not applied to USER.
• enabled - The current value of CLI IDLE TIMEOUT is
applied to USER.
APPLY essentially acts as a mask on the value of CLI IDLE
TIMEOUT. If the mask is on (enabled), the value is applied. If the
mask is off (disabled), the value is not applied.
Command Example
To create a user profile demo that applies the password 1234 and readonly access to user
accounts that use it as a template, while setting other parameter values that are not passed on to
user accounts:
% CREATE USER PROFILE demo
% CONFIGURE USER PROFILE demo ..
PASSWORD 1234
PASSWORD APPLY enabled
ACCESS readOnly
ACCESS APPLY enabled
STATE enabled
COMMENT Iamagenericuser
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
User
This object allows you to add user accounts to the GSX. The maximum number of configurable
GSX users is six (6).
When the GSX software is initialized a user with username Admin, password gsx9000, and
access-type admin is created and activated. This user can change the access-type and
password for all other users, including disabling and deleting users who are currently logged on.
NOTE
For GSX4000 series switches, the initial password is also gsx9000.
CAUTION
If you change the Admin user’s password, you must remember the new password.
There is no way to retrieve a forgotten password. Write down the new Admin
password whenever you change it.
When you add a user, the admin-state parameter must be enabled for this user to log on. This
parameter must be disabled to delete this user.
All users can change their own passwords, except users with access-type readOnly.
When a PROFILE NAME is configured to a USER, the parameter values specified in the profile are
passed on to the USER, subject to the APPLY parameter described in "User Profile" on page 3–4. A
parameter value that is assigned directly to USER takes precedence over a value assigned to USER
through the user profile.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Command Parameters
Field
Parameter Length Description
username 1-23 An alphanumeric account-name that you may use to log on to the
GSX. First character must be alpha.
password 4-16 The alphanumeric password string that enables you to
successfully log on to the GSX. The minimum length of this string
is 4 characters. The default value is gsx9000.
access-type N/A The type of access available to this user.
• readOnly (default) - User may read but may not write into GSX
memory.
• readWrite - User may read and write into any GSX memory
that is not marked as requiring admin privileges.
• admin - User may read and write into any GSX memory and
also change the value of the password and access-type
parameters of all other users.
comment-text 1-31 An alphanumeric string that describes this user. This comment is
displayed by the SHOW command.
profilename N/A The name of a user profile to use for default parameter values.
pathrsh N/A Specifies the maximum number of days for which a password is
valid. Must be 0-999, default is 0. A value of 0 disables password
aging.
aathrsh N/A Specifies the maximum number of days for which an account is
valid. Must be 0-999, default is 0. A value of 0 disables account
aging.
llthrsh N/A Specifies the number of invalid login attempts that can be made
before the account is locked. Must be 0-15, default is 0. A value of
0 disables login lockout.
lldura N/A Specifies the number of minutes that login is locked out after the
invalid login threshold is exceeded. Must be 0-360, default is 1
(minute).
cli_idle_to N/A Specifies the number of minutes of user interface inactivity that
may occur before the user is automatically logged off by the GSX
software.
admin-state N/A The administrative state of the user:
• disabled (default) - User account is not activated.
• enabled - User configuration is activated.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Command Example
Name: joe
Profile:
Access: READONLY
State: ENABLED
Comment: None
To create user bob, using the demo template created previously under USER PROFILE:
% CREATE USER bob
% CONFIGURE USER bob PROFILE NAME demo
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Name: bob
Profile: demo
Access: READONLY
State: DISABLED
Comment: None
NOTE
Notice above that the profile values of STATE (enabled) and COMMENT
(Iamagenericuser) were not passed through to USER bob because they were not
applied (using APPLY enabled) to the demo profile.
Name: bob
Last Config: 00-00,00:00:00
Invalid Logins: 0
Login Locked Count: 0
Login State: ENABLED
Account Expiration:
Password Expiration:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Node Name
When you use the CONFIG NODE RESTART command to reboot a GSX with redundant MNS
modules or GNS modules, you reset both modules. The module in Slot 1 will be active after the
command is carried out. On GSXs with a local disk, the GSX rejects this command if the local
disks are not synced. Use the CONFIG NODE RESTART FORCED command to force a restart when
the local disks are not synced. Use the CONFIGURE NODE MODE outofservice to dry up an
entire chassis when a power-down is required.
Command Syntax
Command Parameters
Field
Parameter Length Description
name 1-255 The host name of the GSX being configured. This name must be
configured in the PSX Gateways table in order to access this GSX.
This name must be compliant with and resolvable by a Domain
Naming System (DNS).
loc 1-255 A text field that Sonus suggests using to specify the location of this
GSX. Quotes are required around any string that contains space
characters.
contact 1-255 A text field that Sonus suggests using to specify the name and
phone number of the system administrator for this GSX. Quotes
are required around any string that contains space characters.
oper-state N/A The operational state of the entire node:
• inservice (default) - Active.
• outofservice - Not active, existing calls are allowed to
terminate normally; no new calls are accepted.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Command Example
Name: TPUBS
Contact: John Smith
Location: SYSLAB
Mode: INSERVICE
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Slot
This object performs a software reset on a specific module. Although you may force a switchover
by performing this command on an active module that is a member of a redundancy group, Sonus
recommends that you use the CONFIGURE REDUNDANCY GROUP...SWITCHOVER command for
this purpose. See "Redundancy Group" on page 3–48.
The RESET option resets the specified module. The COREDUMP option performs a software reset,
and also generates a core dump of the module, in the core dump directory.
Command Syntax
NOTE
When issuing SLOT commands on a GSX4000 series switch, omit the SHELF
parameter.
Command Parameters
Field
Parameter Length Description
shelfnumber N/A The shelf number in the GSX node configuration. In this
release, one shelf is supported. Must be 1.
Note: This parameter does not apply to GSX4000 series
switches.
slotnumber N/A The slot number occupied by the module. For MNS and
GNS hardware modules, this number must be 1 or 2. For
all other modules, this number must be 3-16.
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Server
The server object specifies which server modules are administratively configured to exist within
this GSX node.
You can reserve an empty slot to later receive a module by configuring the HWTYPE parameter in
the slot. Subsequently you must insert the module and activate it by changing its administrative
state to enabled.
To delete a module from the configuration, its administrative state must be disabled.
The CREATE SERVER .. command (GSX9000 only) also generates automatic, permanent names
for packet network interfaces (NIFs), T1 circuit spans, E1 circuit spans, T3 circuits, and SONET
ports. The structure of each generated name is discussed in this chapter in the introduction to each
corresponding object. These names (and their implicit objects) cannot be deleted except by
removing the associated server module through the DELETE SERVER .. command.
The CREATE SERVER .. HWTYPE CNS30 .. command may be used to generate an unpaired circuit
module set, in addition to the paired circuit module sets (CNS30/CNA30 and CNS30/CNA03).
The unpaired set is an OC-3 TDM subsystem.
The OC-3 TDM subsystem is comprised of a CNS30-triplicate, a Sonet Midplane, and one or two
CNA33s. This subsystem is specified by declaring ADAPTER cna33. The SLOT must be the left-
most (or originating) slot occupied by the CNS30-triplicate. All three CNS30s, two CNA33s, and
an Automatic Protection Switching (APS) group to support SONET channel redundancy are
configured by the single CREATE SERVER .. command. If only one CNA33 is physically present,
do not further configure the APS group. See "APS Group" on page 3–1064 for APS naming
conventions. See the GSX9000 Open Services Switch Installation and Upgrade Guide for
descriptions of paired and unpaired circuit module sets.
The SHOW SERVER...ADMIN commands display the configuration of the module in the
specified shelf and slot.
The SHOW SERVER...STATUS commands display the status of the server module in the
specified shelf and slot. This includes information such as hardware, software, and firmware
versions, serial numbers, assembly numbers, and so on.
The SHOW SERVER...SUMMARY command displays the slot by slot server module configuration
of the specified shelf.
The SHOW ADAPTER...STATUS commands display the status of the adapter module in the
specified shelf and slot. This includes information such as hardware adapter type, hardware
revision, part number, serial number, manufacture date, and so on.
The SHOW ADAPTER...SUMMARY command displays the slot by slot adapter module
configuration of the specified shelf.
The SHOW INVENTORY...STATUS commands display the type and state of the server and adapter
module in the specified shelf and slot. State includes RUNNING, EMPTY, FAULTED, and so on.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
The SHOW INVENTORY...SUMMARY command displays the type and state of every server and
adapter module present in the specified shelf.
The CONFIGURE SCRIPT CACHESIZE ... command provisions the cache size for the primary
MNS, PNS, and CNS modules in the system. There is no cache associated wth standby modules.
NOTE
The CREATE SERVER command is not necessary for slots 1 and 2 of a GSX. These
modules may be assigned only to slots 1 or 2 and hence are created by default in
those locations.
• enabled
• disabled
• inservice
• outofservice
The default operational state is inservice, where the module is available for all runtime
operations. Changing the operational state to outofservice removes the server module in the
designated slot from runtime service. This action is typically taken before replacing the module in
the GSX.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
TABLE 3–6
From
(operational
state) Changing to (operational state)
inservice outofservice
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Command Syntax
NOTE
In the command below, defaults are inserted if ADAPTER and/or redun-type are
omitted. See Command Parameters. The CREATE SERVER and CONFIGURE SERVER
commands below apply to GSX9000 switches only.
NOTE
When issuing SERVER and INVENTORY commands on a GSX4000 series switch,
omit the SHELF parameter. When issuing ADAPTER commands on a GSX4000 series
switch, omit the SHELF parameter.CONFIGURE SCRIPT CACHESIZE LEVEL1
level1
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Command Parameters
Field
Parameter Length Description
shelfnumber N/A The shelf number in the GSX node configuration. In this release, one
shelf is supported. Must be 1.
Note: This parameter does not apply to GSX4000 series switches.
slotnumber N/A The slot number occupied by the module. For MNS/MNA, MTA, or
GNS hardware modules, this number must be 1 or 2. For all other
modules, this number must be 3-16.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Field
Parameter Length Description
svrtype N/A The type of server module (HWTYPE) that is being configured in the
slot.
• pns10 - The slot is occupied by an Ethernet Packet Server
Module/Adapter Module pair.
• pns30 - The slot is occupied by a Gigabit Ethernet Packet Server
Module/Adapter Module pair, or the high capacity equivalent
(PNS30a).
• pns40 - The slot is occupied by a dual Gigabit Ethernet Packet
Server Module/Adapter Module pair.
• cns10 - The slot is occupied by a T1 Circuit Server Module/
Adapter Module pair.
• cns20 - The slot is occupied by an 8-span E1 Circuit Server
Module/Adapter Module pair.
• cns25 - The slot is occupied by a 12-span E1 Circuit Server
Module/Adapter Module pair.
• cns30 - The slot is occupied by a T3 Circuit Server Module/
Adapter Module pair.
• cns31 - The slot is occupied by a non-echo-cancellation T3 Circuit
Server Module/Adapter Module pair.
• cns40 - The slot is occupied by a T1 Circuit Server Module/
Adapter Module pair.
• cns45 - The slot is occupied by a T1 Circuit Server Module/
Adapter Module pair.
• cns60 - The slot is occupied by a 3xT3 Circuit Server Module/
Adapter Module pair.
• cns71 - The slot is occupied by a high density optical Circuit
Server Module/Adapter Module pair.
• cns80 - The slot is occupied by a 3xT3 Circuit Server Module/
Adapter Module pair.
• cns81 - The slot is occupied by a high density optical Circuit
Server Module/Adapter Module pair.
• cns85 - The slot is occupied by a 3xT3 Circuit Server Module/
Adapter Module pair.
• cns86 - The slot is occupied by a a high density optical Circuit
Server Module/Adapter Module pair.
• sps70 - The slot is occupied by a dedicated purpose compression
CODEC resource.
• sps80 - The slot is occupied by a dedicated purpose compression
CODEC resource.
Note: This parameter does not apply to GSX4000 series switches.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Field
Parameter Length Description
adptype N/A The type of adapter module that is being configured in the slot behind
the previously specified server module:
• cna10 (default) - Valid for a cns10 server module used as a
redundancy client.
• cna01 - Valid for a cns10 server module used as a redundant
module.
• cna20 (default) - Valid for a cns20 server module used as a
redundancy client.
• cna21 - Valid for a cns20 server module used as a redundancy
client.
• cna02 - Valid for a cns20 server module used as a redundant
module.
• cna25 (default) - Valid for a cns25 server module used as a
redundancy client.
• cna05 - Valid for a cns25 server module used as a redundant
module.
• cna30 (default) - Valid for a cns30 or cns31 server module used
as a redundancy client.
• cna33 - Valid for a cns30 server module triplicate that will perform
as a SONET OC-3 Circuit Server.
• cna03 - Valid for a cns30 or cns31 server module used as a
redundant module.
• cna40 - Valid for a cns40 or cns45 server module used as a
redundancy client.
• cna04 - Valid for a cns40 or cns45 server module used as a
redundant module.
• cna60 - Valid for a cns60 3xT3 server module used as a
redundancy client.
• cna06 - Valid for a cns60 3xT3 server module used as a
redundant module.
• cna70 - Valid for a cns71 optical circuit server module used as a
redundancy client.
• cna07 - Valid for a cns71 optical circuit server module used as a
redundant module.
• cna80 - Valid for a cns80 or cns85 server module used as a
redundancy client.
• cna08 - Valid for a cns80, cns81, cns85, and cns86 server
module used as a redundant module.
• cna81 - Valid for a cns81 or cns86 server module used as a
redundancy client.
• pna10 (default) - Valid for a pns10 server module used either as a
redundancy client or as a redundant module.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Field
Parameter Length Description
adptype N/A • pna30 (default) - Valid for a pns30 (or PNS30a) server module
(continued) used either as a redundancy client or as a redundant module.
• pna35 - Valid for a pns30 (or PNS30a) server module used either
as a redundancy client or as a redundant module.
• pna40 (default) - Valid for a pns40 server module used either as a
redundancy client or as a redundant module.
• pna45 - Valid for a pns40 server module used either as a
redundancy client or as a redundant module.
• none - Valid for the sps70 server module.
The defaults shown above are inserted if the ADAPTER parameter is
absent.
redun-type N/A The redundancy group function that the previously specified module
set will perform:
• normal (default) - Either this server module will perform as a
redundancy client or it is not a member of a redundancy group.
• redundant - This server module will perform as a redundant
module.
The default is inserted if this parameter is absent.
cdump-state N/A The action to be taken when a fatal software fault is detected in the
module:
• disabled - Reboot without performing a core dump of the
module.
• enabled (default) - Perform a core dump of the module, then
reboot.
function N/A Specifies the Ethernet redundancy model that will be used when the
HWTYPE is PNS10, PNS30, or PNS40:
• enet (default) - Layer 2 redundancy, requiring a separate Ethernet
switch for each PNS/PNA pair in the redundancy group.
• enetLayer3 - Layer 3 redundancy, requiring the PNS/PNA pairs
to be directly connected to neighbor routers, and utilizing the
OSPF interface.
• hiCapEnet - Layer 2 redundancy for high capacity PNS30a
servers.
• hiCapEnetLayer3 - Layer 3 redundancy for high capacity
PNS30a servers.
level1 N/A Specifies the cache size for the MNS in KB, default is 1 MB
(GSX9000 only).
level2 N/A Specifies the cache size for all CNS, PNS, or GNS modules in KB,
default is 256 KB.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Field
Parameter Length Description
oper-state N/A The operational state of the server module in the GSX chassis:
• inservice (default) - Active.
• outofservice - Not active, able to put into disabled
administrative state.
admin-state N/A The administrative state of the module in the chassis slot:
• disabled (default) - Not active, able to be removed or
reconfigured.
• enabled - Active. Not configurable until taken outofservice
and disabled.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Command Example
To create and activate a cns30 module in slot number 6 (with an implied CNA30 adapter, used
either as a redundancy client or not a redundancy group member):
% CREATE SERVER SHELF 1 SLOT 6 HWTYPE cns30
% CONFIG SERVER SHELF 1 SLOT 6 STATE enabled
Shelf: 1
Slot: 6
Hardware Type: CNS30
Hardware Type Rev: 0
EPLD Rev: 0
Part Number: 810-00410
Part Number Rev: 0D
Manufacture Date: 6/22/1999
Serial Number: 0020000413
Software Version: V05.00.01 A011
Firmware Version: V01.08.00 R001
Redundancy Mode: ACTIVE
Temperature: (Celsius) 38
Memory Utilization: 25%
Total Memory Size: 0x3400000
Total Shared Memory Size: 0x1000000
Total Available Memory Size: 0x26e91c0
Total Available Shared Memory Size: 0xff060f00
CPU Utilization: 4%
Up Time: (seconds) 80290
To create and activate an OC-3 TDM subsystem that occupies slots 5-7 (and simultaneously create
the APS group APS-1-5-2):
% CREATE SERVER SHELF 1 SLOT 5 HWTYPE cns30 ADAPTER cna33
% CONFIG SERVER SHELF 1 SLOT 5 STATE enabled
% CONFIG SERVER SHELF 1 SLOT 6 STATE enabled
% CONFIG SERVER SHELF 1 SLOT 7 STATE enabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
To create and activate a pns30 module in slot number 10 (with an implied pna30 adapter, used
either as a redundancy client or not a redundancy group member):
% CREATE SERVER SHELF 1 SLOT 10 HWTYPE pns30
% CONFIG SERVER SHELF 1 SLOT 10 STATE enabled
Shelf: 1
Slot: 10
Hardware Type: PNS30
Hardware Type Rev: 0
EPLD Rev: 0
Part Number: 810-02600
Part Number Rev: 0C
Manufacture Date: 8/9/2000
Serial Number: 0020008917
Software Version: V04.01.00 A032
Firmware Version: V01.05.00 B023
Redundancy Mode: ACTIVE
Temperature: (Celcius) 45
Memory Utilization: 14%
Total Memory Size: 0x3100000
Total Shared Memory Size: 0x4000000
Total Available Memory Size: 0x2a1d610
Total Available Shared Memory Size: 0x23eff00
CPU Utilization: 1%
Up Time: (seconds) 7805
To create and activate a cns25 module in slot number 7 (with an implied cna25 adapter, used
either as a redundancy client or not a redundancy group member):
% CREATE SERVER SHELF 1 SLOT 7 HWTYPE cns25
% CONFIG SERVER SHELF 1 SLOT 7 STATE enabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Shelf: 1
Slot: 7
Server HwType: CNS25
Adapter HwType: CNA25
State: ENABLED
Mode: INSERVICE
Action: FORCE
Redundancy Role: NORMAL
Server Function: E1
Core Dump State: ENABLED
To create and activate a cns60 module in slot number 10 with a cna60 adapter, used as a
redundancy client:
% CREATE SERVER SHELF 1 SLOT 10 HWTYPE cns60 ADAPTER cna60
% CONFIGURE SERVER SHELF 1 SLOT 10 STATE enabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Shelf: 1
Slot: 10
Hardware Type: CNS60
Hardware Type Rev: 0
EPLD Rev: 0
Part Number: 810-04010
Part Number Rev: 0B
Manufacture Date: 10/18/2001
Serial Number: 0069000348
Software Version: V04.01.00 A032
Firmware Version: V01.08.00 B009
Redundancy Mode: ACTIVE
Temperature: (Celcius) 42
Memory Utilization: 5%
Total Memory Size: 0xf400000
Total Shared Memory Size: 0x4000000
Total Available Memory Size: 0xe6833b0
Total Available Shared Memory Size: 0x1320600
CPU Utilization: 6%
Up Time: (seconds) 8208
To display any inconsistencies between what is configured and what is installed in your GSX:
% SHOW INVENTORY SHELF 1 CONFLICT
Node: TPUBS Date: 2001/08/03 21:56:09 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
To create and activate a pns30 module in slot number 10 with a pna30 adapter, to be a
redundancy client using the Layer 3 PNS redundancy model:
% CREATE SERVER SHELF 1 SLOT 10 HWTYPE pns30 ADAPTER pna30 ..
FUNCTION enetLayer3 normal
% CONFIGURE SERVER SHELF 1 SLOT 10 STATE enabled
To create a CNS71/CNA70 module set in slot 3, automatically creating the optical port OPTICAL-
1-3-1 consisting of one working channel and one protection channel:
To display a summary of the script cache size on the primary modules and their usage.
GSX9000 Example:
% SHOW SCRIPT CACHE SUMMARY
Node: TPUBS Date: 2003/10/22 13:33:13 GMT
Zone: GMTMINUS05-EASTERN-US
GSX4000 Example: (On a GSX4000 series switch, only Level2 cache size is shown):
% SHOW SCRIPT CACHE SUMMARY
Node: TPUBS Date: 2006/02/21 14:40:13 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
To set the script cache size in all CNS and PNS modules (or the GNS module on a GSX4000) to
1 MB:
% CONFIGURE SCRIPT CACHESIZE LEVEL2 1000
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Server Flash
CAUTION
This command should not be used except as directed by Sonus authorized
personnel. Improper use of this command could result in the GSX becoming
unable to boot.
This object enables access to the boot PROM (flash) on each module to either rewrite it or to
examine the status of the last attempt to rewrite it. The images that are written to the flash are in
the /images subdirectory in the GSX System Tree (see Figure 6–15). On a GSX9000, the file
mns10b.bin or mns20b.bin will be written to the MNS modules, the file cns10b.bin will be
written to CNS10s and so on. On a GSX4010 switch, the file gns15b.bin will be written to the
GNS15 modules. You must ensure that these files contain the desired version of the flash before
performing the update. The MONITOR command allows you to observe the update in progress.
Command Syntax
NOTE
When issuing SERVER FLASH commands on a GSX4000 series switch, omit the
SHELF parameter.
Command Parameters
Field
Parameter Length Description
shelfnumber N/A The shelf number in the GSX node configuration. In this release,
one shelf is supported. Must be 1.
Note: This parameter does not apply to GSX4000 series switches.
slotnumber N/A The slot number occupied by the module. For MNS or GNS
hardware modules, this number must be 1 or 2. For all other
modules, this number must be 3-16.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Command Example
To update the boot PROM in the MNS module in slot 1 from the current GSX System Tree:
% CONFIGURE SERVER FLASH SHELF 1 SLOT 1 UPDATE NOW
Shelf: 1
Slot: 1
State: IDLE
Last Status: UNKNOWN
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Local Disk
All GSX4000 switches are equipped with a local CompactFlash card (referred to as the “Local
Disk”) which can be utilized as a mass storage device. You can use either the local disk or a
Network File System (NFS)/DSI Level 0 server for storage of the GSX File System or a
combination of both.
You can specify the storage location of announcement files by choosing the localDisk option in
the following commands:
% CONFIGURE ANNOUNCEMENT DISK location
You can also store core dump files and boot files to the local disk by choosing the localDisk
option in the following commands:
% CONFIGURE NODE NVS ...
CORE DUMP DISK coredisk
BOOT DISK bootdisk
See the "Non-Volatile Storage (NVS) Parameters" commands on page 3–62 for more information.
To check the status of the local disk on startup or re-boot, you use the SHOW LOCAL DISK
STATUS command to make sure the disks are FULLSYNCED.
The Local Disk Management Utility (DMU) is an interactive command-line shell from which
manage the GSX local disk. Basic commands allow you to create, delete, and view the contents of
directories as well as navigate through the directory hierarchy. You access the DMU in one of two
ways:
For additional information on the DMU, including a complete list of DMU commands and their
function, see "Using the Disk Management Utility (DMU)" on page 6–202.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Command Syntax
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
The SSHv2 Secure Shell (SSH) Server allows you to connect to the GSX with greater security than
telnet, providing data stream encryption. SSH protects the user and password from being passed in
cleartext across the network (unlike telnet). The SSH server listens on TCP port 22 and operates
analogously to the telnet daemon, and supports 128-bit public and private DSS host keys stored in
flash on the GSX and synched to the standby module.
• Create the public and private host keys used by the SSH server and to enable the server.
• Delete the public and private host keys used by the SSH server and to disable the server.
• Terminate the specified session.
• Show the status of the host and public keys. You can cut and paste this information into a
known_hosts type file on the client side.
• Show the connected SSH sessions including local and remote IP addresses, local and remote
ports, Username logged in as, number of seconds connected, and inbound and outbound
Cipher and MAC addresses.
Command Syntax
Command Parameters
Field
Parameter Length Description
localipaddr N/A The 32-bit local IP address of the SSH session you wish to
terminate in dotted decimal form (for example 128.127.50.224).
remoteipaddr N/A The 32-bit remote IP address of the SSH session you wish to
terminate in dotted decimal form (for example 128.127.50.224).
localport N/A The local port of the SSH session you wish to terminate.
remoteport N/A The remote port of the SSH session you wish to terminate.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
This object creates and configures local or remote (Certificate Authority (CA) or trusted entity)
certificates. The Public Key Infrastructure (PKI) provides a common set of infrastructure features
supporting public key and certificate-based authentication based on RSA public/private key pairs
and X.509 digital certificates. This functionality runs on MNS20 and PNS40 modules on the
GSX9000 and the GNS15 on the GSX4000.
Certificates for CAs or other entities that are installed in the GSX/NBS can serve as declarations to
the system that a particular public key belongs to a particular remote entity. These are referred to
as trust anchors because they are taken on faith by the system.
You specify the type (local or remote) when creating a certificate using the CREATE SECURITY
PKI CERTIFICATE <pkicert> TYPE <type> command.
Local Certificates
Local certificates are credentials belonging to the local system itself, that it may present to peers in
order to prove its identity. Each local certificate has a corresponding private key. PKCS#12 is the
common format for importing and exporting local certificates with private keys, which are
protected with a password or pass-phrase and read from the security subdirectory (under the
Boot Path directory of the GSX node; see Figure 6–15, "GSX System Tree" on page 6–91 for a
diagram of the GSX directory structure). The maximum number of local certificates configurable
on the GSX is four (4).
You enter the pass-phrase required to extract the local certificate and its corresponding private key
from the PKCS#12 file using the CONFIGURE SECURITY PKI CERTIFICATE <pkicert>
PASSPHRASE <passphrase> command. You must have already created a key pair and the
corresponding certificate along with the pass-phrase on a different platform and placed the
PKCS#12 file in the security subdirectory on the NFS (DSI Level 0).
You import PKCS#12 files from the NFS (DSI Level 0) using the CONFIGURE SECURITY PKI
CERTIFICATE <pkicert> IMPORT <certfilename> command.
The files containing local certificates to be imported are typically for one-time use. Once the
certificate has been imported, the information the GSX needs is stored in the parameter file with
all the other GSX configuration information, and the GSX will not look into the original file again
unless the system administrator issues another IMPORT command referencing it.
CA certificates are credentials belonging to Certificate Authorities. Copies of these certificates are
installed in the GSX/NBS because they are part of a chain of certificates the local system will
present to peers, or because the corresponding CAs are trust anchors for the local system.
Certificates belonging to non-CA remote systems may also be installed as trust anchors in this
manner.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
The Certificate Authority (CA) certificates and other and other trusted remote certificates are not
distributed with private keys and thus do not require any confidentiality protection. There is no
associated password or passphrase. The GSX/NBS imports these certificates from Distinguished
Encoding Rules (DER) formatted files. The maximum number of remote certificates configurable
on the GSX is 16.
As with local certificates, you must place the file containing the certificate in the appropriate
directory on the NFS/DSI before importing it. For remote (CA) certificates, that directory is the
security subdirectory on the NFS/DSI. See Figure 6–15, "GSX System Tree" on page 6–91 for
a diagram of the GSX directory structure.
You import DER files from the NFS/DSI using the CONFIGURE SECURITY PKI CERTIFICATE
<pkicert> IMPORT <certfilename> command.
The files containing CA certificates to be imported are typically for one-time use. Once the
certificate has been imported, the information the GSX needs is stored in the parameter file with
all the other GSX configuration information, and the GSX will not look into the original file again
unless the system administrator issues another IMPORT command referencing it.
Master Key
The master key is a machine-generated key used to encrypt RSA private keys in the parameter file.
The initial master key is generated automatically by the GSX and stored in nonvolatile storage on
the MNS or GNS module(s).
Certificate Chains
When an application using the key and certificate feature is acting in a server or client role, you
can list a chain of certificates in DER-encoded format that may be presented to another party to
authenticate the identity of the GSX/NBS. The SHOW SECURITY PKI CERTIFICATE_CHAIN
<localcert> STATUS command takes the configuration name of a local certificate as a
parameter, and returns a chain of certificates including the named certificate and the linked parent
certificates.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Command Syntax
NOTE
When issuing SECURITY PKI CERTIFICATE commands on a GSX4000 series
switch, omit the SHELF parameter.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Command Parameters
Field
Parameter Length Description
pkicert 1-23 Specifies a name for this certificate. Must be 1-23 characters.
type N/A Specifies the type of certificate
• remote - certificate authority (CA) or trusted entity.
• local
certfilename 1-23 Specifies the certificate filename to import from the NFS (DSI
Level 0). Must be 1-23 characters. The file is one of the following
formats:
PKCS12 (Public Key Cryptography Standards #12) - for local
certificates; for example certname.p12. PKCS12 files are
protected with a password and read from the security
subdirectory (under the Boot Path directory of the GSX node).
DER (Distinguished Encoding Rules) - for remote certificates; for
example certname.der. DER is a method for encoding a data
object, such as an X.509 certificate which uses a digital signature
to bind together a public key with an identity. DER files are read
from the common security subdirectory (under the Mount
Point directory of the NFS/DSI) but are not protected with a
password or pass-phrase.
passphrase 1-23 Specifies the password or pass-phrase to decrypt the RSA
private key in a PKCS12 file. Must be 1-23 characters.
You must configure the PASSPHRASE parameter prior to
executing the IMPORT command.
Note: This parameter applies to LOCAL certificates only.
state N/A Specifies the administrative state of the PKI certificate:
• enabled - this certificate is present in the certificate
database, and can be presented to peers and may be relied
upon as a trust anchor.
• disabled (default) - this certificate is present in the certificate
database, but will not be presented to peers or used as a trust
anchor.
shelf N/A Specifies the shelf number in the GSX node configuration. In this
release, one shelf is supported. Must be 1.
Note: This parameter does not apply to GSX4000 series
switches
slot N/A Specifies the slot number occupied by the MNS20, PNS40, or
GNS15 module. For MNS or GNS (GSX4000 series) modules,
this number must be 1 or 2. For all other modules, this number
must be 3-16.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Command Examples
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Shelf index: 1
Slot index: 3
Local certs installed: 4
CA/remote certs installed: 2
Num success cert validations: 1
Num failed cert validations: 0
Num long local cert chain fails: 0
Num long CA/remote cert chain fails: 0
Num missing master key: 0
Num wrong master key: 0
Num bad/malformed peer certs: 0
Num bad/malformed local certs: 0
Num bad/malformed CA/remote certs: 0
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Software Upgrade
CAUTION
This command should not be used except as directed by Sonus authorized
personnel. Improper use of this command could result in the GSX becoming
unable to boot.
This object allows you to install new GSX software, and monitor its progress, without losing
active stable calls and without rebooting the GSX. This facility is called a Live Software Upgrade
(LSWU). See the GSX9000 Open Service Switch Installation and Upgrade Guide or the
Hardware, Installation, and Upgrade Guide for your GSX4000 series switch for a comprehensive
explanation and example of the use of this facility.
Command Syntax
NOTE
When issuing SOFTWARE UPGRADE commands on a GSX4000 series switch, omit
the SHELF parameter.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Command Parameters
Field
Parameter Length Description
shelf N/A The shelf number in the GSX node configuration. In this release,
one shelf is supported. Must be 1.
Note: This parameter does not apply to GSX4000 series switches.
slot N/A The slot number occupied by the module. For MNS or GNS
(GSX4000 series) modules, this number must be 1 or 2. For all
other modules, this number must be 3-16.
upcntl N/A Specifies the handling of server modules that are In Service, but
not protected by redundancy during a Live Software Upgrade.
• upgrade (default) - These server modules will be individually
reset during the upgrade, thereby dropping any calls they were
carrying at the time.
• skip - These server modules will be left running the old version
of software in an Out of Service with dryup state, and the
upgrade process will exit early. When calls on these server
modules are sufficiently dried up, you must initiate a second
upgrade to complete the shelf upgrade. It is important not to
make any configuration changes until the upgrade is completed.
To set this object, you must have administrative privileges. You
must set this object before an upgrade is initialized.
directory 1-15 The name of the software release directory that is the repository of
the new GSX software in the GSX system tree, see Figure 6–15
on page 6–91.
Command Example
See the GSX9000 Open Services Switch Installation and Upgrade Guide for an example of the use
of this facility.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Feature Control
This object displays the current state of the licensed features on the GSX.
Command Syntax
Command Example
Feature State
---------------------------------------------------
GPX_FEATURE_HPC DISABLED
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Redundancy Group
This object identifies two or more GSX server modules of the same type. One of these modules,
the Redundant Module, stands by ready to replace any of the other (active) modules, should one of
them fail. The active modules are the Redundancy Clients, on whose behalf the redundant module
stands by. The Redundancy Group is made up of the redundant module and the redundancy clients.
(Adapter modules are not redundancy group members; they neither replace nor are replaced by
other adapter modules.)
A redundancy group is automatically created and named whenever a redundant module set is
added to the GSX via the CREATE SERVER .. ADAPTER .. redundant command. See
"Server" on page 3–17 for additional information.
Naming Conventions
GSX9000 – The default name of the redundancy group for the GSX9000 is modname-shelf-
slot or modname-shelf, where modname is the full server module name, shelf is the shelf
number, and slot is the slot number. MNS redundancy groups use the first convention, and all
others the second convention. For example, MNS11-1 identifies the MNS11 redundancy group that
is established by the redundant MNS11/MNA10 module pairs in slots 1 and 2. PNS30-1-4
identifies the PNS30 redundancy group that is established by adding a redundant PNS30/PNA30
module set to slot 4 of shelf 1. CNS71-1-16 identifies the CNS71 redundancy group that is
established adding a redundant CNS71/CNA07 module set to slot 16 of shelf 1.
This redundancy group name (for example, CNS30-1-10) may be changed via CONFIGURE
REDUNDANCY GROUP .. NAME, but it may not be deleted. This redundancy group is removed
only when the CNS30/CNA03 module set in slot 10 is removed via the DELETE SERVER ..
ADAPTER command.
GSX4000 – The default name of the redundancy group for GSX4000 series switches is the full
server module name, for example GNS15.
• The 1:1 model in which a redundancy group is assigned a single redundancy client (server
module). This model is used by MNS modules on the GSX9000, and GNS modules on
GSX4000 series switches.
• The N:1 model in which a redundancy group is assigned N redundancy clients (N equal or
greater than 1). This model is used by all CNS, SPS70, PNS10, PNS30, and PNS40 modules.
A switchover results in the standby server module taking over and becoming active while the
original active module is reset and restored as the new standby, if possible. For a switchover to
occur, the redundancy group must be enabled and the redundant module must be present.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
A redundant module starts out in standby mode backing up one or more clients. On the first
switchover, the redundant module becomes active and the client enters standby state. As
switchovers (possibly) continue, a client may transition from active to standby or from standby to
active. In either case, a client remains a client and a redundant module remains a redundant module
before and after any switchover.
• Missing Client - A redundancy client is not physically present when a redundancy group is
enabled.
• Client Removal - A redundancy client that was an enabled member of a redundancy group is
physically removed from the GSX.
NOTE
Do not switch over an MNS or GNS redundancy group by removing the active
server module. Use the CONFIGURE REDUNDANCY GROUP...SWITCHOVER
command to switch over to the standby module. After issuing this command, you
can safely remove the previous active module.
• Client Reset - A redundancy client is reset either by pressing the front panel reset button or by
issuing the CONFIGURE SLOT SHELF...RESET command. (On GSX4000 series switches,
the command is CONFIGURE SLOT SLOT...RESET.)
• Client Hardware Failure - A hardware failure is detected on a redundancy client.
• Client Software Failure - A software failure is detected on a redundancy client.
• Healthcheck Failure - A redundancy client fails to reply to a Healthcheck poll from the
redundant server module.
• Link Failure - A local port, link, or Ethernet switch problem was detected on an MNA or a
PNA10 by the link verification mechanism, see "Static Routes (IP Routing Table)" on page 3–
182.
• CLI Switchover - A switchover is initiated by issuing one of the CONFIGURE REDUNDANCY
GROUP...SWITCHOVER/REVERT commands.
On a switchover, all relevant stable calls are preserved. (Relevance is dependent on the GSX
server modules that are “switching over;” for MNS and GNS modules, all calls in the GSX are
relevant because they are all processed by the MNS, however for CNS modules only those calls
being processed by the module that is switching over are relevant.) This capability is realized
when the software in the active module is synchronized with the software in the standby module.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
CLI initiated switchovers from the above list may be one of two types as indicated by the
keywords:
• NORMAL - This cooperative switchover is requested by the active module and accepted by the
standby module. This option requires that the standby be synchronized to the active.
• FORCED - This switchover is carried out regardless of the state of the standby (even if it is
not present) by resetting the active module. This option should only be used as a last resort.
FALLBACK specifies whether a previously failed client that has recovered may be automatically
returned to active service:
• REVERTIVE - the recovered client will be automatically returned to active service via a
switchover after it has recovered and remained recovered for TIMEOUT minutes.
• NONREVERTIVE - the recovered client is not automatically returned to service regardless of the
length of the interval that it has been recovered; a manual switchover (via REVERT) must be
performed to return the client to active service.
The redundancy group states influence the behavior that will accompany a switchover. The two
possible states, shown in Table 3–12, may be displayed via the SHOW REDUNDANCY GROUP ..
STATUS command.
Status Description
ACTIVESYNCED The active and standby server modules are fully synchronized such that
the standby is ready to take over if the active fails.
ACTIVENOTSYNCED The active server module is not synchronized with the standby. The
redundancy group may be disabled or the standby may be missing,
down, or initializing. The standby will not take over if the active fails.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Table 3–13 summarizes the conditions and consequences of switchovers using either redundancy
model:
TABLE 3–13 CLI Imposed Switchovers in 1:1 and N:1 Redundancy Model
The methods by which the redundancy group determines its clients, discovers client failures, and
restores recovered clients may be configured as discussed below.
By default, MNS10s are assigned to the redundancy group MNS10-1 (MNS11s are assigned to
redundancy group MNS11-1, MNS20s are assigned to MNS20-1) which is created and enabled
when the GSX is booted. The MNS module in slot 2 is the redundant module and the MNS module
in slot 1 is the client in this group.
On GSX4010 switch, GNS15 modules are automatically assigned to the redundancy group GNS15.
The GNS module in slot 2 is the redundant module and the GNS module in slot 1 is the client in
this group.
If CNS71s or CNS81s are used to support both T1 and E1 circuits, then a separate redundancy
group must be established for each circuit type. This scenario is illustrated in one of the command
examples below.
NOTE
On the GSX4000, after a GNS server switchover by CLI command, the newly
promoted server may report receipt of an ISUP-SG error "Unrecognized message
type xxx received." This merely indicates that a task received messages meant to
be processed in ACTIVE mode before that task switched over. These types of
errors are normal and can be ignored.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
The CNA redundant data path test is an online diagnostic that determines whether the data path
from the redundant CNS to the client CNA adapter cards in a redundancy group is functional.
NOTE
This functionality is not available on GSX4000 series switches.
Test Execution
The CNA redundant data path test is disabled by default. You enable the test with the CONFIG
REDUNDANCY GROUP .. CNATEST ENABLED command. You can also administratively disable
or run the test on demand at any time. Once enabled, the CNA redundant data path test will
automatically run:
NOTE
The test will run for 24 hours after the timestamp in the CNA Test: Time(GMT)
field displayed by SHOW REDUNDANCY GROUP <redundancy-group-name>
STATUS.
Sonus recommends that, immediately prior to performing live software upgrade (LSWU) or a
manual CNS switchover, perform the following steps:
1. Manually run the CNA redundant data path test on all groups
2. Examine the test results
3. Manually disable the test while LSWU is running
4. Re-enable the test when LSWU completes.
The CNA test is temporarily disabled for the applicable redundancy groups while a standby CNS
is active in any redundancy group for a given class or if the redundancy group is disabled. Also, a
CNA test will not start during LSWU. A card will not be tested if the card is not in a redundant
group or the card is OutOfService
Test Results
Actions based on the CNA redundant data path test results are as follows:
Success: DEBUG/INFORMATIONAL event is logged.
Failure: SYSTEM/CRITICAL event is logged and an SNMP trap is generated. If this occurs,
contact Sonus Support for further investigation.
The results for the most recent test are available via the SHOW REDUNDANCY GROUP command.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
CAUTION
The CNATEST commands should only be applied to CNS30, CNS31, CNS40, CNS45,
CNS60, CNS80, CNS81, CNS85, CNS86, and CNS71 redundancy groups on
GSX9000 switches. Unpredictable results could occur if you direct this command
to any other redundancy groups.
Command Syntax
NOTE
In the syntax that follows, omit CLIENT SLOT for 1:1 redundancy groups and
NORMAL in all cases. All permutations are shown in the syntax.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Command Parameters
Field
Parameter Length Description
rgroupname 1-23 The automatically assigned (and possibly changed) name of this
redundancy group. See the beginning of this section for the
structure of the default name.
slotnumber N/A The slot number occupied by the client or redundant server module.
For MNS hardware modules, this number must be 1 or 2. For all
other modules, this number must be 3-16.
Note: This parameter does not apply to GSX4000 series switches.
timeout N/A When the FALLBACK method is REVERTIVE, the timeout is the
number of minutes that the client must be recovered before it will
undergo an automatic switchover to active mode. Must be 5-12
minutes. This value must be entered at configuration time. No
default is provided. If FALLBACK is NONREVERTIVE, this parameter
value is meaningless.
autodetect N/A Specifies whether the clients for a redundancy group will be
automatically detected and assigned:
• enabled - all server modules that are of identical type to the
redundant slot module are assigned as clients to the redundancy
group; types are limited to CNS redundancy groups. (The MNS
module redundancy group is automatically created and
configured, regardless of this parameter setting.)
• disabled (default) - all clients must be manually assigned to the
redundancy group.
healthcheck N/A Specifies whether the redundant server module will poll its clients to
proactively discover failures:
• enabled (default) - polling will be performed
• disabled - polling will not be performed.
newrgname 1-23 A new name for the redundancy group. The redundancy group must
be disabled to perform this operation, and once performed, the old
name will no longer be recognized by the GSX software.
admin-state N/A The administrative state of the redundancy group:
• enabled - Synchronization and mirroring between the clients
and the redundant module is active.
• disabled (default) - Synchronization and mirroring is not in
effect between the clients and the redundant module.
Note that CNS and PNS redundancy groups may only be disabled if
the redundant server module is not active. If it is active, a revert
must be performed first (even if it is a forced revert).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Command Example
To direct an immediate switchover that uses the standby MNS11 module as the new active:
% CONFIGURE REDUNDANCY GROUP MNS11-1 SWITCHOVER NORMAL
------------------------------------------------------
REDUNDANCY GROUP STATUS
------------------------------------------------------
Name: MNS11-1
Shelf: 1
Hardware Type, Function: MNS11, MGMT
Redundant Slot: 2
Redundant Slot State: STANDBY
Number of Synced Clients: 1
Protected Slot: 0
Last Switchover Reason: NONE
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
------------------------------------------------------
REDUNDANCY GROUP CONFIGURATION
------------------------------------------------------
Name: MNS11-1
Shelf: 1
Redundant Slot: 2
Hardware Type, Function: MNS11, MGMT
Fallback Control: NONREVERTIVE
Wait to Revert Time (Minutes): 5
Auto Detect Control: DISABLED
Healthcheck Control: ENABLED
State: ENABLED
Client Client
Slot State
-------- ---------
1 ENABLED
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Redundancy Client
This object allows you to specify a GSX server module that will be replaced by the redundant
server module in the redundancy group if this server module should fail.
NOTE
GSX4000 series switches do not support the REDUNDANCY CLIENT object group.
In 1:1 redundancy models, only one redundancy client may be assigned per redundancy group.
The 1:1 redundancy model is used by MNS modules on the GSX9000 and GNS modules on the
GSX4000. In N:1 redundancy models, N redundancy clients may be assigned (N equal or greater
than 1). The N:1 redundancy model is used by PNS10, PNS30, PNS40, SPS70, SPS80, and all
CNS modules.
In general, only like server modules may exist within a redundancy group. There are several
exceptions:
• A CNS30 redundancy group may contain CNS30 and/or CNS31 redundancy clients. That is, a
CNS30 may backup CNS30s and CNS31s. A CNS31, however, may not backup a CNS30.
Therefore a CNS31 redundancy group may only contain CNS31 redundancy clients.
• A CNS45 redundancy group may contain CNS40 and/or CNS45 redundancy cients (a CNS45
may backup CNS40s and CNS45s). A CNS40, however, may not backup a CNS45. Therefore
a CNS40 redundancy group may only contain CNS40 redundancy clients.
• A CNS85 redundancy group may contain CNS80 and/or CNS85 redundancy cients (a CNS85
may backup CNS80s and CNS85s). A CNS80, however, may not backup a CNS85. Therefore
a CNS80 redundancy group may only contain CNS80 redundancy clients.
• A CNS86 redundancy group may contain CNS86 and/or CNS81 redundancy cients (a CNS86
may backup CNS81s and CNS86s). A CNS81, however, may not backup a CNS86. Therefore
a CNS81 redundancy group may only contain CNS81 redundancy clients.
A redundant module starts out in standby mode backing up one or more clients. On the first
switchover, the redundant module becomes active and the client enters standby state. As
switchovers (possibly) continue, a client may transition from active to standby or from standby to
active. In either case, a client remains a client and a redundant module remains a redundant module
before and after the event.
By default, MNS modules are assigned to the redundancy groups MNS10-1, MNS11-1, or MNS20-
1 which are created and enabled when the GSX is booted. The MNS in slot 2 is the redundant
module and the MNS in slot 1 is the redundancy client in this group.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Command Syntax
Command Parameters
Field
Parameter Length Description
rgroupname 1-23 The automatically assigned (and possibly changed) name of this
redundancy group. See the beginning of this section for the
structure of the default name.
slotnumber N/A The slot number occupied by the client module. For MNS hardware
modules, this number must be 1 or 2. For all other modules, this
number must be 3-16.
admin-state N/A The administrative state of the client:
• enabled - Synchronization is in effect between this server
module and the redundant server module; the client may not be
deleted from the redundancy group.
• disabled (default) - Synchronization is not in effect between
this server module and the redundant server module; the client
may be deleted from the redundancy group.
Note that the redundancy group must be disabled in order to disable
a redundancy client within it.
Command Example
To add a pair of CNS10 clients in slots 4 and 5 to the redundancy group cns10-1:
% CREATE REDUNDANCY CLIENT GROUP cns10-1 SLOT 4
% CREATE REDUNDANCY CLIENT GROUP cns10-1 SLOT 5
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
This object allows you to assign redundancy groups to individual MNA and PNA port on the
GSX9000 and GNA ports on GSX4000 series switches rather than to the controlling PNS/MNS/
GNS module. For GNS modules, the port redundancy group GNS-PACKET-PORT-1 is
automatically generated. For PNS modules, the port redundancy groups are automatically
generated by each respective CREATE SERVER .. PNS .. FUNCTION normal command.
The default name of the port redundancy group is modname-PACKET-PORT-slot where modname
is the full server module name and slot is the slot number. You may change these default names
via the CONFIGURE .. NAME command.
NOTE
Currently port redundancy groups are restricted to PNS and GNS modules, and
only one group per module is permitted.
On a GSX9000, the type of PNS redundancy, layer2 or layer3, is established in the CREATE
SERVER .. command and preserved when the port redundancy group is automatically generated.
On a GSX4000 series switch, the port redundancy group is initially configured as layer2. You may
change the redundancy type for both switch types via the CONFIGURE .. LAYER command,
however you must disable the underlying NIF before doing so.
Command Syntax
NOTE
When issuing PORT REDUNDANCY GROUP commands on a GSX4000 series switch,
omit the SHELF parameter.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Command Parameters
Field
Parameter Length Description
predgroup 1-23 The automatically assigned (and possibly changed) name of this
port redundancy group. See the beginning of this section for the
structure of the default name.
shelf N/A The shelf number in the GSX node configuration. In this release,
one shelf is supported. Must be 1.
Note: This parameter does not apply to GSX4000 series switches.
slot N/A The slot number occupied by the client module. For MNS AND GNS
hardware modules, this number must be 1 or 2. For PNS modules,
this number must be 3-16.
layer N/A Specifies the Ethernet redundancy model that will be used for PNS
or GNS port redundancy groups:
• enetLayer2 (default) - Layer 2 redundancy, requiring a
separate Ethernet switch for each PNS/PNA or GNS/GNA pair in
the redundancy group.
• enetLayer3 - Layer 3 redundancy, requiring the PNS/PNA or
GNS/GNA pairs to be directly connected to neighbor routers, and
utilizing the OSPF interface.
newname 1-23 A new name for the port redundancy group. After performing this
command, the old name will no longer be recognized by the GSX
software.
pnumber N/A The number of a port to be added or removed from a port
redundancy group.
Command Example
To display the configuration of all automatically generated PNS port redundancy groups:
% SHOW PORT REDUNDANCY GROUP ALL ADMIN
Node: TPUBS Date: 2004/09/25 01:09:21 GMT
Zone: GMTMINUS05-EASTERN-US
---------------------------------------
NRS PORT REDUNDANCY GROUP Configuration
---------------------------------------
Index Name Shelf Slot Layer
===== ====================== ====== ====== =============
1 PNS10-PACKET-PORT-3 1 3 ENETLAYER2
2 PNS10-PACKET-PORT-4 1 4 ENETLAYER2
3 PNS30-PACKET-PORT-6 1 6 ENETLAYER2
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
• Configure the Non-Volatile Storage parameters without accessing the GSX firmware.
• Modify the node’s Binary Parameter Mode, to control the loading of the binary parameter file
when the GSX is booted.
• Force updating and synchronizing of the parameter file copies on the NFS (DSI Level 0)
servers.
On GSX9000 switches with redundant MNS modules, and GSX4000 series switches with
redundant GNS modules, the SHOW and CONFIGURE commands to this object are performed by the
active MNS or GNS module. Any changes from these commands are copied to the standby
module, keeping it synchronized with the active module.
CONFIGURE .. CHECK verifies that both NFS (DSI Level 0) servers have an up-to-date parameter
file. If not, then a save is initiated to bring them up-to-date. CONFIGURE .. FLUSH flushes (or
forces) any pending parameter save requests brought about by configuration changes on the GSX.
HOLDOFF_TIME specifies the standard delay between GSX configuration changes and updating of
the parameter files on the NFS (DSI Level 0) servers.
Command Syntax
NOTE
When issuing NVS commands on a GSX4000 series switch, omit the SHELF
parameter.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Command Parameters
NOTE
Sonus recommends that you do not configure the CORE DUMP parameter settings
except as advised by authorized Sonus personnel.
Field
Parameter Length Description
shelfnumber N/A The shelf number in the GSX node configuration. In this release, one
shelf is supported. Must be 1.
Note: This parameter does not apply to GSX4000 series switches.
filelimit N/A The maximum number of core dump files that can be on behalf of a
server which is requesting a core dump. A value of zero specifies no
limit. Must be 0-255, default is 6.
This applies to every server module in the shelf.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Field
Parameter Length Description
parameter- N/A The status of Binary Parameter File loading on a reboot:
mode
• disabled - Prevents the GSX from loading the Binary Parameter
File when it is booted, whether or not the file exists. The NVS CLI
Startup Script File (named by default sysinit.tcl) will be run if
it is present in the BOOT/cli/sys directory of the system tree.
• binaryFile - Forces the loading of the Binary Parameter File
when the GSX is booted. The NVS CLI Startup Script File will not
be run. The Binary Parameter File is selected from BOOT/param
as follows:
(1). file with .prm extension - first choice
(2). file with .bck extension - second choice
(3). no file with .prm or .bck extension - third choice - no file is
loaded and the default value is installed for every
parameter.
In each case, if the file with that extension doesn’t exist or can’t
be opened then the next file in the list is tried. Whenever any
configuration change occurs, a new version of the Binary
Parameter File is written with a .prm extension and the old
.prm file is renamed with a .bck extension.
• defaults - Prevents the GSX from loading the Binary Parameter
File, just like the disabled setting. However, on the first
successful configuration change that is effected, the GSX will
automatically change this setting to binaryFile, and the Binary
Parameter File will be loaded when the GSX next boots. This is
the recommended setting before any configuration takes place
and hence the default.
password 1-23 NVS password.
Important: The NVS Password is necessary to access the firmware
menu subsystem when you boot the GSX. You may change this
password using the CONFIGURE NODE NVS command or through
the NVS Configuration Menus. IF YOU FORGET THIS PASSWORD
you cannot access the firmware menu subsystem and you may have
to return your MNS module to Sonus to recover.
bootdisk N/A Specifies the storage location of the boot file:
• localDisk - the boot file are stored on the local disk
• nfsServer - the boot files are stored on the NFS (DSI Level 0)
Server.
Note: This parameter only applies to GSX switches with local disks
on Management Server Modules.
core-state N/A The conditions under which core is dumped in the specified module:
• disabled - Core dumps will not be taken if there is a program
failure in the module.
• enabled - Core dumps of type severity will be taken if there is
a program failure in the module.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Field
Parameter Length Description
coredisk N/A Specifies the location of the core dump files:
• localDisk - core dumps will be written to the local disk
• nfsServer - core dumps will be written to the NFS (DSI Level 0)
server.
Note: This parameter only applies to GSX switches with local disks
on Management Server Modules.
severity N/A The severity of the error causing the core dump:
• normal - Only non-recoverable errors cause a core dump.
• sensitive - Recoverable, but serious errors also cause a core
dump.
xincrpif N/A Specifies the maximum number of incremental PIF files saved per
NFS (DSI Level 0) server. Upon reaching this number of saved
incremental PIF files, the next saved incremental PIF results in the
removal of the oldest currently saved incremental PIF file.
The incremental PIF file is used by Sonus Insight to discover the
changes between two consecutive incremental PIF files.
Must be 0-10, default is 1.
hotime N/A Specifies the time in seconds to delay, before updating the NFS
parameters following a configuration change on the GSX. This delay
is overridden by the FLUSH command. Must be 15-1800, default is
15 (seconds).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Command Example
To display administrative information about the NVS parameter values in this module:
% SHOW NODE NVS SHELF 1 ADMIN
Node: TPUBS Date: 2004/08/26 19:03:14 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
CAUTION
The NVS Password is necessary to access the firmware menu subsystem when
you boot the GSX. You may change this password using the CONFIGURE NODE NVS
command or through the NVS Configuration Menus. IF YOU FORGET THIS
PASSWORD you cannot access the firmware menu subsystem and you may have
to return your MNS module to Sonus to recover.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
NFS Parameters
This object allows you to configure the GSX file system that is provided by the redundant NFS
(DSI Level 0) servers.
GSX4000 series switches are equipped with a local CompactFlash card (referred to as the “Local
Disk”) which can be utilized as a mass storage device. You can use either the local disk or a
Network File System (NFS)/DSI Level 0 server for storage of the GSX File System or a
combination of both. See "Local Disk" on page 3–34 for more information.
The WRITE-ENABLE keywords may be necessary after an NFS (DSI Level 0) server exceeds a
quota. Use this command to restore the GSX file system after freeing up disk space on the server.
Command Syntax
NOTE
When issuing NFS commands on a GSX4000 series switch, omit the SHELF
parameter.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Command Parameters
Field
Parameter Length Description
shelfnumber N/A The shelf number in the GSX node configuration. In this release,
one shelf is supported. Must be 1.
Note: This parameter does not apply to GSX4000 series switches.
slotnumber N/A The slot number occupied by the MNS or GNS module being
accessed by this command. Must be 1 or 2.
ipaddress N/A The 32-bit IP address of the NFS (DSI Level 0) server specified in
dotted decimal form (for example 128.127.50.224).
mountpoint 2-31 The NFS mount path.
loadpath 2-31 The path of the subdirectory under the mount-point that contains
the GSX system tree. Changing this parameter value allows you to
reboot your GSX from an entirely new system tree.
softwpath 0-15 The name of the software load path. This path is appended to the
Load Path and may be NULL, in which case the software is loaded
directly from the Load Path.
This parameter allows multiple revisions of software to be
maintained below the Load Path and can be overridden by the
Upgrade Path during a Live Software Upgrade (LSWU). During
general operation the complete software load path is formed by
concatenating this object to the Load Path and any applicable file
system mount point.
unixuid N/A The user ID of the UNIX login account the GSX uses for NFS file
operations, default 1036.
unixgid N/A The group ID of the UNIX login account the GSX uses for NFS file
operations, default 101.
revtimeout N/A When the FALLBACK method is REVERTIVE, the timeout is the
number of minutes that the NFS must be recovered before it will
undergo an automatic switchover to active mode. Must be 5-12
minutes. This value must be entered at configuration time. No
default is provided. If FALLBACK is NONREVERTIVE, this
parameter value is meaningless.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Command Example
To “point” the NFS to a new GSX System Tree anchored at subdirectory testtree:
% CONFIGURE NFS SHELF 1 SLOT 1 LOAD PATH testtree
Shelf: 1
UNIX User ID: 1036 Load Path: CORDOBA
UNIX Group ID: 101 Software Path:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
NTP Server
This object specifies a Network Time Protocol server that will supply local time to the GSX. Up to
3 of these objects (servers) can be created. The reference times delivered by NTP are the source of
all time stamps placed into the Accounting Records (see "Call Accounting" on page 7–1 and
following).
Command Syntax
Command Parameters
Field
Parameter Length Description
servername 1-23 A unique name that specifies which server is being addressed.
ipaddress N/A The 32-bit IP address of the server specified in dotted decimal
form (for example 128.127.50.224).
client-type N/A The mode used by the server to provide time:
• poll (default) - The client polls the server.
• broadcast - The server broadcasts to clients.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Field
Parameter Length Description
vnumber N/A The NTP version number that is supported by the client (GSX).
Must be 1-3, default is 3. This must agree with the version of the
remote NTP server.
On GSX4000 series switches, the NTP version number must be
one of the following:
• version3
• version4
mnnumber N/A The minimum polling interval in (power of 2) seconds for the poll
client-type. This range of 1-63 allows an interval between 21
and 263 to be specified. The default value of 3 specifes and
interval of 23 or 8 seconds.
mxnumber N/A The maximum polling interval in (power of 2) seconds for the poll
client-type. This range of 1-63 allows an interval between 21
and 263 to be specified. The default value of 10 specifes and
interval of 210 or 1024 seconds.
admin-state N/A The administrative state of the NTP server:
• disabled (default) - Server is not activated.
• enabled - Server is activated.
Table 3–20 lists the fields displayed by the SHOW NTP .. commands.
Field Description
Server Name of the configured NTP server.
Shelf GSX shelf index (always 1).
(STATUS) Status of the connection between the GSX and the NTP server.
State
• INSYNC - The GSX is receiving valid messages from an NTP server
recognized as a trusted timing source, and the GSX can choose this as its
Active NTP server in order to adjust its timing. This does not indicate that the
time on the GSX is exactly the time on the INSYNC NTP source.
• OUTOFSYNC - The link is active between the GSX and the NTP server and the
GSX is currently slewing to becoming INSYNC with the NTP server. The delay
to complete this transition could be lengthy.
Stratum Integer in the range 1-16 that defines the precision of the derived timing source
within the network (where 1 is the highest precision). Increasing the distance
(physical distance, network hops, etc.) between a node utilizing network timing
and the stratum source of level x, inherently introduces timing-related errors,
thereby increasing the stratum level (lowering the timing precision) at that node.
Reference The time given to the GSX in the last valid NTP server update packet.
Time
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Field Description
IpAddressl IP address of the specified NTP server.
Client The mode used by the server to provide time:
• POLL - the GSX will poll the NTP server and update it's NTP protocol upon
receiving solicited responses from the NTP server.
• BROADCAST - the NTP server will send NTP protocol updates automatically
and the GSX will process it's NTP state based on those unsolicited messages.
Version The version of NTP that is in use. The operator must configure this correctly to
agree with the version of the remote NTP server.
MinPoll The minimum polling interval in (power of 2) seconds for the poll client-
type. This range is 1-63, resulting in an interval between 21 and 263 seconds.
MaxPoll The maximum polling interval in (power of 2) seconds for the poll client-
type. This range is 1-63, resulting in an interval between 21 and 263 seconds.
(ADMIN) State The administrative state of the specified NTP server:
• disabled - Server is not activated.
• enabled - Server is activated.
Current Time The current system time.
Server The last time sent to the GSX in a valid packet from the specified NTP server (or
Reference the last time sent from the NTP server).-
Time
Server Last The time at which the last valid update packet was received from the specified
Update NTP server (or the GSX time when the last time was sent from the NTP server).
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
To display the NTP server time and the GSX system time:
% SHOW NTP TIME
Node: TPUBS Date: 2003/01/07 18:15:33 GMT
Zone: GMTMINUS05-EASTERN-US
Shelf Current Time Server Ref Time Server Last Update Server
----- ---------------- ------------------- ------------------- ---------
1 2003/01/07 18:15:33 2003/01/07 18:11:15 2003/01/07 18:11:15 granite
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Management Client
This object defines an SNMP network management station that may send SNMP requests to and/
or receive SNMP trap messages from the GSX. SNMP traps are messages that notify a
management client that an event has occurred on the GSX node.
The GSX supports SNMP versions SNMPv1 and SNMPv2. The GSX supports three types of
SNMP trap messages:
1. SNMPv1 Trap
2. SNMPv2 Trap
3. SNMPv2 InformRequest
SNMPv1 Trap and SNMPv2 Trap messages are functionally equivalent, but have different
message formats. SNMPv2 Trap and SNMPv2 InformRequest messages have the same message
format, but the latter requires that the management client send a SNMPv2 Response message to
the GSX as an acknowledgement when it receives the SNMPv2 InformRequest message.
The INFORM parameters provide guaranteed trap delivery. This feature ensures that SNMP trap
messages are received by the management client through the use of SNMPv2 InformRequest and
Response messages. If the GSX does not receive a SNMPv2 Response message within a specified
timeout interval, the GSX will re-send the SNMPv2 InformRequest message. This procedure will
be repeated until a SNMPv2 Response message is received, or until the retry count has been
reached. This feature requires that trap-type be inform.
In general any event that results in an SNMP trap message is also logged in an event log (see
"Event Log" on page 3–90) but only a small subset of events generate an SNMP trap message. See
the GSX9000 and GSX4000 Open Services Switch Alarm and Event Troubleshooting Guide, for a
list of all GSX traps and the full MIB name of the trap.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Command Parameters
Field
Parameter Length Description
client 1-23 The name that you are assigning to this network management
station (client).
ipaddress N/A The 32-bit IP address of this network management station
specified in dotted decimal form (for example 128.127.50.224).
Default is 0x01010101.
access N/A A second level of authentication that identifies access privileges
for this management client.
• readOnly (default) - Read only.
• readWrite - Read and write of all management objects except
those restricted to admin access.
• admin - Full administrative privileges to all management
objects.
This entry controls access to MIB objects on a per client basis. All
SNMP requests must first pass the community string
authentication (see the following parameters), then this access
privilege verification.
gcommunity 1-23 A first level authentication mechanism. This string must be
presented by this management client for SNMP get, get-next,
and get-bulk requests. Default value is public. If an invalid
string is presented with the SNMP request, the GSX will drop the
request and no response will be sent.
scommunity 1-23 A first level authentication mechanism. This string must be
presented by this management client for SNMP set, get, get-
next, and get-bulk requests. Default value is private. If an
invalid string is presented with the SNMP request, the GSX will
drop the request and no response will be sent.
tcommunity 1-23 The password that must be presented by the GSX when sending
SNMP trap messages to this management client. Default value is
public. If an invalid string is presented by the GSX, the SNMP
trap message will be ignored by the management client.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Field
Parameter Length Description
timeout N/A The InformRequest message timeout time in seconds. If a
Response message is not received in this interval from a
management client to which an InformRequest message was sent,
a timeout has occurred from the GSX perspective. Must be 1-30,
default is 6 (seconds).
This parameter applies only to trap-type inform.
At least two digits must be entered, for example “05”.
retries N/A The InformRequest message retry count. If a timeout (see above)
occurs after sending an InformRequest message, subsequent
attempts are made until this count is reached. The timeout interval
is doubled on each retry. The retry value must be 0-10, default is
3.
This parameter applies only to trap-type inform.
Two digits must be entered, for example “05”.
queuesize N/A The maximum number of InformRequest message entries that
may simultaneously await Response messages from this
management client. When this number of InformRequest
messages are outstanding, subsequent InformRequest messages
are discarded (and a corresponding event is written to the system
event log). Increasing this number may increase the GSX memory
consumed as well as the CPU time required to process the
InformRequest messages. Must be 1-100, default is 50.
This parameter applies only to trap-type inform.
trap-state N/A A flag that allows this network management station to receive
SNMP trap messages:
• disabled (default) - Ineligible to receive traps.
• enabled - Eligible to receive traps.
trap-port N/A The port number of the management client to which trap/
notification messages are sent. Must be 0-65535, default is 162.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Field
Parameter Length Description
trap-type N/A A global notification directive on behalf of this management client.
Every trap will generate a notification with the following message
type to this management client:
• trapv1 - (SNMPv1 Trap message).
• trapv2 (default) - (SNMPv2 Trap message).
• inform - (SNMPv2 InformRequest message).
• none - Do not enable all traps for this management client. You
may nevertheless configure individual notifications to generate
Trap messages.
Note that setting this parameter to any value other than none is
equivalent to creating separate notifications for each trap for this
management client.
admin-state N/A The administrative state of the network management station:
• disabled (default) - In this state the configuration of this
management client can be changed. The object may be
deleted. SNMP requests from this management client are
ignored.
• enabled - In this state you cannot change the configuration of
this management client. SNMP requests from this management
client are authenticated and executed.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Command Example
To register and configure a network management station that uses default authentication
parameters:
% CREATE MGMT CLIENT granite IPADDRESS 128.1.1.1
% CONFIGURE MGMT CLIENT granite ACCESS readWrite
% CONFIGURE MGMT CLIENT granite STATE enabled
To prevent trap messages from being delivered to this network management station:
% CONFIGURE MGMT CLIENT granite STATE disabled
% CONFIGURE MGMT CLIENT granite TRAP STATE disabled
% CONFIGURE MGMT CLIENT granite STATE enabled
You may use this mechanism, for example, when your network management station is undergoing
an upgrade and temporarily should not receive trap messages.
To display the administrative summary of network management stations registered with this GSX:
% SHOW MGMT CLIENT SUMMARY
Node: TPUBS Date: 1999/06/16 21:05:21 GMT
Zone: GMTMINUS05-EASTERN-US
To configure a guaranteed trap delivery facility with a 5 second timeout, 3 retries, and 50 queue
entries:
% CONFIGURE MGMT CLIENT slate INFORM TIMEOUT 5
% CONFIGURE MGMT CLIENT slate INFORM RETRIES 3
% CONFIGURE MGMT CLIENT slate INFORM QUEUE 50
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Name: slate
State: ENABLED
IP Address: 10.6.254.249
Access: ADMIN
Get Community: public
Set Community: private
Trap Community: public
Trap State: ENABLED
Trap Port: 162
All Traps: TRAPV2
Inform Timeout: 5
Inform Retries: 3
Inform Queue: 50
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Trap
• A list of the traps supported by the GSX. These traps are created at system initialization time,
without CLI control.
• A means of enabling and disabling specific traps at the GSX.
You may use this mechanism to disable specific traps while you reconfigure the GSX, reenabling
them when you’re done. For example, you may cause the generation of trap messages as a result of
temporarily detaching cables but not wish to see them at any SNMP network management station.
For a list of all possible traps, use the SHOW TRAP SUMMARY command.
Command Syntax
Command Parameters
Field
Parameter Length Description
trap 1-23 The name of the trap.
admin-state N/A The administrative state of this trap:
• disabled (default) - Off. In this state the trap message is not
sent to a management client.
• enabled - On. In this state the trap message will be sent to all
properly registered and authenticated management clients.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Command Example
Name: shelfFanTrayFailure
MIB Name: sonusNodeShelfFanTrayFailureNotification
OID: 1.3.6.1.4.1.2879.2.1.1.2.0.5
Class: SYSMGMT
Level: MAJOR
State: ENABLED
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Notification
This object defines which management clients receive which traps. A notification associates a
single trap with a management client. By creating multiple notifications you may notify one
management client of multiple traps. Similarly, you may notify multiple management clients of
one trap.
Command Syntax
Command Parameters
Field
Parameter Length Description
notification 1-23 The name that you are assigning to this notification.
client 1-23 The name of the network management station that will receive
the trap. This network management station must be defined in
the Management Client table (see "Management Client" on
page 3–75).
trap 1-23 The name of the trap. This trap must be defined in the Trap table
(see "Trap" on page 3–81).
trap-type N/A The type of trap messages for this management client:
• trapv1 - (SNMPv1 Trap message).
• trapv2 - (SNMPv2 Trap message).
• inform - (SNMPv2 InformRequest message). Required for
guaranteed trap delivery, see "Management Client" on
page 3–75.
• none - Do not enable all traps for this management client.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Command Example
To create a notification named example1 that assigns one trap, shelfFanTrayFailure, to the
network management station slate:
% CREATE NOTIFICATION example1 MGMT CLIENT slate ..
TRAP shelffantrayfailure
To display a summary of network management stations and the traps that they have registered to
receive:
% SHOW NOTIFICATION SUMMARY
Node: None Date: 1999/06/17 18:18:02 GMT
Zone: GMTMINUS05-EASTERN-US
Name: EXAMPLE1
Mgmt Client Name: SLATE
Trap Name: SHELFFANTRAYFAILURE
Type: TRAPV2
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Alarm Contacts
On the GSX9000, there are 5 outbound physical alarm relay contacts and 5 inbound current
sensing contacts located on the MNA. On GSX4000 series switches, there are 6 outbound alarm
contacts and 4 inbound alarm contacts. See the GSX9000 Installation and Upgrade Guide or the
Hardware, Installation, and Upgrade Guide for your GSX4000 series switch or additional
hardware related details.
The state of the outbound alarm contacts is maintained by both MNS modules on the GSX9000 or
both GNS modules on GSX4000 series switches. Outbound contacts are only set by the active
MNS or GNS module. Inbound contact state information will be maintained on the active MNS or
GNS module.
These contacts are meaningful only if they are connected to an environmental indicator such as a
light. Each outbound alarm contact is assigned the following fixed priority:
Contacts 2, 3, and 4 are configured to indicate system events generated by SNMP trap.
Information regarding these alarm conditions is recorded in the Event Logs. The status of User
Configured alarms is available to the user via the SHOW CONTACTS commands.
At system startup, each outbound alarm is set to indicate a no alarm condition and is immediately
available. However, during the boot process, many traps are generated and will cause alarm
contacts to be set. To prevent unnecessary alarm activity, the alarm contacts are temporarily
disabled during system reboot. The CONFIGURE CONTACTS .. START_DELAY command allows
the user to reconfigure the timer. The timer may be reset during the boot process, but this must
occur before the existing start delay has expired. If the timer is reset before the start delay has
expired, the new value will take effect by increasing or decreasing the amount of time to the
enabling of the alarms. After the start delay has expired, the timer may be set to a different value,
however, the new start delay takes effect the next time the shelf boots. Once the timer has expired,
new alarm events will cause the contacts to transition states. Alarm contacts 1-4 may be reset to
their default state via the CONFIGURE CONTACTS commands.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
The inbound alarm contacts are intended for connecting to external alarm sources such as fire,
smoke, door, etc. They do not have a GSX internal alarm level or significance associated with
them. However, all inbound alarms generate an SNMP trap. The trap indicates shelf, relay, and
current state of the contact.
You can use the SHOW CONTACTS IN command for obtaining the status on the inbound contacts.
You use the CUTOFF keyword to set the specified outbound relay to its alarm clear state, relative to
the relay 'sense' setting. This allows the customer to disable an alarm after it has been set by some
system event.
CUTOFF is a one-time event each time it is used, and does not inhibit future additional alarms on
that relay from occurring.
To permanently disable the an alarm contact, its state must be set to disabled. The CUTOFF
keyword is intended to leave the alarm able to respond to the next event, while quieting its output.
NOTE
Alarm Relays DO NOT automatically clear, and must be cleared manually with the
CUTOFF feature.
NOTE
When issuing alarm CONTACTS commands on a GSX4000 series switch, omit the
SHELF parameter.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Command Parameters
Field
Parameter Length Description
shelf-number N/A The shelf number in the GSX node configuration. Must be 1.
Note: This parameter does not apply to GSX4000 series
switches.
relay-number N/A For GSX9000 switches, the outbound contact number.
For GSX4000 series switches, one of the following:
• shelfpwr-1
• critical-2
• major-3
• minor-4
• user-5
• user-6
state N/A Outbound alarm contacts (except for alarm contact 1) may be in
the following states:
• enabled - Available for immediate use. Trap events will set
the alarm contact.
• disabled -Not Activated.Trap events will not cause the alarm
contact to be set.
value N/A The following values are valid for User Configured alarms only:
• clear - manually clear the alarm.
• alarm - manually set the alarm.
sense N/A This parameter indicates whether an open contact is an alarm or
clear (no alarm) condition. Outbound alarm contacts 2-6 default
state may be configured:
• normal - an open contact indicates a clear (no alarm)
condition.
• inverted - an open contact indicates an alarm condition.
The ADMIN command must be used to verify the sense of each
contact.
start_delay N/A During shelf startup, the outbound contact remains in the alarm
clear state until the time period has expired. Default for contacts
1-4 is 120 seconds. start_delay for User Configured is
permanently set to 0.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Restrictions:
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Alarm-In
Shelf Contact Status
1 1 OPEN
1 2 CLOSED
1 3 OPEN
1 4 OPEN
1 5 OPEN
Reconfigure the outbound contacts. All outbound contact alarms are managed with the CONFIG
CONTACTS commands. Contact 2 requires inverted logic to set an external alarm. Also, minor
alarms are to be ignored.
% CONFIGURE CONTACTS OUT SHELF 1 RELAY 2 SENSE inverted
% CONFIGURE CONTACTS OUT SHELF 1 RELAY 2 STATE enabled
% CONFIGURE CONTACTS OUT SHELF 1 RELAY 3 STATE enabled
% CONFIGURE CONTACTS OUT SHELF 1 RELAY 4 STATE disabled
Using the ADMIN command, note the sense and state of the contacts.
% SHOW CONTACTS OUT SHELF 1 ADMIN
Node: TPUBS Date: 2000/08/25 20:57:24 GMT
Zone: GMTMINUS05-EASTERN-US
Change the alarm delay during shelf startup for the next reboot.
% CONFIGURE CONTACTS OUT SHELF 1 RELAY 2 START_DELAY 180
% CONFIGURE CONTACTS OUT SHELF 1 RELAY 3 START_DELAY 180
% CONFIGURE CONTACTS OUT SHELF 1 RELAY 4 START_DELAY 180
Return the currently set outbound alarm 2 to its default state. Subsequent critical alarms will set
the contact.
% CONFIGURE CONTACTS OUT SHELF 1 RELAY 2 CUTOFF
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Event Log
This object allows you to create and configure log files that capture system, debug, trace, and
accounting events. See "Event Monitoring" on page 6–40 for additional detail on this facility.
The ROLLFILE facility provides a means of closing the active log file and opening a new one with
an incremented (name) suffix. This facilitates real-time analysis of system events by performing
the analysis on closed, rather than opened and growing, files. See "Sequence Number in File
Name" on page 6–42 for additional filename detail.
Command Syntax
NOTE
When issuing SHOW EVENT LOG and SHOW EVENT MEMORY SHELF commands on
a GSX4000 series switch, omit the SHELF parameter.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Command Parameters
Field
Parameter Length Description
event-type N/A The type of event log being configured:
• debug - system debugging data. These files have .DBG
extensions.
• system - system level events. These files have .SYS
extensions.
• trace - system trace data. These files have .TRC
extensions.
• acct - system accounting data. These files have .ACT
extensions.
The keyword ALL imposes the subsequent parameter values on
the event log of every event type.
numfiles N/A The number of log files that will be maintained for this event
type. Must be 1-1000, default is 512 for accounting, 32 for all
others.
Note: This parameter does not apply to stream-based logging.
filesize N/A The maximum size that one log file for this event type can
become, in KB. Must be 256-65535, default is 2048, except for
accounting which is 32768.
Note: This parameter does not apply to stream-based logging.
qmesgno N/A The number of event messages to queue before writing to disk.
Must be 2-32, default is 10. This parameter can be changed
while the event log is enabled. By default, queued messages
are written when 10 events are in the queue or once per
second, whichever comes first.
Sonus recommends setting the number of event messages to
32 for optimize NFS (DSI Level 0) logging performance.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Field
Parameter Length Description
log-dest N/A The location at which to save events for this log type:
• none - no log data is saved.
• disk - log data is written only to disk.
• memory - log data is written only to the internal memory
buffer.
• both (default) - log data is written to disk and to the internal
memory buffer.
If you remove logging to memory (for example by changing this
parameter value from both to disk), all existing memory
events are erased.
membufsize N/A The maximum size of the memory event log buffer in KB. Must
be 1-64, default is 16.
filter-level N/A The minimum severity that warrants the logging of an event of
this type:
• noevents - do not log any events.
• critical - log only events of this threshold.
• major - log major and critical events only.
• minor - log all events other than info.
• info - log every possible event.
This parameter should always be set to major under normal
operating conditions.
Note: This parameter does not apply to stream-based logging.
write-mode N/A Specifies the event log write mode for NFS (DSI Level 0)-based
logging.
• default - log data is written to the NFS/DSI as a 1344-byte
packet.
• optimize - log data is written to NFS/DSI as a 8000-byte
packet. Optimize write mode results in IP fragmentation but
yields better throughput.
Note: This parameter does not apply to stream-based logging.
admin-state N/A The administrative state of event logging for this event type:
• disabled - Logging is not activated. Note that accounting
logs may never be disabled.
• enabled (default) - Logging is activated.
shelfnumber N/A The shelf number in the GSX node configuration. In this release,
one shelf is supported. Must be 1.
Note: This parameter does not apply to GSX4000 series
switches.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Field
Parameter Length Description
event-range N/A The set of log entries in MNS module memory that you wish to
view. Must be greater than 0. Entries are numbered according
to their position in the memory buffer rather than by age. You
must use the time stamps to determine age.
All CLI ranges specify a comma-separated list of numbers and/
or ranges. A range consists of two numbers separated by a
dash, for example, 5-8. An increment can be specified after a
range with the notation, +<incr>, for example 4-10+2. No
spaces are permitted in the expression. All values and ranges
must be in numerically ascending order. Thus the expression:
1,3,5,8-12+2,14-16
is a valid range specification for the numbers:
1,3,5,8,10,12,14,15, and 16.
hh N/A The hour (on a 24 hour clock) at which to initiate a ROLLFILE,
or the number of hours in the interval between rollovers. Must
be in the range 0-23.
mm N/A The minute (in an hour) at which to initiate a ROLLFILE, or the
number of minutes in the interval between rollovers. Must be in
the range 0-59.
type N/A Specifies whether the ROLLFILE that is being set up in this
command designates a single instance or an interval between
repetitions of the rollover:
• repetitive - the rollover will occur repeatedly at the
specified intervals.
• nonrepetitive - the rollover will occur once at the
specified single instance. Omit the INTERVAL keyword for
this TYPE.
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
An excerpt from a system event log is shown below. The field-by-field analysis of the event
messages in this file is beyond the scope of this guide. Notice, however, that many event messages
end with “(t)”. This indicates that a trap was associated with that event. Similarly, an event
message that ends with “(f)” indicates that a fault was associated with that event.
129 10012003 192641.00064:1.01.MAJOR .RTM : Standby Card In Shelf 1, Slot 2
Has Failed
178 10012003 192643.00006:1.01.Minor .XRM : IP Network Interface Low
Watermark: name ENET-1-3-3, shelf 1, slot 3, port 3, ifIndex 10(t)
177 10012003 192644.00003:1.01.Minor .XRM : IP Network Interface Low
Watermark: name ENET-1-3-2, shelf 1, slot 3, port 2, ifIndex 9(t)
177 10012003 192645.00001:1.01.Minor .XRM : IP Network Interface Low
Watermark: name ENET-1-3-1, shelf 1, slot 3, port 1, ifIndex 8(t)
158 10012003 192810.00007:1.02.Info .NTP : NTP server granite Inservice,
waiting to synchronize, shelf 1 slot 2(t)
133 10012003 192810.00008:1.02.MAJOR .NTP : NTP server granite not in sync,
shelf 1 slot 2
156 10012003 192810.00009:1.02.Info .NTP : NTP server slate Inservice,
waiting to synchronize, shelf 1 slot 2(t)
131 10012003 192810.00010:1.02.MAJOR .NTP : NTP server slate not in sync,
shelf 1 slot 2
148 10012003 192810.00011:1.01.Info .SM : Standby Management Server Module
online in shelf 1 slot 2.(f)
161 10012003 192810.00012:1.02.MAJOR .RTM : Synchronization Requested On Shelf
1, From Standby Slot 2 To Active Slot 1
156 10012003 192810.00081:1.02.Info .TRM : 23 Circuits added to Trunk Group
abacusin, shelf 1, slot 9, port 7(t)
156 10012003 192810.00082:1.02.Info .TRM : 23 Circuits added to Trunk Group
abacusin, shelf 1, slot 9, port 8(t)
156 10012003 192810.00083:1.02.Info .TRM : 23 Circuits added to Trunk Group
abacusin, shelf 1, slot 9, port 9(t)
157 10012003 192810.00084:1.02.Info .TRM : 23 Circuits added to Trunk Group
abacusin, shelf 1, slot 9, port 10(t)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Log Server
The Log Server object allows you to create and configure a Log Server connection to the GSX
when using stream-based logging to the DSI (instead of NFS/DSI Level 0-based logging). Just as
in NFS-based logging, stream-based logging creates log files that capture system, debug, trace,
and accounting files.
For more information on Event Logging for both the NFS/DSI Level 0- and stream-based, see the
section, "Event Monitoring" on page 6–40.
The CREATE LOG SERVER... command creates a unique name and priority for each Log Server
connection established. You can configure the GSX for up to four (4) possible log streaming
destinations; each is assigned a priority from 1 to 4. During log streaming, the GSX selects a Log
Server based on priority and availability; a Log Server is considered available if TCP streams for
both event log and CDR data are established.
After creating a Log Server, use the CONFIGURE LOG SERVER... command to configure the IP
address and set the user name and password for the log server. The user name and password are
also configured at the DSI to ensure proper authentication.
Use the CONFIGURE LOG SERVER ... STATE ENABLED to establish the connection to the Log
Server. The Log Server can be outofservice or inservice when changing its state to
ENABLED. The Log Server must be set to outofservice before changing its state to disabled.
In order for stream-based logging to begin, you must change the logging interface from NFS to
STREAM with the CONFIGURE LOG SERVER DESTINATION STREAM command. The GSX
initiates two links (TCP streams) to each Log Server, one for accounting files and the second for
all other event files. Both links must be in READY state to be considered available to receive log
data.
When you use the CONFIGURE LOG SERVER ... MODE OUTOFSERVICE FORCED, you can take
a Log Server outofservice, even when no standby Log Server is present.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Command Syntax
Field
Parameter Length Description
logserver 1-23 Specifies the Log Server name. Must be 1-23 characters. A Log
Server can be uniquely identified in a Log Server cluster by its
name.
priority N/A Specifies the priority of the Log Server. The GSX selects a Log
Server based on priority and availability (a Log Server is
considered available if TCP streams for both event log and CDR
data are established). Each Log Server has a unique priority.
Must be 1-4; priority “1” is the highest.
IPaddress N/A Specifies the 32-bit IP address of the Log Server specified in
dotted decimal form (for example 128.127.50.224). The default
IP address for the Log Server is 0.0.0.0.
username 1-23 Specifies the user name required to access the Log Server.
Must be 1-23 characters.
password 4-16 Specifies the password required to access the Log Server. Must
be 4-16 characters.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Field
Parameter Length Description
mode N/A Specifies the mode of the Log Server:
• inservice (default) - the Log Server is participating in log
streaming. The Log Server can be outofservice or
inservice when changing its state to enabled.
• outofservice - the Log Server is not participating in log
streaming. The Log Server must be set to outofservice
before changing its state to disabled.
When you use the FORCED control in the command (for example
CONFIGURE LOG SERVER <logserver> MODE
OUTOFSERVICE FORCED), you can take a Log Server
outofservice, even when no standby Log Server is present.
state N/A Establishes the link state from the GSX to the Log Server.
• enabled - enables the connection to the Log Server.
• disabled (default) - closes the connection to the Log Server
(after being enabled). The Log Server must be in the
disabled state before it can be deleted.
destination N/A Specifies the destination for logging:
• nfs (default) - event logs are sent to the NFS (DSI Level 0)
server.
• stream - event logs are sent to a remote Log Server.
slot N/A Specifies the slot number.
Command Examples
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
To show the status of all Log Servers, including the number of CDRs and events that are currently
being logged:
% SHOW LOG SERVER STATUS SUMMARY
Node: TPUBS Date: 2006/06/02 16:09:43 GMT
Zone: GMTMINUS05-EASTERN-US
To show the status of data spooling when a Log Server is or becomes unavailable.
% SHOW LOG STATUS SUMMARY
Node: TPBUS Date: 2006/06/02 20:25:59 GMT
Zone: GMTMINUS05-EASTERN-US
Log Destination: STREAM
Connectivity Errors: 2
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Event Subsystem
The Event Subsystem object lets you specify an INFO-level logging “white list.” You can
selectively turn on one or more INFO/MINOR events that would otherwise be filtered out by a
current Event Filter configuration. Like the Event Filter object, the Event Subsystem object applies
only to Active servers.
You can select whether to log specific subsystem INFO-level events as follows:
• Turn on logging of INFO/MINOR events generated by a selected subsystem of a selected
server module. You can specify an unlimited number of subsystem-server combinations, with
each combination requiring its own configuration command.
• [For Sonus use only] Optionally further limit allowed INFO events to specific event type(s),
to prevent flooding the SYS/DNG log with INFO events from a high-activity subsystem:
• Specify the minimum and maximum event ID range
• Enable one or more factory-specified categories of events to be logged.
NOTE
The Event Log and Event Filter objects control overall GSX event logging and
filtering. If the Event Filter mode is set to OFF, or the Event Filter level is already
set to INFO, then you do not need to use this Event Subsystem object.
Command Syntax
The following CLI commands can be used to display/configure subsystem INFO event logging on
an active server.
NOTE
When issuing EVENT SUBSYSTEM commands on a GSX4000 series switch, omit the
SHELF parameter.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Command Parameters
Field
Parameter Length Description
shelf N/A The GSX shelf index for which subsystem event entries apply.
Range 1-6. In this release, only shelf 1 is supported.
Note: This parameter does not apply to GSX4000 series
switches.
slot N/A The GSX slot index for which the subsystem event entries
apply. This specifies the server module being configured for
INFO logging events. Must be 1-18.
sysid_name N/A Specifies the name of the GSX subsystem for which the
subsystem event entries apply (the software subsystem from
which to log INFO events on the specified module):
acm, arm, arma, asg, atmrm, brm, cam, cassg,
cb, cc, cli, cmtsg, dcl, dd, debug, diag, dm,
dnsc, drm, ds, enm, epdh, evlog, fm, fmwd,
ftpd, gwfe, gwsg, h323fe, h323sg, hsim, icm,
ipdcfe, ipdh, isdn, led, lesim, ltt, mgcpfe,
mgsg, mtp2, mtrm, ncm, ncomm, nfs, nrm, nrma,
nrs, ntp, param, pfa, prm, psd, psdh, rtcp,
rtm, sec, sg, sg-7, sipfe, sipsg, sm, sma,
snmp, spm, spma, ss7fe, sta, stm, tccs, tm,
tmw, trm, xrm
The summary screen (e.g., SHOW EVENT SUBSYSTEM SHELF
1 SLOT 1 SUMMARY.) lists all the available subsystem names.
State N/A The subsystem's INFO level event logging state.
• enabled - allow (do not filter out) subsystem INFO/MINOR
events in the specified event range.
• disabled (default)
MinEventId N/A The subsystem's minimum event ID that does not get filtered
out (integer 0-2048.)
For Sonus use only.
MaxEventId N/A The subsystem's maximum event ID that does not get filtered
out (integer 0-2048.)
For Sonus use only.
EventCategory N/A The factory-specified category (C0-C7) assigned to each event.
Select one or more of the following values, separated by “|”.
Default = c0:
c0|c1|c2|c3|c4|c5|c6|c7
In this release, only C0 is supported.
For Sonus use only.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Command Examples
The SHOW EVENT SUBSYSTEM ...SUMMARY screen displays a list of the specified module’s
subsystem logging configurations, containing each subsystem’s name, event range, category, and
state (by default, all subsystems’ INFO event logging states are disabled.) For example, this
command:
% SHOW EVENT SUBSYSTEM SHELF 1 SLOT 1 SUMMARY
The command below shows a summary of all the event subsystems that are State = Enabled:
% SHOW EVENT SUBSYSTEM ALL ENABLED SUMMARY
The command below shows the event subsystem administration information for a given
subsystem:
% SHOW EVENT SUBSYSTEM SHELF shelf SLOT slot SYSID sysid ADMIN
The CONFIGURE EVENT SUBSYSTEM command turns on event logging of one or more INFO/
MINOR events generated from a server module by a subsystem. For example:
% CONFIGURE EVENT SUBSYSTEM SHELF 1 SLOT 1 SYSID CAM ENABLED
Note that the MAXRANGE, MIDRANGE, and CATEGORY parameters are optional. If they are not
present, all INFO messages from the selected subsystem will be logged.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Event Filter
This object allows you to fine tune the log file by selecting only events that:
NOTE
This object can only be used with NFS (DSI Level 0)-based logging. It does not
apply to stream-based logging.
• Whenever a server module is reset by a system boot or an individual module switchover, any
LOG event of any LEVEL will be written to the log file until that file receives its filter
configuration.
• After a log file has been configured to prevent the logging of less critical events, a particular
event will nevertheless be logged if an SNMP trap is also generated by its occurrence.
See "Event Filters" on page 6–45 for additional detail on this subject.
Command Syntax
NOTE
When issuing EVENT FILTER commands on a GSX4000 series switch, omit the
SHELF parameter.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Command Parameters
Field
Parameter Length Description
shelfnumber N/A The shelf number in the GSX node configuration. In this release,
one shelf is supported. Must be 1.
Note: This parameter does not apply to GSX4000 series
switches.
slotnumber N/A The slot number occupied by the module being configured for
logging events.
event-type N/A The type of event log being configured:
• debug - system debugger data. These files have .DBG
extensions.
• system - system level events. These files have .SYS
extensions.
• trace - system trace data. These files have .TRC
extensions.
filter-level N/A The minimum severity that warrants the logging of an event of
this type:
• noevents - do not log any events.
• critical - log only events of this threshold.
• major - log major and critical events only.
• minor - log all events other than info.
• info - log every possible event.
filter-state N/A The mode of the event filter:
• off (default) - Filter is not activated.
• on - Filter is activated.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Field
Parameter Length Description
class-name N/A The software subsystem from which log events are sought:
• callproc - call processing
• resmgmt - resource management
• sysmgmt - system management
• directory - directory management
• netmgmt - network management
• signaling - signaling
• routing - routing
slotrange N/A The set of slots for which you wish to view or configure filtering
information.
All CLI ranges specify a comma-separated list of numbers and/
or ranges. A range consists of two numbers separated by a
dash, for example, 5-8. An increment can be specified after a
range with the notation, +<incr>, for example 4-10+2. No
spaces are permitted in the expression. All values and ranges
must be in numerically ascending order. Thus the expression:
1,3,5,8-12+2,14-16
is a valid range specification for the numbers:
1,3,5,8,10,12,14,15, and 16.
Command Example
To capture system events of major and critical criticality that originate on the CNS10 module that
resides in slot 7 and that occur in the call processing subsystem:
% CONFIG EV FILTER SHELF 1 SLOT 7 LOG system ..
CLASS callproc LEVEL major MODE on
To examine the administrative status of system event filters for all software subsystems for slot 7:
% SHOW EV FILT SHELF 1 SLOT 7 LOG system CLASS ALL ADMIN
Node: None Date: 1999/04/27 20:52:31 GMT
Zone: GMTMINUS05-EASTERN-US
Shelf Slot Type Class Level Mode
----- ---- ------ --------- -------- --------
1 7 SYSTEM SYSMGMT MAJOR OFF
1 7 SYSTEM CALLPROC MAJOR ON
1 7 SYSTEM RESMGMT MAJOR OFF
1 7 SYSTEM DIRECTORY MAJOR OFF
1 7 SYSTEM NETMGMT MAJOR OFF
1 7 SYSTEM SIGNALING MAJOR OFF
1 7 SYSTEM ROUTING MAJOR OFF
1 7 SYSTEM MAJOR OFF
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
• log file name - the name of the file currently being logged to.
• (empty) - event logging is disabled for that event type.
• RECOVERING - error has occurred and an automatic attempt to restart logging is in progress.
Event Events
Shelf Slot Type Class Filtered
----- ---- ------ --------- --------
1 1 SYSTEM SYSMGMT 1
1 1 SYSTEM CALLPROC 0
1 1 SYSTEM RESMGMT 0
1 1 SYSTEM DIRECTORY 0
1 1 SYSTEM NETMGMT 68
1 1 SYSTEM SIGNALING 0
1 1 SYSTEM ROUTING 0
1 1 DEBUG SYSMGMT 49
1 1 DEBUG CALLPROC 4251390
1 1 DEBUG RESMGMT 195341885
1 1 DEBUG DIRECTORY 126117
1 1 DEBUG NETMGMT 0
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Directory Services
This object configures the access method for policy requests. This is set to external when
configuring the GSX for use with a PSX Policy Server, and must be set to local when using the
GSX in Local Policy Mode. See Chapter 4, "Using the GSX in Local Policy Mode" for more
information.
Command Syntax
Command Parameters
Field
Parameter Length Description
access N/A Specifies the access method for policy requests:
• internal - (for Sonus use only).
• external (default) - for use when a PSX Policy Server is
utilized for policy requests.
• local - for use when the GSX is in Local Policy mode.
Command Examples
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Call Trace
This group of commands allows you to create and configure up to 16 Call Trace Filters and one
(global) Call Trace Error Filter that specify criteria that the GSX uses to determine call events
added to the system trace data event log (which uses the “.TRC” file extension).
MAXTRIGGERCOUNTPERSLOT is used to set/reset the Trigger Count, a mechanism used to limit
the logging of call/error filter events in the .TRC file.
CAUTION
Do not turn on the Call Trace Filter to trace all calls. Doing so may cause poor
system performance. Use this mechanism to trace a specific type of call.
For Call Trace Filters, you can use the following criteria to designate calls logged to the trace files:
• Called Party Number
• Calling Party Number
• Contractor Number
• Redirecting Number
• Call Transfer Capability
• Service Group
• Slot/Port/Channel
• Trunk Group
• Peer IP Address
NOTE
When issuing the CALL TRACE FILTER SLOTPORTCHANNEL command on a
GSX4000 series switch, omit the SLOT parameter.
Use the MATCH keyword to specify criteria to use to capture call data upon a match. Use the KEY
keyword to specify criteria on which to filter call data. Typically the MATCH and KEY parameters
will be consistent, as in the scenario shown in "Command Example" on page 3–115. However,
you could supply a MATCH for each and every criterion, but only those that are also filtered
(through KEY) will be examined to capture active calls.
• Call attempt
• Lookup request sent
• Lookup request received
• Alerting received
• Cut-through received
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
The TRC event log LEVEL must be info for this facility to operate properly.
The CALL TRACE ERROR type applies only to SIP call traces. The SIP PDUs that are logged are
established by the value of this parameter. See "Command Parameters" on page 3–113.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
The Trigger Count applies to each slot of the GSX9000. For example, if you set the trigger count
to 1, each MNS, CNS, and PNS module in the system will be able to log 1 call for a possible
maximum of 16 calls in the .TRC file. The default value of the Trigger Count is 0.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Command Parameters
Field
Parameter Length Description
ctfilter 1-23 The name of a call trace filter that will be applied to the system
trace data log file. This filter may be created, configured, and
deleted.
cpartynum 1-30 The Called or Calling Party number to trace. An X or x means
accept anything in that digit position. For example, 617xxx1212
would filter for all numbers 6170001212 through 6179991212.
The % symbol acts as a wildcard for all remaining digits. For
example, use 978% to trace all calls with a 978 prefix.
contractor 1-30 The Contractor number to trace. An X or x means accept anything
in that digit position. For example, 617xxx1212 would filter for all
numbers 6170001212 through 6179991212. The % symbol acts
as a wildcard for all remaining digits. For example, use 978% to
trace all calls with a 978 prefix.
redirecting 1-30 The Redirecting number to trace. An X or x means accept
anything in that digit position. For example, 617xxx1212 would
filter for all numbers 6170001212 through 6179991212. The %
symbol acts as a wildcard for all remaining digits. For example,
use 978% to trace all calls with a 978 prefix.
servicegroup 1-23 The name of a service group to trace. This string must match the
service group name exactly. You cannot use wildcard characters
for this argument.
tgname 1-23 The name of a trunk group to trace. This string must match the
trunk group name exactly. You cannot use wildcard characters for
this argument.
ipaddr N/A The specific host IP Address of the source/destination of the call.
For a P2P call, you must create two Call Trace Filters, if you wish
to log the PDU for both call legs.
transcap N/A The transfer capability of a call to trace:
• speech -
• unrestricted -
• audio31Khz -
• unrestrictedWithTones -
• video -
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Field
Parameter Length Description
level N/A The filter level or minimum severity that warrants the capture of
this call data:
• level1 - trace everything
• level2 (default) - trace everything but raw hex dumps
• level3 - trace only external message information (ISDN/
ISUP/CAS etc.) and errors
triggercount N/A Specifies the maximum number of calls that match the CALL
TRACE FILTER criteria and the CALL TRACE ERROR type that
may be logged to the .TRC file, per slot. When this limit is
reached on a module in a particular slot, this parameter value
becomes 0 and matching events are no longer logged. To re-
enable logging, you must issue a CLI command that configures
this parameter to a nonzero value.
Must be 0-16, default is 0.
ctfkey N/A A single call trace filter criterion to use to trace a call:
• called -
• calling -
• contractor -
• redirecting -
• transferCapability -
• slotPortChannel -
• serviceGroup -
• trunkGroup -
Use the “|” operator to combine more than one filter criteria.
errtype N/A Specifies the type of error to log:
• none (default) - No SIP PDU logging, including validation/
parsing errors.
• any - Log all SIP PDUs that meet the requirement of the
parseerror, outofdialog, and earlyattempt options
below.
• parseerror - Log received SIP PDUs that fail parsing. If an
error is detected by SIP signaling, the accompanying PDUs will
not be associated with any dialog, including an existing dialog.
Hence all in dialog and out of dialog PDUs are assigned to this
category. If an error is detected at the front end pre-parser, the
PDU is logged by this software and not forwarded to SIP
signaling. This prevents an offending PDU from being logged
by both the pre-parser and SIP signaling.
• outofdialog - Log incoming syntactically correct SIP PDUs
(except INVITE) that do not belong to an existing dialog.
• earlyattempt - Logs incoming SIP PDUs that result in early
termination of the call (by either the pre-parser or SIP
signaling).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Field
Parameter Length Description
slot N/A The slot number on which to trace a call.
port N/A The port or span supported by the module in the SLOT on which to
trace a call.
channel N/A The channel number on the SLOT and PORT, or on the
T1PORTNAME/E1PORTNAME, on which to trace a call. Must be
1-32.
t1portname N/A The automatically assigned (and possibly changed) name of the
T1 span on which to trace a call. See "T1 Circuits" on page 3–576
for the structure of the default name.
e1portname N/A The automatically assigned (and possibly changed) name of the
E1 span on which to trace a call. See "E1 Circuits" on page 3–
613 for the structure of the default name.
admin-state N/A The administrative state of this filter:
• disabled (default) - Off. In this state no calls will be traced by
this filter. The filter must be in this state to change its
configuration.
• enabled - On. In this state all calls will be processed by this
filter for possible inclusion in the system trace data log file.
Command Example
To create, configure, and enable a call trace filter, filter508, to log all voice calls from
exchange 435 to exchange 366 in the 508 area code:
% CREATE CALL TRACE FILTER filter508
% CONFIGURE CALL TRACE FILTER filter508 MATCH CALLED 508366XXXX
% CONFIGURE CALL TRACE FILTER filter508 MATCH CALLING 508435XXXX
% CONFIGURE CALL TRACE FILTER filter508 MATCH TRANSFER ..
CAPABILITY speech
% CONFIGURE CALL TRACE FILTER filter508 ..
KEY calling|called|transferCapability
% CONFIGURE CALL TRACE FILTER filter508 STATE enabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Each trace log entry contains the following information (The value in parenthesis is from the first
record):
LEVEL 1
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
=====================================================================
LEVEL 2
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
This High Probability of Completion Shelf (HPC) object is necessary to support the HPC network
capability intended to provide enhanced probability of call completion to authorized Government
Emergency Telecommunication Service (GETS) and Wireless Priority Service (WPS) users
during time of network stress and/or congestion. For more information on this set of features
which include Office-Wide Call Queuing (OWCQ) and support of the SIP Resource Priority
Header (RPH), see "Support for Government Emergency Telecomunications Service (GETS) and
Wireless Priority Service (WPS)" on page 6–237.
NOTE
The use of the GETS Software is restricted in the U.S. and U.S. TERRITORIES to
NS/EP users authorized by the Office of the Manager, National Communications
System (OMNCS). See "GETS Software" on page xxviii.
You enable HPC capability switch-wide using the CREATE HIGH PROBABILITY OF
COMPLETION SHELF command. You configure the maximum number of HPC calls that can be
simultaneously queued and whether or not an early ACM or SIP-18x message should be sent using
the CONFIGURE HIGH PROBABILITY OF COMPLETION SHELF .. commands. You also use
these commands to set the DSCP and COS values to be used with egress SIP and DIAMETER
signaling packets and to identify the DSCP value that will be used to identify packets that receive
preferred ingress processing.
Command Syntax
NOTE
When issuing HIGH PROBABILITY OF COMPLETION commands on a GSX4000
series switch, omit the SHELF parameter.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Command Parameters
Field
Parameter Length Description
shelf N/A Specifies the shelf number in the GSX node configuration. In
this release, one shelf is supported. Must be 1.
Note: The shelf 1 instance is automatically created and can not
be deleted. In addition, the creation and deletion of shelves
other than 1 is blocked as they do not exist. The command
syntax is provided for future purposes.
Note: This parameter does not apply to GSX4000 series
switches.
queuelength N/A Specifies the maximum number of HPC calls that can be
simultaneously queued on the GSX. Must be 1 - 1024; default
is 256.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Field
Parameter Length Description
earlyacm N/A Specifies whether or not an early ACM or SIP-18x message
should be sent. This setting can be overridden by the early
ACM setting on individual trunk groups.
• on - send the early ACM or SIP-18x message.
• off (default) - don’t send the early ACM or SIP-18x
message.
hpcdscp N/A Specifies the Diffserv Code Point (DSCP) value to be set in the
IP header of UDP packets transmitted as signaling for HPC
calls. This value is placed in the high-order 6 bits of the Type of
Service field. It is also used to identify received signaling
packets that merit preferential queuing. On input the high-order
6 bits of TOS are matched to this value and the low-order 2 bits
are disregarded. Must be 0 - 63; default is 0 (best effort).
nonhpcdscp N/A Specifies the Diffserv Code Point (DSCP) value to be set in the
IP header of UDP packets transmitted as signaling for non-
HPC calls. This value is placed in the high-order 6 bits of the
Type of Service field. Must be 0 - 63; default is 0 (best effort).
hpccos N/A Specifies the Class of Service (COS) value to be set in the
IEEE 802.1D User Priority field of UDP packets transmitted as
signaling for HPC calls. This parameter only has an effect if the
network interface supports 802.1Q-tagged Ethernet frames.
nonhpccos N/A Specifies the Class of Service (COS) value to be set in the
IEEE 802.1D User Priority field of UDP packets transmitted as
signaling for non-HPC calls. This parameter only has an effect
if the network interface supports 802.1Q-tagged Ethernet
frames. Must be 0 - 7; default is 0 (best effort).
interval N/A Specifies the interval for which the set of statistics is available.
1 is the most recently completed interval, and N is the interval
immediately preceding the one identified by N-1. Must be 1-12.
Command Examples
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
This object creates a template for the High Probability of Completion (HPC) trunk group object.
HPC trunk groups configured with a profile will silently take every parameter value specified in
the profile unless explicitly overridden.
You configure the trunk type, queue size and timeout, announcement details, oversubscription
factors, and precedence value using the CONFIGURE HIGH PROBABILITY OF COMPLETION
TRUNK GROUP PROFILE commands.
The following default HPC trunk group profiles are auto-created for each queuing type:
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Command Parameters
Field
Parameter Length Description
profile 1-23 Specifies the name of the HPC profile name that can be
applied to an HPC trunk group. Must be 1-23 characters.
queuelength N/A Specifies the maximum number of calls that can be
simultaneously queued at each trunk group. Must be 1 - 256;
default is 5.
queuetimeout N/A Specifies the maximum time (in seconds) an HPC call can be
queued before the attempt to connect the call in this trunk
group is abandoned. Must be 1-90 seconds; default is 15.
announcement 1-23 Specifies the name of the announcement to play when an HPC
call is queued. Must be 1-23 characters.
announcedelay N/A Specifies the delay (in seconds) between two successive
announcements for a queued call. Must be 1-90 seconds;
default is 15.
oversubfactor N/A Specifies the percentage over the configured resources for IP
trunk groups that HPC calls can consume before they are
queued. Must be 0 - 100; default is 10.
This parameter is valid only if the HPC trunk group TYPE is
intipqueuing or extipqueuing.
useprecendence N/A Specifies whether the ets value in outgoing SIP messages for
the call takes the precedence value received in the incoming
ISUP trunk group:
• enabled - when USEPRECEDENCE is enabled at the ingress
trunk group for a call, and USEWPSPRECEDENCE is enabled
at the egress trunk group for the call, the ets value in
outgoing SIP messages for the call takes the precedence
value received in the incoming ISUP trunk group (or the wps
value if the incoming trunk is an IP trunk group with SIP).
The USEWPSPRECEDENCE parameter is configured in the
SIP SERVICE RESOURCE PRIORITY HEADER
PROFILE.
• disabled (default) - the ets field in the outgoing SIP
messages for the call uses the value of the DEFAULTVALUE
parameter in the applicable SIP SERVICE RESOURCE
PRIORITY HEADER PROFILE (normally 0), when either
of the applicable USEPRECEDENCE at the ingress trunk
group, or the USEWPSPRECEDENCE field at the egress trunk
group fields are disabled, or there was no precedence
value available at the incoming trunk group.
For information, see "SIP Service Resource Priority Header
Profile" on page 3–479.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
Field
Parameter Length Description
trunktype N/A Specifies the type of trunk group for which this profile applies:
• callqueuing - inter-switch trunk groups (TDM connections
between carrier switches).
• egressqueuing - egress trunk groups (TDM connections
to customer devices, such as PBXs).
• intipqueuing - internal IP trunk groups, representing the
path between GSX media gateways in a single
administrative domain.
• extipqueuing - external IP trunk group, representing the
path to another administrative domain or to non-GSX
devices.
state N/A Specifies whether or not HPC call queuing is enabled for this
profile:
• enabled
• disabled (default)
Note: Enabling this will affect all trunks groups that are
configured to use this HPC trunk group profile. If you do not
want HPC capability for some of those trunk groups, they must
first be reconfigured to point to a new HPC trunk group profile
whose state is disabled before enabling this profile.
Command Examples
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
To display the configured parameters for HPC trunk group profiles hpc1:
% HOW HIGH PROBABILITY OF COMPLETION TRUNK GROUP PROFILE hpc1 ADMIN
Node: TPUBS Date: 2006/11/10 18:59:28 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
This object creates and configures SIP peers that are subject to limits on HPC calls. A peer will be
recognized by the IP address it uses for signaling to or from the GSX. Because the same IP address
can appear in multiple disjoint networks, the peer is identified by a combination of its IP address
and associated signaling Zone.
Command Syntax
Command Parameters
Field
Parameter Length Description
limitname 1-23 Specifies the name of the HPC limit object. Must be 1-23
characters.
sigzone 1-23 Specifies the (signaling) Zone associated with a SIP peer
subject to limits on HPC calls. The default value is INTERNAL.
sigip N/A The IP address of the SIP peer subject to limits on HPC calls in
dotted decimal form (for example 128.127.50.224).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Node CLI Reference
Field
Parameter Length Description
maxinrate N/A Specifies the number of ingress HPC call attempts per minute
allowed from the subject SIP peers (including calls promoted to
HPC status based on the number dialed). The rate is monitored
by a token bucket algorithm that tolerates bursts equal to the
limit. The maximum is enforced by denying call attempts that
exceed the limit.
An alarm is raised when the configured limit is reached,
indicating that zero calls have been denied in this interval. At
the next interval, if any HPC calls were denied, the same alarm
is issued again, containing the number of calls denied during
the interval. The interval alarm continues until the number of
denied calls is zero. Must be 0 - 2000; default is 10. A value of
0 denies all HPC calls from the subject SIP peer.
maxcalls N/A Specifies the total number of active plus stable HPC calls
allowed from or to the subject SIP peers. This includes calls
promoted to HPC status based on the number dialed. The
maximum is enforced by denying new call attempts that exceed
the limit. Existing calls persist even if the limit is lowered.
An alarm is raised when the configured limit is reached,
indicating that zero calls have been denied in this interval. At
the next interval, if any HPC calls were denied, the same alarm
is issued again, containing the number of calls denied during
the interval. The interval alarm continues until the number of
denied calls is zero. Must be 0 - 20,000; default is 10. A value
of 0 denies all HPC calls from or to the subject SIP peer.
state N/A Specifies whether or not HPC call limits are enabled for this IP
peer:
• enabled
• disabled (default)
Command Examples
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Node
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
These objects specify the IP interfaces that the GSX will utilize for telephony, management, and
system debugging traffic.
This object defines the Ethernet packet interface for system call data. It assigns a name to a link
between a non-management Ethernet port and the packet network.
Naming Conventions
GSX9000 – four NIFs of TYPE ETHERNETCSMACD are automatically created and named when a
PNS10/PNA10 module set is added to the GSX via the CREATE SERVER .. ADAPTER command.
See "Server" on page 3–17 for additional information. The default name of the ETHERNETCSMACD
NIF on a GSX9000 is ENET-shelf-slot-port, where port is the PNA10 port number (1-4).
For example, ENET-1-5-2 identifies the NIF on the second port of the PNA10 that resides behind
the PNS10 in slot 5 of shelf 1. Two additional GSX9000 ETHERNETCSMACD NIFs may be created
on the two MNA20 packet ports, via the CREATE NIF .. command.
GSX4010 – two NIFs of TYPE ETHERNETCSMACD are automatically created and named when a
GSX4010 switch is installed, and assigned port numbers 3 and 4. (Ports 1 and 2 are reserved for
Management NIFs.) The default name of the ETHERNETCSMACD NIFs on a GSX4010 is ENET-
slot-port. For example, ENET-1-3 identifies the NIF on the port 3 of the GNA10.
These names may be changed via the CONFIGURE NIF...NAME command shown in the command
syntax below. Renaming must be performed while the NIF is disabled and before any other
configuration commands are issued. None of these automatically created (and possibly renamed)
NIFs may be directly deleted. On a GSX9000, PNA10 Ethernet NIFs are removed only when the
PNS10/PNA10 module set is removed from the GSX via the DELETE SERVER .. ADAPTER
command. MNA20 packet Ethernet NIFs may be deleted directly, but only after placing them into
outofservice operational state and disabled administrative state.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
The multiplexing of multiple IP interfaces over a single physical Ethernet port is achieved via the
NIF SUBINTERFACE object. These Network Border Switch (NBS) Ethernet interfaces support
the 802.1q-1998 IEEE Standards for Local and Metropolitan Area Networks: Virtual Bridged
Local Area Networks, which the router uses as its standardized format for frame tagging. This
feature essentially supports channelizing the Ethernet interface into multiple logical sub-
interfaces.
SUBINTERFACEs (or SIFs) may be defined only on PNS40 and MNS20 packet NIFs on the
GSX9000, or GNS15 packet NIFs on the GSX4000. A maximum of 512 SIFs may be defined per
ETHERNETCSMACD NIF on the MNA20 packet ports. A maximum of 254 SIFs may be defined per
ETHERNETCSMACD NIF on the GNA10 packet ports. A maximum of 2048 management and
packet interfaces (NIFs and SIFs) may be defined per GSX9000 system. A maximum of 508 NIFs
and SIFs may be defined per GSX4000 system. Each SIF is assigned to a parent NIF and given a
unique name and a number. This number, or VLAN TAG, is the IEEE 802.lq VLAN ID, which
must be assigned in the range:
• 1-4094 (GSX9000)
• 1-254 (GSX4000)
(A VLAN TAG, as well as a unique IPADDRESS, must also be assigned to the parent NIF.) A
maximum BANDWIDTH is assigned to each SIF. This bandwidth is aggregated among the SIFs
that share a parent NIF. This aggregation may not exceed the physical bandwidth of the parent
NIF, or the SIF that causes this overflow will be rejected. If a SIF is defined without provisioning
a BANDWIDTH, then active bandwidth subscriptions up to the parent NIF’s maximum bandwidth
are allowed on the SIF.
SIFs have the same IP and routing properties as NIFs. Static routes can be added to SIFs by
referencing their IFINDEX. SIFs have the same IP and bandwidth statistics as NIFs. SIFs have
the same CAC properties as NIFs. SIFs support ARP using the MAC address of the parent NIF.
The NIF CLASS is inherited by the SIF. If CONTINGENCY and DEVIATION are not provisioned
on the SIF, they are inherited from the parent NIF.
Application software running on or outside of the GSX cannot distinguish SIFs from NIFs. In
order to assign a SIF to a NIF, the NIF must set VLAN TAG STATE to enabled. Each SIF may be
configured into any subnet as needed, regardless of the subnet in which the parent NIF resides.
Multiple SIFs that share a parent NIF may reside on the same subnet.
You must assign each NIF/SIF a unique IPADDRESS, regardless of its VLAN TAG.
In order to disable a NIF, all underlying SIFs must be disabled first. In order to delete a NIF, all
underlying SIFs must be deleted first.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
This object provides protection against Denial of Service (DoS) and Distributed Denial of Service
(DDos) attacks. See "IP Traffic Policing" on page 3–230 for a complete description of this feature.
Darkgray (or default peer) policing applies to packets that are not white-listed (received from a
known peer), not black-listed (received from a known attacker), and not evaluated under a
lightgray policer.
This feature applies only to MNS20 (Ethernet) and GNS1x packet NIFs.
The darkgray POLICERs use the same “single token bucket” model used by white list policers
(see "Token Bucket Policers" on page 3–233).
The NIF .. POLICER DARKGRAY STATE must be enabled before this policer will monitor
packets.
NOTE
The darkgray POLICER monitors signaling traffic on the NIF. This policer is
configured per NIF and limits the received signaling traffic to which it is subjected.
The BANDWIDTH control monitors media (voice and data) traffic on the NIF
SUBINTERFACE. This parameter is set per NIF SUBINTERFACE and establishes
the bandwidth available for use in call admission control.
Lightgray policing applies to packets that are authorized via the SIP .. REGISTRAR, see "SIP
Signaling Registration" on page 3–430. A successful SIP registration instantiates a lightgray
policer for the registering peer. During a SIP registration, packets from the registering SIP
endpoints are policed by darkgray policers; after successful completion of the registration, these
packets are policed by the lightgray policers. Lightgray policing is applied peer by peer, however it
is either enabled or disabled across the NIF.
The lightgray POLICERs use the same “single token bucket” model used by white list and
darkgray policers (see "Token Bucket Policers" on page 3–233). Unlike the white list and
darkgray policers however, the lightgray policers are limited to one BUCKETSIZE and one
FILLRATE that is used for every lightgray policer instance (these parameters are configured
through the POLICER SYSTEM object, see "Node-Wide Policer Settings" on page 3–238).
The NIF .. POLICER LIGHTGRAY STATE must be enabled before this policer will monitor
packets.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
NOTE
A successful SIP registration adds an entry to the lightgray list. However, this
entry is not immediately removed when the registration lapses. An extended
preservation in this list is enforced, in order to minimize the time that this peer
needs to be policed by the darkgray rather than the lightgray list policer. The entry
is removed from the lightgray list 24 hours after the registration has lapsed without
being reactivated.
PERVLAN policing applies to all signaling packets received on all logical interfaces (NIFs and
SIFs). Signaling packets are evaluated and, if necessary, throttled by this policer after evaluation
by black list, white list, lightgray, and darkgray policers. These policers use the same “single token
bucket” model previously described. You may configure a unique BUCKETSIZE and FILLRATE
for this policer on each NIF and each SIF. When PERVLAN STATE is enabled, these policers
evaluate received packets on a per-logical-IP-interface basis, where these IP interfaces are either
the already-provisioned VLAN subinterfaces or the untagged Ethernet NIF.
When PERVLAN STATE is disabled, this policer evaluates packets received on the per-
physical-Ethernet-interface (NIF) only. By default, the BUCKETSIZE and FILLRATE used are
set to their maximum values in this circumstance, effectively resulting in no NIF or SIF policing.
However, you can take advantage of the PERVLAN policer to turn it into a viable NIF policer. By
reducing the BUCKETSIZE and FILLRATE, while PERVLAN STATE is disabled, you create a
NIF policer that discards excess packets on the NIF according to the BUCKETSIZE and
FILLRATE settings that you specify.
The PERVLAN policer behavior, when enabled, and as well when disabled, is illustrated in
Figure 3–1.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
Physical NIF 1
PerVLAN Policer Disabled: The NIF's Policer setting is applied to all the traffic on the physical NIF
Physical NIF 1
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
Black list, white list, lightgray, darkgray, and logical interface policers may all be applied to NIFs.
Black list, white list, and per-VLAN policers may also be applied to SIFs. Table 3–35 summarizes
the global characteristics of these policers.
Granularity
with which
Bucketsize Granularity of Policer is
Granularity of Units Bucketsize enabled/
Policer Policing Domain Fillrate Units and Fillrate disabled Hardware
Black list filter per peer per N/A N/A per NIF/SIF PNS40
NIF MNS20
filter per peer per GNS1x
SIF
White list policer per peer Bytes configured per per NIF/SIF PNS40
per NIF Bytes/second peer per NIF/ MNS20
policer per peer SIF GNS1x
per SIF
Darkgray policer per NIF Bytes configured per per NIF PNS40
Bytes/second NIF MNS20
GNS1x
Lightgray policer per Packets configured per per NIF (DSIP) PNS40
registered peer Packets/ten- system GNS1x
per NIF seconds
PerVLAN policer per NIF Bytes configured per per NIF PNS40
policer per SIF Bytes/second NIF/SIF MNS20
GNS1x
• enabled
• disabled
• inservice
• outofservice
The default operational state is inservice, where the link is available for use. Changing the
operational state to outofservice makes the IPADDRESS associated with the NIF or SIF
available for test and maintenance.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
TABLE 3–36
From
(operational
state) Changing to (operational state)
inservice outofservice
inservice - Affirm the prompt query.
No new calls on this NIF/SIF are
allowed. If the ACTION dryup is
specified, then current calls have
until the TIMEOUT value expires to
complete. After the TIMEOUT
expires, all calls are dropped, the
NIF/SIF is in operational state
outofservice and its
administrative state may be
disabled.
outofservice Make sure the underlying Ethernet -
port is ready for general usage.
Change administrative state to
enabled.
Change operational state to
inservice.
Before a NIF can go to outofservice operational state, all underlying SIFs must be
outofservice. Before a NIF can be disabled, all underlying SIFs must be disabled.
This applies to GSX systems that use Layer 2, N:1 redundancy models: PNS and MNS20 modules
on the GSX900 and GNS modules on GSX4000 series switches. If you use the Sonus OSPF
Interface to provide PNS Layer 3 redundancy, this section does not apply and you may ignore the
setting of LOGICAL SIGNALING ADDRESS BINDING STATUS.
You may wish to create GATEWAY, H323, and SIP SIGNALING PORTs on the same subnet as the
IPADDRESS on other NIFs. Set the LOGICAL SIGNALING ADDRESS BINDING STATUS to
enabled to enable this feature. This will cause the GSX to respond to Address Resolution
Protocol (ARP) requests for logical signaling addresses (which are ignored when this status is
disabled). The advantages of this strategy are:
• You do not need to configure static routes on the router to reach these logical signaling
addresses. See "Static Routes (IP Routing Table)" on page 3–182.
• You may utilize intermediate Layer 2 switches as “pure” switches for both signaling and RTP
call traffic. Otherwise, you either need to have a “pinger task” to determine whether a logical
signaling address is reachable, or you need to set the link verification threshold to 1 so that a
switchover occurs on one NIF failure. When LOGICAL SIGNALING ADDRESS BINDING
STATUS is enabled, the pinger task is unnecessary and link verification thresholds may be
greater than one.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
• You may dedicate a particular NIF to signaling traffic, and others to RTP traffic, by properly
configuring routes. Because the addresses are not “pinned” to a particular PNS10, MNS20, or
GNS port, you must set the switchover threshold to 1 to maintain the isolation of these traffic
types. (See "Link Detection Group" on page 3–207.)
The potential advantages of placing a SIGNALING PORT on a different subnet from a NIF are:
• You may configure the logical signaling addresses on a subnet that is reachable from all NIFs
(because the GSX allows multiple NIFs on one subnet, unlike routers).
• You need not restrict the NIF link verification thresholds. If you use a common subnet for
logical signaling addresses as well as all other traffic, then for Layer 2 redundancy purposes,
you must set a link verification threshold count that is not more than the maximum number of
NIFs on the subnet.
• When a switchover to another NIF is necessary, if the logical signaling addresses are on the
same subnet as the NIFs, then the standby PNS10, MNS20, or GNS may have reduced
capacity.
Command Syntax
NOTE
When issuing SHOW NIF commands on a GSX4000 series switch, omit the SHELF
parameter.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
Command Parameters
Field
Parameter Length Description
nifname 1-23 The automatically assigned (and possibly changed) name of this
link. See the beginning of this section for the structure of the
default name.
shelf N/A The shelf number in the GSX node configuration. In this release,
one shelf is supported. Must be 1.
Note: This parameter does not apply to GSX4000 series
switches.
slot N/A The slot number occupied by the PNA, MNA20, or GNA module
you are configuring. Must be 3-16 (PNA) or 1-2 (GNA and
MNA20).
pnsport N/A The number of the Ethernet port on the PNA, MNA20, or GNA
module that you are configuring. Must be 1-4 (PNA), 3-4 (GNA),
or 3-4 (MNA20).
nipaddress N/A The 32-bit IP address of the PNA10, MNA20, or GNA Ethernet
port in dotted decimal form (for example 128.127.50.224).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
Field
Parameter Length Description
deviation N/A The percentage of overall NIF or SUBINTERFACE bandwidth
by which the actual bandwidth exceeds expected bandwidth
before a trap will be set. That is, when actual bandwidth is greater
than expected bandwidth plus DEVIATION, a trap will be set.
This trap will remain set until actual bandwidth becomes lower
than expected bandwidth, when it is cleared.
See Table 3–40, "Deriving the Available Bandwidth" for actual
and expected bandwidth definitions.
A trap may occur as well from less than expected usage. If the
actual bandwidth is lower than expected bandwidth less two
DEVIATIONs, then a different trap is set. This trap will remain set
until actual bandwidth is equal or greater than expected
bandwidth. Must be 0-100, default is 0.
See the NIF or SUBINTERFACE status for actual/expected
bandwidths.
contingency N/A The percentage of maximum BANDWIDTH that is reserved for
contingency. NIF maximum bandwidth is the physical bandwidth
on the link, less an arbitrary amount set aside for signaling traffic.
SIF maximum BANDWIDTH is as provisioned, or if not
provisioned, the parent NIF’s maximum bandwidth. Must be 0-
100, default is 0.
For a call to be allowed on a NIF/SIF, the maximum bandwidth
minus the contingency bandwidth minus the greater of actual/
expected bandwidth must exceed 0. As an example, a value of
90 for this parameter would leave only 10% of the maximum
bandwidth as potentially available bandwidth.
See the NIF or SUBINTERFACE status for actual/expected
bandwidths.
bandwidth N/A Specifies the maximum amount of BANDWIDTH (MaxBW)
allowed for this SUBINTERFACE in units of 1K bits per second.
Must be 0-2147483647 as follows:
• 0 - Allow bandwidth subscriptions up to the parent NIF’s
maximum bandwidth.
• non-zero - Allow up to the specified number of 1K bits per
second on this SIF. The aggregate of this number and all
previously provisioned SIF BANDWIDTHs that share this
parent NIF must not exceed the parent NIF’s maximum
bandwidth.
If this parameter is not configured on the SIF, then allow
bandwidth subscriptions up to the parent NIF’s maximum
bandwidth.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
Field
Parameter Length Description
nhipaddress N/A The 32-bit IP address of a default subnetwork gateway in dotted
decimal form (for example 128.127.50.224). Default value is
0.0.0.0.
This parameter need not be configured (in which case it retains
the value of 0.0.0.0). Under these circumstances, the IP routing
table must accurately contain a route to the call destination IP
address.
If this parameter is configured (contains a value other than
0.0.0.0), then this NIF will not become InService, until it can
successfully send an ARP request to this IP address and get an
ARP reply in response.
If the IP routing table contains no route on this NIF that reaches
the call destination IP address, and this IP address is configured,
then the call traffic is directed to this IP address.
See "Static Routes (IP Routing Table)" on page 3–182 for further
discussion of IP routing table considerations.
class N/A The type of use to be made of the NIF resources:
• general (default) - Available for the use of all GSX or Sonus
PSX controlled calls.
• reserved - Dedicated to Static Calls. See "Static Call" on
page 3–1206.
subnet-mask N/A The 32-bit subnet mask in dotted decimal form (for example
255.255.255.0)
newnifname 1-23 A new name for the NIF. The renaming operation will not be
allowed if the automatically created name is referenced by any
other configuration object. Therefore this operation should be
performed right after the automatically named NIF is configured
via CREATE SERVER, if it is performed at all.
oper-state N/A The operational state of the NIF:
• INSERVICE (default) - This state is set by default when
admin-state is enabled.
• OUTOFSERVICE - Set this state before changing admin-
state to disabled.
teardownmode N/A The method by which calls are torn down when operational state
goes to outofservice:
• dryup (default) - calls remain active until the teardowntime
interval expires.
• force - calls are dropped immediately.
teardowntime N/A The number of minutes to wait for active calls to complete before
dropping the call when operational state is outofservice and
ACTION is dryup. Must be 1-1440, default is 60.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
Field
Parameter Length Description
rtpportbase N/A The RTP port lookup base entry on all Ethernet based NIFs. Must
be 5000-16000, default is 5000.
Each RTP port lookup entry uses two consecutive logical ports
(even for RTP, odd for RTCP).
This is the lowest RTP port number that you may use.
For the MNS20 using an MNA20 adapter, up to 8K even/odd
entries may be used. Hence, when using the default base of
5000, RTP ports 5000-21382 may be used, yielding 8K even
numbered and 8K odd numbered ports. When using a base of
16000, RTP ports 16000-32382 may be used, yielding the same
8K even and 8K odd numbered ports.
For the PNS10, up to 5K even/odd entries may be used. Hence,
when using the default base of 5000, RTP ports 5000-15238 may
be used, yielding 5K even numbered and 5K odd numbered
ports.
For the GNS1X, up to 1488 even/odd entries may be used.
Hence, when using the default base of 5000, RTP ports 5000-
7974 may be used, yielding 1488 even numbered and 2K odd
numbered ports.
Ports 5060/5061 may not be used as they are reserved for SIP
signaling.
Ports 40000 and higher may not be used because they are
reserved by the system.
The command to change this parameter is accepted and
committed only when the GSX has no IP calls active. If any IP call
is active, the command is rejected.
The range of UDP port numbers on a GSX module is unrelated to
the maximum call rate achievable by that module.
lsas N/A The state of logical signaling address binding:
• disabled - In this state, the GSX does not respond to ARP
requests for logical addresses. These logical addresses must
be reachable on all NIFs and the NEXT HOP router/switch must
have proper static routes to direct traffic to these addresses.
• enabled (default) - In this state, the GSX will respond to ARP
requests for logical addresses. This condition allows you to
configure logical signaling addresses on the same subnet as
other NIFs. The benefits of this state are described above.
admin-state N/A The administrative state of the NIF:
• disabled (default) - in this state the NIF is inactive, it does
not respond to a ping.
• enabled - in this state the NIF is active and it responds to a
ping if the Ethernet cable is plugged in.
sif_name 1-23 The SUBINTERFACE (SIF) name. Use this string to configure
the SIF and to display its configuration, statistics, and status.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
Field
Parameter Length Description
newsif_name 1-23 A new name for the SUBINTERFACE. The renaming operation
will not be allowed unless the SIF is disabled.
physicalnif 1-23 The MNA20 or GNA10 NIF name as described at the beginning
of this section. This string must be provided to define a
SUBINTERFACE on that NIF. A renamed NIF cannot be
channelized into SUBINTERFACEs.
vlantag N/A A unique VLAN ID that must be assigned to each NIF upon which
you will configure one or more SUBINTERFACEs. Must be 1-
4094 (MNA20) or 1-254 (GNA10). When the parent NIF is
created, this parameter is assigned the NULL (0) tag. When the
NIF is enabled for VLAN TAG STATE, in order to provision a
SUBINTERFACE, this parameter must already be set to a value
in the 1-4094 or 1-254 range, or the enable command will fail.
When the NIF is disabled for VLAN TAG STATE, this parameter
is again assigned the NULL (0) tag.
The parent NIF will receive non-tagged or NULL (0) tagged
frames.
This unique VLAN ID, in the ranges cited above, must also be
assigned to each SUBINTERFACE when it is configured.
This value must be unique over all NIFs/SUBINTERFACEs.
vlan_state N/A The administrative state of VLAN Tagging:
• disabled (default) - in this state the NIF may not be
channelized into SUBINTERFACEs.
• enabled - in this state the NIF may be channelized into
SUBINTERFACEs.
sif_adminstate N/A The administrative state of the SIF:
• disabled (default) - in this state the SIF is inactive; it does
not respond to a ping.
• enabled - in this state the SIF is active; it responds to a ping
if the Ethernet cable is plugged in to the PNA port on which the
parent NIF of this SUBINTERFACE is defined.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
Field
Parameter Length Description
lightgray- N/A The administrative state of the LIGHTGRAY POLICER on this
state NIF:
• disabled - In this state, lightgray packets received on this
NIF are never discarded by this policer.
• enabled (default) - In this state, the lightgray POLICER
parameters determine the rate at which lightgray packets
received on this NIF are accepted.
Ethernet lightgray POLICERs are available only on GNS1x
packet NIFs.
Ethernet lightgray POLICERs are applied per NIF or per SIF,
depending on the interface on which the REGISTER packet was
received.
dgbucketsize N/A The “bucket size”, in bytes. Must be 16-65520, default is 12272
(bytes).
This quantity represents a darkgray packet “credit balance” that
must be consumed before darkgray packets are discarded.
These credits are reduced by every darkgray packet that is
received on the NIF and restored by the FILL RATE described
below.
These “credits” reside in the “bucket”. Each received darkgray
packet causes this sum to be decremented by the packet size.
When a darkgray packet is received while the credit balance is
less than the size of the packet, the packet is discarded and
subject to the alarm actions controlled by the DISCARD RATE
PROFILE selected by the system or server POLICER ALARM
monitoring this NIF.
dgfillrate N/A The fill rate, in bytes per second. Must be 256-16776960, default
is 1572864 (bytes per second).
The number of bytes to add to the bucket credit balance every
second. For darkgray packets to be discarded, they must be
received at a rate that exceeds this fill rate such that the credits
are reduced to zero. When darkgray packets are discarded, they
are subject to the alarm actions controlled by the DISCARD
RATE PROFILE selected by the system or server POLICER
ALARM monitoring this NIF.
The bucket credit balance will never grow larger than the
configured BUCKETSIZE, regardless of the size of this
increment.
This value represents the darkgray bytes per second threshold
beyond which packets are discarded (after the initial credit
balance has been reduced to zero).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
Field
Parameter Length Description
darkgray-state N/A The administrative state of the DARKGRAY POLICER:
• disabled - In this state, darkgray packets received on this
NIF are never discarded by this policer.
• enabled (default) - In this state, the darkgray POLICER
parameters determine the rate at which darkgray packets
received on this NIF are accepted.
Ethernet darkgray POLICERs are available only on MNA20 and
GNS1x packet NIFs.
nif_pvbucketsi N/A The NIF per VLAN “bucket size”, in bytes. Must be 16-65520,
ze default is 12288 (bytes).
This quantity represents a packet “credit balance” that must be
consumed before packets are discarded on the NIF. These
credits are reduced by every packet that is received on the NIF
and restored by the FILL RATE described below.
These “credits” reside in the “bucket”. Each received packet
causes this sum to be decremented by the packet size. When a
packet is received while the credit balance is less than the size of
the packet, the packet is discarded and subject to the alarm
actions controlled by the DISCARD RATE PROFILE selected by
the system or server POLICER ALARM monitoring this NIF.
The NIF PERVLAN POLICER evaluates all packets received on
the NIF, independent of SIF packet evaluations.
nif_pvfillrate N/A The NIF per VLAN fill rate, in bytes per second. Must be 256-
16776960, default is 625000 (bytes per second).
The number of bytes to add to the bucket credit balance every
second. For packets to be discarded, they must be received at a
rate that exceeds this fill rate such that the credits are reduced to
zero. When packets are discarded, they are subject to the alarm
actions controlled by the DISCARD RATE PROFILE selected by
the system or server POLICER ALARM monitoring this NIF.
The bucket credit balance will never grow larger than the
configured BUCKETSIZE, regardless of the size of this
increment.
This value represents the bytes per second threshold beyond
which packets are discarded (after the initial credit balance has
been reduced to zero).
The NIF PERVLAN POLICER evaluates all packets received on
the NIF, independent of SIF packet evaluations.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
Field
Parameter Length Description
pervlan-state N/A The administrative state of the PERVLAN POLICER on this NIF:
• disabled (default) - In this state, the NIF .. PERVLAN
BUCKETSIZE and NIF .. PERVLAN FILLRATE is used to
police all traffic received on the NIF; all SUBINTERFACE
traffic is policed at the NIF PERVLAN POLICER level.
• enabled - In this state, the NIF SUBINTERFACE
BUCKETSIZE and the NIF SUBINTERFACE FILLRATE is
used to police traffic received on each NIF SUBINTERFACE;
this traffic is also policed at the NIF level by the NIF
PERVLAN POLICERs.
PERVLAN POLICERs are available only on MNA20 and GNS1x
packet NIFs.
sif_pvbucketsi N/A The SIF per VLAN “bucket size”, in bytes. Must be 16-65520,
ze default is 512 (bytes).
This quantity represents a packet “credit balance” that must be
consumed before packets are discarded on the SIF. These
credits are reduced by every packet that is received on the SIF
and restored by the FILL RATE described below.
These “credits” reside in the “bucket”. Each received packet
causes this sum to be decremented by the packet size. When a
packet is received while the credit balance is less than the size of
the packet, the packet is discarded and subject to the alarm
actions controlled by the DISCARD RATE PROFILE selected by
the system or server POLICER ALARM monitoring this SIF.
The SIF PERVLAN POLICER evaluates all packets received on
the SIF.
sif_pvfillrate N/A The SIF per VLAN fill rate, in bytes per second. Must be 256-
16776960, default is 512 (bytes per second).
The number of bytes to add to the bucket credit balance every
second. For packets to be discarded, they must be received at a
rate that exceeds this fill rate such that the credits are reduced to
zero. When packets are discarded, they are subject to the alarm
actions controlled by the DISCARD RATE PROFILE selected by
the system or server POLICER ALARM monitoring this SIF.
The bucket credit balance will never grow larger than the
configured BUCKETSIZE, regardless of the size of this
increment.
This value represents the bytes per second threshold beyond
which packets are discarded (after the initial credit balance has
been reduced to zero).
The SIF PERVLAN POLICER evaluates all packets received on
the SIF.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
If any NIF is out of service, the SHOW NIF ALL STATUS command lists the reason in the OOS
Reason column. The NIF could be out of service due to one of the following reasons: operator
initiated command, gateway not responding to ARP request, port failure/outOfService, or server
failure/outOfService.
Integer
OOS Reason Code Value Description
N/A 1 Out of service condition is Not Applicable. Set when the NIF is
inService or in dryUp state. Valid for all PNS, MNS20, and GNS
modules.
admin 2 The NIF is down due to operator-initiated command. Valid for all
PNS, MNS20, and GNS modules.
gateway 3 The NIF is down because the gateway is not responding to arp
requests. Valid for all PNS, MNS20, and GNS modules.
portDown 4 The NIF is down because the port has failed. (A port cannot be
administratively taken out of service.) Valid for all PNS, MNS20,
and GNS modules.
serverDown 5 The NIF is down because the server has failed or is out of
service. Valid for all PNS and MNS20 modules.
srvrAbsent 8 The server module is not inserted in the chassis. Valid for all
PNS and MNS20 modules.
linkDown 9 The link connectivity is lost. This applies only to redundancy.
Valid for all other PNS, MNS20, and GNS modules.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
To create, enable, and configure a packet NIF, mnspnif, on port 3 of the MNA20 in slot 1:
% CREATE NIF mnspnif SHELF 1 SLOT 1 PORT 3 TYPE ethernetCsmacd
% CONFIGURE NIF mnspnif IPADDRESS 1.1.1.1 MASK 255.255.255.0
% CONFIGURE NIF mnspnif STATE enabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
To delete mnspnif:
To create and configure a pair of packet NIFs, mnsnif1 and mnsnif2, on ports 3 and 4 of the
MNA20 in slot 1, and enable them for subinterfaces via VLAN tagging:
% CREATE NIF mnsnif1 SHELF 1 SLOT 1 PORT 3 TYPE ethernetCsmacd
% CONFIGURE NIF mnsnif1 MODE OUTOFSERVICE
% CONFIGURE NIF mnsnif1 STATE disabled
% CONFIGURE NIF mnsnif1 VLAN TAG STATE enabled
% CONFIGURE NIF mnsnif1 VLAN TAG 240
% CONFIGURE NIF mnsnif1 IPADDRESS 10.96.1.5 MASK 255.255.255.0 ..
NEXTHOP 0.0.0.0
% CONFIGURE NIF mnsnif1 STATE enabled
% CONFIGURE NIF mnsnif1 MODE INSERVICE
To create SIF1 on mnsnif1 and SIF2 on mnsnif2, using VLAN TAG 100:
# Create SIFs on mnsnif1 and mnsnif2
% CREATE NIF SUBINTERFACE SIF1 NIF mnsnif1
% CONFIGURE NIF SUBINTERFACE SIF1 IPADDRESS 64.140.241.11 ..
MASK 255.255.255.0 NEXTHOP 0.0.0.0
% CONFIGURE NIF SUBINTERFACE SIF1 VLAN TAG 100
% CONFIGURE NIF SUBINTERFACE SIF1 STATE enabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
The above SIFs, SIF1 and SIF2, could be assigned to Customer A. The SIFs created below, SIF3
and SIF4, could be assigned to Customer B.
# Create more SIFs on mnsnif1 and mnsnif2
% CREATE NIF SUBINTERFACE SIF3 NIF mnsnif1
% CONFIGURE NIF SUBINTERFACE SIF3 IPADDRESS 64.140.241.13 ..
MASK 255.255.255.0 NEXTHOP 0.0.0.0
% CONFIGURE NIF SUBINTERFACE SIF3 VLAN TAG 101
% CONFIGURE NIF SUBINTERFACE SIF3 STATE enabled
NOTE
In the above example, beginning with the creation of NIFs mnsnif1 and mnsnif2,
unique IPADDRESSes were assigned to each NIF and each SIF. This convention
must be observed for every NIF and SIF that you define. You may optionally
choose as well to use the convention of a unique VLAN TAG per customer.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
This object defines the Gigabit Ethernet packet interface for system call data. It assigns a name to
a link between the packet network and the:
One NIF of TYPE gigabitEthernet (Gigabit Ethernet) is automatically created and named
when a PNS30/PNA30/PNA35 module set is added to the GSX9000 via the CREATE SERVER ..
ADAPTER command. A pair of TYPE gigabitEthernet NIFs are automatically created and
named when a PNS40/PNA40/PNA45 module set is added. See "Server" on page 3–17 for
additional information.
The default name of the gigabitEthernet NIF is GENET-shn-sln-ptn, where shn is the shelf
number (always 1), sln is the slot number, and ptn is the port number. ptn is always 1 for PNS30,
and 1 or 2 for PNS40. For example, GENET-1-5-2 may identify the NIF on the 2nd port on the
PNA40/PNA45 that resides behind the PNS40 in slot 5 of shelf 1. This name may be changed via
the CONFIGURE NIF .. NAME command shown in the command syntax below. Renaming must
be performed while the NIF is disabled and before any other configuration commands are issued.
An additional gigabitEthernet NIF may be assigned on the MNA21/25 packet port via the
CREATE NIF command. This NIF may be renamed (via CONFIGURE NIF...NAME) according to
the above rules.
The automatically created (and possibly renamed) gigabitEthernet NIFs may not be directly
deleted. These NIFs are removed only when the PNS30 or PNS40 module set is removed via the
DELETE SERVER .. ADAPTER command. The MNA21/25 gigabitEthernet NIF may be
deleted directly, but only after placing it into outofservice operational state and disabled
administrative state.
The multiplexing of multiple IP interfaces over a single physical Ethernet port is achieved via the
NIF SUBINTERFACE object. These NBS Ethernet interfaces support the 802.1q-1998 IEEE
Standards for Local and Metropolitan Area Networks: Virtual Bridged Local Area Networks,
which the router uses as its standardized format for frame tagging. This feature essentially
supports channelizing the Gigabit Ethernet interface into multiple logical sub-interfaces.
SUBINTERFACEs (or SIFs) may be defined only on PNS40 and MNS20 NIFs on the GSX9000,
or GNS15 NIFs on the GSX4000. A maximum of 512 SIFs may be defined per
gigabitEthernet NIF. A maximum of 2048 management and packet interfaces (NIFs and
SIFs) may be defined per GSX9000 system. Each SIF is assigned to a parent NIF and given a
unique name and a number. This number, or VLAN TAG, is the IEEE 802.lq VLAN ID, which
must be assigned in the range 1-4094.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
(A VLAN TAG, as well as a unique IPADDRESS, must also be assigned to the parent NIF.) A
maximum BANDWIDTH is assigned to each SIF. This bandwidth is aggregated among the SIFs
that share a parent NIF. This aggregation may not exceed the physical bandwidth of the parent
NIF, or the SIF that causes this overflow will be rejected. If a SIF is defined without provisioning
a BANDWIDTH, then active bandwidth subscriptions up to the parent NIF’s maximum bandwidth
are allowed on the SIF.
SIFs have the same IP and routing properties as NIFs. Static routes can be added to SIFs by
referencing their IFINDEX. SIFs have the same IP and bandwidth statistics as NIFs. SIFs have
the same CAC properties as NIFs. SIFs support ARP using the MAC address of the parent NIF.
The NIF CLASS is inherited by the SIF. If CONTINGENCY and DEVIATION are not provisioned
on the SIF, they are inherited from the parent NIF.
Application software running on or outside of the GSX cannot distinguish SIFs from NIFs. In
order to assign a SIF to a NIF, the NIF must set VLAN TAG STATE to enabled. Each SIF may be
configured into any subnet as needed, regardless of the subnet in which the parent NIF resides.
Multiple SIFs that share a parent NIF may reside on the same subnet.
You must assign each NIF/SIF a unique IPADDRESS, regardless of its VLAN TAG.
In order to disable a NIF, all underlying SIFs must be disabled first. In order to delete a NIF, all
underlying SIFs must be deleted first.
This object provides protection against Denial of Service (DoS) and Distributed Denial of Service
(DDos) attacks. See "IP Traffic Policing" on page 3–230 for a complete description of this feature.
Darkgray (or default peer) policing applies to packets that are not white-listed (received from a
known peer) and not black-listed (received from a known attacker). This includes:
This feature applies only to MNS20 (Gigabit Ethernet) and PNS40 packet NIFs.
The darkgray POLICERs use the same “single token bucket” model used by white list policers
(see "Token Bucket Policers" on page 3–233).
The NIF .. POLICER DARKGRAY STATE must be enabled before this policer will monitor
packets.
NOTE
The darkgray POLICER monitors signaling traffic on the NIF. This policer is
configured per NIF and limits the received signaling traffic to which it is subjected.
The BANDWIDTH control monitors media (voice and data) traffic on the NIF
SUBINTERFACE. This parameter is set per NIF SUBINTERFACE and establishes
the bandwidth available for use in call admission control.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
Lightgray policing applies to packets that are authorized via the SIP .. REGISTRAR, see "SIP
Signaling Registration" on page 3–430. A successful SIP registration instantiates a lightgray
policer for the registering peer. During a SIP registration, packets from the registering SIP
endpoints are policed by darkgray policers; after successful completion of the registration, these
packets are policed by the lightgray policers. Lightgray policing is applied peer by peer, however it
is either enabled or disabled across the NIF.
Lightgray policing is performed only on PNS40 Gigabit Ethernet NIFs running Distributed SIP
Processing (DSIP).
The lightgray POLICERs use the same “single token bucket” model used by white list and
darkgray policers (see "Token Bucket Policers" on page 3–233). Unlike the white list and
darkgray policers however, the lightgray policers are limited to one BUCKETSIZE and one
FILLRATE that is used for every lightgray policer instance (these parameters are configured
through the POLICER SYSTEM object, see "Node-Wide Policer Settings" on page 3–238).
The NIF .. POLICER LIGHTGRAY STATE must be enabled before this policer will monitor
packets.
NOTE
A successful SIP registration adds an entry to the lightgray list. However, this
entry is not immediately removed when the registration lapses. An extended
preservation in this list is enforced, in order to minimize the time that this peer
needs to be policed by the darkgray rather than the lightgray list policer. The entry
is removed from the lightgray list 24 hours after the registration has lapsed without
being reactivated.
PERVLAN policing applies to all signaling packets received on all logical interfaces (NIFs and
SIFs). Signaling packets are evaluated and, if necessary, throttled by this policer after evaluation
by black list, white list, lightgray, and darkgray policers. These policers use the same “single token
bucket” model previously described. You may configure a unique BUCKETSIZE and FILLRATE
for this policer on each NIF and each SIF. When PERVLAN STATE is enabled, these policers
evaluate received packets on a per-logical-IP-interface basis, where these IP interfaces are either
the already-provisioned VLAN subinterfaces or the untagged Gigabit Ethernet NIF.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
When PERVLAN STATE is disabled, this policer evaluates packets received on the per-
physical-Gigabit-Ethernet-interface (NIF) only. By default, the BUCKETSIZE and FILLRATE
used are set to their maximum values in this circumstance, effectively resulting in no NIF or SIF
policing. However, you can take advantage of the PERVLAN policer to turn it into a viable NIF
policer. By reducing the BUCKETSIZE and FILLRATE, while PERVLAN STATE is disabled,
you create a NIF policer that discards excess packets on the NIF according to the BUCKETSIZE
and FILLRATE settings that you specify.
The PERVLAN policer behavior, when enabled, and as well when disabled, is illustrated in
Figure 3–1.
Black list, white list, lightgray, darkgray, and logical interface policers may all be applied to NIFs.
Black list, white list, and logical interface policers may also be applied to SIFs. Table 3–35 on
page 3–138 summarizes the global characteristics of these policers.
• enabled
• disabled
The default operational state is inservice, where the link is available for use. Changing the
operational state to outofservice makes the IPADDRESS associated with the NIF or SIF
available for test and maintenance.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
TABLE 3–39
From
(operational
state) Changing to (operational state)
inservice outofservice
inservice - Affirm the prompt query.
No new calls on this NIF/SIF are
allowed. If the ACTION dryup is
specified, then current calls have
until the TIMEOUT value expires to
complete. After the TIMEOUT
expires, all calls are dropped, the
NIF/SIF is in operational state
outofservice and its
administrative state may be
disabled.
outofservice Make sure the underlying Gigabit -
Ethernet port is ready for general
usage.
Change administrative state to
enabled.
Change operational state to
inservice.
Before a NIF can go to outofservice operational state, all underlying SIFs must be
outofservice. Before a NIF can be disabled, all underlying SIFs must be disabled.
Available Bandwidth
Table 3–40 summarizes the bandwidth entities that are used to derive “Available Bandwidth.”
Available Bandwidth determines whether or not another call can be allowed on a NIF or SIF.
Bandwidth
Entity Abbr. NIF Definition SIF Definition
Maximum MaxBW The physical link capacity or The amount of 1K bits per second
Bandwidth 1000000000 bits per second for provisioned on the SIF by the
PNA40 and PNA45. BANDWIDTH parameter. If not
(This number is reduced arbitrarily provisioned, or if BANDWIDTH is
by an amount of approximately 5% set to 0, then the MaxBW for the
that is set aside for signaling.) parent NIF is used. If provisioned,
then the sum of this value and all
other SIF BANDWIDTHs on this
parent NIF must not exceed
MaxBW for the parent NIF.
Actual ActBW The BW usage on the NIF/SIF. This is continuously measured by GSX
Bandwidth hardware. It can be requested and obtained at any time by GSX software.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
Bandwidth
Entity Abbr. NIF Definition SIF Definition
Expected ExpBW The sum of the BW usage of all calls on the NIF/SIF based on each
Bandwidth call’s audio encoding, frame size, silence factor, and so on.
Contingency Cont The percentage of MaxBW that is reserved for contingency on the NIF/
SIF.
Deducted DedBW The greater of ActBW or ExpBW.
Bandwidth
Available AvBW The amount of NIF/SIF BW that is available to place another call.
Bandwidth
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
Command Parameters
Field
Parameter Length Description
nifname 1-23 The automatically assigned (and possibly changed) name of this
link. See the beginning of this section for the structure of the
default name.
shelf N/A The shelf number in the GSX node configuration. In this release,
one shelf is supported. Must be 1.
slot N/A The slot number occupied by the PNA or MNA2X module you are
configuring. Must be 1-16.
pnsport N/A The number of the Gigabit Ethernet port on the PNA or MNA2X
module that you are configuring. Must be 1 for PNA30/PNA35.
Must be 1-2 for PNA40/PNA45. Must be 3 for MNA21/MNA25.
nipaddress N/A The 32-bit IP address of the PNA/MNA2X Gigabit Ethernet port
NIF or SUBINTERFACE in dotted decimal form (for example
128.127.50.224).
deviation N/A The percentage of overall NIF or SUBINTERFACE bandwidth
by which the actual bandwidth exceeds expected bandwidth
before a trap will be set. That is, when actual bandwidth is greater
than expected bandwidth plus DEVIATION, a trap will be set.
This trap will remain set until actual bandwidth becomes lower
than expected bandwidth, when it is cleared.
See Table 3–40, "Deriving the Available Bandwidth" for actual
and expected bandwidth definitions.
A trap may occur as well from less than expected usage. If the
actual bandwidth is lower than expected bandwidth less two
DEVIATIONs, then a different trap is set. This trap will remain set
until actual bandwidth is equal or greater than expected
bandwidth. Must be 0-100, default is 0.
See the NIF or SUBINTERFACE status for actual/expected
bandwidths.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
Field
Parameter Length Description
contingency N/A The percentage of maximum BANDWIDTH that is reserved for
contingency. NIF maximum bandwidth is the physical bandwidth
on the link, less an arbitrary amount set aside for signaling traffic.
SIF maximum BANDWIDTH is as provisioned, or if not
provisioned, the parent NIF’s maximum bandwidth. Must be 0-
100, default is 0.
For a call to be allowed on a NIF/SIF, the maximum bandwidth
minus the contingency bandwidth minus the greater of actual/
expected bandwidth must exceed 0. As an example, a value of
90 for this parameter would leave only 10% of the maximum
bandwidth as potentially available bandwidth.
See the NIF or SUBINTERFACE status for actual/expected
bandwidths.
bandwidth N/A Specifies the maximum amount of BANDWIDTH (MaxBW)
allowed for this SUBINTERFACE in units of 1K bits per second.
Must be 0-2147483647 as follows:
• 0 - Allow bandwidth subscriptions up to the parent NIF’s
maximum bandwidth.
• non-zero - Allow up to the specified number of 1K bits per
second on this SIF. The aggregate of this number and all
previously provisioned SIF BANDWIDTHs that share this
parent NIF must not exceed the parent NIF’s maximum
bandwidth.
If this parameter is not configured on the SIF, then allow
bandwidth subscriptions up to the parent NIF’s maximum
bandwidth.
nhipaddress N/A The 32-bit IP address of a default subnetwork gateway in dotted
decimal form (for example 128.127.50.224). Default value is
0.0.0.0.
This parameter need not be configured (in which case it retains
the value of 0.0.0.0). Under these circumstances, the IP routing
table must accurately contain a route to the call destination IP
address.
If this parameter is configured (contains a value other than
0.0.0.0), then this NIF or SUBINTERFACE will not become
InService, until it can successfully send an ARP request to this
IP address and get an ARP reply in response.
If the IP routing table contains no route on this NIF that reaches
the call destination IP address, and this IP address is configured,
then the call traffic is directed to this IP address.
See "Static Routes (IP Routing Table)" on page 3–182 for further
discussion of IP routing table considerations.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
Field
Parameter Length Description
class N/A The type of use to be made of the NIF resources:
• general (default) - Available for the use of all GSX or Sonus
PSX controlled calls.
• reserved - Dedicated to Static Calls. See "Static Call" on
page 3–1206.
subnet-mask N/A The 32-bit subnet mask in dotted decimal form (for example
255.255.255.0)
newnifname 1-23 A new name for the PNA or MNA21/MNS25 NIF. The renaming
operation will not be allowed if the automatically created name is
referenced by any other configuration object. Therefore this
operation should be performed right after the PNS30 or PNS40
module set is configured via CREATE SERVER, if it is performed at
all.
oper-state N/A The operational state of the NIF:
• INSERVICE (default) - This state is set by default when
admin-state is enabled.
• OUTOFSERVICE - Set this state before changing admin-
state to disabled.
teardownmode N/A The method by which calls are torn down on a NIF or a
SUBINTERFACE when operational state goes to
outofservice:
• dryup (default) - calls remain active until the teardowntime
interval expires.
• force - calls are dropped immediately.
teardowntime N/A The number of minutes to wait for active calls to complete before
dropping the call when operational state is outofservice and
ACTION is dryup. Must be 1-1440, default is 60.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
Field
Parameter Length Description
rtpportbase N/A The RTP port lookup base entry on all Gigabit Ethernet based
NIFs. Must be 5000-16000, default is 5000.
Each RTP port lookup entry uses two consecutive logical ports
(even for RTP, odd for RTCP).
This is the lowest RTP port number that you may use.
For the PNS40, up to 12000 even/odd entries may be used on
each of the two PNA4X ports. Hence, when using the default
base of 5000, RTP ports 5000-28998 may be used, yielding
12000 even numbered and 12000 odd numbered ports. When
using a base of 16000, RTP ports 16000-39998 may be used,
yielding the same 12000 even and 12000 odd numbered ports.
For the PNS30, up to 8K even/odd entries may be used. Hence,
when using the default base of 5000, RTP ports 5000-21382 may
be used, yielding 8K even numbered and 8K odd numbered
ports.
For the MNS20 using an MNA21 or MNA25 adapter, up to 8K
even/odd entries may be used. Hence, when using the default
base of 5000, RTP ports 5000-21382 may be used, yielding 8K
even numbered and 8K odd numbered ports.
Ports 5060/5061 may not be used as they are reserved for SIP
signaling.
Ports 40000 and higher may not be used because they are
reserved by the system.
The command to change this parameter is accepted and
committed only when the GSX has no IP calls active. If any IP call
is active, the command is rejected.
The range of UDP port numbers on a GSX module is unrelated to
the maximum call rate achievable by that module.
admin-state N/A The administrative state of the NIF:
• disabled (default) - in this state the NIF is inactive, it does
not respond to a ping.
• enabled - in this state the NIF is active and it responds to a
ping if the Ethernet cable is plugged in.
sif_name 1-23 The SUBINTERFACE (SIF) name. Use this string to configure
the SIF and to display its configuration, statistics, and status.
newsif_name 1-23 A new name for the SUBINTERFACE. The renaming operation
will not be allowed unless the SIF is disabled.
physicalnif 1-23 The PNS40 or MNS20 GENET-shn-sln-ptn NIF name as
described at the beginning of this section. This string must be
provided to define a SUBINTERFACE on that NIF. A renamed
NIF cannot be channelized into SUBINTERFACEs.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
Field
Parameter Length Description
vlantag N/A A unique VLAN ID that must be assigned to each NIF upon which
you will configure one or more SUBINTERFACEs. Must be 1-
4094. When the parent NIF is created, this parameter is assigned
the NULL (0) tag. When the NIF is enabled for VLAN TAG
STATE, in order to provision a SUBINTERFACE, this parameter
must already be set to a value in the 1-4094 range, or the enable
command will fail. When the NIF is disabled for VLAN TAG
STATE, this parameter is again assigned the NULL (0) tag.
The parent NIF will receive non-tagged or NULL (0) tagged
frames.
This unique VLAN ID, in the ranges cited above, must also be
assigned to each SUBINTERFACE when it is configured.
This value must be unique over all NIFs/SUBINTERFACEs.
vlan_state N/A The administrative state of VLAN Tagging:
• disabled (default) - in this state the PNS40 NIF may not be
channelized into SUBINTERFACEs.
• enabled - in this state the PNS40 NIF may be channelized
into SUBINTERFACEs.
sif_adminstate N/A The administrative state of the SIF:
• disabled (default) - in this state the SIF is inactive; it does
not respond to a ping.
• enabled - in this state the SIF is active; it responds to a ping
if the Ethernet cable is plugged in to the PNA port on which the
parent NIF of this SUBINTERFACE is defined.
bucketsize N/A The “bucket size”, in bytes. Must be 16-65520, default is 20464
(bytes).
This quantity represents a darkgray packet “credit balance” that
must be consumed before darkgray packets are discarded.
These credits are reduced by every darkgray packet that is
received on the NIF and restored by the FILL RATE described
below.
These “credits” reside in the “bucket”. Each received darkgray
packet causes this sum to be decremented by the packet size.
When a darkgray packet is received while the credit balance is
less than the size of the packet, the packet is discarded and
subject to the alarm actions controlled by the DISCARD RATE
PROFILE selected by the system or server POLICER ALARM
monitoring this NIF.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
Field
Parameter Length Description
fillrate N/A The fill rate, in bytes per second. Must be 256-16776960, default
is 3145728 (bytes per second).
The number of bytes to add to the bucket credit balance every
second. For darkgray packets to be discarded, they must be
received at a rate that exceeds this fill rate such that the credits
are reduced to zero. When darkgray packets are discarded, they
are subject to the alarm actions controlled by the DISCARD
RATE PROFILE selected by the system or server POLICER
ALARM monitoring this NIF.
The bucket credit balance will never grow larger than the
configured BUCKETSIZE, regardless of the size of this
increment.
This value represents the darkgray bytes per second threshold
beyond which packets are discarded (after the initial credit
balance has been reduced to zero).
darkgray-state N/A The administrative state of the DARKGRAY POLICER:
• disabled - In this state, darkgray packets received on this
NIF are never discarded by this policer.
• enabled (default) - In this state, the darkgray POLICER
parameters determine the rate at which darkgray packets
received on this NIF are accepted.
The darkgray POLICER is available only on MNS20 (Gigabit
Ethernet) and PNS40 packet NIFs.
If any NIF is out of service, the SHOW NIF ALL STATUS command lists the reason in the OOS
Reason column. The NIF could be out of service due to one of the following reasons: operator
initiated command, gateway not responding to ARP request, port failure/outOfService, or server
failure/outOfService. See Table 3–38 on page 3–150, "NIF Out-of-Service (OOS) Reason
Codes".
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
To configure NIFs, GENET-1-3-1 and GENET-1-3-2, on ports 1 and 2 of the PNA40 in slot 3,
and enable them for subinterfaces via VLAN tagging:
To create SIF1 on GENET-1-3-1 and SIF2 on GENET-1-3-2, using VLAN TAG 100:
# Create SIFs on GENET-1-3-1 and GENET-1-3-2
% CREATE NIF SUBINTERFACE SIF1 NIF GENET-1-3-1
% CONFIGURE NIF SUBINTERFACE SIF1 IPADDRESS 64.140.241.11 ..
MASK 255.255.255.0 NEXTHOP 0.0.0.0
% CONFIGURE NIF SUBINTERFACE SIF1 VLAN TAG 100
% CONFIGURE NIF SUBINTERFACE SIF1 STATE enabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
The above SIFs, SIF1 and SIF2, could be assigned to Customer A. The SIFs created below, SIF3
and SIF4, could be assigned to Customer B.
# Create more SIFs on GENET-1-3-1 and GENET-1-3-2
% CREATE NIF SUBINTERFACE SIF3 NIF GENET-1-3-1
% CONFIGURE NIF SUBINTERFACE SIF3 IPADDRESS 64.140.241.13 ..
MASK 255.255.255.0 NEXTHOP 0.0.0.0
% CONFIGURE NIF SUBINTERFACE SIF3 VLAN TAG 101
% CONFIGURE NIF SUBINTERFACE SIF3 STATE enabled
NOTE
In the above example configuring NIFs GENET-1-3-1 and GENET-1-3-2, unique
IPADDRESSes were assigned to each NIF and each SIF. This convention must be
observed for every NIF and SIF that you define. You may optionally choose as well
to use the convention of a unique VLAN TAG per customer.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
This object defines the packet interface for system management data. It defines a link between an
Ethernet port on the Management Network Adapter (MNA) on a GSX9000 or the GNA adapter on
a GSX4000 series switch and a gateway (or router) to an adjacent subnetwork.
Sonus recommends that you configure two Management NIFs, both of which are always
operationally active. Both MGMT NIF ports on a given slot have equal preference. Routes are added
to the routing table in the order they are configured and loaded. Thus an equivalent route on a
second management port could end up on top of the routing table because of the order in which
ports are brought up. If you wish to have a route to a destination on one management port favored
over the other, use the PREFERENCE parameter when you configure the static route. See "Static
Routes (IP Routing Table)" on page 3–182.
The LOGICAL MGMTIF object allows you to assign a single virtual management address to the
MNS group on a GSX9000 or the GNS group on a GSX4000. Thus the active port associated with
the active MNS or GNS will have two IP addresses. If the active MNS or GNS port goes down, the
virtual management address will shift to the next active MNS or GNS port.
The interface status of a Management NIF reflects the physical and administrative state of the
interface as follows:
• Inservice - The physical link is up and the interface is operational.
• OutOfService - The physical link is down and the interface is not operational.
• OutOfServiceDisabled - The physical link is up and the interface is not operational
because the administrative state is disabled.
• OutOfServiceLinkDown - The physical link is down and the interface is operational.
These states cannot be explicitly set. They are displayed by the SHOW MGMT NIF ... STATUS
command.
Management NIFs are protected by system policers (see "IP Traffic Policing" on page 3–230).
Darkgray and SERVER PROTECT policing is applied to Management NIFs. However, you may
not configure these policers in any manner. They are always enabled and may not be disabled. The
STATISTICS, OFFENDERS, alarm counts, and thresholds that you view through the SHOW ..
POLICER commands reflect accumulations from Management NIFs as well as packet NIFs. The
MNS20 Management NIF Darkgray policer has a fixed fill rate of 64 Megabytes per second, and a
fixed bucket size of 32 kBytes.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
Command Syntax
NOTE
When issuing MGMT NIF commands on a GSX4000 series switch, omit the SHELF
parameter.
Command Parameters
Field
Parameter Length Description
shelf N/A The shelf number in the GSX node configuration. In this release,
one shelf is supported. Must be 1.
Note: This parameter does not apply to GSX4000 series switches.
slot N/A The slot number occupied by the MNA or GNS module you are
configuring. Must be 1-2.
port N/A The logical reference number to the Management NIF port. Must
be 1-2.
ipaddress N/A The 32-bit IP address of the Ethernet port in dotted decimal form
(for example 128.127.50.224).
nhipaddress N/A The 32-bit IP address of a default subnetwork gateway in dotted
decimal form (for example 128.127.50.224). Default value is
0.0.0.0.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
Field
Parameter Length Description
lipaddress N/A The 32-bit IP address of a virtual management address (or logical
management interface IP address) in dotted decimal form (for
example 128.127.50.224). Default value is 0.0.0.0.
This address is designed to represent the MNS group by a single
IP address.
A second virtual management address may be specified if the
second MNA or GNA port is configured for a different IP subnet.
subnet-mask N/A The 32-bit subnet mask in dotted decimal form (for example
255.255.255.0)
admin-state N/A The administrative state of the NIF:
• disabled (default) - in this state the NIF is inactive, it will not
respond to a ping.
• enabled - in this state the NIF is active and it will respond to a
ping if the Ethernet cable is plugged in.
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
CAUTION
This object is for use by Sonus authorized personnel only.
This object defines the packet interface for system debugging. It defines a link between the
Ethernet port on a server module and a gateway to the network that contains the debugging station.
Command Syntax
NOTE
When issuing DEBUG NIF commands on a GSX4000 series switch, omit the SHELF
parameter.
Command Parameters
Field
Parameter Length Description
shelf N/A The shelf number in the GSX node configuration. In this release,
one shelf is supported. Must be 1.
Note: This parameter does not apply to GSX4000 series switches.
slot N/A The slot number occupied by the module you are configuring.
ipaddres N/A The 32-bit IP address of the Ethernet port specified in dotted
decimal form (for example 128.127.50.224).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
Field
Parameter Length Description
nhipaddress N/A The 32-bit IP address of a default subnetwork gateway in dotted
decimal form (for example 128.127.50.224). Default value is
0.0.0.0.
This IP address should not be on the same IP network as PNS10
NIFs.
subnet-mask N/A The 32-bit subnet mask in dotted decimal form (for example
255.255.255.0)
admin-state N/A The administrative state of the NIF:
• disabled (default) - in this state the NIF is inactive, it will not
respond to a ping.
• enabled - in this state the NIF is active and it will respond to a
ping if the Ethernet cable is plugged in.
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
NIF Groups
This object is a named group of physical network interfaces (NIFs) that support the Network
Border Switch (NBS) functions of the GSX. This mechanism, in conjunction with the Signaling
Zone, supports the disjoint addressing, overlap addressing, and VLAN multiplexing features of
NBS. A NIFGROUP may be associated with and used by a:
A NIFGROUP contains one or more physical packet based network interfaces (or sub-interfaces,
as described below). Management network interfaces cannot be assigned to a NIFGROUP. Any
particular NIF can be assigned to more than one NIFGROUP. NIFs can be added to or deleted
from a NIFGROUP regardless of administrative and operational state. That is, the NIF could be
enabled, disabled, inService, outOfService, drying up, and so on. When the NIFGROUP
configuration is so changed, these changes will apply only to future calls on the SIP, H.323, and
Gateway service group/signaling port with which the NIFGROUP is associated. Deleting an
interface from a NIFGROUP will not affect an existing call using that NIF.
In addition to NIFs, NIF SUBINTERFACEs may also be added to NIFGROUPs.
SUBINTERFACEs may be provisioned on PNS40 and MNS20 packet interfaces on the GSX9000,
or the GNS15 on the GSX4000. These Virtual LAN (VLAN) sub-interfaces allow the
multiplexing of different channels over the physical PNS40 or MNS20 link. See "PNS30, PNS40,
MNS20/MNA21/MNA25 Network Interface (Gigabit Ethernet NIF)" on page 3–155.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
NOTE
When a GSX is upgraded from a non-NBS to an NBS environment, NIFGROUPs
must be assigned to the signaling ports. Otherwise, upon reboot the GSX stops
sending all SIP messaging from existing signaling ports that aren't in NIFGROUPs.
Command Syntax
Command Parameters
Field
Parameter Length Description
nifgroup 1-23 The name assigned to the group of physical network interfaces
that make up this NIFGROUP.
nifname 1-23 The automatically assigned (and possibly changed) name of the
NIF that is being added to or deleted from the NIFGROUP. See
"Ethernet Packet Interface (Ethernet NIF)" on page 3–133 and
"PNS30, PNS40, MNS20/MNA21/MNA25 Network Interface
(Gigabit Ethernet NIF)" on page 3–155 for additional detail about
these automatically assigned names.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
Field
Parameter Length Description
subinterface 1-23 The name of the VLAN sub-interface (on the MNS20 or PNS40
NIF) that is being added to or deleted from the NIFGROUP.
"PNS30, PNS40, MNS20/MNA21/MNA25 Network Interface
(Gigabit Ethernet NIF)" on page 3–155 for more detail on the NIF
sub-interface.
admin_state N/A The administrative state of the NIFGROUP:
• disabled (default) - The NIFGROUP is inactive. NIF
INTERFACEs and SUBINTERFACEs can be added to and
deleted from the NIFGROUP.
• enabled - The NIFGROUP is active. Its configuration cannot
be changed. Its INTERFACEs/SUBINTERFACEs are in use in
the signaling ports and/or service groups that have attached it.
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
This object specifies the gateway to which you wish to direct traffic from your Packet,
Management, or Debugger network interface (NIF). In effect, this object allows you to add,
change, and delete gateways (NEXTHOPs) to these NIFs. NIFs and static routes combine to form
the IP routing table for your network. This table must ultimately provide a route to each potential
call destination IP address.
The SHOW IP NETSTAT commands display NIF statistics that have accumulated since the GSX
was booted.
A route PREFERENCE may be configured for static routes as shown in the command syntax. The
lower the PREFERENCE value, the more likely the route is to be used. The debug command, SHOW
IP ROUTES ALL, may be used to determine which route is being used when multiple routes to the
same destination exist. The topmost entry is the route that is used. When routes to the same
destination are configured with equal preferences across multiple gateways, the last route
configured is used for forwarding non-RTP traffic. This traffic is not load balanced.
NOTE
Packet voice call traffic is not included in the NIF statistics; call signaling and link
verification command traffic is included in these statistics.
Command Syntax
NOTE
When issuing IP ROUTE and NETSTAT commands on a GSX4000 series switch,
omit the SHELF and SLOT parameter.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
NEXTHOP nhipaddress
PREFERENCE preference
CONFIGURE IP ROUTE ADD DEBUG NIF SHELF shelf ..
SLOT slot
IPADDRESS ipaddress
MASK subnet-mask
NEXTHOP nhipaddress
PREFERENCE preference
CONFIGURE IP ROUTE ADD IFINDEX ifindex ..
IPADDRESS ipaddress
MASK subnet-mask
NEXTHOP nhipaddress
PREFERENCE preference
CONFIGURE IP ROUTE DELETE NIF nifname ..
IPADDRESS ipaddress
MASK subnet-mask
NEXTHOP nhipaddress
CONFIGURE IP ROUTE DELETE NIF SUBINTERFACE subinterface..
IPADDRESS ipaddress
MASK subnet-mask
NEXTHOP nhipaddress
CONFIGURE IP ROUTE DELETE MGMT NIF SHELF shelf ..
SLOT slot
PORT port
IPADDRESS ipaddress
MASK subnet-mask
NEXTHOP nhipaddress
CONFIGURE IP ROUTE DELETE DEBUG NIF SHELF shelf ..
SLOT slot
IPADDRESS ipaddress
MASK subnet-mask
NEXTHOP nhipaddress
CONFIGURE IP ROUTE DELETE IFINDEX ifindex ..
IPADDRESS ipaddress
MASK subnet-mask
NEXTHOP nhipaddress
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
Command Parameters
Field
Parameter Length Description
nifname 1-23 The name of an existing NIF.
subinterface 1-23 The name of the VLAN sub-interface (on the MNS20, PNS40, or
GNS15 NIF) on which a static route is being added or deleted.
See "PNS30, PNS40, MNS20/MNA21/MNA25 Network Interface
(Gigabit Ethernet NIF)" on page 3–155 for more detail on the
NIF sub-interface.
ipaddress N/A The 32-bit destination IP address specified in dotted decimal
form (for example 128.127.50.224). This may be an Ethernet
switch address. This must never be a symbolic IP address.
nhipaddress N/A The 32-bit IP address of a default subnetwork gateway in dotted
decimal form (for example 128.127.50.224). Default value is
0.0.0.0.
subnet-mask N/A The 32-bit subnet mask in dotted decimal form (for example
255.255.255.0)
shelf N/A The shelf number in the GSX node configuration. In this release,
one shelf is supported. Must be 1.
Note: This parameter does not apply to GSX4000 series
switches.
slot N/A The slot number occupied by the MNS module in a GSX9000
series switch upon which a static route is being configured. The
static routes that are configured with this parameter must be
defined on MNS modules, so this value must be 1 or 2.
port N/A The logical reference number to the Management NIF port. Must
be 1 or 2.
ifindex N/A A non-zero, unsigned integer assigned to each port by the GSX.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
Field
Parameter Length Description
type N/A The type of IP routes to display:
• local - local routes
• ospf - OSPF routes, each of which has an associated cost
(see "Open Shortest Path First (OSPF) Interface" on page 3–
213)
preference N/A Specifies the route preference. Route preferences are used by
the lookup engine to decide the route entry to use if multiple
equivalent routes exist to the same destination. By default, route
preferences on active NIFs take the values:
• 1 - local route
• 5 - direct route
• 10 - static route
• 20 - OSPF route
Static and OSPF routes on standby NIFs have a value of 250
added. The higher the route preference, the less likely the route
is to be used. This value must be in the range 1-255 for active
NIFs and the corresponding entries on the standby will have a
value of 250 added.
The fields that are displayed by the SHOW IP NETSTAT ... ICMP COUNTERS commands are
described in Table 3–46. These fields display the number of different types of ICMP messages
that were received by or sent from the NIF since the GSX was booted.
Field Description
In Messages Total number of ICMP messages received at the NIF.
In Errors Total number of ICMP messages that contain errors that are received at
the NIF.
In Dst Unreach Number of destination-unreachable messages received at the NIF. This
type of message is received when a datagram that was sent from the NIF
has an address that is unreachable.
In Time Exceed Number of time-exceeded messages received at the NIF. This type of
message is received when a datagram that was sent from the NIF has a
time to live field that has reached zero.
In Parm Probs Number of parameter problem messages received at the NIF. This type of
message is received when a datagram that was sent from the NIF has a
problem in its header.
In Src Quench Number of source quench messages received at the NIF. This type of
message requests that the NIF reduces its transmission rate.
In Redirects Number of redirect messages received at the NIF. This type of message is
sent from a gateway that receives a datagram from the NIF, and
determines that another gateway is a more direct route to the destination.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
Field Description
In Echos Number of echo messages received at the NIF. This type of message is
sent from another device to test the connection with the NIF.
In Echo Reps Number of echo reply messages received at the NIF. This type of message
is sent from another device in response to an echo message sent by the
NIF.
In Time Stamps Number of time stamp messages received at the NIF. This type of
message is sent from another device to determine the delay that occurs at
the NIF.
In TStamp Reps Number of time stamp reply messages received at the NIF. This type of
message is sent from another device in response to a time stamp
message sent by the NIF, and is used to determine the delay at the other
device.
In Addr Mask Number of information request messages received at the NIF. This type of
message is sent from another device in order to get the number of the
network it is on.
In Addr Mask Reps Number of information reply messages received at the NIF. This type of
message is sent from another device in response to an information request
message sent by the NIF, and supplies the NIF with the number of the
network.
Out Messages Total number of ICMP messages sent from the NIF.
Out Errors Total number of ICMP messages that contain errors that are sent from the
NIF.
Out Dst Unreach Number of destination-unreachable messages sent from the NIF. This type
of message is sent to another device when a datagram received from that
device has an address that is unreachable.
Out Time Exceed Number of time-exceeded messages sent from the NIF. This type of
message is sent to another device when a datagram received from that
device has a time to live field that has reached zero.
Out Parm Probs Number of parameter problem messages sent from the NIF. This type of
message is sent to another device when a datagram received from that
device has a problem in its header.
Out Src Quench Number of source quench messages sent from the NIF. This type of
message requests that another device reduces its transmission rate.
Out Redirects Number of redirect messages sent from the NIF. This type of message is
sent to a device when the NIF host determines that datagrams from the
device to a particular destination can follow a more direct route through
another gateway, rather than passing through the NIF.
Out Echos Number of echo messages sent from the NIF. This type of message is sent
to another device to test the connection with the NIF.
Out Echo Reps Number of echo reply messages sent from the NIF. This type of message
is sent in response to an echo message received from another device.
Out Time Stamps Number of time stamp messages sent from the NIF. This type of message
is sent to another device to determine the delay that occurs at the device.
Out TStamp Reps Number of time stamp reply messages sent from the NIF. This type of
message is sent in response to a time stamp message sent by another
device, and is used to determine the delay at the NIF.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
Field Description
Out Addr Mask Number of information request messages sent from the NIF. This type of
message is sent to get the number of the network the NIF is on.
Out Addr Mask Reps Number of information reply messages sent from the NIF. This type of
message is sent in response to an information request message received
by another device, and supplies the device with the number of the network.
Command Example
To display the status of the IP routing table for the Management NIFs:
% SHOW IP ROUTES SHELF 1 SLOT 1
Node: TPUBS Date: 2004/09/20 19:38:37 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
To display the status of the all IP routing tables for all NIFs:
% SHOW IP ROUTES ALL
Node: TPUBS Date: 2004/09/21 13:35:11 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
To display the configuration of the all IP routing tables for all NIFs:
% SHOW IP NETSTAT ALL ROUTES ADMIN
Node: TPUBS Date: 2003/10/29 03:32:15 GMT
Zone: GMTMINUS05-EASTERN-US
To display SCTP statistics such as total number of packets received, number of SCTP chunks
received, number of active associations, and other SCTP counters:
% SHOW IP NETSTAT ALL SCTP COUNTERS
Node: TPUBS Date: 2006/02/06 22:03:36 GMT
Zone: GMTMINUS05-EASTERN-US
Shelf: 1 Slot: 1
Active Associations: 0 Active Streams : 0
Attempt Fails : 0 Current Estab : 0
In packets : 0 In Errors : 0
Checksum errors : 0 In Chunks : 0
In INIT chunks : 0 Out INIT chunks: 0
In DATA chunks : 0 Out DATA chunks: 0
In SACKs : 0 Out SACKs : 0
In Heartbeats : 0 Out Hearbeats : 0
In ERROR chunks : 0 Out ERROR chunks:0
In ABORTs : 0 Out ABORTs : 0
In Out-of-blue chunks:0
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
IP Input Filter
The CREATE, CONFIGURE, and DELETE IP INPUT FILTER commands provide the ability to
configure filters to either permit or deny signaling and management traffic originating from certain
sources or traffic terminating on certain ports. This is achieved by filtering incoming packets
according to combination(s) of criteria that include:
• Protocol
• Interface (NIF or SIF) range
• Source address range
• Source port range
• Destination port range
You configure an IP input filter in two stages, CONFIGURE IP INPUT FILTER and CONFIGURE
IP INPUT ACTION ENTRY. The CONFIGURE IP INPUT FILTER command specifies the filter
characteristics and CONFIGURE IP INPUT ACTION ENTRY dictates the action to take if the
incoming traffic matches that filter, either permit or deny. When an IP input filter is active, each
packet either matches or doesn't match the filter.
NOTE
Filters are kept on specific PNS40 and/or MNS server modules on the GSX9000 and
on the GNS module on the GSX4000. Only signaling and management IP traffic
(such as SIP/H323/GW signaling, SGX, PSX, and NFS/DSI Level 0 traffic) is subject
to filtering. Media IP traffic (such as RTCP and RTP) is not subject to input filtering.
If you do not configure any input filters on the GSX, a default filter (defaultWhiteLst), is
added, on the MNS or GNS, to permit all incoming IP traffic. The default list may be deleted using
the DELETE IP INPUT FILTER command at anytime during GSX operation. However, because
the system default is to permit packets that do not match any filter, deleting defaultWhiteLst
will not alter this behavior.
Each filter contains the criteria mentioned above, however, only the IP INPUT FILTER name is
mandatory. All unspecified criteria are set to ignore and match all possible values for that criterion.
IP input filters are provisioned independently and processed according to the following rules:
1. Filter applicability is determined by matching first by the protocol field, and then by interface
range, source address range, source port range, and destination port range in that order.
2. For each of these criteria, filter applicability is determined first by specificity and then
lexicographically. For example if an incoming packet had a source address 10.1.1.5 and
FilterA specified source address range 10.1.1.1 to 10.1.1.10 and FilterB specified a source
address range of 10.1.1.5, then FilterB which is more specific would be applied and FilterA
would not. It is possible to configure multiple overlapping filter entries of equal specificity, for
example, FilterA with source address range 10.1.1.1 - 10.1.1.10 and FilterB with source
address range 10.1.1.10 - 10.1.1.19 and all the other attributes the same. If the incoming packet
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
has source address 10.1.1.10, then the lexicographical ordering would dictate that FilterA is
applied and FilterB is not.
3. Whenever a match occurs, the packet is subject to the ACTION ENTRY of the filter.
4. If none of the filters match, the received packet is accepted.
The packet filtering algorithm requires that you be especially careful when provisioning filters
deployed to accept a restricted set of packets and deny everything else. In particular, if an
incoming packet matches an initial set of the filter criteria associated with an IP Input Filter (for
example, protocol, interface range, and source address range), other IP Input Filters which are less
specific in these initial criteria are no longer potential matching candidates. To deal with these
situations, you may be required to provision additional “counter” IP input Filters for each of these
initial criteria to force the intended discarding of the packet. The examples provided later in this
section illustrate provisioning for such cases.
Command Syntax
NOTE
When issuing IP INPUT FILTER commands on a GSX4000 series switch, omit the
SHELF and SLOT parameter.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
Command Parameters
Field
Parameter Length Description
shelf N/A The shelf number in the GSX node configuration. In this release,
one shelf is supported. Must be 1.
Note: This parameter does not apply to GSX4000 series
switches.
slot N/A The slot number of the PNS40 module on a GSX9000 series
switch where the named filter will be applied. Use the SHOW
SIP/H323 SIGNALING PORT .. command to determine the
slot used for the signaling port of interest.
When this parameter is omitted on the GSX9000, the filter will
reside on the appropriate MNS server module.
This parameter must be omitted on the GSX4000, where all
filters reside on the GNS module.
Non-SIP and non-H.323 IP traffic (such as TCP, UDP, and
ICMP) filters should be applied on the MNS (and not on the
PNS40).
On the GSX9000, this must be a slot occupied by a PNS40 or
(by omission) an MNS.
protocol N/A The IP protocol type that will be a criterion of the IP input filter:
• any (default) - filter all protocols
• icmp - filter ICMP only
• udp - filter UDP only
• tcp - filter TCP only
• sctp - filter SCTP only
• ospf - filter OSPF only
These protocols are typically associated with particular logical
port values.
filtername 1-23 An alphanumeric name that you assign to the IP input filter that
is being created or configured. Up to 1024 IP input filters may be
defined per GSX system.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
Field
Parameter Length Description
indexstart N/A The interface index number that will be a criterion of the IP input
filter, either as a single interface index number or as the starting
point of a range of interface index numbers. Must be 1-65535.
If a value for NIFINDEX-END is absent, this is a single NIF
index number that will apply to the IP input filter.
indexend N/A The interface index number that will be a criterion of the IP input
filter, as the endpoint of a range of interface index numbers.
Must be 1-65535 and higher than the value for NIFINDEX-
START.
sourceaddrst N/A The 32-bit IP address that will be a criterion of the IP input filter,
either as a single IP address or as the starting point of a range of
source IP addresses. A number in dotted decimal form (for
example 128.127.50.224).
If a value for SOURCEADDRESS-END is absent, this is a single
IP address that will apply to the IP input filter.
sourceaddrend N/A The 32-bit IP address that will be a criterion of the IP input filter,
as the endpoint of a range of source IP addresses. A number in
dotted decimal form (for example 128.127.50.224) which is
higher than the value for SOURCEADDRESS-START
sourceportst N/A The logical port number that will be a criterion of the IP input
filter, as the starting point of a range of source logical port
numbers. Must be 1-65535.
If a value for SOURCEPORT-END is absent, this is a single
logical port number that will apply to the IP input filter.
Cannot be configured without the associated transport protocol
(UDP/TCP/SCTP).
sourceportend N/A The logical port number that will be a criterion of the IP input
filter, as the endpoint of a range of source logical port numbers.
Must be 1-65535 and higher than the value for SOURCEPORT-
START.
destportst N/A The logical port number that will be a criterion of the IP input
filter, as the starting point of a range of destination logical port
numbers. Must be 1-65535.
If a value for DESTINATIONPORT-END is absent, this is a
single logical port number that will apply to the IP input filter.
Cannot be configured without the associated transport protocol
(UDP/TCP/SCTP).
destportend N/A The logical port number that will be a criterion of the IP input
filter, as the endpoint of a range of destination logical port
numbers. Must be 1-65535 and higher than the value for
DESTINATIONPORT-START.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
Field
Parameter Length Description
nifstart 1-23 The name of the NIF that will be a criterion of IP input filter,
either as a single NIF or as the starting point of a range of NIFs.
If NIF-END is absent, this is a single NIF that will apply to the IP
input filter. If NIF-END is present, then the range of NIFs is
those whose index numbers begin with this NIF’s index number
and end with the index number of the NIF-END NIF.
nifend 1-23 The name of the NIF that will be a criterion of IP input filter as
an ending point of a range of NIFs. This NIF’s index number is
the last one in a range of NIF index numbers beginning with the
index number of the NIF-START NIF that will apply to the IP
input filter.
The NIF index number of this NIF must be greater than the NIF
index number of NIF-START.
As an example, if nif_1, index number 25, was assigned to
NIF-START and nif_3, index number 27, was assigned to
NIF-END, then the IP input filter would apply to the NIFs whose
index numbers were 25, 26, and 27.
sifstart 1-23 The name of the NIF SUBINTERFACE (SIF) that will be a
criterion of an IP input filter, either as a single SIF or as the
starting point of a range of SIFs. If SIF-END is absent, this is a
single SIF that will apply to the IP input filter. If SIF-END is
present, then the range of SIFs is those whose index numbers
begin with this SIF’s index number and end with the index
number of the SIF-END SIF.
See "Ethernet NIF Virtual LAN (VLAN) Support via NIF
SUBINTERFACE" on page 3–134 and "Gigabit Ethernet Virtual
LAN (VLAN) Support via NIF SUBINTERFACE" on page 3–155
for more detail on SIFs.
sifend 1-23 The name of the SIF that will be a criterion of an IP input filter as
an ending point of a range of SIFs. This SIF’s index number is
the last one in a range of SIF index numbers beginning with the
index number of the SIF-START SIF that will apply to the IP
input filter.
The SIF index number of this SIF must be greater than the SIF
index number of SIF-START.
As an example, if sif_1, index number 25, was assigned to
SIF-START and sif_3, index number 27, was assigned to
SIF-END, then the IP input filter would apply to the SIFs whose
index numbers were 25, 26, and 27.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
Field
Parameter Length Description
action N/A Indicates the action to be taken on all traffic that matches a
defined IP input filter:
• permit (default)
• deny
An IP input action is created automatically when the
corresponding IP input filter is created. The filter action entry’s
access attribute is set to permit by default. This access is
modified using the CONFIGURE IP INPUT ACTION ENTRY
command.
This control can be changed while the administrative state of the
IP input filter is enabled.
state N/A The administrative state of the IP input filter:
• disabled (default) - Inactive and may be configured.
• enabled - Active, the IP input filter can be enabled only if it is
unique among existing enabled filters.
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
To create and enable an IP INPUT FILTER, no_telnet_on_nifs, that rejects any telnet traffic
(tcp port 23) on any of the NIFs with index numbers between those indexes assigned to nif_1 and
nif_2:
To create and enable an IP INPUT FILTER, block_telnet, that rejects any telnet traffic (tcp
port 23) on all NIFs:
% CREATE IP INPUT FILTER block_telnet
% CONFIGURE IP INPUT FILTER block_telnet PROTOCOL tcp
% CONFIGURE IP INPUT FILTER block_telnet DESTINATIONPORT-START 23
% CONFIGURE IP INPUT FILTER block_telnet STATE enabled
% CONFIGURE IP INPUT ACTION ENTRY block_telnet ACCESS deny
To create and enable a pair of IP INPUT FILTERs, allow_icmp and block_icmp, that allow
ICMP from hosts in the range 10.1.1.1 to 10.1.1.10 and reject all other ICMP:
% CREATE IP INPUT FILTER allow_icmp
% CONFIGURE IP INPUT FILTER allow_icmp PROTOCOL ICMP
% CONFIGURE IP INPUT FILTER allow_icmp SOURCEADDRESS-START 10.1.1.1
% CONFIGURE IP INPUT FILTER allow_icmp SOURCEADDRESS-END 10.1.1.10
% CONFIGURE IP INPUT FILTER allow_icmp STATE enabled
% CONFIGURE IP INPUT ACTION ENTRY allow_icmp ACCESS permit
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
(This filter drops all ICMP packets from any other source )
% CREATE IP INPUT FILTER block_icmp
% CONFIGURE IP INPUT FILTER block_icmp PROTOCOL ICMP
% CONFIGURE IP INPUT FILTER allow_icmp STATE enabled
% CONFIGURE IP INPUT ACTION ENTRY allow_icmp ACCESS deny
Notice, in the above example, that an ICMP packet from host 10.1.1.5 will match the
allow_icmp filter and because of permit ACCESS, this packet will be removed from further IP
INPUT FILTER screening and forwarded to the application. However an ICMP packet from host
10.1.1.11 will fail to match the SOURCEADDRESS range criterion of allow_icmp, hence failing
to match the filter, and hence accepted for futher screening. This packet will then match the
block_icmp filter and because of deny ACCESS, this packet will be rejected. Because the
specificity of allow_icmp is greater than block_icmp, packets are screened by allow_icmp
before block_icmp.
To create and enable a pair of IP INPUT FILTERs, allow_sip and block_sip, that allow SIP
traffic on port 5060 from hosts in the range 10.1.1.1 to 10.1.1.10 and reject all other SIP traffic:
% CREATE IP INPUT FILTER allow_sip
% CONFIGURE IP INPUT FILTER allow_sip PROTOCOL UDP
% CONFIGURE IP INPUT FILTER allow_sip SOURCEADDRESS-START 10.1.1.1
% CONFIGURE IP INPUT FILTER allow_sip SOURCEADDRESS-END 10.1.1.10
% CONFIGURE IP INPUT FILTER allow_sip DESTINATIONPORT-START 5060
% CONFIGURE IP INPUT FILTER allow_sip STATE enabled
% CONFIGURE IP INPUT ACTION ENTRY allow_sip ACCESS permit
(This filter drops all SIP packets from any other source.)
% CREATE IP INPUT FILTER block_sip
% CONFIGURE IP INPUT FILTER block_sip PROTOCOL UDP
% CONFIGURE IP INPUT FILTER block_sip DESTINATIONPORT-START 5060
% CONFIGURE IP INPUT FILTER block_sip STATE enabled
% CONFIGURE IP INPUT ACTION ENTRY block_sip ACCESS deny
To create and enable a pair of IP INPUT FILTERs, accept_telnet and block_all, that
allow telnet traffic (tcp port 23) from one source and reject all other traffic (UDP, ICMP, etc.),
including telnet from other sources:
% CREATE IP INPUT FILTER accept_telnet
% CONFIGURE IP INPUT FILTER accept_telnet PROTOCOL TCP
% CONFIGURE IP INPUT FILTER accept_telnet SOURCEADDRESS-START 10.1.1.1
% CONFIGURE IP INPUT FILTER accept_telnet DESTINATIONPORT-START 23
% CONFIGURE IP INPUT FILTER accept_telnet STATE enabled
% CONFIGURE IP INPUT ACTION ENTRY accept_telnet ACCESS permit
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
In the example above, if telnet traffic is received from 10.1.1.1, it will match the accept_telnet
filter and be forwarded to the application. If UDP or ICMP or OSPF or any other protocol is
received from 10.1.1.1 or any other address, it will match block_all and be rejected. However,
if telnet traffic is received from 10.1.1.2, it will not match the accept_telnet filter and won’t
even be screened by the block_all filter (because block_all is less specific with regard to the
already matched protocol criterion). Hence that packet fails to match any filter and is thus accepted
and forwarded to the application. Furthermore, other TCP traffic such as SSH from 10.1.1.2
arriving on port 23, or on another port, will also fail to match any filter for the same reason and
likewise be forwarded to the application. This example illustrates the requirement for a counter
rule at every level that is not wild-carded. block_all provides a counter rule for PROTOCOL
TCP. However, a counter rule is also necessary for SOURCEADDRESS-START 10.1.1.1 and for
DESTINATIONPORT-START 23. These counter rules are respectively block_telnet and
block_other_tcp, below.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
Figure 3–2, "accept_telnet Filter and Counter Filters" illustrates the processing, and the processing
order, that is applied as a result of the above configuration. Packets A through H, characterized in
Table 3–48, are screened by the filters cited in the Filtering Sequence column, in the order
shown. In every case, the packet matches the last filter that is applied, and hence is dispatched by
that filter’s ACTION ENTRY, shown in the Result column. This figure also illustrates the
unintended consequences that could occur when the counter filters block_telnet and
block_other_tcp are absent.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
accept_telnet block_all
yes
block_telnet
yes no
block_other_tcp
Destport no
TCP?
23?
yes yes
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
To create and enable a pair of IP INPUT FILTERs, accept_icmp and block_all, that allow
ICMP traffic from one source (10.1.1.1) on a specific interface (nif_1) and reject all other traffic:
% CREATE IP INPUT FILTER accept_icmp
% CONFIGURE IP INPUT FILTER accept_icmp PROTOCOL ICMP
% CONFIGURE IP INPUT FILTER accept_icmp NIF-START nif_1
% CONFIGURE IP INPUT FILTER accept_icmp SOURCEADDRSS-START 10.1.1.1
% CONFIGURE IP INPUT FILTER accept_icmp STATE enabled
% CONFIGURE IP INPUT ACTION ENTRY accept_icmp ACCESS permit
This example illustrates the same issue as the previous example. If ICMP traffic is received from
10.1.1.1 on the interface nif_1, it will match the accept_icmp filter and be forwarded to the
application. All other kinds of traffic received on 10.1.1.1 on nif_1 will be dropped. However, if
ICMP is received on the interface nif_1 from 10.1.1.2, or if it is received on any interface other
than nif_1 then it will fail to match any filter and hence be accepted. To prevent that, the
following counter rules must be imposed by the filters reject_icmp and
reject_icmp_on_other_nifs.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
Ethernet Switch
This object defines the IP address of the Ethernet switch that is connected to an MNA, PNA10,
PNA30/PNA35, or PNA40/PNA45 Ethernet port on a GSX9000, and a GNA module on a
GSX4000 series switch. By properly provisioning the link failure detection parameters, described
in the following section, the Ethernet links, including the Ethernet switches, are periodically
checked. If the check fails, a recovery action such as a switchover to a redundant PNS/PNA may
be initiated so that call processing can continue.
You may specify each physical MNA, PNA10, or GNA port in this command. PNA30s/PNA35s
have only one port, which need not be specified in the CLI command.
Because this object is used to explicitly verify Ethernet links, the IP address that is specified for
the switch must not be a symbolic IP address. Otherwise, the link verification mechanism could
improperly determine that a link is down, as described in the next section.
Command Syntax
NOTE
When issuing SERVER commands on a GSX4000 series switch, omit the SHELF
parameter.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
Command Parameters
Field
Parameter Length Description
ipaddress N/A The 32-bit destination IP address of the Ethernet switch, specified
in dotted decimal form (for example 128.127.50.224). This must
never be a symbolic IP address.
shelf N/A The shelf number in the GSX node configuration. In this release,
one shelf is supported. Must be 1.
Note: This parameter does not apply to GSX4000 series switches.
slot N/A The slot number occupied by the MNS, CNS, or PNS module on a
GSX9000, or a GNS module on a GSX4000 series switch. Must
be 1-16.
phys_port N/A The physical port on either the PNA10 or the MNA on which to
perform failure-stage link verification. Must be 1-2 for MNA links,
must be 1-4 for PNA10 links. This parameter is omitted for PNA30/
PNA35 links, because only one physical port is available on the
PNA30/PNA35.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
Command Example
To define the IP address of the Ethernet switch that is connected to the second physical port on the
MNA in slot 1:
% CONFIGURE SERVER ETHERNET SWITCH IPADDRESS ..
SHELF 1 SLOT 1 PORT 2 IPADDRESS 10.6.254.211
To display the IP addresses of all Ethernet switches that are connected to this GSX:
% SHOW SERVER ETHERNET SWITCH IPADDRESS ALL ADMIN
Node: TPUBS Date: 2001/12/26 20:06:13 GMT
Zone: GMTMINUS05-EASTERN-US
Ethernet
Switch
Shelf Slot Port IpAddress
===== ==== ==== =========
1 1 1 10.6.254.210
1 1 2 10.6.254.211
1 2 1 10.6.254.211
1 2 2 10.6.254.210
1 13 1 10.7.8.9
1 13 2 10.7.8.9
1 13 3 10.7.8.9
1 13 4 10.7.8.9
1 14 1 10.7.254.250
1 14 2 10.7.254.250
1 14 3 10.7.254.250
1 14 4 10.7.254.250
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
This object provides a link verification mechanism for PNA10, PNA30/PNA35, PNA40/PNA45,
and MNA ports on the GSX9000, and GNA ports on GSX4000 series switches. Each PNA/MNA
or GNA port, including those on redundant modules, must be uniquely provisioned for this
facility.
You must define a link detection group for each PNS and MNS or GNS server module and assign
it a THRESHOLD value. Then each PNA/MNA or GNA port is assigned to the group via ADD PORT,
and the VERIFY TIMER, REATTEMPT TIMER, RETRY COUNT, and SWITCHONLY LINKTEST
parameters are individually configured. (The default values are used if these parameters are not
configured.) Then that port may be individually enabled for link failure detection. A switchover is
indicated when the threshold count that was set for the server module (or LINK DETECTION
GROUP) is met by a series of PERPORT failures.
(You may define more than one group on one server module, however each port on the adapter
may only be configured in one group; you must delete a port from one group before adding it to
another group.)
When SWITCHONLY LINKTEST is disabled, each individual NIF builds its own list of IP
destinations to verify. A destination is added for every NEXTHOP router on the local Ethernet that is
used for an active call. When SWITCHONLY LINKTEST is enabled (the default), then the only
destination that will be verified is the ETHERNET SWITCH defined for the NIF. After you have
configured the timer, retry, and threshold parameters, and enabled link failure detection, periodic
ICMP Echo Requests are sent to the destinations.
When a NEXTHOP destination fails to reply within these parameter boundaries, the Ethernet switch
IP address is used as a destination. If the Ethernet switch replies, then the GSX software assumes
that the problem is at the far end, and the port is not declared down. If the Ethernet switch does not
reply, then the GSX software assumes that there is a local port, link, or Ethernet switch problem
and the port is declared Link Down (down due to link verification failures).
NOTE
If no Ethernet Switch IP address is configured, then the link will never be declared
Link Down, and the original destination will continue to have ICMP Echo Requests
directed to it. Hence, in the absence of an actual Ethernet Switch, the router
address must be configured as an Ethernet Switch IP address in order to perform
link verification.
When a Link Down failure dictates a PNS switchover, a request to do so is made of the redundant
PNS module. If a switchover is not immediately feasible (because for example, a FLASH update is
in progress), then the decision will be reevaluated in 250 milliseconds and if the down port
threshold is still met, the request will be made again. The redundant PNS module must have fewer
failed ports than its configured threshold. If the standby module has as many or more failed ports
than its configured threshold, then the switchover is not requested. To accomplish this switchover,
a PNS10, PNS30, or PNS40 redundancy group must be properly configured. See "Redundancy
Group" on page 3–48.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
NOTE
The NIF associated with the PNS that will be switched over to must be in service,
or the switchover will not take place.
NOTE
If you enable link failure detection switchovers, Sonus recommends that you set
redundancy group fallback control to non-revertive. Failure to do so could result in
automatic reversions into the original failed link condition. The original link failure
condition should be diagnosed and corrected before a manual reversion is
performed. See FALLBACK REVERTIVE in "Redundancy Group" on page 3–48
This mechanism verifies MNA and GNA ports, and directs MNS and GNS switchovers, as
described above for PNSs, except that because there are never any active calls using these links,
the destination IP address is the first to be defined of:
(Of course, if SWITCHOVER LINKTEST is enabled, then the Ethernet switch is the verified
destination.)
Sonus recommends that you use the system defaults for all parameter values, including 500
milliseconds for the port Verify Timer and 250 milliseconds for the port re-attempt timer. Sonus
also recommends that you initially specify a switchover threshold value of 0, preventing any
switchovers due to link failures. When you have determined that all configured addresses in all
NIFs are reachable and reliable over time, you should increase this value to (effectively) enable
link failure switchovers.
NOTE
On an MNS or GNS switchover, the virtual management address (see "Management
Packet Interface (Management NIF)" on page 3–172) will shift to the new active
MNS or GNS port.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
Command Syntax
NOTE
When issuing LINK DETECTION and LINK FAILURE commands on a GSX4000
series switch, omit the SHELF parameter.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
Command Parameters
Field
Parameter Length Description
ldgroup 1-23 The name of the link detection group associated with the PNS or
MNS module on a GSX9000 and the GNS module on a GSX4000
series switch.
pnumber N/A The number of an MNA, PNA, or GNA port to be added or
removed from a link detection group. Must be 1 or 2 for MNAs or
GNAs, 1 for PNA30/35, and 1-4 for PNA10.
shelf N/A The shelf number in the GSX node configuration. In this release,
one shelf is supported. Must be 1.
Note: This parameter does not apply to GSX4000 series switches.
slot N/A The slot number occupied by the MNS or PNS module on a
GSX9000, or a GNS module on a GSX4000 series switch. Must
be 1-16.
thresholds N/A The number of individual port or link failures that may be accepted
before a switchover request to the redundant PNS, MNS, or GNS
modules is initiated. Must be between 0 and the number of
Ethernet ports on the server module; that is 0-1 for a PNS30 or
PNS40, 0-4 for a PNS10, and 0-2 for an MNS or GNS. A value of 0
means that a port or link failure will never cause a switchover.
When a nonzero THRESHOLD value is specified for a standby
module, then in order for that module to be activated by a
switchover, the number of link failures present must be less than
that value. When THRESHOLD or more link failures are present, the
switchover is not attempted.
verifytimer N/A The time (in milliseconds) to send the ICMP Echo when the link is
up, as well as the time to await the ICMP Echo Reply from an IP
destination. Must be 0-60000, default is 500 (milliseconds).
retimer N/A The time (in milliseconds) to send the ICMP Echo, as well as the
time to await the ICMP Echo Reply from the Ethernet switch, after
an initial ICMP Echo failure until the link is declared down. Must be
0-60000, default is 250 (milliseconds).
retrycount N/A The number of ICMP Echo Request retries to make before
declaring that the port or link has failed. Must be 0-10, default is 2.
solinktest N/A Specifies whether the LINK FAILURE ICMP Echo Requests are
sent to all the NIF destinations, or just the ETHERNET SWITCH
address:
• enabled (default) - send ICMP Echo Requests to the
ETHERNET SWITCH only
• disabled - send ICMP Echo Requests to each NEXTHOP
router or ETHERNET SWITCH on the local Ethernet
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
Field
Parameter Length Description
admin_state N/A The administative state of link failure detection on the designated
PNA or MNA port:
• enabled - turned on and active
• disabled (default) - not in use
ifindex N/A The index that was assigned to the underlying link detection group
when it was created. This number may be displayed by SHOW
LINK DETECTION GROUP .. ADMIN.
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
To enable (layer 2) link failure switchovers to a redundant PNS10 module from the PNS10
redundancy group occupying slots 3 and 4 when 3 link failures occur on any port associated with
the slot 3 PNS10 or when 1 link failure occurs on any port associated with the slot 4 PNS10:
% CREATE LINK DETECTION GROUP PNS10-1 SHELF 1 SLOT 3
% CONFIGURE LINK DETECTION GROUP PNS10-1 THRESHOLD 3
% CONFIGURE LINK DETECTION GROUP PNS10-1 ADD PORT 1
% CONFIGURE LINK DETECTION GROUP PNS10-1 ADD PORT 2
% CONFIGURE LINK DETECTION GROUP PNS10-1 ADD PORT 3
% CONFIGURE LINK DETECTION GROUP PNS10-1 ADD PORT 4
% CREATE LINK DETECTION GROUP PNS10-2 SHELF 1 SLOT 4
% CONFIGURE LINK DETECTION GROUP PNS10-2 THRESHOLD 1
% CONFIGURE LINK DETECTION GROUP PNS10-2 ADD PORT 1
% CONFIGURE LINK DETECTION GROUP PNS10-2 ADD PORT 2
% CONFIGURE LINK DETECTION GROUP PNS10-2 ADD PORT 3
% CONFIGURE LINK DETECTION GROUP PNS10-2 ADD PORT 4
% CONFIGURE LINK DETECTION PERPORT PARAMETER ..
SHELF 1 SLOT 3 PORT 1 STATE enabled
% CONFIGURE LINK DETECTION PERPORT PARAMETER ..
SHELF 1 SLOT 3 PORT 2 STATE enabled
% CONFIGURE LINK DETECTION PERPORT PARAMETER ..
SHELF 1 SLOT 3 PORT 3 STATE enabled
% CONFIGURE LINK DETECTION PERPORT PARAMETER ..
SHELF 1 SLOT 3 PORT 4 STATE enabled
% CONFIGURE LINK DETECTION PERPORT PARAMETER ..
SHELF 1 SLOT 4 PORT 1 STATE enabled
% CONFIGURE LINK DETECTION PERPORT PARAMETER ..
SHELF 1 SLOT 4 PORT 2 STATE enabled
% CONFIGURE LINK DETECTION PERPORT PARAMETER ..
SHELF 1 SLOT 4 PORT 3 STATE enabled
% CONFIGURE LINK DETECTION PERPORT PARAMETER ..
SHELF 1 SLOT 4 PORT 4 STATE enabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
This object defines an OSPF instance to run in the GSX. OSPF is a standard intra-domain IP
routing protocol. In comparison to the Routing Information Protocol (RIP), OSPF has better
scalability and fast network convergence and is hence better suited for carrier class VoIP
networks.
The GSX behaves as an IP end system in an OSPF environment, but nevertheless benefits from
OSPF participation because:
• Most static routes may be eliminated from the manual configuration process, on both the GSX
and the neighbor routers
• The GSX can dynamically adapt to any topology changes that occur in the IP network
• Layer 3 redundancy (or “routed redundancy”) can be achieved by directly connecting GSX
packet network interfaces to routers, providing an alternative to connecting the interfaces to
Ethernet switches to achieve Layer 2 redundancy
As an OSPF end system, the GSX advertises all gateway-to-gateway signaling, SIP, H.323, and
logical bearer (associated with Layer 3 redundancy) IP addresses and subnets defined in the
system to outside networks and also learns IP routing information from outside. This enables the
GSX to install all selected routes into a routing database and forwarding table for packet
transmission.
Each OSPF route is assigned an associated “cost.” Routes and route costs are continuously
“learned” by OSPF. The route that is selected for any particular traffic item, will be the route with
the lowest cost. Certain properties of this route calculation scheme are not well suited to the GSX
environment. In particular, all PNS ports must carry the same cost to ensure load balancing on
these ports. Also, if a lesser cost (different) route were chosen during an active call, that call would
be dropped. Sonus OSPF route calculations (or SORC) have been defined to overcome these
issues.
In the Layer 3 redundancy model, each active and standby interface (PNS and/or MNS) is
advertised. The OSPF cost of reaching the standby interfaces is set higher than the costs for the
active interfaces. This ensures the use of the active interfaces for all bearer and signaling traffic. If
a switchover occurs, causing the standby interface(s) to become active, a new advertisement is sent
out announcing a lower cost than the previously active interface(s), ensuring that the routers use
the newly active interfaces for all traffic. The LOGICAL BEARER ADDRESS object is used in the
Layer 3 redundancy model. See "Layer 3 PNS Redundancy" on page 6–27.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
Command Syntax
NOTE
When issuing OSPF commands on a GSX4000 series switch, omit the SHELF
parameter.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
Command Parameters
Field
Parameter Length Description
shelf N/A The shelf number in the GSX node configuration. In this
release, one shelf is supported. Must be 1.
Note: This parameter does not apply to GSX4000 series
switches.
area_id N/A The identity of the OSPF area that is being configured. A
number in dotted decimal form, such as 0.0.0.1. The value
0.0.0.0 means backbone area.
255.255.255.255 is not a valid area identity.
type N/A Specifies the interfaces that the OSPF area will cover:
• MNS (default) - only MNS IP interfaces.
• PNS - only PNS IP interfaces.
• COMMON - MNS, PNS, and GNS (GSX4000) IP interfaces
Whenever an OSPF interface is created and configured, it is
automatically included in the corresponding OSPF area or
areas.
if_addr N/A The 32-bit destination IP address an individual OSPF
interface, specified in dotted decimal form (for example
128.127.50.224).
lb_if_addr N/A The 32-bit IP address to be assigned to the Ethernet port of
the OSPF Interface that is being configured, as the logical
bearer address. This is a standard IP address in dotted
decimal form that will be assigned to a call endpoint.
subnet-mask N/A The 32-bit subnet mask in dotted decimal form (for example
255.255.255.0) to be applied to the LOGICAL BEARER IP
address.) 0 and 1 subnet broadcast addresses are not used.
size N/A Specifies the number of LOGICAL BEARER IP addresses to be
allocated. This size should be smaller than the range defined
by the MASK. Must be 1-1024, default is 32.
neighbor_addr N/A The 32-bit IP address of an adjacent Ethernet port. If this
parameter is specified, then only that address will be tried for
adjacency. If not specified, then the GSX will discover a
“neighbor” from the OSPF interface. A number in dotted
decimal form (for example 128.127.51.224).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
Field
Parameter Length Description
hellointerval N/A The number of seconds between the transmission of hello
packets on the OSPF interface. Must be 1-65535, default is 10
(seconds).
This must match the value configured in neighbor routers in
order for adjacency to be established.
rtxinterval N/A The number of seconds to wait before retransmitting link state
advertisements on the OSPF interface. Must be 0-3600,
default is 5 (seconds).
This must match the value configured in neighbor routers in
order for adjacency to be established.
deadinterval N/A The number of seconds to wait before declaring a silent router
down on the OSPF interface. Must be 0-2,147,483,647,
default is 40 (seconds).
This must match the value configured in neighbor routers in
order for adjacency to be established.
routecalctype N/A Specifies the type of route calculation to be performed for the
MNS, PNS, or COMMON IP interface that the OSPF area will
cover:
• spf - Traditional least cost routing (also known as Dijkstra)
calculations on the OSPF database.
• sorc (default) - Sonus OSPF route calculations, which
generally disregard the reachability costs of the destination.
This scheme enables load balancing across PNS10 ports
and disables route changes while a call is active. A route
change within an active call would result in dropping the
call.
Sonus recommends sorc for all applications, but also
provides a means to force traditional spf for a particular
interface area.
offset 2 Specifies the cost offset between active and standby OSPF
interfaces. Must be between 2-14 (inclusive); the default value
is 2.
OSPF code ensures that the cost of all logical addresses (SIP,
H323, GW-GW signaling, logical bearer address) on standby
interfaces is higher by this offset value as compared with the
active interfaces. Sonus recommends that this offset value be
one or more than the link cost between peering routers.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
Field
Parameter Length Description
mode N/A This specifies whether those routes that are learned from
OSPF are installed into the routing table:
• active (default) - Install all OSPF learned routes into the
routing table, making them available for use by the GSX.
• passive - Do not install any OSPF learned routes, but
keep their adjacencies with neighbors active and continue
advertising all local information. This setting may be helpful
for certain situations where IP network troubleshooting is
indicated. In this mode, you may have to manually
configure static routes to reach the call destinations. See
"Static Routes (IP Routing Table)" on page 3–182.
if_admin-state N/A The administrative state of an individual OSPF interface:
• disabled - The OSPF interface is inactive. All OSPF
learned routes and adjacencies relative to this interface are
removed from the routing table. You must enforce this state
to change the value of any parameter associated with the
interface.
• enabled (default) - All parameter values associated with
this OSPF interface are active.
f_admin-state N/A The administrative state of the OSPF process:
• disabled (default) - The OSPF facility and all OSPF
interfaces are inactive. All adjacencies on all OSPF
interfaces are removed; all OSPF installed routes are
removed from the routing table.
• enabled - The OSPF facility and all configured and
enabled OSPF interfaces are activated.
To be at all meaningful, the OSPF area must be configured
before the OSPF instance is enabled. To change the
configuration of the OSPF area, the OSPF process must be
disabled.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
The discussion and example below provides additional detail about each of these steps.
To configure both PNS and MNS interfaces into a single OSPF area, 0.0.0.0:
% CONFIGURE OSPF SHELF 1 AREA 0.0.0.0 TYPE common
To run OSPF on PNS interfaces, but not MNS interfaces, you must nevertheless specify an MNS
AreaID. The command below produces this result, by setting up both PNS and MNS areas the
same. All PNS interfaces are assigned to OSPF area 0.0.0.0. The MNS interfaces are given the
same AreaID, but OSPF does not run on those interfaces:
% CONFIGURE OSPF SHELF 1 AREA 0.0.0.0 TYPE common
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
To complete this step of the procedure, you must create, configure, and enable each individual
OSPF interface. OSPF does not automatically create or enable any of the interfaces in the OSPF
area. To enable OSPF on a PNS interface with IP address 10.7.11.1:
% CREATE OSPF IF SHELF 1 IPADDRESS 10.7.11.1
% CONFIGURE OSPF IF SHELF 1 IPADDR 10.7.11.1 STATE enabled
Values of 10 seconds for the HELLO interval, 40 seconds for the router DEAD interval, and 5
seconds for the RETRANSMIT interval are automatically set by default on this OSPF interface.
To change any of these parameters, the OSPF interface must first be disabled. For example, to
change HELLO interval to 5 seconds, and the router DEAD interval to 30 seconds:
% CONFIGURE OSPF IF SHELF 1 IPADDRESS 10.7.11.1 STATE disabled
% CONFIGURE OSPF IF SHELF 1 IPADDRESS 10.7.11.1 ..
HELLOINTERVAL 5 DEADINTERVAL 30
% CONFIGURE OSPF IF SHELF 1 IPADDRESS 10.7.11.1 STATE enabled
OSPF will automatically learn neighbor information during protocol message exchange. However,
if you want to establish adjacency with a specific router interface, when multiple routers are
directly reachable, then you should specify the NBR IP address. OSPF will then try to establish
adjacency on this interface only with that neighbor. This neighbor must be on the same subnet as
the interface. Thus, to route all traffic from the PNS OSPF interface 10.7.11.1 to the router at IP
address 10.7.11.5:
% CONFIGURE OSPF IF SHELF 1 IPADDRESS 10.7.11.1 STATE disabled
% CONFIGURE OSPF IF SHELF 1 IPADDRESS 10.7.11.1 NBR 10.7.11.5
% CONFIGURE OSPF IF SHELF 1 IPADDRESS 10.7.11.1 STATE enabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
Command Example
10.1.1.1
active MNS
10.1.1.2
Switch LAN 10.1.0.0
standby
10.1.1.3
MNS
10.1.1.4
10.1.2.1
10.2.1.1 OSPF
active PNS
10.2.1.2 Router
10.2.2.1
10.2.1.3
10.2.1.4
Switch
LAN 10.2.0.0
standby PNS
Area 0.0.0.1
To configure an OSPF single area as depicted in Figure 3–3 with two subnets, allowing OSPF to
discover a neighbor from the interface:
% CREATE OSPF SHELF 1
% CONFIGURE OSPF SHELF 1 AREA 0.0.0.1 TYPE COMMON
% CREATE OSPF IF SHELF 1 IPADDRESS 10.1.1.1
% CONFIGURE OSPF IF SHELF 1 IPADDRESS 10.1.1.1 STATE enabled
% CREATE OSPF IF SHELF 1 IPADDRESS 10.1.1.2
% CONFIGURE OSPF IF SHELF 1 IPADDRESS 10.1.1.2 STATE enabled
% CREATE OSPF IF SHELF 1 IPADDRESS 10.1.1.3
% CONFIGURE OSPF IF SHELF 1 IPADDRESS 10.1.1.3 STATE enabled
% CREATE OSPF IF SHELF 1 IPADDRESS 10.1.1.4
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
---------------------------------------------------------------------
OSPF Area Shelf: 1 Instance: 1
---------------------------------------------------------------------
MNS Area ID : 0.0.0.10 MNS Area RouteCalc Method: SORC
PNS Area ID : 0.0.0.1 PNS Area RouteCalc Method: SORC
Admin Status: ENABLED Version : VERSION2
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
To display configuration information about the OSPF Link State Advertisement database of
individual areas:
% SHOW OSPF LSDB ALL
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
Differentiated Services
The DIFFSERV MARK object is associated with a particular IP output filter. This object provides a
means of inserting a specific value into the Type of Service (TOS) byte of every outbound packet
that matches the IP output filter. (See the TOS parameter description in "Packet Service Profile"
on page 3–690.) The TOS byte may be inspected by network routers for Quality of Service (QoS)
decisions. This Sonus facility enables a differentiated services solution for network flow
aggregation problems. The TOS parameter in the PACKET SERVICE PROFILE may be applied
to media packets; the IP OUTPUT FILTER however is restricted to signaling packets.
The monitoring and management of network resources is called Traffic Engineering (TE). The IP
OUTPUT FILTER and DIFFSERV MARK objects assist Traffic Engineering tasks that arise in the
network.
NOTE
This GSX capability is limited to the marking of the outgoing (signaling) IP packets
with specific TOS values. The GSX itself does not perform any traffic shaping
based on these values. It is expected that downstream routers will use these
values to prioritize or shape the traffic that originates from the GSX.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
Command Parameters
Field
Parameter Length Description
ipfiltername 1-23 The name of the IP output filter.
sipaddress N/A The 32-bit IP address that will be a criterion of the IP output
filter, either as a single IP address or as the starting point of a
range of IP addresses. A number in dotted decimal form (for
example 128.127.50.224).
If ENDADDR is absent, this is a single IP address that will apply
to the IP output filter. If ENDADDR is present, this is the start of a
range of IP addresses, that will apply to the IP output filter. If
SOURCEADDRESS is present, this address specifies an
Ethernet port that is being transmitted from. If
DESTINATIONADDRESS is present, this address specifies an
Ethernet port that is being transmitted to.
If this IP address is absent, then all IP addresses will apply to
this IP output filter.
eipaddress N/A The 32-bit IP address that will be a criterion of the IP output
filter, as the endpoint of a range of IP addresses. A number in
dotted decimal form (for example 128.127.50.224).
This range of IP addresses will apply to the IP output filter. If
SOURCEADDRESS is present, this endpoint specifies a range of
Ethernet ports that are being transmitted from. If
DESTINATIONADDRESS is present, this endpoint specifies a
range of Ethernet ports that are being transmitted to.
sportnumber N/A The logical port that will be a criterion of the IP output filter,
either as a single port or as the starting point of a range of
logical port numbers. Must be 1-65535.
If ENDPORT is absent, this is a single logical port that will apply
to the IP output filter. If ENDPORT is present, this is the start of a
range of logical ports that will apply to the IP output filter. If
SOURCEPORT is present, this address specifies a logical port
that is being transmitted from. If DESTINATIONPORT is
present, this address specifies a logical port that is being
transmitted to.
If this logical port number is absent, then all logical port
numbers will apply to this IP output filter.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
Field
Parameter Length Description
eportnumber N/A The logical port number that will be a criterion of the IP output
filter, as the endpoint of a range of logical port numbers. Must
be 1-65535.
This range of logical port numbers will apply to the IP output
filter. If SOURCEPORT is present, this endpoint specifies a range
of logical ports that are being transmitted from. If
DESTINATIONPORT is present, this endpoint specifies a range
of logical ports that are being transmitted to.
protocol N/A The IP protocol type that will be a criterion of the IP output
filter:
• any (default) - filter all protocols
• icmp - filter ICMP only
• udp - filter UDP only
• tcp - filter TCP only
• ospf - filter ospf only
• sctp - filter sctp only
These protocols are typically associated with particular logical
port values.
nifname 1-23 The name of the Network Interface that will be a criterion of the
IP output filter. Giving no name causes all NIFs to match the
filter.
application N/A The application type that will be a criterion of the IP output
filter:
• any (default) - filter all packets from all the applications
below
• other - filter all packets that do not belong to the
applications listed below
• snmp - filter snmp packets
• nfs - filter NFS packets
• telnet - filter telnet packets
• sip - filter SIP packets
• h323 - filter H.323 packets
• ping - filter ping packets
• ospf - filter OSPF packets
• ss7 - filter SS7 signaling packets
• gwgw - filter gateway to gateway signaling packets
These applications are associated with the logical port values
that run UDP or TCP protocols.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
Field
Parameter Length Description
dscp N/A The TOS value to be inserted into the packet header of all
packets that match the named IP output filter criteria. Must be
in the range 0-63. This value will be inserted into the high order
six bits of this eight bit field.
See TOS in "Packet Service Profile" on page 3–690.
admin-state N/A The administrative state of the IP output filter:
• disabled (default) - Inactive and may be configured.
• enabled - Active, the IP output filter can be enabled only if
it is unique among existing enabled filters.
Command Example
The commands below create and configure an IP output filter, f1. All outbound UDP packets that
are sent from any IP address between 10.20.20.0 and 10.20.20.255, on any logical port between
5000 and 5999, to any logical port between 6000 and 6999, will match the filter criteria. By
creating and associating a DiffServ mark with that IP output filter, the matching packets will have
the value 5 inserted into the high order bits of their TOS byte in the packet header. By inserting the
value 5 into the high order six bits of the TOS, the TOS byte will be 0x14 or 20. The interpretation
of this value for quality of service purposes will be made by the network routers that forward these
packets.
% CREATE IP OUTPUT FILTER f1
% CONFIGURE IP OUTPUT FILTER f1 PROTOCOL udp
% CONFIGURE IP OUTPUT FILTER f1 SOURCEADDRESS START 10.20.20.0 ..
ENDADDR 10.20.20.255
% CONFIGURE IP OUTPUT FILTER f1 SOURCEPORT START 5000 ENDPORT 5999
% CONFIGURE IP OUTPUT FILTER f1 DESTINATIONPORT START 6000 ENDPORT 6999
% CONFIGURE IP OUTPUT FILTER f1 STATE enabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Network Interfaces (NIF)
To display configuration information about the DiffServ mark associated with IP output filter f1:
% SHOW DIFFSERV MARK f1
Node: TPUBS Date: 2002/02/07 19:48:03 GMT
Zone: GMTMINUS05-EASTERN-US
If necessary, you can specify the maximum segment size (MSS) value of TCP connections.
NOTE
The changed MSS value does not get stored in the parameter file. Also, the
maximum transfer unit (MTU) = 1500 regardless of the MSS setting.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Interfaces (NIF) CLI Reference
Command Parameters
Field
Parameter Length Description
tcp_seg_size N/A Specifies the TCP maximum segment size. Range 536-1460
octets; default is 1452. Should be a multiple of 4.
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference IP Traffic Policing
IP Traffic Policing
Figure 3–4 below summarizes the high level GSX policing policy for media, signaling, and
control traffic packets. Once a received packet is validated by the hardware, it is placed into a
media or non-media stream. Each media packet that is forwarded for a “call”:
Each signaling/control packet is screened by the following subsytems (in the presented order)
before being forwarded to the appropriate application for further action:
• Black list (packets from known attacking peers) filtering, described later in this section
• White list (packets from known friendly peers) policing, described later in this section.
• Lightgray (or SIP registered peer) policing, described in "Lightgray POLICER on the Ethernet
NIF" on page 3–135.
• Darkgray (or default peer) policing described later in this section, and in "Darkgray POLICER
on the Ethernet NIF" on page 3–135.
• Logical Interface (or Per-VLAN) policing, described in "Per-VLAN POLICER on the
Ethernet NIF" on page 3–136.
• Server protect policing described later in this section.
These subsystems provide a wire-rate ability to limit the amount of signaling traffic that is
processed by the system. Following application of all these mechanisms, Access Control filtering
(see "IP Input Filter" on page 3–192) is applied. This subsystem provides a flexible ability to
further limit packet traffic according to finer-grained criteria.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
IP Traffic Policing CLI Reference
Received
packet
IP packet Fail
validations
Yes Media No
packet?
Per-VLAN
policing
Server-
protect
policing
Application
level
policing
Application
processing
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference IP Traffic Policing
The IP traffic policing commands provide a configurable facility to block, identify, and report
Denial-of-Service (DoS) and Distributed Denial-of-Service (DDoS) IP attacks, within the
processing flow pictured above.
In general, an attack is recognized by an excessive packet discard rate (of various packet types).
Once recognized, these attacks are announced through MAJOR or MINOR ALARMs. Packet discard
rate thresholds and durations are defined for recognizing an attack and as well for recognizing a
cessation of the attack, which is also announced via MAJOR and MINOR ALARMs.
These filtering and policing mechanisms identify and limit black list, white list, lightgray, and
darkgray packets. Black list filters and white list POLICERs are named and assigned to a NIF or a
NIF SUBINTERFACE (VLAN SIF), and associated with the SOURCE IPADDRESS of a known
friendly or unfriendly peer. A darkgray (or default peer) POLICER may be assigned similarly to
each NIF. The darkgray POLICER does not take a name. See "Network Interfaces (NIF)" on
page 3–133 for more detail on the darkgray POLICER.
The act of discarding a packet triggers the threshold and duration monitoring actions that are
configured in the DISCARD RATE PROFILE. A DISCARD RATE PROFILE is assigned to each
MAJOR or MINOR ALARM. The ALARM may be associated with a particular server module, or with
the entire system. When a (DISCARD RATE PROFILE) threshold is met and a discard rate (or
higher) is maintained for a prescribed duration, the ALARM that is associated with your system or
server module is triggered. That ALARM is cleared when a lesser threshold is met and that discard
rate (or lower) is maintained for a prescribed duration.
The POLICER ALARM SERVER object sets the MAJOR and MINOR ALARM generation levels for
specific (MNS20 or PNS40) server modules on the GSX9000. The POLICER ALARM SYSTEM
object sets the MAJOR and MINOR ALARM generation levels for the entire GSX9000 or GSX4000
system.
A DISCARD RATE PROFILE is assigned to each ALARM. Each ALARM is active when:
Once active, the specific DISCARD RATE PROFILE thresholds and durations direct the setting
and clearing of specific alarms.
ALARM and POLICER configuration, status, and statistics may be displayed via the SHOW
POLICER, SHOW CURRENT, and SHOW INTERVAL commands.
The POLICER SYSTEM object allows you to configure system-wide aspects of signaling and
media policing.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
IP Traffic Policing CLI Reference
The “single token bucket” policer model is used by white list and darkgray policers. This model
allows you to apply rate limiting to streams of received packets. Packets in excess of the permitted
rate are deemed "nonconforming" and are discarded. Black lists do not use this model because
they don't apply policing -- every packet matching a black list entry is discarded. (However the
discard rate of black listed packets is measured and may cause the triggering of an alarm.)
These policers protect the system itself and the protected networks behind it against Denial of
Service caused by overwhelming floods of packets. The policers also protect the delivery of
service to each peer system in the network against disruption by floods of packet sent by other
peers.
Each policer instance conceptually consists of a “bucket” that collects “tokens”. (A token may be
thought of as a "credit".) New tokens flow into the bucket at a constant rate called the FILLRATE.
If the bucket "fills up" (the number of tokens in the bucket reaches the BUCKETSIZE) additional
credits that are added per the FILLRATE "spill over" the edge of the bucket and are lost. When a
packet to be policed is received, if there are sufficient credits in the bucket to accommodate the
packet then the packet is accepted and the corresponding credits are deducted from the bucket. If
there are insufficient credits in the bucket, the packet is discarded and no credits are removed from
the bucket. The FILLRATE never increases the credit balance beyond the BUCKETSIZE and the
arrival of packets never reduces the credit balance below zero.
Over time, the maximum rate at which packets may be accepted by the policer is equal to the
FILLRATE. However, since the bucket can store up tokens, it allows a limited number of tokens
(or BUCKETSIZE) to be saved up during periods when packets are arriving more slowly. Those
saved credits allow the policer to accept short term bursts at a later time that are temporarily
arriving at a rate in excess of the FILLRATE. The larger the BUCKETSIZE, the more credits may
be saved for later. The bucket thus allows the policer to accommodate some burstiness in the
arrival of packets.
For the GSX white list and darkgray policers, the tokens represent units of bytes. Thus the
FILLRATE is in bytes per second and the BUCKETSIZE is in bytes.
• The FILLRATE limits the received packets per second over the long term.
• The amount of credits in the bucket at any given time limits the burst of packets that may be
accepted at a rate greater than the FILLRATE over a short term.
• The BUCKETSIZE limits the maximum credits that may ever be saved up, thus defining the
maximum burst that may ever be accepted.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference IP Traffic Policing
Policing Example
The example data shown in Table 3–54 illustrates a simple 6-second time slice using bytes per
second policing. This example policer uses a bucket size of 2048 bytes and a fill rate of 512 bytes/
sec. No packets are received in the first two seconds, but the credit balance remains at 2048. In the
next two seconds, varying bursts of packets are received, but the new credits keep the credit
balance above zero and no packets are discarded (dropped). In the fifth second (Time 4), bursts of
packets are received in sufficient quantity to reduce the credit balance to near zero, despite the 512
new credits that are deposited. Thus the 544 byte packet received during that interval is discarded,
but the smaller 128 byte packet at the end of that interval is accepted (passed) because the credit
balance of 168 is sufficient. During the next interval, no packets are received so the credit balance
is increased by 512 bytes. In the next interval, a 128 byte packet is received and accepted because
of the credit balance of 552.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
IP Traffic Policing CLI Reference
White and black list POLICERs are named, assigned to a NIF or a NIF SUBINTERFACE (VLAN
SIF), and associated with the SOURCE IPADDRESS of a known peer. These POLICERs are
activated when they are enabled. The BUCKETSIZE and FILLRATE parameters do not apply to
black lists, because all black list packets are discarded.
Command Syntax
Command Parameters
Field
Parameter Length Description
policername 1-23 The name of the IP POLICER that is being created,
configured, deleted, or examined.
nif_name 1-23 The name of the NIF on which the IP POLICER is being
created.
sif_name 1-23 The name of the NIF SUBINTERFACE on which the IP
POLICER is being created.
policertype N/A The type of policing:
• black - packets that are received on this interface from
known attacking addresses.
• white - packets that are received on this interface from
known friendly peers.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference IP Traffic Policing
Field
Parameter Length Description
ipaddress N/A The 32-bit IP source address of white (friendly peer) packets or
black (attacking) packets. A number in dotted decimal form (for
example 128.127.50.224).
bucketsize N/A The “bucket size” in bytes. Must be 2048-65520, default is
2048 (bytes). This quantity represents a white packet “credit
balance” that must be consumed before white packets are
discarded. These credits are reduced by every white packet
that is received on the NIF/SIF and restored by the FILL
RATE described below.
These “credits” reside in the “bucket”. Each received white
packet causes this sum to be decremented by the packet size.
When a white packet is received while the credit balance is
less than the size of that packet, the packet is discarded and
subject to the alarm actions controlled by the DISCARD RATE
PROFILE selected by the system or server POLICER ALARM
monitoring this NIF/SIF.
fillrate N/A The fill rate, in bytes per second. Must be 512-8388608, default
512 (bytes per second).
The number of bytes to add to the bucket credit balance every
second. In order for white packets to be discarded, they must
be received at a rate that exceeds this fill rate such that the
credits are reduced to zero. When white packets are
discarded, they are subject to the alarm actions controlled by
the DISCARD RATE PROFILE selected by the system or
server POLICER ALARM monitoring this NIF/SIF.
The bucket credit balance will never grow larger than the
configured BUCKETSIZE, regardless of the size of this
increment.
This value represents the white bytes per second threshold
beyond which packets are discarded (after the initial credit
balance has been reduced to zero).
admin_state N/A The administrative state of the named POLICER:
• disabled (default) - In this state, white or black packets
received on this NIF or SIF are never discarded by this
policer.
• enabled - In this state, the named POLICER parameters
determine the rate at which packets received on this NIF/
SIF are accepted, making them subject to the alarm actions
controlled by the DISCARD RATE PROFILE selected by
the system or server POLICER ALARM monitoring this
NIF/SIF.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
IP Traffic Policing CLI Reference
Command Example
To create and enable a GSX9000 black list policer on the Gigabit Ethernet NIF on port 2 of the
PNS40 in slot 15, that monitors packets received from the known (unfriendly) peer address
10.16.20.101:
% CREATE POLICER blackpolicer1 TYPE black NIF NAME GENET-1-15-2 ..
SOURCE IPADDRESS 10.16.20.101
% CONFIGURE POLICER blackpolicer1 STATE enabled
Policer Status
--------------
Intf Source IP NP Total Total
Indx Name Index Address ID Pkts Discards
===== ======================== ===== =============== ===== ========== ==========
1 blackpolicer1 0 0.0.0.0 N/A N/A N/A
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference IP Traffic Policing
The POLICER SYSTEM object allows you to manage certain aspects of policing that are
controlled at a node-wide level of granularity. The POLICER SYSTEM alarm announces that a
particular percentage of policer resources are now in use. The in-use-policer thresholds (in
percentages) control the setting and clearing of this alarm.
You can exclude all media packets that are received and discarded during a configurable ROGUE
MEDIA GRACE PERIOD following the termination of a call, from further scrutiny.
The LIGHTGRAY policers are configured through the POLICER SYSTEM object. These policers
monitor signaling packets that are generated by access peers following a successful SIP
registration. Each SIP endpoint is policed individually, however lightgray policing itself is
enabled/disabled per NIF. You can set the lightgray policer FILLRATE (in packets/ten-seconds)
and BUCKETSIZE (in packets). There is only one FILLRATE and BUCKETSIZE setting for the
system, however policing is performed individually for each peer (using the same FILLRATE and
BUCKETSIZE). See "Lightgray POLICER on the Ethernet NIF" on page 3–135 for additional
detail on lightgray policing.
Command Syntax
NOTE
When issuing POLICER SYSTEM commands on a GSX4000 series switch, omit the
SHELF parameter.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
IP Traffic Policing CLI Reference
Command Parameters
Field
Parameter Length Description
shelf N/A The shelf number in the GSX node configuration. In this
release, one shelf is supported. Must be 1.
(GSX9000 only.)
media_policing_s N/A The administrative state of system wide media policing:
tate
• disabled - Not active.
• enabled (default) - Active.
setinusepolicers N/A The percentage of activated policing resources, above which
an alarm is set. When this percentage of in-use policer
resources is met or exceeded, the alarm is triggered. This
alarm thereby notifies you of a resource utilization issue, not an
actual policing issue. Must be 1-100, default is 90 (percent).
This must always be greater than the CLEAR THRESHOLD.
clearinusepolice N/A The percentage of activated policing resources, less than
rs which an alarm is cleared. When this alarm has been triggered,
this is the percentage of in-use policer resources beneath
which, the alarm is cleared. Must be 1-100, default is 75
(percent). This must always be less than the SET
THRESHOLD.
roguemediagracep N/A The time in seconds that unexpected media is ignored after a
eriod call terminates. Must be 0-16, default is 4 (seconds).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference IP Traffic Policing
Field
Parameter Length Description
bucketsize N/A The “bucket size” in packets. Must be 0-31.
This quantity represents a lightgray packet “credit balance” that
must be consumed before packets that are evaluated by a
lightgray policer are discarded. The credit balance is reduced
by every packet that is accepted by the policer and restored by
the FILLRATE described below.
These “credits” reside in the “bucket”. Each received packet
accepted by the policer causes this sum to be decremented by
one. When a lightgray packet is received while the credit
balance is zero, the packet is discarded and subject to the
alarm actions controlled by the DISCARD RATE PROFILE
selected by the system or server POLICER ALARM.
fillrate N/A The fill rate, in packets per ten second interval. Must be 0-400
(packets per ten second interval).
The number of packets to add to the bucket credit balance
every ten seconds. Lightgray packets will be discarded if they
are received at a rate that exceeds this fill rate, causing the
credit balance to be reduced to zero. When lightgray packets
are discarded, they are subject to the alarm actions controlled
by the DISCARD RATE PROFILE selected by the system or
server POLICER ALARM monitoring this NIF.
The bucket credit balance will never grow larger than the
configured BUCKETSIZE, regardless of the size of this
increment.
Command Example
Shelf 1
Resouce Utilization Set Threshold : 90
Resouce Utilization Clear Threshold : 75
Media Policing State : ENABLED
Rogue Media Grace Period : 4
Light Gray Policer Bucket Size : 31
Light Gray Policer Fill Rate : 400
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
IP Traffic Policing CLI Reference
This object is linked to each POLICER ALARM, described in the following sections. This profile
establishes the specific rate and duration of each event type that will trigger each alarm, and as
well, the rate and duration that will clear each alarm.
For each of these events, an events per second THRESHOLD (or higher) must be maintained for
DURATION seconds to trigger the associated alarm. To clear the alarm a lesser THRESHOLD must
be maintained for DURATION seconds.
Default DISCARD RATE PROFILEs are defined for MNS10 (applies to MNS1x), MNS20,
PNS40, and GNS1X server modules for major and minor alarms. See "Server Level Alarms" on
page 3–259 and "System Level Alarms" on page 3–255 for a list of these profiles.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference IP Traffic Policing
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
IP Traffic Policing CLI Reference
SET ROGUEMEDIAUNALLOCATEDPORT ..
DURATION set_roguemediaunallocatedport_duration
SET ROGUEMEDIAUNALLOCATEDPORT ..
THRESHOLD set_roguemediaunallocatedport_threshold
CLEAR ROGUEMEDIAUNALLOCATEDPORT DURATION
clear_roguemediaunallocatedport_duration
CLEAR ROGUEMEDIAUNALLOCATEDPORT THRESHOLD
clear_roguemediaunallocatedport_threshold
SET LIGHTGRAY DURATION set_lightgray_duration
SET LIGHTGRAY THRESHOLD set_lightgray_threshold
CLEAR LIGHTGRAY DURATION clear_lightgray_duration
CLEAR LIGHTGRAY THRESHOLD clear_lightgray_threshold
SET PERVLAN DURATION set_pervlan_duration
SET PERVLAN THRESHOLD set_pervlan_threshold
CLEAR PERVLAN DURATION clear_pervlan_duration
CLEAR PERVLAN THRESHOLD clear_pervlan_threshold
SET SERVERPROTECT DURATION set_serverprotect_duration
SET SERVERPROTECT THRESHOLD set_serverprotect_threshold
CLEAR SERVERPROTECT DURATION clear_serverprotect_duration
CLEAR SERVERPROTECT THRESHOLD clear_serverprotect_threshold
CONFIGURE POLICER DISCARD RATE PROFILE discard_profile STATE admin_state
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference IP Traffic Policing
Command Parameters
Field
Parameter Length Description
discard_profile 1-23 The name of the DISCARD RATE PROFILE that is being
created, configured, deleted or examined. The DISCARD
RATE PROFILE establishes the conditions for generating
alarms due to excessive packet discarding.
admin_state N/A The administrative state of the DISCARD RATE PROFILE:
• disabled (default) - Not active. In this state, this profile
cannot be assigned to a SYSTEM or SERVER ALARM.
• enabled - Active. In this state, this profile may be assigned
to any SYSTEM or SERVER ALARM.
set_white_durati N/A The time in seconds that the SET WHITE THRESHOLD
on (discard rate) must be maintained before the associated
ALARM is generated. Must be 0-65535. A value of 0 causes
the ALARM to be generated whenever the WHITE
THRESHOLD is crossed.
set_white_thresh N/A The white packet discard rate in packets per second that will
old generate the associated ALARM if it is maintained for WHITE
DURATION seconds. Must be 0-2147483647. A value of 0
disables the alarm for this policer.
clear_white_dura N/A The time in seconds that the CLEAR WHITE THRESHOLD
tion (discard rate) must be maintained before the associated
ALARM is cleared. Must be 0-65535. A value of 0 causes the
ALARM to be cleared whenever the CLEAR WHITE
THRESHOLD is crossed.
clear_white_thre N/A The white packet discard rate in packets per second that will
shold clear the associated ALARM if it is maintained for CLEAR
WHITE DURATION seconds. Must be 0-2147483647. You
must configure this to a value less than the value of SET
WHITE THRESHOLD.
set_black_durati N/A The time in seconds that the SET BLACK THRESHOLD
on (discard rate) must be maintained before the associated
ALARM is generated. Must be 0-65535. A value of 0 causes
the ALARM to be generated whenever the BLACK
THRESHOLD is crossed.
set_black_thresh N/A The black packet discard rate in packets per second that will
old generate the associated ALARM if it is maintained for BLACK
DURATION seconds. Must be 0-2147483647. A value of 0
disables the alarm for this policer.
clear_black_dura N/A The time in seconds that the CLEAR BLACK THRESHOLD
tion (discard rate) must be maintained before the associated
ALARM is cleared. Must be 0-65535. A value of 0 causes the
ALARM to be cleared whenever the CLEAR BLACK
THRESHOLD is crossed.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
IP Traffic Policing CLI Reference
Field
Parameter Length Description
clear_black_thre N/A The black packet discard rate in packets per second that will
shold clear the associated ALARM if it is maintained for CLEAR
BLACK DURATION seconds. Must be 0-2147483647. You
must configure this to a value less than the value of SET
BLACK THRESHOLD.
set_darkgray_dur N/A The time in seconds that the SET DARKGRAY THRESHOLD
ation (discard rate) must be maintained before the associated
ALARM is generated. Must be 0-65535. A value of 0 causes
the ALARM to be generated whenever the DARKGRAY
THRESHOLD is crossed.
set_darkgray_thr N/A The darkgray packet discard rate in packets per second that
eshold will generate the associated ALARM if it is maintained for
DARKGRAY DURATION seconds. Must be 0-2147483647. A
value of 0 disables the alarm for this policer.
clear_darkgray_d N/A The time in seconds that the CLEAR DARKGRAY THRESHOLD
uration (discard rate) must be maintained before the associated
ALARM is cleared. Must be 0-65535. A value of 0 causes the
ALARM to be cleared whenever the CLEAR DARKGRAY
THRESHOLD is crossed.
clear_darkgray_t N/A The darkgray packet discard rate in packets per second that
hreshold will clear the associated ALARM if it is maintained for CLEAR
DARKGRAY DURATION seconds. Must be 0-2147483647.
You must configure this to a value less than the value of SET
DARKGRAY THRESHOLD.
set_media_durati N/A The time in seconds that the SET MEDIA THRESHOLD
on (discard rate) must be maintained before the associated
ALARM is generated. Must be 0-65535. A value of 0 causes
the ALARM to be generated whenever the MEDIA
THRESHOLD is crossed.
set_media_thresh N/A The media packet discard rate in packets per second that will
old generate the associated ALARM if it is maintained for MEDIA
DURATION seconds. Must be 0-2147483647. A value of 0
disables the alarm for this policer.
clear_media_dura N/A The time in seconds that the CLEAR MEDIA THRESHOLD
tion (discard rate) must be maintained before the associated
ALARM is cleared. Must be 0-65535. A value of 0 causes the
ALARM to be cleared whenever the CLEAR MEDIA
THRESHOLD is crossed.
clear_media_thre N/A The media packet discard rate in packets per second that will
shold clear the associated ALARM if it is maintained for CLEAR
MEDIA DURATION seconds. Must be 0-2147483647. You
must configure this to a value less than the value of SET
MEDIA THRESHOLD.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference IP Traffic Policing
Field
Parameter Length Description
set_roguemediaba N/A The time in seconds that the SET ROGUEMEDIABADDEST
ddest_duration THRESHOLD (discard rate) must be maintained before the
associated ALARM is generated. Must be 0-65535. A value of
0 causes the ALARM to be generated whenever the
ROGUEMEDIABADDEST THRESHOLD is crossed.
These are packets in which the destination IPADDRESS does
not match the expected destination IPADDRESS for the
allocated media port.
set_roguemediaba N/A The “rogue media packets with bad destinations” discard rate
ddest_threshold in packets per second that will generate the associated ALARM
if it is maintained for ROGUEMEDIABADDEST DURATION
seconds. Must be 0-2147483647. A value of 0 disables the
alarm for this policer.
clear_roguemedia N/A The time in seconds that the CLEAR ROGUEMEDIABADDEST
baddest_duration THRESHOLD (discard rate) must be maintained before the
associated ALARM is cleared. Must be 0-65535. A value of 0
causes the ALARM to be cleared whenever the CLEAR
ROGUEMEDIABADDEST THRESHOLD is crossed.
clear_roguemedia N/A The “rogue media packets with bad destinations” discard rate
baddest_threshol in packets per second that will clear the associated ALARM if it
d is maintained for CLEAR ROGUEMEDIABADDEST
DURATION seconds. Must be 0-2147483647. You must
configure this to a value less than the value of SET
ROGUEMEDIABADDEST THRESHOLD.
set_roguemediaba N/A The time in seconds that the SET ROGUEMEDIABADSOURCE
dsource_duration THRESHOLD (discard rate) must be maintained before the
associated ALARM is generated. Must be 0-65535. A value of
0 causes the ALARM to be generated whenever the
ROGUEMEDIABADSOURCE THRESHOLD is crossed.
These are packets in which the IP source address or source
port does not match the expected value for allocated media
port or the UDP source port does not match expected value for
allocated media port.
set_roguemediaba N/A The “rogue media packets with a bad source” discard rate in
dsource_threshol packets per second that will generate the associated ALARM if
d it is maintained for ROGUEMEDIABADSOURCE DURATION
seconds. Must be 0-2147483647. A value of 0 disables the
alarm for this policer.
clear_roguemedia N/A The time in seconds that the CLEAR
badsource_durati ROGUEMEDIABADSOURCE THRESHOLD (discard rate) must
on be maintained before the associated ALARM is cleared. Must
be 0-65535. A value of 0 causes the ALARM to be cleared
whenever the CLEAR ROGUEMEDIABADSOURCE
THRESHOLD is crossed.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
IP Traffic Policing CLI Reference
Field
Parameter Length Description
clear_roguemedia N/A The “rogue media packets with a bad source” discard rate in
badsource_thresh packets per second that will clear the associated ALARM if it is
old maintained for CLEAR ROGUEMEDIABADSOURCE
DURATION seconds. Must be 0-2147483647. You must
configure this to a value less than the value of SET
ROGUEMEDIABADSOURCE THRESHOLD.
set_roguemediami N/A The time in seconds that the SET
dcallbadvlan_dur ROGUEMEDIAMIDCALLBADVLAN THRESHOLD (discard
ation rate) must be maintained before the associated ALARM is
generated. Must be 0-65535. A value of 0 causes the ALARM
to be generated whenever the
ROGUEMEDIAMIDCALLBADVLAN THRESHOLD is crossed.
These are packets with a wrong or unexpected VLAN tag: the
packet VLAN tag does not match value expected for the
allocated media port, or the packet contains a VLAN tag when
none was expected.
set_roguemediami N/A The “rogue media midcall packets with a bad VLAN tag”
dcallbadvlan_thr discard rate in packets per second that will generate the
eshold associated ALARM if it is maintained for
ROGUEMEDIAMIDCALLBADVLAN DURATION seconds.
Must be 0-2147483647. A value of 0 disables the alarm for this
policer.
clear_roguemedia N/A The time in seconds that the CLEAR
midcallbadvlan_d ROGUEMEDIAMIDCALLBADVLAN THRESHOLD (discard
uration rate) must be maintained before the associated ALARM is
cleared. Must be 0-65535. A value of 0 causes the ALARM to
be cleared whenever the CLEAR
ROGUEMEDIAMIDCALLBADVLAN THRESHOLD is crossed.
clear_roguemedia N/A The “rogue media midcall packets with a bad VLAN tag”
midcallbadvlan_t discard rate in packets per second that will clear the associated
hreshold ALARM if it is maintained for CLEAR
ROGUEMEDIAMIDCALLBADVLAN DURATION seconds.
Must be 0-2147483647. You must configure this to a value less
than the value of SET ROGUEMEDIAMIDCALLBADVLAN
THRESHOLD.
set_roguemediaun N/A The time in seconds that the SET
allocatedport_du ROGUEMEDIAUNALLOCATEDPORT THRESHOLD (discard
ration rate) must be maintained before the associated ALARM is
generated. Must be 0-65535. A value of 0 causes the ALARM
to be generated whenever the
ROGUEMEDIAUNALLOCATEDPORT THRESHOLD is crossed.
These packets are destined for an unassigned RTP media
port, while not in the ROGUE MEDIA GRACE PERIOD.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference IP Traffic Policing
Field
Parameter Length Description
set_roguemediaun N/A The “rogue media packets with an unallocated destination port”
allocatedport_th discard rate in packets per second that will generate the
reshold associated ALARM if it is maintained for
ROGUEMEDIAUNALLOCATEDPORT DURATION seconds.
Must be 0-2147483647. A value of 0 disables the alarm for this
policer.
clear_roguemedia N/A The time in seconds that the CLEAR
unallocatedport_ ROGUEMEDIAUNALLOCATEDPORT THRESHOLD (discard
duration rate) must be maintained before the associated ALARM is
cleared. Must be 0-65535. A value of 0 causes the ALARM to
be cleared whenever the CLEAR
ROGUEMEDIAUNALLOCATEDPORT THRESHOLD is crossed.
clear_roguemedia N/A The “rogue media packets with an unallocated destination port”
unallocatedport_ discard rate in packets per second that will clear the associated
threshold ALARM if it is maintained for CLEAR
ROGUEMEDIAUNALLOCATEDPORT DURATION seconds.
Must be 0-2147483647. You must configure this to a value less
than the value of SET ROGUEMEDIAUNALLOCATEDPORT
THRESHOLD.
set_lightgray_du N/A The time in seconds that the SET LIGHTGRAY THRESHOLD
ration (discard rate) must be maintained before the associated
ALARM is generated. Must be 0-65535. A value of 0 causes
the ALARM to be generated whenever the LIGHTGRAY
THRESHOLD is crossed.
set_lightgray_th N/A The lightgray packet discard rate in packets per second that
reshold will generate the associated ALARM if it is maintained for
LIGHTGRAY DURATION seconds. Must be 0-2147483647. A
value of 0 disables the alarm for this policer.
clear_lightgray_ N/A The time in seconds that the CLEAR LIGHTGRAY
duration THRESHOLD (discard rate) must be maintained before the
associated ALARM is cleared. Must be 0-65535. A value of 0
causes the ALARM to be cleared whenever the CLEAR
LIGHTGRAY THRESHOLD is crossed.
clear_lightgray_ N/A The lightgray packet discard rate in packets per second that
threshold will clear the associated ALARM if it is maintained for CLEAR
LIGHTGRAY DURATION seconds. Must be 0-2147483647.
You must configure this to a value less than the value of SET
LIGHTGRAY THRESHOLD.
set_pervlan_dura N/A The time in seconds that the SET PERVLAN THRESHOLD
tion (discard rate) must be maintained before the associated
ALARM is generated. Must be 0-65535. A value of 0 causes
the ALARM to be generated whenever the PERVLAN
THRESHOLD is crossed.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
IP Traffic Policing CLI Reference
Field
Parameter Length Description
set_pervlan_thre N/A The per-vlan packet discard rate in packets per second that will
shold generate the associated ALARM if it is maintained for
PERVLAN DURATION seconds. Must be 0-2147483647. A
value of 0 disables the alarm for this policer.
clear_pervlan_du N/A The time in seconds that the CLEAR PERVLAN THRESHOLD
ration (discard rate) must be maintained before the associated
ALARM is cleared. Must be 0-65535. A value of 0 causes the
ALARM to be cleared whenever the CLEAR PERVLAN
THRESHOLD is crossed.
clear_pervlan_th N/A The per-vlan packet discard rate in packets per second that will
reshold clear the associated ALARM if it is maintained for CLEAR
PERVLAN DURATION seconds. Must be 0-2147483647. You
must configure this to a value less than the value of SET
PERVLAN THRESHOLD.
set_serverprotec N/A The time in seconds that the SET SERVERPROTECT
t_duration THRESHOLD (discard rate) must be maintained before the
associated ALARM SERVER alarm is generated. Must be 0-
65535. A value of 0 causes the ALARM to be generated
whenever the SERVERPROTECT THRESHOLD is crossed.
This (SERVERPROTECT) policer is intended to protect server
modules from packets that have cleared all other policers.
Although you cannot configure the bucket size and fillrate of
this policer, you can configure the alarm thresholds and
durations.
set_serverprotec N/A The aggregate discard rate in packets per second that will
t_threshold generate the associated ALARM SERVER alarm if it is
maintained for SERVERPROTECT DURATION seconds. Must
be 0-2147483647. A value of 0 disables the alarm for this
policer.
clear_serverprot N/A The time in seconds that the CLEAR SERVERPROTECT
ect_duration THRESHOLD (discard rate) must be maintained before the
associated ALARM is cleared. Must be 0-65535. A value of 0
causes the ALARM to be cleared whenever the CLEAR
SERVERPROTECT THRESHOLD is crossed.
clear_serverprot N/A The aggregate discard rate in packets per second that will
ect_threshold clear the associated ALARM SERVER alarm if it is maintained
for CLEAR SERVERPROTECT DURATION seconds. Must be
0-2147483647. You must configure this to a value less than the
value of SET SERVERPROTECT THRESHOLD.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference IP Traffic Policing
Command Example
To display the names and configuration of all DISCARD RATE PROFILEs on the GSX9000:
% SHOW POLICER DISCARD RATE PROFILE ALL ADMIN
Node: SKYLARK Date: 2007/05/01 14:58:12 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
IP Traffic Policing CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference IP Traffic Policing
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
IP Traffic Policing CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference IP Traffic Policing
---------------------------------------------------------------------------
White : 20 10 3 3
Black : 100 20 3 3
Light Gray : 20 10 3 3
Dark Gray : 20 10 3 3
Per VLAN : 20 10 3 3
Server Protect : 20 10 3 3
Media : 20 10 3 3
Rogue Media Unallocated Port : 20 10 3 3
Rogue Media Mid Call Bad Source : 20 10 3 3
Rogue Media Mid Call Bad Dest : 20 10 3 3
Rogue Media Mid Call Bad Vlan : 20 10 3 3
---------------------------------------------------------------------------
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
IP Traffic Policing CLI Reference
The POLICER ALARM SYSTEM object allows MAJOR and MINOR ALARM thresholds to be
assigned at the overall GSX9000 or GSX4000 system level. A DISCARD RATE PROFILE is
assigned to each ALARM. Each ALARM is active when:
Once active, the specific DISCARD RATE PROFILE thresholds and durations direct the setting
and clearing of specific alarms.
ALARM and POLICER configuration, status, and statistics may be displayed via the SHOW
POLICER, SHOW CURRENT, and SHOW INTERVAL commands.
Default DISCARD RATE PROFILEs exist for the POLICER ALARM SYSTEM for SHELF 1.
Major and minor default profiles are defined for GSX4000s, GSX9000s using MNS10s, and
GSX9000s using MNS20s:
• defaultMinorSysMns10
• defaultMajorSysMns10
• defaultMinorSysMns20
• defaultMajorSysMns20
• defaultMinorSysGns
• defaultMajorSysGns
You can also assign a custom DISCARD RATE PROFILE for the system level. To set the system
level alarms back to using the default DISCARD RATE PROFILE for the server module types, set
the system policer DISCARD RATE PROFILE to the null string.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference IP Traffic Policing
Command Syntax
NOTE
When issuing POLICER ALARM SYSTEM commands on a GSX4000 series switch,
omit the SHELF parameter.
Command Parameters
Field
Parameter Length Description
discard_profile 1-23 The name of the DISCARD RATE PROFILE that is being
assigned to a major or minor system policer alarm. The
DISCARD RATE PROFILE establishes the conditions for
generating alarms due to excessive packet discarding.
shelf N/A The shelf number in the GSX node configuration. In this
release, one shelf is supported. Must be 1.
(GSX9000 only.)
oper-state N/A The operational state of the associated (MAJOR or MINOR)
SYSTEM ALARM:
• inservice - Able to be triggered.
• outofservice (default) - Not active.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
IP Traffic Policing CLI Reference
Command Example
To configure and activate MAJOR and MINOR POLICER ALARMs on a GSX9000 system, using
customized DISCARD RATE PROFILEs for each:
% CONFIGURE POLICER ALARM SYSTEM SHELF 1 ..
LEVEL MAJOR DISCARD RATE PROFILE discrateprof_maj
LEVEL MAJOR MODE inservice
LEVEL MINOR DISCARD RATE PROFILE discrateprof_min
LEVEL MINOR MODE inservice
To reset the system level alarms to use the default MAJOR DISCARD RATE PROFILE:
% CONFIGURE POLICER ALARM SYSTEM SHELF 1 ..
LEVEL MAJOR DISCARD RATE PROFILE “”
To display the configuration of the system alarms created and configured above:
% SHOW POLICER ALARM SYSTEM SHELF 1 ADMIN
Node: TPUBS Date: 2006/07/27 23:44:57 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference IP Traffic Policing
Shelf Index : 1
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
IP Traffic Policing CLI Reference
The POLICER ALARM SERVER object allows MAJOR and MINOR ALARM thresholds to be
assigned to specific (MNS20 or PNS40) server modules on the GSX9000. A DISCARD RATE
PROFILE is assigned to each ALARM. Each ALARM is active when:
Once active, the specific DISCARD RATE PROFILE thresholds and durations direct the setting
and clearing of specific alarms.
You may display the configuration and status of server alarms via SHOW POLICER ALARM
SERVER ..
You can also assign a custom DISCARD RATE PROFILE to a server module. To set the server
level alarms back to using the default DISCARD RATE PROFILE for the server module types, set
the server policer DISCARD RATE PROFILE to the null string.
Command Syntax
NOTE
When issuing POLICER ALARM commands on a GSX4000 series switch, omit the
SHELF and SLOT parameters.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference IP Traffic Policing
Command Parameters
Field
Parameter Length Description
discard_profile 1-23 The name of the DISCARD RATE PROFILE that is being
assigned to a major or minor server policer alarm. The
DISCARD RATE PROFILE establishes the conditions for
generating alarms due to excessive packet discarding on a
server module.
shelf N/A The shelf number in the GSX node configuration. In this
release, one shelf is supported. Must be 1.
(GSX9000 only.)
slot N/A The slot number occupied by the server module for which a
POLICER ALARM is being configured or examined. This
number must be 1-16.
(GSX9000 only.)
oper-state N/A The operational state of the designated (MAJOR or MINOR)
SERVER ALARM:
• inservice - Able to be triggered.
• outofservice (default) - Not active.
Command Example
To configure and enable a SERVER MAJOR and MINOR ALARMs on the PNS40 in slot 9, using
different DISCARD RATE PROFILEs for each:
% CONFIGURE POLICER ALARM SERVER SHELF 1 SLOT 9
LEVEL MAJOR DISCARD RATE PROFILE discrateprof_maj
% CONFIGURE POLICER ALARM SERVER SHELF 1 SLOT 9
LEVEL MAJOR MODE inservice
% CONFIGURE POLICER ALARM SERVER SHELF 1 SLOT 9
LEVEL MINOR DISCARD RATE PROFILE discrateprof_min
% CONFIGURE POLICER ALARM SERVER SHELF 1 SLOT 9
LEVEL MINOR MODE inservice
To reset the server alarms in slot 4 to the default MAJOR DISCARD RATE PROFILE for that
server module type:
% CONFIGURE POLICER ALARM SERVER SHELF 1 SLOT 4
MAJOR DISCARD RATE PROFILE “”
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
IP Traffic Policing CLI Reference
To display the configuration of the server alarms created and configured above:
% SHOW POLICER ALARM SERVER SHELF 1 SLOT 9 ADMIN
Node: TPUBS Date: 2006/07/27 23:23:43 GMT
Zone: GMTMINUS05-EASTERN-US
To display the status of the server alarms created and configured above:
% SHOW POLICER ALARM SERVER SHELF 1 SLOT 9 STATUS
Node: TPUBS Date: 2006/07/27 23:29:14 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference IP Traffic Policing
The INTERVAL POLICER/CURRENT POLICER object allows you to view policer statistics
from recent time slots (or INTERVALs). These statistics may be generated by one (PNS40,
MNS20, or GNS1X) server module or by the entire GSX system. You may configure the number
and length of INTERVALs. You may view the statistics from a specific INTERVAL, or from all
INTERVALs. Whereas SHOW INTERVAL POLICER .. displays the statistics accumulated during
one or more historical INTERVALs, SHOW CURRENT POLICER .. displays the statistics that
have accumulated so far in the current interval. When statistics have been deposited into all
defined INTERVALs, the next accumulation of statistics will overwrite the first INTERVAL.
Command Syntax
NOTE
When issuing INTERVAL and CURRENT POLICER STATISTICS commands on a
GSX4000 series switch, omit the SHELF and SLOT parameters.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
IP Traffic Policing CLI Reference
Command Parameters
Field
Parameter Length Description
shelf N/A The shelf number in the GSX node configuration. In this
release, one shelf is supported. Must be 1.
(GSX9000 only.)
slot N/A The slot number occupied by the server module for which
interval statistics are being examined. This number must be 1-
16.
(GSX9000 only.)
interval N/A This number specifies the interval for which you seek statistics.
The INTERVAL SIZE and NUMBER OF INTERVALS are
established by the CONFIGURE PERFORMANCE
STATISTICS .. command (see "Performance Statistics" on
page 3–984.)
For INTERVAL POLICER STATISTICS, the maximum
number of intervals is 288, default is 4. The interval length
must be 5-1440 (minutes), default is 15.
INTERVAL SIZE times NUMBER OF INTERVALS must be less
than or equal 1440 (minutes). Thus to set the NUMBER OF
INTERVALS to 288, the INTERVAL SIZE must be 5.
When statistics for the last interval are accumulated and
written, the next accumulation overwrites the first interval.
Command Example
To display the statistics that have accumulated system wide for each policer in the current interval:
% SHOW CURRENT POLICER SYSTEM ALL STATISTICS
Node: TPUBS Date: 2007/05/02 15:40:18 GMT
Zone: GMTMINUS05-EASTERN-US
Shelf Index :
-------------------------------------------------------
White Discard Packet Count : 0
White Peak Discard Rate : 0
White Minor Alarm Count : 0
White Major Alarm Count : 0
White Minor Alarm Duration : 0
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference IP Traffic Policing
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
IP Traffic Policing CLI Reference
NOTE
The Alarm Duration value, for each of these policers, is the cumulative time in
seconds that the alarm was triggered during the period being examined.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference IP Traffic Policing
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
IP Traffic Policing CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference IP Traffic Policing
The POLICER OFFENDERS object assists you in the diagnosis of DoS attacks. The reports
generated by the SHOW POLICER OFFENDERS .. commands provide a detailed accounting of
the individual POLICER packet rejections. In addition to policer violations, you may examine the
following types of offenders:
• ROGUEMEDIABYSOURCE - the source IP address with the most rogue media discarded
packets, and the count and nature of these packets.
• ROGUEMEDIABYDEST - the destination IP address (owned by the GSX) with the most rogue
media discarded packets, and the count and nature of these packets.
• duringCallGracePeriod - rogue media during the configured grace period (these will not
appear in POLICER OFFENDERS reports).
• unallocatedPort - rogue media on an unallocated port.
• badDestAddr - rogue media with a bad destination address
• badSourceAddr - rogue media with a bad source address or port.
• incorrectVLan - rogue media with an incorrect VLAN ID, for example expected 3 and got 4.
• unexpectedVLan - rogue media with an unexpected VLAN ID, for example containing a
VLAN ID when it shouldn’t have or VLAN ID not present when it should have been.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
IP Traffic Policing CLI Reference
Command Syntax
NOTE
When issuing POLICER OFFENDERS commands on a GSX4000 series switch, omit
the SHELF, SLOT, and POSITION parameters.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference IP Traffic Policing
Command Parameters
Field
Parameter Length Description
shelf N/A The shelf number in the GSX node configuration. In this
release, one shelf is supported. Must be 1.
(GSX9000 only.)
slot N/A The slot number occupied by the server module for which
OFFENDERS statistics are being examined. This number must
be 1-16.
(GSX9000 only.)
position N/A The position of the SERVER POLICER OFFENDER being
examined, where the worst offender is (position) 1.
(GSX9000 only.)
Command Example
To display the status of the Server Protect Offenders detected by the PNS40 server module in
slot 7:
% SHOW POLICER OFFENDERS SERVERPROTECT SHELF 1 SLOT 7 STATUS
Node: TPUBS Date: 2006/08/07 19:24:11 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
IP Traffic Policing CLI Reference
In the above display, only one the Destination Unique value UNIQUE, indicates that these
discarded packets all contained the same Destination IP Address and the same Ether Type (2054).
(These packets were discarded because the system bandwidth would have otherwise been
exceeded.)
To display the status of the Darkgray Offenders detected by the PNS40 server module in slot 7:
% SHOW POLICER OFFENDERS DARKGRAY SHELF 1 SLOT 7 STATUS
Node: TPUBS Date: 2006/08/02 19:02:48 GMT
Zone: GMTMINUS05-EASTERN-US
• UNIQUE - In the above display only one packet from any given “offender” is shown. If all the
packets from that offender in the given interval were the same as the one shown, the UNIQUE
tag is displayed. If the packets varied, the UNIQUE tag is not displayed.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference IP Traffic Policing
• UNALLOCATEDPORT - Indicates that these discarded packets were all rejected because of an
invalid Destination IP Port that was unallocated when each packet was received.
• Destination IP Address - 10.16.20.120 is the GSX owned IP address that received the
most discarded rogue media packets
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
IP Traffic Policing CLI Reference
The rogue media quarantine function is a mechanism to place arbitrary RTP ports, used for media
reception, into “quarantine” for a varying period of time. When that time period expires, the port is
returned to “clean” status. When the GSX software detects significant rogue media on an RTP
port, it causes that port to be quarantined. Using CONFIGURE ROGUEMEDIA PORT .., you may:
As with other IP policing features, this mechanism is available on PNS40, MNS20, and GNS15
packet ports.
A MEDIAMETRIC parameter is assigned to every logical RTP port on every physical port (that
supports IP policing). At system initialization, this parameter value is set to zero on all ports.
Subsequently, the GSX software keeps track of rogue media, and assigns a nonzero
MEDIAMETRIC value to those RTP ports upon which significant rogue media packets are
received.
• Quarantined Port Free Pool - all ports with nonzero MEDIAMETRIC values
• Clean Port Free Pool - all ports with a MEDIAMETRIC value of zero
When a new call is set up, the RTP media port is allocated from the Clean Port Free Pool if
possible. If the Clean Port Free Pool is empty, the RTP media port is allocated from the
Quarantined Port Free Pool.
The MEDIAMETRIC parameter value is “decayed” over time to direct it toward a zero value in
order to move the underlying RTP port to the Clean Port Free Pool. This is accomplished by
dividing the MEDIAMETRIC value by 2 every 60 seconds. When this halving results in a value
less than one, the underlying RTP port is returned to the Clean Port Free Pool with a
MEDIAMETRIC value of zero. This mechanism allows RTP ports to “automatically” age their way
out of quarantine. However, continued detection of rogue media on a quarantined port adds to the
MEDIAMETRIC value and prolongs the quarantine period.
You may display the Quarantined Port Free Pool through SHOW .. QUARANTINE .. LIST. You
may display various Quarantined RTP port statistics through SHOW .. QUARANTINE ..
STATUS. You may force a specific RTP port on a specific physical port into quarantine through
CONFIGURE .. MEDIAMETRIC, by setting it to a sufficiently high value. Once you have forced
an RTP port into quarantine, automatic aging will eventually bring it out of quarantine. However
you may bring it out of quarantine immediately by CONFIGURE .. MEDIAMETRIC, setting it to
zero. You may also lengthen its quarantine time by increasing MEDIAMETRIC, or reduce its
quarantine time by decreasing MEDIAMETRIC.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference IP Traffic Policing
Command Syntax
Command Parameters
Field
Parameter Length Description
shelf N/A The shelf number in the GSX node configuration. In this
release, one shelf is supported. Must be 1.
slot N/A The slot number occupied by the MNS2x or PNS40 server
module for which a ROGUEMEDIA PORT QUARANTINE is
being configured or examined. This number must be 1-16.
physicalport N/A The physical port on the MNA2x or the PNA4x that is being
configured or examined for ROGUEMEDIA PORT
QUARANTINE.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
IP Traffic Policing CLI Reference
Field
Parameter Length Description
rtpport N/A The logical number of the local Realtime Transport Protocol
(RTP) port that is being configured for ROGUEMEDIA PORT
QUARANTINE.
These ports are unique throughout MNS20s. On PNS40s,
these ports are unique throughout each of the two physical
ports.
This number must be in the range [RTP Port Base]-[RTP Port
Base+21384]. For a typical RTP Port Base of 5000, the
applicable range is 5000-26384.
mediametric N/A The rogue media metric for the specified RTP port on the
specified physical port. When this parameter value is changed
from zero to nonzero on an RTP port, then that port is
immediately is placed in the quarantined port free pool. When
the value changes from nonzero to zero, the port is released to
the clean port free pool.
This number is halved every 60 seconds, in order to move the
value toward zero and eventually return every quarantined port
to the clean port pool.
You can force an RTP port into the QUARANTINE LIST by
setting this parameter to a nonzero value; you can also remove
a port from the QUARANTINE LIST by setting this parameter
to zero.
This number must be 0-4294967295.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference IP Traffic Policing
Command Example
To place RTP port 10222 on physical port 1 of the PNS40 in slot 3 into quarantine:
% CONFIGURE ROGUEMEDIA PORT SHELF 1 SLOT 3 PHYSICALPORT 1 ..
RTP PORT 10222 MEDIAMETRIC 11
NOTE
The MEDIAMETRIC value 11 means that the port will remain in the QUARANTINE
LIST for 4 decay periods or 240 seconds.
Shelf Index : 1
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
IP Traffic Policing CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference IP Traffic Policing
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus PSX CLI Reference
Sonus PSX
This object identifies and configures the Sonus PSX that the GSX uses for route lookups.
Sonus PSX
The Sonus PSX performs route lookups and other related tasks. You can provide Sonus PSX
redundancy and/or load-sharing by configuring up to ten Sonus PSXs per GSX node.
Redundant Sonus PSXs are always in one of four operational states (modes), and are configured
using the CONFIGURE SONUS SOFTSWITCH ssswname MODE oper-state:
• active
• standby
• alternate
• outofservice
By configuring more than one PSX in the active mode, the GSX can have more than one PSX in
the active state. When a PSX in the active mode goes down, a PSX in the standby mode is
promoted to the active state. The GSX distributes traffic in round robin fashion to all the PSXs that
are currently in the active state.
Additionally, the GSX can register with up to eight additional alternate PSX systems, allowing
each PSX to properly route all late call forwarding attempts to the appropriate GSX. The number
of alternate PSXs configurable is determined by subtracting the number of active and standby
PSXs from 10. For a Softswitch session configured as an alternate, the GSX exchanges keep-alive
messages with the PSX and responds to mid-call trigger requests from the PSX. The GSX does not
issue new policy requests to the PSX on alternate sessions. Additionally, the configuration of
alternate sessions does not affect the existing active or standby sessions nor will the alternate
sessions be used in the event that an active or standby PSX fails.
This command swaps the modes of the two named PSXs, when one is in active mode and the other
is in standby mode.
% CONFIGURE SONUS SOFTSWITCH ssswname1 SWAPMODE SOFTSWITCH ssswname2
In the case where the SWITCHOVER mode is set to manual, when a PSX in the active mode goes
down and then comes back up, the PSX remains in the standby state until you issue the
CONFIGURE SONUS SOFTSWITCH ssswname1 SWITCHBACK command. In the case where the
SWITCHOVER mode is set to automatic, the PSX automatically goes to the active state, and issuing
this command is not necessary.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus PSX
TABLE 3–64
From
(operational
state) Changing to (operational state)
active standby outofservice
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus PSX CLI Reference
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus PSX
Command Parameters
Field
Parameter Length Description
ssswname 1-23 An alphanumeric name that you assign to the Sonus PSX.
ipaddress N/A The 32-bit IP address of the Sonus PSX specified in dotted
decimal form (for example 128.127.50.224). Default is 0.0.0.0.
portnumber N/A The logical port number for the GSX to use for IP communication
with the Sonus PSX. Default is 3055.
delaytime N/A The time (in milliseconds) between transaction retries subsequent
to the initial retry. The initial retry occurs after transtime
milliseconds. This must be 50-60000, default is 500.
retries N/A The number of times to retry any Sonus PSX transaction. Must be
0-32, default is 3.
keep-alive N/A The time interval (in seconds) to wait before issuing a “keep-alive”
poll to the Sonus PSX. This poll is issued only if there is no other
Sonus PSX activity during this interval. The receipt of any
message from the Sonus PSX resets the elapsed time to 0.
Must be 1-60, default is 15.
transtime N/A The time to wait (in milliseconds) for a reply from the initial
transaction request. When this timer expires, a transaction retry
will be issued. Subsequent retries of this transaction are controlled
by retries and delaytime. Must be 50-60000, default is 500.
admin-state N/A The administrative state of the Sonus PSX:
• disabled (default) - in this state the Sonus PSX is inactive and
oper-state is outofservice.
• enabled - in this state the Sonus PSX oper-state is
active or standby.
oper-state N/A The operational state (mode) of the Sonus PSX:
• active - in-service.
• standby - available for use but not active. Intended to serve as
a backup when another server in the active mode becomes
unavailable.
• alternate - configure this PSX as an alternate. The
configuration of alternate sessions does not affect the existing
active or standby sessions. The PSX is not expected to receive
query messages from the GSX, but can send messages to it.
• outofservice (default) - Out-of-service. You must be in this
state to change admin-state to disabled.
action N/A The method by which queued transactions are processed when
oper-state goes to standby or outofservice:
• dryup (default) - all queue entries are processed to completion
unless retries expires.
• force - all queue transactions are dropped immediately.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus PSX CLI Reference
Field
Parameter Length Description
switchover N/A The method by which the primary Sonus PSX is reinstated after
being switched:
• automatic - automatically attempt a connection with the
primary after the retrytime interval expires.
• manual - do not attempt to switch back except as directed by
an operator.
retrytime N/A The time to wait (in seconds) before retrying to establish
connection with the primary Sonus PSX after a switchover to the
standby in automatic mode. This retry will occur only if there is an
active standby. Must be 1-3600, default is 10.
cong-state N/A The Sonus PSX congestion control state:
• enabled (default)
• disabled
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus PSX
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Congestion Control CLI Reference
Congestion Control
The OVERLOAD PROFILE, CONGESTION SYSTEM, and CONGESTION SERVER objects provide a
facility for managing call congestion on the GSX.
Overload Profile
The Overload Profile specifies a set of congestion thresholds, congestion durations, and overload
controls. When a particular threshold is exceeded for a particular duration, the congestion level
may be raised to a higher level. Then, the overload control may be applied to help alleviate the
congestion. The profile also specifies clear congestion thresholds and durations. These values
establish the criteria for returning to the previous congestion level. These values require that the
overload conditions fall below their configured clear threshold values for a specific duration of
time, in order to return to the previous congestion level. These minimum clear durations prevent
thrashing in and out of congestion levels.
You may assign an Overload Profile to the SYSTEM (and apply it throughout the GSX) or the
SERVER (and apply it to a particular GSX server module on a GSX9000). You may specify and
manage the following congestion criteria through this facility:
• CPU utilization
• Memory utilization
• Call arrival rate for all modules in a GSX
• PSX Capacity (recognized only at the SYSTEM level)
• Log Spooler utilization (for stream-based logging only)
Default Overload Profiles are automatically created for SYSTEM congestion levels 1-3, as well as
for CNS, PNS, and SPS server modules on the GSX9000. These profiles are named:
• defaultMC1
• defaultMC2
• defaultMC3
• defaultCns (GSX9000 only)
• defaultPns (GSX9000 only)
• defaultSps (GSX9000 only)
You must disable an Overload Profile in order to change its configuration. Then, when you enable
the profile, you cause all the parameter values to be validated. Once validated, these values are
applied to the (SYSTEM or SERVER) congestion level that references the profile. When you disable
a profile, the GSX software continues to utilize the previous values of the profile for congestion
control processing. When you make a change in this manner, the system or server congestion level
is cleared if the Overload Profile was being referenced.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Congestion Control
Standby modules also perform congestion processing but you cannot configure the module
settings.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Congestion Control CLI Reference
Command Parameters
Field
Parameter Length Description
ovlprofname 1-23 An alphanumeric name that you assign to the Overload Profile
that is being created or configured.
cputhresh N/A The CPU utilization percentage threshold at which the
congestion level associated with this Overload Profile may be
set. In a SERVER context, this designates the CPU usage on
the server module that occupies the specified SLOT; in a
SYSTEM context, this designates the CPU usage on the active
MNS. Must be 0-100 (percent). A value of 0 disables CPU
utilization as a criterion for congestion.
On standby modules, this value is permanently set to 85% and
cannot be configured.
memthresh N/A The memory utilization percentage threshold at which the
congestion level associated with this Overload Profile may be
set. In a SERVER context, this designates the memory usage
on the server module that occupies the specified SLOT; in a
SYSTEM context, this designates the memory usage on the
active MNS. Must be 0-100 (percent). A value of 0 disables
memory utilization as a criterion for congestion.
On standby modules, this value is permanently set to 95% on
CNS30s, 85% on non-CNS30s and cannot be configured.
callrthresh N/A The rate of calls, in calls per second, at which the congestion
level associated with this Overload Profile may be set. In a
SERVER context, this designates the call rate on the server
module that occupies the specified SLOT, in a SYSTEM
context, this designates the combined call arrival rate for the
node. Must be 0-65535 (calls per second). A value of 0
disables call rate as a criterion for congestion.
psxcapthresh N/A The PSX congestion level which initiates this GSX congestion
level. This parameter applies only in SYSTEM context, never in
SERVER context. Must be 0-3. A value of 0 disables PSX
congestion level as a criterion for GSX congestion.
logspthresh N/A Specifies the Log Spooler utilization threshold at which a
congestion level may be set. Must be 1-100 (percent); default
is 90.
Note: This parameter is for stream-based logging only.
clcputhresh N/A The CPU utilization percentage threshold at which a
congestion level may be cleared. This clear threshold must be
less than or equal to the set threshold. Must be 0-100
(percent).
On standby modules, this value is permanently set to 75% and
cannot be configured.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Congestion Control
Field
Parameter Length Description
clmemthresh N/A The memory utilization percentage threshold at which a
congestion level may be cleared. This clear threshold must be
less than or equal to the set threshold. Must be 0-100
(percent).
On standby modules, this value is permanently set to 90% on
CNS30s, 75% on non-CNS30s and cannot be configured.
clcallrthresh N/A The call rate threshold at which a congestion level may be
cleared. This clear threshold must be less than or equal to the
set threshold. Must be 0-65535 (calls per second).
clpsxcapthresh N/A The PSX congestion level which clears this GSX congestion
level. This clear threshold must be less than or equal to the set
threshold. Must be 0-3.
cllogspthresh N/A Specifies the Log Spooler utilization threshold at which a
congestion level may be cleared. Must be 0-100 (percent);
default is 85.
Note: This parameter is for stream-based logging only.
cpudura N/A The time in seconds that the CPU utilization percentage must
be above its threshold before the congestion level is set. Must
be 0-65535 (seconds). A value of zero sets the congestion
level immediately.
On standby modules, this value is permanently set to 10
seconds and cannot be configured.
memdura N/A The time in seconds that the memory utilization percentage
must be above its threshold before the congestion level is set.
Must be 0-65535 (seconds). A value of zero sets the
congestion level immediately.
On standby modules, this value is permanently set to 10
seconds and cannot be configured.
callrdura N/A The time in seconds that the call rate must be above its
threshold before the congestion level is set. Must be 0-65535
(seconds). A value of zero sets the congestion level
immediately.
psxcapdura N/A The time in seconds that the PSX capacity must be above its
threshold before the congestion level is set. Must be 0-65535
(seconds). A value of zero sets the congestion level
immediately.
logspdura N/A Specifies the length of time that Log Spooler utilization must
be above its threshold before the congestion level is set. Must
be 0-65535 (seconds); default is 10. A value of zero sets the
congestion level immediately.
Note: This parameter is for stream-based logging only.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Congestion Control CLI Reference
Field
Parameter Length Description
clcpudura N/A The time in seconds that the CPU utilization percentage must
be below its clear threshold before the congestion level is
cleared. Must be 0-65535 (seconds). A value of zero clears
the congestion level immediately.
On standby modules, this value is permanently set to 10
seconds and cannot be configured.
clmemdura N/A The time in seconds that the memory utilization percentage
must be below its clear threshold before the congestion level is
cleared. Must be 0-65535 (seconds). A value of zero clears
the congestion level immediately.
On standby modules, this value is permanently set to 10
seconds and cannot be configured.
clcallrdura N/A The time in seconds that the call rate must be below its clear
threshold before the congestion level is cleared. Must be 0-
65535 (seconds). A value of zero clears the congestion level
immediately.
clpsxcapdura N/A The time in seconds that the PSX capacity must be below its
clear threshold before the congestion level is cleared. Must be
0-65535 (seconds). A value of zero clears the congestion level
immediately.
cllogspdura N/A Specifies the length of time that Log Spooler utilization must
be below its clear threshold before the congestion is cleared.
Must be 0-65535 (seconds); default is 10. A value of zero
clears the congestion level immediately.
Note: This parameter is for stream-based logging only.
acceptpercen N/A The overload control, or the rate at which calls will be
accepted in this congestion level. Must be 0-100 (percent). A
value of 0 rejects all calls. A value of 100 accepts all calls.
When SYSTEM CONGESTION is LEVEL MC3, the value of this
parameter is effectively 0, causing all calls to be rejected.
admin-state N/A The administrative state of the Overload Profile:
• disabled (default) - You must put the Overload Profile into
this state to change the value of any of its parameters. In
this state, congestion processing continues to use the
previous values of the profile.
• enabled - You must put the Overload Profile into this state
to apply it to a congestion level (SYSTEM or SERVER) that
references this profile. Putting it into this state will cause all
parameter values to be validated.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Congestion Control
Command Example
To change the configuration of the (default) Overload Profile defaultMC1, assigning new values
to the call rate thresholds and durations:
% CONFIGURE OVERLOAD PROFILE defaultMC1 STATE disabled
% CONFIGURE OVERLOAD PROFILE defaultMC1 THRESHOLD ..
SET CALLRATE THRESHOLD 150
% CONFIGURE OVERLOAD PROFILE defaultMC1 THRESHOLD ..
CLEAR CALLRATE THRESHOLD 130
% CONFIGURE OVERLOAD PROFILE defaultMC1 DURATION ..
SET CALLRATE THRESHOLD 12
% CONFIGURE OVERLOAD PROFILE defaultMC1 DURATION ..
CLEAR CALLRATE THRESHOLD 8
% CONFIGURE OVERLOAD PROFILE defaultMC1 STATE enabled
To change the overload control of the (default) Overload Profile defaultMC2 to accept 50%
of ingress calls to this GSX:
% CONFIGURE OVERLOAD PROFILE defaultMC2 STATE disabled
% CONFIGURE OVERLOAD PROFILE defaultMC2 ..
ACCEPT PERCENTAGE 50
% CONFIGURE OVERLOAD PROFILE defaultMC2 STATE enabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Congestion Control CLI Reference
Congestion
Four SYSTEM congestion levels are defined for the GSX node. Each level represents an increasing
severity of congestion within the GSX:
You may configure the percentage of ingress calls to be processed (P1 and P2). In levels MC1 and
MC2, the GSX software will attempt to balance traffic by assigning H.323 and SIP calls to non-
congested CNS or GNS modules. In levels MC1, MC2, and MC3, all INFO event log messages are
suppressed (see "Event Filter" on page 3–103.)
Two SERVER congestion levels are defined for each GSX server module (GSX9000 only), again
representing an increasing severity of congestion within the server module:
• No Congestion - All calls are processed by the module.
• Congested - The GSX will process only a percentage of ingress calls from the module. The
GSX software will attempt to direct any new packet calls away from the congested module. If
a non-congested server module cannot be found, then the packet call will be rejected. SS7
Automatic Congestion Control (ACC) will not be enacted when a server module is in a
congested state.
NOTE
All egress calls will continue to be directed to a server module that is congested. If
the overload is due to egress calls, then the congested state may persist.
These congestion levels apply to both circuit and packet calls. You define the thresholds at which
these congestion levels are triggered, and the rate at which ingress call processing is throttled by
associating each level with an OVERLOAD PROFILE. (See "Overload Profile" on page 3–285.)
Four independent congestion criteria thresholds and durations are specified in the Overload
Profile:
• CPU utilization on the active MNS or GNS (SYSTEM) or specific server module (SERVER)
• Memory utilization on the active MNS or GNS (SYSTEM) or specific server module (SERVER)
• Combined call arrival rate for all GSX server modules (SYSTEM only)
• PSX Capacity (SYSTEM only)
By configuring the Overload Profile appropriately, one or more of these congestion criteria can
trigger a change in the congestion level.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Congestion Control
You must place a congestion level into MODE outOfService before you assign a (new) Overload
Profile to it. The GSX software will suspend congestion control processing while the MODE is
outOfService. When the parameter values in the new Overload Profile are validated and the
profile is placed inService, the new parameter values take effect.
When you reconfigure a congestion level, you clear any existing congestion on the corresponding
system or the server module.
NOTE
For PNS modules handling H.323 calls, the SHOW..CONGESTION..
SERVER..STATISTICS could be misleading. Although all PNS modules may be
used to route H.323 voice traffic, only the PNS module used for H.323 signaling will
ever show non-zero congestion statistics for H.323 traffic. This is the PNS module
that is configured as the H.323 Forwarding Engine (FE). H.323 congestion statistics
(current and interval) are not maintained on PNS modules used solely to route
voice traffic.
NOTE
SIP and H323 calls utilize CNS resources distributed across the GSX. When CNS
servers become congested, incoming calls cease to use the congested CNSs in
favor of uncongested CNSs. In the event that all become congested, resources are
evenly utilized across all CNSs once more. An edge scenario may also come into
play: as the last remaining, uncongested CNS approaches a congested state (for
example, if the call congestion threshold is 40 cps, and the call rate is approaching
this level on this server as a result of all other CNSs being congested) then calls
may start to be redistributed to other CNSs, even though the as yet uncongested
CNS has not yet reached MC1. This mechanism in effect is preventing the onset of
congestion on the only uncongested server.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Congestion Control CLI Reference
When activated by a congestion event, an adaptive algorithm supplements the congestion control
algorithm and iteratively adjusts the MNS call acceptance rate up or down to maintain a target
CPU load (~95%) and maximize call throughput throughout the overload event. The algorithm is
self-tuning to automatically adjust to GSX nominal capacity (and to non-call-rate related events
consuming unpredictable amounts of CPU) and is independent of hardware platforms (MNS10,
MNS11, MNS20), call scenario mix, signaling types, and user retry behavior. There is a single
default configuration for all system configurations. Priority calls are always allowed regardless of
MC level or whether the adaptive algorithm is activated.
The following parameters are for configuration of system-wide Adaptive Overload controls:
• ADAPTIVE MCLEVEL
• ADAPTIVE OVERLOAD GAIN FACTOR
• RESAMPLE INTERVAL
• RESOURCE AVG FACTOR
• RESAMPLE INTERVAL
• RESOURCE AVG FACTOR
Upgrade Considerations
If you are upgrading from a release that supports the adaptive algorithm (and the algorithm has
never been configured) or a release that does not support the adaptive algorithm, you must make
changes to the overload settings by running the script overloadUpgRec.tcl.
For more information and a listing of releases that support the Adaptive Overload feature, see the
current GSX Release Notes.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Congestion Control
Command Syntax
NOTE
When issuing CONGESTION SYSTEM commands on a GSX4000 series switch, omit
the SHELF parameter. GSX4000 series switches do not support CONGESTION
SERVER commands.
Congestion System
CREATE CONGESTION SYSTEM SHELF shelf
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Congestion Control CLI Reference
Congestion Server
CREATE CONGESTION SERVER SHELF shelf SLOT slot
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Congestion Control
Command Parameters
Field
Parameter Length Description
shelf N/A The shelf number in the GSX node configuration. In this release,
one shelf is supported. Must be 1.
Note: This parameter does not apply to GSX4000 series switches.
slot N/A The slot number occupied by the server module for which
congestion control is being configured or for which configuration,
status, or statistical information is being displayed. This number
must be 3-16.
mc1mode N/A The operational state of machine congestion level 1 or MC1:
• inService - the most recently assigned OVERLOAD PROFILE
is validated and activated.
• outOfService (default) - congestion control processing for
machine level 1 is suspended so that a new OVERLOAD
PROFILE can be assigned
mc2mode N/A The operational state of machine congestion level 2 or MC2:
• inService - the most recently assigned OVERLOAD PROFILE
is validated and activated.
• outOfService (default) - congestion control processing for
machine level 2 is suspended so that a new OVERLOAD
PROFILE can be assigned
mc3mode N/A The operational state of machine congestion level 3 or MC3:
• inService - the most recently assigned OVERLOAD PROFILE
is validated and activated.
• outOfService (default) - congestion control processing for
machine level 3 is suspended so that a new OVERLOAD
PROFILE can be assigned
cmode N/A The operational state of congestion level control for the specified
server module or SERVER:
• inService - the most recently assigned OVERLOAD PROFILE
is validated and activated.
• outOfService (default) - congestion control processing for
this server module is suspended so that a new OVERLOAD
PROFILE can be assigned
mc1opname 1-23 The name of the Overload Profile that you are assigning to
Machine Congestion Level 1 (MC1).
mc2opname 1-23 The name of the Overload Profile that you are assigning to
Machine Congestion Level 2 (MC2).
mc2opname 1-23 The name of the Overload Profile that you are assigning to
Machine Congestion Level 3 (MC3).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Congestion Control CLI Reference
Field
Parameter Length Description
adapmclevel N/A Sets the system machine congestion level at which the adaptive
algorithm activates:
• mc0 - set to this level during LWSU to disable the adaptive
algorithm.
• mc1
• mc2 (default for new installations)
• mc3
adapgain N/A Specifies a numeric value (integer) for the System Overload Gain
Factor used to optimize the adaptive algorithm. Higher values
result in a faster decrease in accepted load (i.e. the system will be
more aggressive in rejecting traffic). Must be 1-10; default is 3.
resampleint N/A Specifies the re-sample interval (in seconds) over which the
system re-computes the CPU and memory utilization percentages
and applies the adaptive algorithm, re-computing the call
acceptance rate. When applied at the server-level this determines
the interval at which the CPU and memory utilization percentages
are re-computed; however, the adaptive algorithm is not applied
for Server congestion. The recommended value is 3. Must be 1-30
(seconds); default is 1.
resavgfactor N/A Specifies the percentage of influence the previous internal
average (rather than current sample) has on the CPU and Memory
average computations. Must be 0-100; default is 30.
The new RES (CPU and memory) samples are calculated as
follows:
RESnew = RESprev * A + (100 – A) * REScurr
Where:
RESnew equals the new utilization percentage used by the
overload algorithm.
RESprev equals the previous utilization percentage used by the
overload algorithm.
REScurr equals the actual sampled utilization percentage for the
current interval.
Note: The greater the resource average factor, the more influence
the previous interval resource utilization value has on the newly
calculated utilization value (i.e., A = 100 means the new utilization
value will be based solely on the previous interval value.
Note: The resource average factor only affects the resource
utilization percentages used by the adaptive overload algorithm. It
does not affect the resource utilization percentages maintained by
the SHOW SERVER commands.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Congestion Control
Field
Parameter Length Description
copname 1-23 The name of the Overload Profile that you are assigning the server
module in the specified SLOT.
interval N/A A number that identifies the 15-minute interval for which SYSTEM
or SERVER congestion statistics are sought. The number 1 selects
the most recent interval, the number 2 selects 2 intervals ago, and
so on. Must be 1-288.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Congestion Control CLI Reference
Command Example
Shelf Index : 1
-------------------------------------------
MC1 Count : 0
MC1 Total Time : 0
MC2 Count : 0
MC2 Total Time : 0
MC3 Count : 0
MC3 Total Time : 0
Call Arrivals : 1358
GSX Calls Rejected : 0
PSX Calls Rejected : 0
Avg. Call Rate : 39
Peak Call Rate : 42
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Congestion Control
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Congestion Control CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Congestion Control
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Congestion Control CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Congestion Control
To display the four previous 15-minute intervals of SERVER congestion statistics for SLOT 3:
% SHOW INTERVAL CONGESTION SERVER SHELF 1 SLOT 3 STATISTICS
Node: TPUBS Date: 2003/07/07 20:48:54 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
SS7 Gateway
These objects identify and configure the SS7 gateway that will be accessed for call signaling
control.
You can optionally configure SS7 F links for direct termination to the GSX4000, or to a CNS25,
CNS40, CNS45, CNS71, CNS81, and CNS86 module on the GSX9000, eliminating the need (in
some cases) for a SS7 gateway. For more information, see "SS7 Link Termination" on page 3–
357.
SS7 Gateway
The SS7 gateway interfaces the GSX to the SS7 network. By supplying two gateways (Dual CEs)
you can provide redundancy. In this sense, configuration of the SS7 gateway is similar to
configuring the Sonus PSX.
SS7 gateways are always in one of two administrative states:
• enabled
• disabled
TABLE 3–68
From
(operational
state) Changing to (operational state)
inservice outofservice
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
The GSX selects one of four paths whenever it initiates a connection to the SGX:
• primary
• secondary
• primary-alternate
• secondary-alternate
Each path is selectable only if the corresponding host (PRIMARY or SECONDARY) MODE is
configured to inService. For example, if PRIMARY MODE is configured outOfService, then
the GSX will not select the primary or primary-alternate paths when initiating a connection to the
SGX. Once the connection is established while both hosts are inService, then if one host MODE
is configured to outOfService, overall service is not impacted because the connection will be
established on the other host MODE that remains inService. However if both host MODEs become
outOfService, the GSX will be disconnected from the SGX and overall service will be
impacted. One scenario that illustrates this circumstance is the following:
While the connection is established, one host MODE is configured outOfService and then the
connection to the other host is lost. The GSX will not be able to make a connection to the SGX
because each path to each CE in a Dual CE SGX is outOfService.
You may create a maximum of 16 SS7 GATEWAYs on one GSX.
NOTE
For GATEWAY TYPE dgms, when you change PRIMARY MODE or SECONDARY MODE
to outOfService, the client/server connections are not torn down and that SS7
GATEWAY remains AVAILABLE when viewed from the SS7 NODE via the SHOW SS7
NODE .. STATUS command. It is similarly available when viewed from the SGX.
The MODE is used to decide which SS7 GATEWAYs to use for new connections. For
GATEWAY TYPE m3ua, the client/server connections are torn down when the MODE
is changed to outOfService.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
Command Parameters
Field
Parameter Length Description
ss7gwname 1-23 An alphanumeric name you assign to the SS7 gateway.
gwtype N/A The gateway type as identified by the gateway protocol it uses:
• dgms (default)
• m3ua
pname 1-39 The name of the host computer that will be the primary SS7
gateway. This name should be a DNS entry.
p-ipaddress N/A The 32-bit IP address of the primary host link specified in
dotted decimal form (for example 128.127.50.224). Default is
0.0.0.0.
pa-ipaddress N/A The 32-bit IP address of the alternate primary host link
specified in dotted decimal form (for example 128.127.50.224).
Default is 0.0.0.0.
oper-state N/A The operational state of the associated (primary or secondary)
host:
• inservice
• outofservice (default)
sname 1-39 The name of the secondary SS7 gateway host. This name
should be a DNS entry.
s-ipaddress N/A The 32-bit IP address of the secondary host link specified in
dotted decimal form (for example 128.127.50.224). Default is
0.0.0.0.
sa-ipaddress N/A The 32-bit IP address of the alternate secondary host link
specified in dotted decimal form (for example 128.127.50.224).
Default is 0.0.0.0.
clientport N/A The SCTP/TCP port number for the client of the M3UA
association. Range: 1024 - 65535 or 0. When 0 is selected, the
port is assigned by SCTP/TCP.
serverport N/A The SCTP/TCP port number for the server of the M3UA
association. Must be 1024 - 65535
acktimer N/A The ACK timer length in milliseconds. The ACK timer is started
when the GSX sends an Application Server Process (ASP)
message (ASP Up, ASP Down, ASP Active, or ASP Inactive). If
the ASP does not receive a response before the timer expires,
the GSX may restart the timer and resend the message until it
receives an ACK message. Must be 100 -6000. Default: 2000
audittimer N/A The Audit timer length in milliseconds. The audit timer is started
after the GSX sends a Destination State Audit (DAUD)
message to the SGX to audit the availability and congestion
state of SS7 routes from the SGX to one or more affected
destinations, and they have become unavailable or congested
for the interval specified. Must be 1000 - 60000. Default: 10000
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
Field
Parameter Length Description
sctprtoinit N/A The initial retransmission timeout (RTO) timer length in
milliseconds. An SCTP endpoint uses this timer to ensure data
delivery in the absence of any feedback from its peer. Use this
parameter to set the RTO until an RTT (Round Trip Time)
measurement has been made for a packet sent to the given
destination transport address. Must be 100 - 60000. Default:
3000
sctprtomin N/A The minimum value for the retransmission timeout timer (RTO)
in milliseconds. An SCTP endpoint uses this timer to ensure
data delivery in the absence of any feedback from its peer.
Must be 100 - 60000. Default: 1000
sctprtomax N/A The maximum value for the retransmission timeout timer (RTO)
in milliseconds. An SCTP endpoint uses this timer to ensure
data delivery in the absence of any feedback from its peer.
Must be 100 - 180000. Default: 8000.
sctpinitretrans N/A The maximum number of times an endpoint will retransmit the
INIT/COOKIE ECHO message after the T1-init/T1-cookie timer
expires, before aborting the initialization process and reporting
the error to the SCTP user. Must be 2 - 20. Default: 5
sctppathretrans N/A The maximum number of times an endpoint will retransmit an
unacknowledged HEARTBEAT within an RTO to an idle
address, or the number of times the T3-rtx timer expires on any
address, before the endpoint marks the destination transport
address as inactive. Must be 1 - 20. Default: 3
hbinterval N/A The frequency of HEARTBEAT checks sent by an SCTP
endpoint in milliseconds. An SCTP endpoint monitors the
reachability of the idle destination transport address(es) of its
peer by sending a HEARTBEAT check periodically to the
destination transport address(es). Must be 50 - 60000. Default:
100
admin-state N/A The administrative state of this SS7 gateway:
• disabled (default) - Not active.
• enabled - Active.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
SS7 Node
This object identifies the SS7 gateway server application that the GSX client uses for call signaling
control. You may assign required service properties to this application. You may create a
maximum of eight (8) SS7 NODEs on the GSX.
• inservice
• outofservice
TABLE 3–70
From
(operational
state) Changing to (operational state)
inservice outofservice
NOTE
In a Dual CE configuration (see "SS7 Gateway" on page 3–305) with two SS7 NODEs
configured to each CE pair, when a LAN outage occurs, the recovery requires that
the GSX re-register to the first SS7 NODE, then to the second. The registration to the
second SS7 NODE will require 60 additional seconds after it has registered to the
first.
NOTE
You may not DELETE an SS7 NODE that is currently assigned to one or more
enabled TRUNK GROUPs.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
NOTE
Once an SS7 NODE is taken out of service, verify that all SGX connections to the
SS7 NODE have terminated before deleting the SS7 Node from the GSX. See the
SGX SS7 Gateway Operations Guide for information on determining the status of
the connections to the GSX.
The GSX allows you to modify the default values for approximately forty SS7 timers that reside
on the SGX. To specify a timer, you use the TIMER parameter, specify the particular timer
keyword, and enter the new value for the timer. For example, to specify the ITU timer T2 with a
value of five minutes (300 seconds), enter the following command: CONFIGURE SS7 NODE
TIMER T2 300.
The SHOW SS7 NODE ALL ADMIN command displays the current values for all timers that have
meaningful defaults on the SGX, or that you have configured.
For detailed information on SS7 Timer values, see "SS7 Timer Values" on page 3–318.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
Command Parameters
Field
Parameter Length Description
ss7nodename 1-23 The name of the SS7 node. This name was created when you
configured the SS7 gateway software (see the SGX SS7
Gateway Operations Guide).
localpc N/A The local or originating point code that identifies the SS7 node.
The format of the point code must match the format defined in
the pcformat parameter.
protocol N/A The SS7 protocol type supported by this Node entry. Protocol
choices are:
• ansi (default)
• itu
• etsi
• japan
• bt7
• china
services N/A The SS7 services required by this client:
• isupOnly (default)
• tcapOnly - not allowed
• isupAndTcap - not allowed
Note: isupOnly is the only allowable value for this parameter.
ss7altgwname 1-23 The name of the SS7 alternate gateway to which this SS7
Node is assigned in the case of geographic redundancy.
ss7gwname 1-23 The name of the primary SS7 gateway to which this SS7 Node is
assigned.
mtp3-mgmt 1-23 The name of the MTP3 management associated with this node.
Note: This parameter is for direct SS7 link termination to the
GSX (no SGX is used).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
Field
Parameter Length Description
connect N/A Specifies when the GSX will establish an ISUP connection with
the SS7 Gateway. This allows the GSX to establish only those
ISUP connections that are required by its ISUP circuits:
• always - ISUP service connection will be established when
the node is enabled.
• asNeeded (default) - ISUP service connection will be
established only if there are ISUP circuits assigned to this
node.
This parameter applies to ISUP service registration.
pcsize N/A Point code size. Integer from 1 - 32. Indicates the total number of
bits in the point code, when expressed in binary. Default is 24.
You should specify the POINTCODE SIZE parameter if you will
be entering point code values whose size (length in bits when
expressed as a binary value) is different from the default point
code size for this SS7 node, as defined on the SGX gateway. If
you will be entering point codes of non-default length, you must
also specify the exact format in which you will enter the alternate
length point codes, using the POINTCODE FORMAT option, below.
You must enter the point code size that is appropriate for the
protocol you are using:
• ansi - 24
• itu - 14
• japan - 16
• bt7 - 14
• china - 24
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
Field
Parameter Length Description
pcformat N/A The point code format required by this SS7 Node, in w1-w2-w3[-
wn] notation, where w(i) is a decimal number that designates the
maximum bit length of the subfield. The sum of the subfields
specifies the total bit length of the point code. This format option
accommodates any point code representation consisting of
decimal numbers separated by dashes, adding up to the total
number of bits in the point code. Note that this value may consist
of as few as one number. Hence for a POINTCODE SIZE of 14,
POINTCODE FORMATs of 3-8-3, or 4-10, or 14 are all satisfactory.
The sum of w1+w2+w3[+wn] must be no greater than 32 (bits).
For further example, 8-8-8 specifies three 8-bit values that, when
combined, occupy a 24-bit field. The highest decimal value that
can be represented in 8 bits is 255, therefore, using the 8-8-8
format, the highest possible point code you could specify would
be 255-255-255.
The following SS7 protocols require the specified point code
formats:
• ansi — 8-8-8
• itu — 3-8-3 or 14
• japan — 4-5-7 or 16
• bt7 — 3-8-3
If you want to use a different point code format, without changing
the default point code size, you need merely to reconfigure the
POINTCODE FORMAT parameter.
oper-state N/A The operational state of the node:
• inservice
• outofservice (default) - must be in this operational MODE in
order to make the administrative STATE disabled.
servprotocol N/A The server protocol used on this interface between the SS7
Client on the GSX and the SS7 Gateway (SGX).
• dgmsSuperRaw (default) - supports ansi, itu, bt7, japan,
and china.
• local - for direct SS7 link termination to the GSX (no SGX is
used); itu protocol only.
• m3ua - this option is only applicable with certain SGX
releases. Please refer to the SGX documentation to see
whether m3ua is supported and which protocols (e.g. itu) can
be used with it.
hsinterval 1 - 255 Handshake interval between the client and the server in
seconds. Not presently in use. Included for a future release.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
Field
Parameter Length Description
timer-name N/A Specifies the timer name. For TIMER names and default values,
see the following tables:
• "ITU Timers" on page 3–318
• "ANSI T1.113 Timers" on page 3–325
• "ANSI Bellcore Timers" on page 3–331
• "Japan Timers" on page 3–338
• "China Timers" on page 3–341
• "BT7 IUP Timers" on page 3–348
For additional detail on the function of each timer, see the ANSI
T1.113-1995 specification.
timer-value N/A Specifies the timer value. For TIMER names and default values,
see the following tables:
• "ITU Timers" on page 3–318
• "ANSI T1.113 Timers" on page 3–325
• "ANSI Bellcore Timers" on page 3–331
• "Japan Timers" on page 3–338
• "China Timers" on page 3–341
• "BT7 IUP Timers" on page 3–348
For additional detail on the function of each timer, see the ANSI
T1.113-1995 specification.
slsbits N/A Specifies the number of SLS bits to use. Must be 4-8, default is 5
(SLS bits).
If you use PROTOCOL ansi and SERVER PROTOCOL
dgmsSuperRaw, Sonus recommends 8 bit SLS to provide better
SS7 link utilization when traversing the STP networks. This
usage is compatible with most 5 SLS bit installations.
This parameter is configured on both the GSX and the SGX.
When these values differ, the lower value always prevails.
Unlike other SS7 NODE parameters, you do not need to bring the
SS7 NODE out of service to change this parameter. As soon as
this value changes, the ISUP service group will begin using the
new value.
isupvar N/A Specifies the SS7 ISUP variant set during Client Initialization:
• standard (default) - Default ISUP variant.
• j7ttc - Japan ISUP variant.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
Field
Parameter Length Description
indicator N/A Specifies the Network Indicator value to be used in the ISUP
Message header. Normally it is intl0 for international interfaces,
and natl0 for national interfaces.:
• intl0 - Corresponds to 00
• intl1 - Corresponds to 01
• natl0 (default) - Corresponds to 10
• natl1 - Corresponds to 11
tdcalls N/A Specifies whether or not to tear down all active calls when the
node goes out of service:
• enabled - Tear down the active calls.
• disabled (default) - Do not tear down the active calls.
m3ua-appear N/A Specifies the M3UA Network Appearance value; a local
reference shared by the SGX and the application server. This
value, combined with the Signaling Point Code uniquely identifies
an SS7 node by indicating the specific SS7 network it belongs to.
Must be 0 - 4294967295. Default Value: 0.
generatencr N/A Specifies whether to generate a Network Control Reference
(NCR) parameter if the GSX does not receive an IAM containing
an NCR parameter:
• enabled - generate an NCR parameter if it is not present in
the IAM.
• disabled (default) - do not generate an NCR parameter.
georedun N/A Specifies whether geographic redundancy is being used an
therefore a Alternate Gateway must be configured on the SS7
node (when the SERVER PROTOCOL is m3ua):
• enabled (default) - you must configure an Alternate Gateway
on the SS7 node.
• disabled - you can configure the SS7 node without setting
an Alternate Gateway.
During parameter loading, the value defaults to enabled, to
maintain the previous behavior.
admin-state N/A The administrative state of this SS7 node:
• disabled (default) - Not active. The MODE must be
outofservice to enter this state.
• enabled - Active.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
The following tables list the SS7 Node timers for each standard. In all cases, the timer-value is
expressed as an integer.
In all cases, the information in these tables applies only when you are using SS7 NODE SERVER
PROTOCOL dgmsSuperRaw.
The Timeout Range indicates the range according to the Sonus implementation, and the default
value. For actual timeout ranges for each standard, refer to the appropriate standard.
The Compliance column indicates that:
If the Sonus implementation is not compliant, then this column describes the exceptions.
ITU Timers
Table 3–72 quantifies timer behavior for ISUP protocol REVISIONs itu1993, itu1997,
itu1988, ituq767, and all REVISIONs other than ansi1992, ansi1995, nttfcc, and nttcom.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
ANSI Timers
Table 3–73 and Table 3–74 quantify timer behavior for REVISIONs ansi1992 and ansi1995.
In most cases, these timers do the same thing but have different names.
ANSI T1.113
Symbol Initiated by Event after Expiry
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
ANSI T1.113
Symbol Initiated by Event after Expiry
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
ANSI T1.113
Symbol Initiated by Event after Expiry
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
ANSI T1.113
Symbol Initiated by Event after Expiry
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
ANSI T1.113
Symbol Initiated by Event after Expiry
T36 T36 When Initial Address Message is Proceed with call processing
received indicating that another
segment follows
2–4 Receipt of an unsolicited Not supported
Information message
T37 T37 When ISDN User Part availability Restart availability test
test is started
4 – 30 Receipt of a message from the Not supported
affected ISDN User Part
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
ANSI T1.113
Symbol Initiated by Event after Expiry
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
ANSI T1.113
Symbol Initiated by Event after Expiry
ANSI Bellcore
Symbol Initiated by Event after Expiry
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
ANSI Bellcore
Symbol Initiated by Event after Expiry
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
ANSI Bellcore
Symbol Initiated by Event after Expiry
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
ANSI Bellcore
Symbol Initiated by Event after Expiry
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
ANSI Bellcore
Symbol Initiated by Event after Expiry
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
ANSI Bellcore
Symbol Initiated by Event after Expiry
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
ANSI Bellcore
Symbol Initiated by Event after Expiry
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
Japan Timers
Table 3–75 quantifies timer behavior for REVISIONs nttfcc and nttcom.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
China Timers
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
SETTING Network
Where
Timer Purpose Min Max Value Started Cancelled Run
TO-01 For called sub held. 2s 3m 2m When the Called When the Outgoing
Sub clears first Calling Sub
Note 7 and Note 2 clears or Called
This is an sub reanswers
originating node
timer only
TO-02 For non-receipt of 1m 12m Note 6 On receipt of On receipt of Outgoing
answer ACM. Answer or
Clear/Release
This is an
originating node Note 1
timer only
TO-03 To allow Re-answer 2s 5m Note 6 When Called Sub Receipt of Incoming
clears first. Release
Note 2 forward or when
This is a
called Sub re-
terminating node answers
timer only.
TO-04 To delay release of 2m 2m 2m When overload Never Outgoing
Circuit to exchange received from cancelled.
in overload. next node. Always matures
to initiate
Note 3 release.
TO-05 Awaiting Answer 1m 14m Note 6 When set-up in On receipt of Incoming
term node is Answer. (termina-
complete and ting node)
Note 1
detected.
This is a
terminating node
timer only.
TO-06 To determine; 1s 6s 4s On receipt of a On receipt of a Any
digit subsequent
-end of dialling digit
(To be started
-number length at
within networks
intermediate node. performing non-
C7 interworking
where number
length is unknown
and on receipt of
each digit after
the maximum
number of digits
have been
received.)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
SETTING Network
Where
Timer Purpose Min Max Value Started Cancelled Run
TO-08 For non-receipt of; - 1s 40s 30s On sending; On receipt of Both
Blocking/ Blocking/
- Blocking
Unblocking Unblocking
acknowledgement - Unblocking acknowledgem
ent.
TO-08a For non-receipt of 5m 15m 10m On sending an On receipt of Both
Unblocking Unblocking Unblocking
acknowledgement message due to Acknowledgem
expiry of Timer ent.
TO-08 for the
third time, or
restarted on
expiry of Timer
TO-08a.
TO-09 Awaiting 5s 30s 30s - Started on On receipt of a Outgoing
appropriate sending of the SEND N
backward message IFAM or IAM DIGITS, SEND
after IFAM/IAM/ ALL DIGITS, or
- Restarted on
SAM/FAM or ADDRESS
sending of any
forward Group 7 COMPLETE
forward Group 7
message is sent message
message if Timer
during call setup
TO-09 is currently
phase.
running
- Started or
restarted on
sending of SAM
or FAM
TO-10 To await forward 1s 40s 25s When any of the On receipt of Incoming
Release following forward release.
backward
messages are
sent:
- Release
- Congestion
- Terminal
Congestion
- Sub Engaged
- Sub Out of
Order
- Repeat Attempt
- CNA
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
SETTING Network
Where
Timer Purpose Min Max Value Started Cancelled Run
TO-12 Await receipt of 1s 60s 25s On sending On receipt of Both
circuit free or release. Cct. free or
When
blocking message. Blocking
provided at
Also used in each end of
bothway circuit the same
configuration, to circuit,
supervise clearing ensures
of the bearer circuit. release of
the circuit if
circuit free/
blocking
messages
are lost.
TO-12a Await receipt of 5m 15m 10m Started on On receipt of Both
circuit free or sending a third Circuit Free or
blocking message Release message Blocking
due to expiry of
Timer TO-12, or
restarted on
expiry of Timer
TO-12a.
TO-14 Await receipt of 1s 40s 5s When request is When message Both
Additional Info. sent. is received
Message.
A general purpose
protection timeout
which is to be run
whenever a
response message
is expected.
TO-16 For prolonged call 1m 3m 3m When calling Cancelled by Outgoing
set-up customer initiates Address
Note 4
call request (on Complete
sending of IAM/ Message,
IFAM) RELEASE
Message, or
when the calling
subscriber
clears.
TO-17 Non-receipt of SAM 5s 20s 20s When SAD is On receipt of Incoming
or FAM in response sent. Re-started FAM
to "Send All Digits" on receipt of SAM
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
SETTING Network
Where
Timer Purpose Min Max Value Started Cancelled Run
TO-18 Non-receipt of SAM 5s 3m Note 5 When SND is On receipt of Incoming
or FAM in response sent SAM or FAM
to "Send N Digits"
TO-21 To enable call clear 3m 3m 3m On receipt of On receipt of Both
due to non-receipt suspend resume
of resume indication indication from indication from
customer customer
Note 1: It is recommended that, within a network, Timer TO-05 is greater than Timer TO-02.
However, between networks this may not always apply.
Note 2: Timer TO-03, at the Terminating Node, ensures cleardown if the backward Clear (sent on
Call Sub Clears) is lost and Timer TO-01 at the Outgoing Network is therefore not started.
Note 5: The currect value of Timer TO-18 depends on the node and the number of digits required.
See table Table 3–78.
Note 6: Values for Timers TO-02, 03 and 05 differ in fixed and mobile applications, and shall be
agreed bilaterally.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
Note 7: Timer TO-01 is a general timeout or the Called Sub Held condition in the Outgoing
Network (Originating Node); different variants of this timer come into force depending upon the
Clearing Program in operation. Table 3–79 lists the associated basic Clearing Programs. Special
Clearing Programs - e.g. ISDN immediate release, Operator release - may override basic clearing
programs.
Min Max
First Party TO-01a 0 3m 0
Calling Party TO-01b 0 2m 2m
Called Party TO-01c 2s 180s 5s
Last Party TO-01d 5s 24h 24h
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
T22 : 38
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
Gateway Assignment :
Point Code (decimal) : 3-3-3 (197379)
Protocol Type : BT7
Services : ISUPONLY
Isup Connect Cntrl : ASNEEDED
PointCode Size in Bits : 14
PointCode Format : 3-8-3
Server Protocol : DGMSSUPERRAW
Handshake Interval : 0 Secs
Network Indicator : NATL0
SLS bits : 0
ISUP Variant : STANDARD
Teardown Calls : DISABLED
Timer Settings (Secs) :
TO-01 : 120 TO-05 : 120 TO-14: 5
TO-01a: 0 TO-06 : 4 TO-16: 180
TO-01b: 120 TO-08 : 30 TO-17: 20
TO-01c: 5 TO-08a: 600 TO-18: 60
TO-01d: 86400 TO-09 : 30 TO-20: 0
TO-02 : 120 TO-10 : 25 TO-21: 180
TO-03 : 120 TO-12 : 25
TO-04 : 120 TO-12a: 600
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
Active Management Server Module <--> SS7 Gateway TCP Connections Map:
CE Host Name Ip Address Link State Link Mode
-- ----------------------------------- --------------- --------------- --------
CE1 ubrs 10.3.99.80 AVAILABLE ACTIVE
CE1 ubrs 10.4.99.80 AVAILABLE STANDBY
Standby Management Server Module <--> SS7 Gateway TCP Connections Map:
CE Host Name Ip Address Link State Link Mode
-- ----------------------------------- --------------- --------------- --------
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
Integrated SS7 F link (fully-associated link) termination allows the GSX to serve as the physical
interface point connecting the GSX directly to the SS7 signaling network. Direct termination of
SS7 F links from the SS7 network is via T1/E1 interfaces on the GSX4000 and via E1 interfaces
on CNS25, CNS40, CNS45, CNS71, CNS81, and CNS86 modules. For more information on this
feature, see "Configuring Local SS7 Links" on page 6–197.
When you create an SS7 node, you define the protocol type used between the GSX9000 or
GSX4000 series switch and its signaling gateway using the SERVER PROTOCOL parameter. The
local option establishes that direct SS7 termination (no external Signaling Gateway) is used.
NOTE
You can configure a maximum of:
-- 256 SS7 links on the GSX9000: one SS7 link per three E1s (20 SS7 Links per
CNS71, CNS81,or CNS86 and four (4) per CNS25, CNS40, or CNS45).
The following objects are used to configure, control, and display the status of MTP2 and MTP3
protocol layers:
MTP2 Objects
• SS7 MTP2LINK PROFILE
• SS7 MTP2LINK
MTP3 Objects
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
This object creates a template for the MTP2LINK object. MTP2LINK objects that are configured
with a profile will silently take every parameter value specified in the profile unless explicitly
overridden. The default values for timers are set based on the protocol variant.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
Command Parameters
Field
Parameter Length Description
profilename 1-23 The name of the SS7 MTP2 link profile. Must be 1-23 characters.
variant N/A The SS7 MTP2 stack type protocol variant:
• itu (default)
• ansi
linkspeed N/A The SS7 MTP2 linkspeed:
• low
• high (default)
bitrate N/A The SS7 MTP2 bit rate in KB per second:
• bitrate64 (default)
• bitrate56
• bitrate48
ecm N/A The SS7 MTP2 error correction method:
• basic (default) - Basis Method of Error Correction. Depends
on a constant receipt of acknowledgements by the sending
point code.
• pcr - Preventive Cyclic Retransmission. An error correction
method used when there is a long propagation delay with
satellite links. PCR does not wait for acknowledgements; rather,
if no new message signaling unit (MSUs) are available for
transmission, those available for retransmission are
retransmitted cyclically.
For step-by-step instructions on changing the error correction
method to PCR, see "Changing Error Correction Methods for
MTP2 Links" on page 6–200.
timer-value N/A The timer value for the specified timer in milliseconds. See
Table 3–80, "MTP2LINK Timers" for information on each of the
timers, their valid ranges, and default values.
admin-state N/A The administrative state of this SS7 MTP2 Profile:
• disabled (default) - Not active.
• enabled - Active.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
MTP2LINK Timers
Table 3–81 describes the MTP2LINK timers, their valid ranges, and default values. All values
must be expressed as integers.
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
This object creates a SS7 MTP2LINK. SS7 MTP2LINK objects are associated with a particular
SS7 LINK object, which are associated with a particular SS7 NODE. The MTP2LINK object also
has an association with a physical DS0 channel. This establishes the slot, port, and channel to be
used for SS7 MTP signaling.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
Command Parameters
Field
Parameter Length Description
mtp2linkname 1-23 The name of the MTP2 Link. Must be 1-23 characters.
profilename N/A The name of the MTP2 Link profile.
port N/A The name of the T1 or E1 port assigned to the SS7 interface.
timeslot N/A The MTP2 link channel time slot. Must be 1 to 31. The default is
24.
trace N/A Determines the logging of layer events to the trace event log file.
• none (default)
• layer2
admin-state N/A The administrative state of this MTP2 link:
• disabled (default) - Not active.
• enabled - Active.
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
The SS7 MTP3 ANSI Profile object configures MTP3 timers, Signaling Link Testing (SLT),
and maintenance timers that are required by the ITU-T standards.
Command Syntax
Command Parameters
Field
Parameter Length Description
profilename N/A The name of SS7 MTP3 ANSI Profile. Must be 1-23 characters.
timer-name N/A The name of the MTP3 timer. (See Table 3–84, "MTP3 ANSI
Timers" for more information.)
timer-value N/A The timer value in milliseconds. (See Table 3–84, "MTP3 ANSI
Timers" for more information.)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
Table 3–84 describes the MTP3 ANSI timers, their valid ranges, and default values. All values
must be expressed as integers.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
The SS7 MTP3 ITU Profile object configures MTP3 timers, Signaling Link Testing (SLT),
and maintenance timers that are required by the ITU-T standards.
Command Syntax
Command Parameters
Field
Parameter Length Description
profilename N/A The name of SS7 MTP3 ITU Profile. Must be 1-23 characters.
timer-name N/A The name of the MTP3 timer. (See Table 3–86, "MTP3 ITU
Timers" for more information.)
timer-value N/A The timer value in milliseconds. (See Table 3–86, "MTP3 ITU
Timers" for more information.)
Table 3–86 describes the MTP3 ITU timers, their valid ranges, and default values. All values must
be expressed as integers.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
Command Examples
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
The SS7 MTP3 MGMT object configures stack type, stack capacity, timer profile, and the
measurement interval for statistics collection. This object also enables and disables the stack trace.
NOTE
Be sure to carefully configure the MTP3 MGMT configuration object when using the
CREATE SS7 MTP3 MGMT command. The CONFIGURE SS7 MTP3 MGMT mtp3name
... command allows you to change parameters of the MTP3 MGMT object. However,
the new values do not take effect until the MTP3 MGMT is re-initialized. Since there is
no DISABLE / ENABLE function for the MTP3 MGMT object, you must take the
following actions before the new values can take effect: 1) Delete all SS7
configuration. 2) Remove the SS7 management object. 3) Re-create the SS7
management object, and 4) Re-create all SS7 configuration.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
Command Parameters
Field
Parameter Length Description
mtp3name 1-23 The name of the MTP3 Mgmt. Must be 1-23 characters.
stacktype N/A The MTP3 Stack type:
• itu (default)
• ansi
maxnodes N/A The maximum number of SS7 Nodes. Must be 1-8.
maxdestin N/A The maximum number of remote point codes of the MTP3 stack.
Must be 1-256.
maxlinks N/A The maximum number of SS7 links of the MTP3 stack. Must be
1-256.
maxlinksets N/A The maximum number of SS7 linksets of the MTP3 stack. Must be
1-256.
maxroutes N/A The maximum number of SS7 routes of the MTP3 stack. Must be
1-512.
mtp3profile 1-23 The name of the MTP3 profile this MGMT uses. Must be 1-23
characters.
actvmode N/A The activation mode of the MTP3 stack.
ITU, ETSI:
• default - all active links in each link set are activated using
the normal alignment.
• allEmergency - all active links in each link set are activated
using the emergency alignment
• firstLinkEmergency - the first active link that was
configured in each linkset is activated using the emergency
alignment. The remaining are activated using the normal
alignment.
ANSI:
• default - same as firstLinkEmergency
• allEmergency - all active links in each link set are activated
using the emergency alignment
• firstLinkEmergency - the first active link that was
configured in each linkset is activated using the emergency
alignment. The remaining are activated using the normal
alignment default.
congpriority N/A Specifies whether the congestion priority is activated:
• on
• off
This parameter only applies to the national network.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
Field
Parameter Length Description
restartmode N/A The MTP restart mode:
• full
• partial (default)
Note: Applies to ANSI only.
statsinterval N/A The interval in minutes at which the MTP3 statistics are collected.
Must be 3-30.
statsmode N/A The statistics collection mode of the MTP3 stack.
• enabled (default) - enables the MTP3 stack statistics collection
at the rate that is specified by the STATISTICS INTERVAL
parameter.
• reset - zeros all the statistics counters when the collection is
enabled.
• disabled - disables the collection of statistics.
tracelevel N/A The trace level of the MTP3 stack.
• off (default) - turns the trace off.
• brief - logs the major events.
• detailed - logs the maximum information at numerous points
in the flow of execution.
Command Examples
To show the parameters configured for the SS7 MTP3 MGMT mtp3:
% SHOW SS7 MTP3 MGMT mtp3 ADMIN
Node: TPUBS Date: 2007/02/26 20:47:19 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
SS7 Destination
The SS7 DESTINATION object establishes and configures the destination node in a network that
has a signaling relationship with the local SS7 node.
Command Syntax
Command Parameters
Field
Parameter Length Description
destination 1-23 The name of the SS7 Destination node. Must be 1-23 characters.
destin-type N/A The SS7 Destination type:
• adjacent - directly connected destination
• remote - indirectly connected destination
pointcode 1-64 The point code assigned to this destination node.
ss7node N/A The name of the source SS7 Node.
mtp3mgmtname 1-23 The name of the source SS7 MTP3 MGMT. Must be 1-23
characters.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
Command Examples
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
SS7 Link
The SS7 Link object creates and configures a link between a source SS7 node and an adjacent
destination, and associates the link with a MTP2 Link.
Command Syntax
Command Parameters
Field
Parameter Length Description
linkname 1-23 The name of the SS7 link. Must be 1-23 characters.
linktype N/A The SS7 Link type:
• f - fully-associated links
• a - access links
• e - extended links
slc N/A The signaling link code (SLC) used by this SS7 link. Must be 0-15.
ss7node N/A The name of the source SS7 node.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
Field
Parameter Length Description
ss7destina- N/A The name of the SS7 destination node.
tion
mtp2link 0-23 The name of the MTP2 link associated with this SS7 link.
activ-mode N/A The activation mode of the SS7 link:
• deactivate -
• normal -
• emergency -
block-mode N/A The block mode of the SS7 link:
• off
• on
inhibit-mode N/A The inhibit mode of the SS7 link:
• off
• on
slt-mode N/A The signaling link terminal (SLT) operation:
• single - on-time occurrence
• periodic - scheduled occurrence
• off - turn of the periodic SLT that was previously set.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
Command Examples
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
SS7 Linkset
The SS7 Linkset object creates a linkset between a source SS7 node and an adjacent destination.
When you configure an SS7 linkset, all SS7 links previously configured between the two specified
SS7 nodes are collected into the SS7 linkset
Command Syntax
CREATE SS7 LINKSET linkset SS7 NODE ss7node SS7 DESTINATION destination
Command Parameters
Field
Parameter Length Description
linkset 1-23 The SS7 linkset name. Must be 1-23 characters.
ss7node N/A The name of the source SS7 Node.
destination N/A The name of the SS7 Destination node.
activ-mode N/A The activation mode for the linkset:
• deactivate - deactivates all SS7 links within the linkset
• normal - activate the link in normal mode.
• emergency - activate the link in emergency mode.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
SS7 Route
The SS7 Route object creates and configures a route from a source SS7 node to a destination node,
associates the route with a previously configured SS7 Linkset, and establishes a priority to
determine how the route is used with other routes to an SS7 Destination. Routes with the same
priority load share their traffic to their SS7 Destination.
Command Syntax
CREATE SS7 ROUTE ss7route ..
TYPE routetype
PRIORITY priority
SS7 NODE ss7node
SS7 DESTINATION destination
SS7 LINKSET linkset
Command Parameters
Field
Parameter Length Description
ss7route 1-23 The name of the SS7 route. Must be 1-23 characters.
routetype N/A The type of SS7 Route:
• direct - the route to the destination PC consists of a single
link set.
• indirect - the route to the destination PC consists of more
than one link set in tandem.
• dircluster - the route to the destination cluster consists of a
single link set.
• indirCluster - the route the destination cluster consists of
more than one link set in tandem.
priority N/A Determines how this route is used with other routes to an SS7
Destination. Routes with the same priority load share traffic to their
SS7 Destination. Must be 0-3.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference SS7 Gateway
Field
Parameter Length Description
ss7node N/A The name of the source SS7 node for this route.
destination N/A The name of the Destination SS7 node for this route.
linkset N/A The name of the linkset configured between the source and
desination nodes.
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SS7 Gateway CLI Reference
Type: INDIRECT
State: UNAVL|TFA
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Gateway-to-Gateway Signaling
The objects in this section allow you to configure signaling ports for gateway-to-gateway call
signaling.
The GSX performs gateway-to-gateway call signaling over TCP connections, which are referred
to as gateway signaling links. These links are established on an as needed basis (that is, this GSX
will establish a link with a remote GSX the first time it initiates a call to the remote GSX).
Signaling links are directional in the sense that they carry call signal traffic for calls that go from
this GSX to a specific remote GSX. For calls from a remote GSX, the remote GSX will establish a
link to this GSX.
The links are established by creating a TCP “connection” to a remote gateway signaling port. The
gateway signaling port is the address and TCP port number to which the remote GSX listens for
new connections. As described in the following subsections, this address is also used as the local
address for links which are created.
This object is the logical port to which the GSX “listens” for connection requests from other
GSXs.
A primary gateway signaling port makes gateway signal link connection requests to other GSXs,
using the IP address of that port as the local address. If no primary gateway signal port exists then
no connection requests to other GSXs can be made. All calls that require a new gateway signal link
connection will be dropped.
A secondary gateway signaling port is used only for listening and may not establish new gateway
signal links.
Two gateway signaling ports may be configured to permit potential network-wide configuration
changes with minimal service disruption as in the following scenario:
Configure a second port in the primary role. The former port becomes secondary but remains
functional for “listening”. When all other GSX gateways have been re-configured to connect to
this GSX on this new primary port, the former port can be safely placed out of service, disabled,
and deleted. In this manner, the network can be re-configured without shutting down this GSX.
You may wish to create GATEWAY SIGNALING PORTs on the same subnet as the IPADDRESS on
other NIFs. Set the LOGICAL SIGNALING ADDRESS BINDING STATE to enabled to enable this
feature. This will cause the GSX to respond to Address Resolution Protocol (ARP) requests for
logical signaling addresses (which are ignored when this status is disabled). See "Layer 2, N:1
Redundancy Model Considerations" on page 3–139 for additional detail.
• enabled
• disabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
• inService
• outOfService
• primary
• secondary
TABLE 3–92
From To
primary secondary
From
(operational
state) Changing to (operational state)
inService outOfService
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Command Parameters
Field
Parameter Length Description
sig-port N/A The logical reference number to the port for use with SNMP and/or
CLI. Must be 1-2.
ipaddress N/A The 32-bit IP address of the sig-port (above) specified in dotted
decimal form (for example 128.127.50.224). Default is 0.0.0.0.
This address MUST DIFFER FROM any existing network interface
addresses. Although it will use one of these physical interfaces
(see nif-type), its Internet Address must be unique.
log-port N/A The logical port number to use for this connection. Default is 2569.
Numbers greater than 4999 should not be used as these are
assumed to be for voice traffic.
nif-type N/A The type of network interface being configured for this function:
• mgtNif - The Management Network interface on the MNA or
GNA module.
• nif - The Packet Network interface on a PNA, GNA, or MNA2X
module.
If nif is chosen, then call signaling bandwidth usage will be taken
from the PNA or GNA bandwidth budgets. This allocation is
approximately 1.2 MB/sec.
role N/A The main role of the signaling port:
• primary (default) - the port that makes gateway signal link
connection requests to other GSXs, using its ipaddress as
the local address for listening.
• secondary - an alternate port that is used for listening only
and cannot be used to establish new gateway signal links.
When no primary port exists, connection requests to other GSXs
cannot be issued and calls which require them are disconnected.
When a secondary port is configured to be primary, the
previous primary is automatically made secondary.
lsas N/A The state of logical signaling address binding:
• disabled - In this state, the GSX does not respond to ARP
requests for logical signaling addresses. These logical
addresses must be reachable on all NIFs and the NEXT HOP
router/switch must have proper static routes to direct traffic to
these addresses.
• enabled (default) - In this state, the GSX will respond to ARP
requests for logical signaling addresses. This condition allows
you to configure logical signaling addresses on the same
subnet as other NIFs. The benefits of this state are described in
"Layer 2, N:1 Redundancy Model Considerations" on page 3–
139.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Field
Parameter Length Description
nifgroup 1-23 The name of the NIFGROUP that is being associated with this
GATEWAY SIGNALING PORT. A NIFGROUP is a named group
of physical packet based interfaces.
oper-state N/A The operational state of the signaling port:
• inService (default) - the signal port listens for incoming
gateway signal link connection requests.
• outOfService - the signal port is not available for incoming
gateway signal link connection requests and thus cannot be
used to create new gateway signal links to other GSXs.
admin-state N/A The administrative state of this signaling port:
• disabled (default) - Not active.
• enabled - Active.
Command Example
To create and configure a gateway signaling port on the MNA that by default becomes the
inService, primary signal port:
% CREATE GATEWAY SIGNALING PORT 1
% CONFIG GATEWAY SIGNALING PORT 1 IPADDR 128.2.3.4
% CONFIG GATEWAY SIGNALING PORT 1 STATE enabled
To create and configure a secondary gateway signaling port on the PNA10 which overrides certain
defaults:
% CREATE GATEWAY SIGNALING PORT 2
% CONFIG GATEWAY SIGNALING PORT 2 IPADDR 128.5.6.7
% CONFIG GATEWAY SIGNALING PORT 2 PORTNUM 3000
% CONFIG GATEWAY SIGNALING PORT 2 INTERFACE nif
% CONFIG GATEWAY SIGNALING PORT 2 ROLE secondary
% CONFIG GATEWAY SIGNALING PORT 2 STATE enabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Sig Port
Id IP Addr Num Intf Role Mode State NIF Group
---- --------------- ---- ------ --------- --------- ------- ----------
1 128.2.3.4 2569 NIF PRIMARY INSERVICE ENABLED
Sig Port
Id IP Addr Num Intf Role State NIF Group
---- --------------- ---- ------ --------- ------------ ---------
1 128.2.3.4 2569 NIF PRIMARY INSERVICE
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
This object allows you to gracefully establish or take down a signaling link with other GSXs. You
can also view currently established links. SHOW...SUMMARY displays collective link data,
SHOW..IPADDRESS displays individual links.
The CONGESTION RELEASE timer applies to all gateway links, and hence all to all GATEWAY
SERVICE groups. In general, congestion control of GATEWAY trunk groups is achieved through
the congestion control parameters provided in "Gateway Service" on page 3–393.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Command Parameters
Field
Parameter Length Description
ipaddress N/A The 32-bit IP address of the gateway with whom this link is
desired. Specified in dotted decimal form (for example
128.127.50.224). Default is 0.0.0.0.
log-port N/A The logical port number to use for this connection.
direction N/A The direction in which to tear down the link:
• to (default) - toward this GSX.
• from - away from this GSX.
• both - to and from this GSX.
Closing this link may disrupt service. You will be prompted to
affirm the command.
establishtime N/A The call signaling establishment timer (in seconds). Must be 1-
65535, default is 10 (seconds). This is the time interval to wait
for an acknowledgement to the OPEN message.
katime N/A The time interval (in seconds) between keepalive polls between
GSXs. Must be 1-65535, default is 3 (seconds).
retrytimer N/A The call signaling retry timer (in minutes). Must be 1-65535,
default is 60 (minutes). This is the time period that the GSX will
attempt to recover a signaling link, if stable calls are present.
Stable calls will not be torn down during this period, while
attempting to recover the link.
idletimer N/A The call signaling idle timer (in hours). Must be 0-65535, default
is 0. This is the time period after which an idle signaling link will
be taken down. When this value is 0, an idle signaling link will
never be taken down.
pendqmax N/A The maximum number of calls to be queued on a signaling link
that is coming up. Must be 1-20, default is 20 (calls). When this
limit is exceeded, the call will be rerouted (or cranked back).
This parameter only applies to a signaling link that is first coming
up. No calls are queued on a signaling link that has gone down
and upon which a recovery is being attempted.
congestionrelea N/A The time (in seconds) to wait to release a call when that call was
seto rejected due to congestion. This parameter effectively prevents
the machine congestion level from escalating due to rapid
repeated call attempts by equipment that does not support
congestion detection. Must be 0-5 (seconds), default is 0. A
value of 0 disables this timer.
If this value is nonzero, the timer is started when a call is
rejected due to congestion. When the timer expires, the network
release is sent and the call resources are de-allocated. If a
network release is received during the delay, the timer is
stopped and the call resources are de-allocated.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Command Example
NOTE
The Remote MC Level status may not always be accurate. In order for it to be
accurate, release messages must be received from the remote gateway for calls
sent there from the local gateway. The value displayed is always the last MC Level
received from the remote gateway, but the possibility exists that it is not the
current level.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Gateway Service
This object binds a GATEWAY service to an IP trunk group and assigns a name and properties to
this binding.
You can manage trunk group congestion through proper use of the Automatic Congestion Control
parameters (ACC LEVEL1 .., ACC LEVEL2 .., and ACC TACC).
You may temporarily remove and restore this service by toggling its operational state between
INSERVICE and OUTOFSERVICE. When you remove service in this manner you could disrupt
existing calls, so you will be prompted to affirm your command. The mechanisms used to carry out
these configuration changes are summarized below.
• enabled
• disabled
• inservice
• outofservice
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
TABLE 3–96
From
(operational
state) Changing to (operational state)
inservice outofservice
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Command Parameters
Field
Parameter Length Description
gwservname 1-23 The name of the GATEWAY service you are configuring.
tgname 1-23 The name of the IP trunk group to which this GATEWAY service
belongs.
saf_state N/A Specifies whether or not the GSX will perform IP source address
filtering on incoming media packets for the IP trunk group that
uses this GATEWAY service group. The source address to filter
on is supplied during call signaling.
• disabled - The service group does not filter the incoming
media stream.
• enabled (default) - The service group will only accept incoming
media packets whose source address matches the destination
address of the outbound packets.
nifgroup 1-23 The name of the NIFGROUP that is being associated with this
GATEWAY SERVICE group. A NIFGROUP is a named group of
physical packet based interfaces. If present, the media traffic on
the IP TRUNK GROUP that is assigned to this GATEWAY
SERVICE group is directed through the NIFs that make up this
NIFGROUP. If this parameter is not specified, then the default null
NIFGROUP is used. The null NIFGROUP includes all defined
NIFs.
level1calls N/A Automatic Congestion Control (ACC) Level 1 Reduction
Percentage. Indicates the percentage of calls to be allowed to be
directed to a remote gateway when that gateway is reporting
congestion level 1. Must be 0-100, default is 90. All priority calls
are allowed during ACC Level 1.
This reduction will until ACC TACC expires.
level2calls N/A Automatic Congestion Control (ACC) Level 2 Reduction
Percentage. Indicates the percentage of calls to be allowed to be
directed to a remote gateway when that gateway is reporting
congestion level 2. Must be 0-100, default is 70. All priority calls
are allowed during ACC Level 2.
This reduction will until ACC TACC expires.
acctacc N/A Specifies the Automatic Congestion Control timer in seconds.
Must be 0-10, default is 0. A value of 0 disables ACC and no traffic
reduction occurs.
If the value is nonzero, then each time a release message is
received with the congestion parameter, this timer is restarted with
this value. This enforces the traffic reduction behavior described
above for ACC LEVEL1 and LEVEL2. When the timer expires, no
further traffic reduction occurs.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Field
Parameter Length Description
drytimeout N/A The time (in minutes) to wait for all calls to complete before placing
the GATEWAY service in outOfService oper-state. Must be
0-1440 (minutes), default is 0. A value of 0 means wait indefinitely.
admin_state N/A The administrative state of this GATEWAY service:
• disabled (default) - Not active, and able to be configured.
• enabled - Active.
Command Example
To create, configure, and enable GATEWAY service group gwiptg1 on IP trunk group iptg1,
using source address filtering:
CREATE GATEWAY SERVICE gwiptg1
CONFIGURE GATEWAY SERVICE gwiptg1 TRUNK GROUP iptg1
CONFIGURE GATEWAY SERVICE gwiptg1 SOURCE ADDRESS FILTERING enabled
CONFIGURE GATEWAY SERVICE gwiptg1 STATE enabled
CONFIGURE GATEWAY SERVICE gwiptg1 MODE inService
-----------------------------------------------------------------
Gateway Service : defaultGwIpSrvcGrp
-----------------------------------------------------------------
Admin State : ENABLED
Mode : INSERVICE
Action : UNDEFINED
Dryup Timeout (min) : 0
Trunk Group : defaultiptg
Source Address Filtering : ENABLED
ACC Level1 Calls Allowed (%) : 90
ACC Level2 Calls Allowed (%) : 70
ACC TAcc (seconds) : 0
Media NIF Group :
----------------------------------------------------------------
Gateway Service : gwiptg1
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
----------------------------------------------------------------
Admin State : ENABLED
Mode : INSERVICE
Action : UNDEFINED
Dryup Timeout (min) : 5
Trunk Group : iptg1
Source Address Filtering : ENABLED
ACC Level1 Calls Allowed (%) : 90
ACC Level2 Calls Allowed (%) : 70
ACC TAcc (seconds) : 0
Media NIF Group :
-------------------------------------
Gateway Service Status
------------------------ ------------
defaultGwIpSrvcGrp AVAILABLE
gwiptg1 AVAILABLE
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
This object allows you to configure up to 32 H323 signaling ports on the GSX (or 16 H323
signaling ports when a PNS10 is installed on the GSX), allowing the GSX to function as an H323
Gateway, supporting H323 Network-to-Network call interoperability.
Essentially, you declare that a particular PNS module will be your H323 server through the CLI
commands described in this section. Both services must be assigned to the same PNS module. The
IP address and the logical port number provide a “logical address” for each signaling service.
These logical addresses must be identical for each port.
The basic requirements to provision the GSX for H323 functionality are to:
• G.711 A-law
• G.711 U-law
• G.729A+B voice compression
• G.729A voice compression
• G.723.1 voice compression
• G.726 voice compression
• T.38 fax relay
• transmission and reception of DTMF tones Out-of-Band by H.245 signaling
• jitter and lost packets compensation
• out of sequence packet handling
• RTCP statistics reports
The SHOW H323 SIGNALING PORT .. STATUS commands provide the following statistics:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
You may wish to create H323 SIGNALING PORTs on the same subnet as the IPADDRESS on other
NIFs. Set the LOGICAL SIGNALING ADDRESS BINDING STATE to enabled to enable this feature.
This will cause the GSX to respond to Address Resolution Protocol (ARP) requests for logical
signaling addresses (which are ignored when this status is disabled). See "Layer 2, N:1
Redundancy Model Considerations" on page 3–139 for additional detail.
NOTE
When you provision an H323 SIGNALING PORT, make sure that each NIF/SIF is
associated with only one ZONE via a NIFGROUP.
The H323 signaling port on the GSX is always in one of two administrative states:
• enabled
• disabled
The H323 signaling port on the GSX is always in one of two operational states:
• inService
• outOfService
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
TABLE 3–98
From
(operational
state) Changing to (operational state)
inService outOfService
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Command Parameters
Field
Parameter Length Description
sig-port N/A The logical reference number to the H323 signaling port for use
with SNMP and/or CLI. Must be 1 or 2.
log-port N/A The logical port number of the UDP port to use for this
connection. This defines the H.225 well known port. Must be 1-
5000, default is 1720.
ipaddress1 N/A The 32-bit IP address used by the PNS module cited above for
H225 signaling. Specified in dotted decimal form (for example
128.127.50.224). Default is 0.0.0.0.
ipaddress2 N/A The 32-bit IP address used by the PNS module cited above for
H245 signaling. Specified in dotted decimal form (for example
128.127.50.224). Default is 0.0.0.0. This must equal
ipaddress1 in the current implementation.
slot N/A The slot number occupied by the PNS module that will be the
H323 server. Must be 3-16. Must be the same for both signaling
services.
Note: This parameter does not apply to GSX4000 series
switches.
t301 N/A The T301 or call signaling establishment timer (in seconds). This
is the maximum interval to wait for an H.225 CONNECT after
receiving an H.225 ALERT.Must be 0-65535, default is 180
(seconds). A value of 0 means use the default.
t302 N/A The T302 or Ingress Inter-Digit Timeout (in seconds). The timer
starts when a SETUP ACKNOWLEDGE message is sent, and
restarts timer whenever an INFO message is received with more
digits. The timer stops when a send complete Information
Element (IE) is present in an incoming INFO message, or in the
transmission of a call progress message. The expiry of this timer
clears the call. Must be 0-127 seconds; default is 15.
t303 N/A The T303 or call signaling setup timer (in seconds). This is the
maximum interval between H.225 SETUP send and receipt of an
H.225 ALERT, CONNECT, CALL PROC, or SETUP ACK. Must
be 0-127, default is 4 (seconds). A value of 0 means use the
default.
t304 N/A The T304 Egress Inter-Digit Timeout (in seconds). The timer
starts when a SETUP ACKNOWLEDGE message is received,
and restarts whenever an INFO message with additional
addressing digits is received from the ingress side. Upon receipt
of any call progress message, the timer is stopped. The expiry of
this timer clears the call. Must be 0-127 seconds; default is 15
seconds.
t310 N/A The T310 timer (in seconds). This is the maximum interval
between the receipt of an H.225 CALL PROC and the receipt of
an H.225 ALERT or CONNECT. Must be 0-127, default is 10
(seconds). A value of 0 means use the default.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Field
Parameter Length Description
linkestablish N/A The LINKESTABLISH timer, applicable to an incoming H.323 call
to the GSX from a peer. After the peer has opened a TCP socket
to the GSX and the GSX has accepted the socket connection,
this is the maximum interval that the GSX will wait to receive the
H225 SETUP from the peer (in seconds). If the SETUP is not
received within this interval, the TCP socket is closed and the
resources are released. Must be 0-127, default is 4 (seconds). A
value of 0 means to use the default.
tcpconnect N/A The TCP Connect Timer, applicable to an outgoing H.323 call
from the GSX to a peer. After the GSX has opened a TCP socket
to connect to the peer, this is the maximum interval that the GSX
will wait for the peer to accept the TCP connection (in seconds). If
the accept is not received within this interval, the TCP socket is
closed and the resources are released.
If this timer expires and there are additional routes, then a
reattempt with a new route will be tried.
Must be 0-127, default is 3 (seconds). A value of 0 disables this
timer.
Sonus recommends a minimum value of 3 seconds for this timer.
lsas N/A The state of logical signaling address binding:
• disabled - In this state, the GSX does not respond to ARP
requests for logical signaling addresses. These logical
addresses must be reachable on all NIFs and the NEXT HOP
router/switch must have proper static routes to direct traffic to
these addresses.
• enabled - In this state, the GSX will respond to ARP requests
for logical signaling addresses. This condition allows you to
configure logical signaling addresses on the same subnet as
other NIFs. The benefits of this state are described in "Layer 2,
N:1 Redundancy Model Considerations" on page 3–139.
nifgroup 1-23 The name of the NIFGROUP that is being associated with this
H323 SIGNALING PORT. A NIFGROUP is a named group of
physical packet based interfaces.
signalingzone 1-23 The name of the SIGNALING ZONE to which this H323
SIGNALING PORT is being assigned. You create a ZONE and
assign an optional ZONE IDENTIFIER using the ZONE
configuration object (see "Zone" on page 3–511). Must be 1-23
characters.
If this parameter is not specified, then the default SIGNALING
ZONE is INTERNAL, Zone ID 0.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Field
Parameter Length Description
oper-state N/A The operational state of the H323 signaling service:
• inService - the signaling port listens for incoming H323
signal link connection requests.
• outOfService - the signaling port is not available for
incoming H323 signal link connection requests and thus
cannot be used to create new gateway signal links to other
H323 gateways.
action N/A The method by which active calls using this H323 signaling
service are processed when MODE goes to outofservice:
• none - no action is taken.
• dryup - all calls are allowed to complete until TIMEOUT
expires.
• force - all calls are dropped immediately.
timeout N/A The time (in minutes) to wait for active calls to finish in order to
place the H323 signaling service in outofservice MODE. Must
be 0-1440, default is 0.
A value of 0 causes an indefinite wait.
admin-state N/A The administrative state of this H323 signaling port:
• disabled - Not active.
• enabled - Active.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Command Example
To configure an H323 signaling port on the PNS module in slot 3 with the IP address 128.6.7.8,
logical port 1720 (by default), and a TCPESTABLISH timer of 10 seconds for ingress calls (all
other parameters take default values):
% CREATE H323 SIGNALING PORT 1
% CONFIGURE H323 SIGNALING PORT 1 ..
H225 IPADDRESS 128.6.7.8
H245 IPADDRESS 128.6.7.8
SLOT 3
% CONFIGURE H323 SIGNALING TIMERS TCPESTABLISH 10
% CONFIGURE H323 SIGNALING PORT 1 STATE enabled
% CONFIGURE H323 SIGNALING PORT 1 MODE inService
-----------------------------------------------------------
H323 Signaling Port 1
Slot 3 Mode: INSERVICE State: ENABLED
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
TCP Connections: 0
Per-NIF Status:
ENET-1-3-1 AVAILABLE
ENET-1-3-2 AVAILABLE
H323 Timers:
H323 Call Establishment timer (T301): 180 seconds
H323 Overlap Receiving timer (T302): 15 seconds
H323 Call Setup timer (T303): 4 seconds
H323 Overlap Sending timer (T304): 20 seconds
H323 Call Proceeding (T310): 10 seconds
H323 Link Establishment timer: 4 seconds
H323 TCP Connect timer: 3 seconds
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
H323 Service
This object binds an H323 service to an IP trunk group and assigns a name and properties to this
binding.
You may temporarily remove and restore this service by toggling its operational state between
INSERVICE and OUTOFSERVICE. When you remove service in this manner you could disrupt
existing calls, so you will be prompted to affirm your command. The mechanisms used to carry out
these configuration changes are summarized below.
• enabled
• disabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
TABLE 3–100
From
(operational
state) Changing to (operational state)
inservice outofservice
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Command Parameters
Field
Parameter Length Description
h323servname 1-23 The name of the H323 service you are configuring.
tgname 1-23 The name of the IP trunk group to which this H323 service
belongs.
tpackagename 1-23 The name of a tone package to be used by the H323 service.
See "Tone Package" on page 3–1201.
saf_state N/A Specifies whether or not the GSX will perform IP source address
filtering on incoming media packets for the IP trunk group that
uses this H323 service group. The source address to filter on is
supplied during call signaling.
• disabled (default) - The service group does not filter the
incoming media stream.
• enabled - The service group will only accept incoming media
packets whose source address matches the destination
address of the outbound packets.
dctprofile 1-23 The name of a Disconnect Treatment Profile that will be used to
map a disconnect reason code to a Disconnect Signaling
Sequence Profile (SSP) for the ISUP service. See "Disconnect
Treatment Profile" on page 3–1162.
asupvtimeout N/A When answer supervision is enabled, specifies the timeout
period, in seconds, from the egress receiving the first backwards
message from the called party exchange (Call Proceeding,
Alerting, Call Progress) until the call is answered. If the timeout
period expires, the answer supervision action specified is
triggered.
Must be 0-1000, default is 300 (seconds). A value of 0 disables
this timer.
drytimeout N/A The time (in minutes) to wait for all calls to complete before
placing the H323 service in outOfService oper-state. Must
be 0-1440 (minutes), default is 0. A value of 0 means wait
indefinitely.
cgrtimeout N/A The time (in seconds) to wait to release a call when that call was
rejected due to congestion. This parameter effectively prevents
the machine congestion level from escalating due to rapid
repeated call attempts by equipment that does not support
congestion detection. Must be 0-5 (seconds), default is 0. A
value of 0 disables this timer.
If this value is nonzero, the timer is started when a call is
rejected due to congestion. When the timer expires, the network
release is sent and the call resources are deallocated. If a
network release is received during the delay, the timer is
stopped and the call resources are deallocated.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Field
Parameter Length Description
nifgroup 1-23 The name of the NIFGROUP that is being associated with this
H323 SERVICE group. A NIFGROUP is a named group of
physical packet based interfaces. If present, the media traffic on
the IP TRUNK GROUP that is assigned to this H323 SERVICE
group is directed through the NIFs that make up this
NIFGROUP. If this parameter is not specified, then the default
null NIFGROUP is used. The null NIFGROUP includes all
defined NIFs.
signalingzone 1-23 The name of the SIGNALING ZONE associated with the
signaling port used for this service group. You create a ZONE
and assign an optional ZONE IDENTIFIER using the ZONE
configuration object (see "Zone" on page 3–511). Must be 1-23
characters.
If this parameter is not specified, then the default SIGNALING
ZONE is INTERNAL, Zone ID 0.
ldcaction N/A Specifies the action to take if the Long Duration Call (LDC) timer
expires. The call may be released, a SNMP trap may be
generated, or both:
• noAction (default) - take no action on LDC timer expiry (a
debug log entry will be generated).
• trap - generate an SNMP trap.
• release - automatic call disconnect without generation of a
trap.
• trapAndRelease - generate an trap and release the call.
ldcemergcalls N/A Specifies whether emergency calls should be excluded from, or
included in Long Duration Call (LDC) disconnect procedures:
• include
• exclude (default)
Note: Emergency call exclusion relies on the PSX call type or
other protocol-specific criteria to identify the call as an
“emergency” call.
ldcrelcause N/A Specifies the GSX disconnect reason used to release the call if
the call is released due to Long Duration Call (LDC) timer expiry.
Must be 1 to 127; default is 41 (Temporary Failure).
ldctimeout N/A Specifies the timeout value of the Long Duration Call (LDC)
timer in minutes. Must be 0 or 60-2880. A value of 0 disables the
timer; a value of 60-2880 sets the timer. Default is 0.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Field
Parameter Length Description
overlap N/A Specifies whether the GSX should perform H.323 overlap dialing
• enabled (default) - perform overlap dialing. The GSX sends
an egress H.323 call with insufficient addressing digits in a
Setup message when the canOverlapSend flag is set in the
User-to-User Information Element (IE). The GSX includes the
Send Complete IE if the address is complete at the time the
Setup message is sent. On the ingress side, the GSX sends
the Setup ACK when a Setup message with the
canOverlapSend flag is set in the User-to-User IE.
• disabled - do not perform overlap dialing. Call address
collection must be complete before an egress call is
generated.
mindigits N/A Specifies the minimum number of CalledAddress digits to collect
before attempting a route query, when overlap addressing is
supported and CalledAddress receive is not complete. Must be
0-30, default is 0 (digits).
cbprof N/A The index number of the CRANKBACK PROFILE to use with this
H323 service group. This must specify a valid Call Crankback
profile index, in the range 1-10. The default is 1, or Call
Crankback Profile default. See"Call Crankback Profile" on
page 3–1171.
admin_state N/A The administrative state of this H.323 service:
• disabled (default) - Not active, and able to be configured.
• enabled - Active.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Command Example
To create, configure, and enable H323 service group Myh323IpSrvcGrp on IP trunk group
iptg2, using source address filtering:
--------------------------------------------------------------------
H323 Service : defaultH323IpSrvcGrp
--------------------------------------------------------------------
Admin State : ENABLED
Mode : INSERVICE
Action : UNDEFINED
Dryup Timeout (min) : 0
Trunk Group : defaultiptg
Disc Treatment : h323Default
Tone Package : default
Source Address Filtering : DISABLED
Ans Supervision Timeout : 300
Signaling Zone : INTERNAL
Signaling Zone ID : 0
Media NIF Group :
Congestion Rel Timeout (sec) : 0
Minimum Digits For Sending DS Query : 0
Overlap Dialing : DISABLED
LDC Timeout (mins) : 0
LDC Timeout Action : NOACTION
LDC Release Cause : 41
LDC Emergency Calls : EXCLUDE
Crank Back Profile : 1
------------------------------------------------------------------
H323 Service : MyH323SrvcGrp
------------------------------------------------------------------
Admin State : ENABLED
Mode : INSERVICE
Action : DRYUP
Dryup Timeout (min) : 5
Trunk Group : iptg2
Disc Treatment : h323Default
Tone Package : default
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
-------------------------------------
H323 Service Status
------------------------ ------------
defaultH323IpSrvcGrp AVAILABLE
MyH323SrvcGrp AVAILABLE
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
This object is the logical port on which the GSX sends and listens for Session Initiation Protocol
(SIP) call signaling packets. For UDP and TCP, the actual port number is the same (the configured
port number, or the default 5060). For TLS over TCP, the actual port number is one greater (5061
by default.
Using the command syntax described below, you may configure multiple SIP signaling ports on
the GSX, allowing the GSX to function as a SIP User Agent Client and/or Server. The overview of
SIP services is described elsewhere in the Sonus technical documentation.
The conventions for configuring the SIP ports are similar to those discussed previously for
Gateway Signaling Links, see in particular "Gateway Signaling Port" on page 3–384. The ports
may be assigned to either an MNA module or a PNA module on a GSX9000, through the
INTERFACE parameter as discussed below. On a GSX4000 series switch, the ports are
automatically assigned to the GNA module.
An additional SIP signaling port may be configured to permit potential network-wide
configuration changes with minimal service disruption as in the following scenario:
Configure a new SIP signaling port. All previously configured ports remain functional for
sending and listening. When all other Application Servers have been re-configured to connect
to this GSX (acting as a User Agent Client or Server) on the new port, the original port (or
ports) can be safely placed out of service, disabled, and deleted. In this manner, the network
can be re-configured without shutting down this GSX.
By assigning the SLOT occupied by a PNS40 to a SIP SIGNALING PORT, the SIP signaling
packets will be processed directly by GSX software running on that PNS40 server module. These
packets thereby will not need to be propagated internally to an MNS server module (the default
SIP SIGNALING PORT) for processing, and an improvement in system performance should
result. To optimally use this feature:
• every PNS40 must have a local NIF connecting it to every network
• every PNS40 must have a SIP SIGNALING PORT on every network
• every PNS40 SIP SIGNALING PORT must use the local NIF
• every PNS40 must be a member of a N:1 redundancy group, protected by a redundant module
• the SIP SERVICE REGISTRATION parameters must be configured appropriately for the SIP
environment in which you are operating (see "SIP Service" on page 3–437).
You may wish to create SIP SIGNALING PORTs on the same subnet as the IPADDRESS of the
member NIFs of the NIFGROUP bound to this signaling port. Set the LOGICAL SIGNALING
ADDRESS BINDING STATE to enabled to enable this feature. This will cause the GSX to respond
to Address Resolution Protocol (ARP) requests for logical signaling addresses (which are ignored
when this status is disabled). See "Layer 2, N:1 Redundancy Model Considerations" on page 3–
139 for additional detail.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
• enabled
• disabled
• inService
• outOfService
From
(operational
state) Changing to (operational state)
inService outOfService
The Network Border Switch (NBS) application permits named NIFGROUPs and SIGNALING
ZONEs to be associated with SIP signaling ports. A NIFGROUP is a named group of physical
packet based network interfaces (see "NIF Groups" on page 3–178). You can only associate a
NIFGROUP with a SIP signaling port if that signaling port is configured for a nif INTERFACE.
Multiple SIP signaling ports may share one or more common NIFs through their respective
NIFGROUPs, as long as their IPADDRESSes are unique. Multiple SIP signaling ports may share
an IPADDRESS as long as they do not share a common NIF through their associated
NIFGROUPs.
A SIGNALING ZONE is a named collection of SIP and/or H.323 signaling ports. When a ZONE is
created (see "Zone" on page 3–511) and a ZONE IDENTIFIER is specified, the new ZONE can be
assigned to a set of SIP and/or H.323 signaling ports. This facility provides a means of explicitly
directing outgoing signaling traffic to a set of equivalent SIP or H.323 signaling ports.
NOTE
When you provision a SIP SIGNALING PORT, make sure that each NIF/SIF is
associated with only one ZONE via a NIFGROUP.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
When a SIP or H.323 signaling port is created and configured without an explicit SIGNALING
ZONE, it is assigned to the default SIGNALING ZONE, INTERNAL. A Zone ID of 0 is always
assigned to INTERNAL. A SIGNALING ZONE is created using the ZONE object, then a SIP or
H.323 signaling port is configured with that unique ZONE name.
NOTE
When you configure these signaling ports in non-NBS environments, ignore
NIFGROUPs and SIGNALING ZONEs and use the default values.
The SHOW .. STATUS command displays the Per-NIF Status. This reflects the availability
status of each NIF in each NIFGROUP that is attached to the SIP signaling port. The NIF must be
an enabled member of an explicit (not NULL) NIFGROUP to be displayed by this command.
SIP ingress calls will be accepted on any SIP signaling port. SIP egress calls can be directed to all
explicit, appropriately configured SIP signaling ports. SIP egress calls can be directed to the
default SIP signaling port (SIGNALING ZONE INTERNAL, Zone ID 0) when the configuration
does not otherwise establish an explicit SIP signaling zone.
When using SIP over TCP with Transport Layer Security (TLS), commands are available to show
status and statistical information for TLS sessions and their associated TLS connections on the
given SIP signaling port. Status information includes IP addresses and TCP port numbers,
negotiated session parameters, session start time, remaining resumption time (if applicable), client
and server roles, client authentication or not, negotiated session parameters, current connection
information, session ID, etc.
For more information on Transport Layer Security and TLS statistics and status, see "Transport
Layer Security Profile" on page 3–500.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
SESSION tlssesionID
Command Parameters
Field
Parameter Length Description
sig-port N/A The logical reference number to the port for use with SNMP and/or
CLI. Must be 1-2048 for MNS2x based systems (that contain
PNS40s) or 1-1024 for MNS1x based systems.
ipaddress N/A The 32-bit IP address of the sig-port (above) specified in dotted
decimal form (for example 128.127.50.224).
This IPADDRESS must be unique from any other GSX address,
such as an H.323 signaling port. Although it may use one of these
physical interfaces (see nif-type), its Internet Address must be
unique.
Overlap signaling addressing is supported. Two SIP signaling
ports may share an IPADDRESS as long as the respective
NIFGROUPs associated with each port do not share common
NIFs.
This parameter is mandatory, and takes no default value. A value
of 0.0.0.0 will not be accepted.
log-port N/A The logical port number of the UDP or TCP port to use for this link.
Default is 5060. This well-known port number, 5060, is also the
default port for PNA, MNA2X, and GNA NIFs. For SIP over TLS/
TCP, the port number is the UDP/TCP port number + 1.
The logical port number used for SIP signaling cannot be in the
range of port numbers reserved for RTP. For PNS10s, that range
is 5000-15238. For PNS30s, that range is 5000-21382. For
PNS40s, that range is 5000-28998. For MNS20s (ethernet or
gigabitEthernet), this range is 5000-21382. For GNSs, this range
is 5000-7974.
In all cases, well known port number 5060 is the only exception
within those ranges.
The PNS40 provides this RTP port range on each PNA4X port.
For PNS10s, PNS30s, and MNS20s, this range applies per server,
not per physical port. For GNS, this range applies per system.
The range of UDP port numbers on a GSX module is unrelated to
the maximum call rate achievable by that module.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Field
Parameter Length Description
nif-type N/A The type of network interface being configured for the SIP
signaling port:
• mgtnif (default) - The Management Network interface on the
MNA or GNA module.
• nif - The Packet Network interface on a PNA, GNA, or MNA2X
module.
If nif is chosen, then SIP signaling bandwidth usage will be taken
from the PNA or GNA bandwidth budgets. This allocation is
approximately 1.2 MB/sec.
lsas N/A The state of logical signaling address binding:
• disabled - In this state, the GSX does not respond to ARP
requests for logical signaling addresses. These logical
addresses must be reachable on all NIFs and the NEXT HOP
router/switch must have proper static routes to direct traffic to
these addresses.
• enabled (default) - In this state, the GSX will respond to ARP
requests for logical signaling addresses. This condition allows
you to configure logical signaling addresses on the same
subnet as other NIFs. The benefits of this state are described in
"Layer 2, N:1 Redundancy Model Considerations" on page 3–
139.
nifgroup 1-23 The name of the NIFGROUP that is being associated with this
SIP SIGNALING PORT. A NIFGROUP is a named group of
physical packet based interfaces.
signalingzone 1-23 The name of the SIGNALING ZONE to which this SIP SIGNALING
PORT is being assigned. You create a ZONE and assign an
optional ZONE IDENTIFIER using the ZONE configuration object
(see "Zone" on page 3–511). Must be 1-23 characters.
If this parameter is not specified, then the default SIGNALING
ZONE is INTERNAL, Zone ID 0.
slot N/A The slot number occupied by the PNS40 server module upon
which the SIP SIGNALING PORT IPADDRESS is configured.
This directs signaling packets to this address for processing on
this PNS40 server module. This prevents the need to propagate
these packets internally to another server module for processing.
When this parameter is explicitly specified, it must be 3-16, and
that slot must be occupied by a PNS40.
When this parameter is omitted, the default value of 1 is used to
direct that the SIP SIGNALING PORT IPADDRESS be
configured on the MNS server.
When this parameter is non-zero, all NIFs in the NIFGROUP
associated with this SIP SIGNALING PORT must also reside on
the PNS40 in this slot.
Note: This parameter does not apply to GSX4000 series switches.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Field
Parameter Length Description
oper-state N/A The operational state of the SIP signaling port:
• inservice (default) - the signal port is available for SIP call
signaling with other Application Servers.
• outofService - the signal port is not available for SIP call
signaling.
admin-state N/A The administrative state of this SIP signaling port:
• disabled (default) - Not active.
• enabled - Active.
tlspeer N/A Specifies the 32-bit IP address of the remote Transport Layer
Security (TLS) peer in dotted decimal form (for example
128.127.50.224).
For more information on Transport Layer Security and TLS
statistics and status, see "Transport Layer Security Profile" on
page 3–500.
tlssesionID N/A Specifies the uniquely-identified Transport Layer Security (TLS)
session ID. This ID is obtained from the SHOW SIP SIGNALING
PORT sigport TLS SESSION STATUS command. This
parameter is necessary when issuing the DELETE SIP TLS
SESSION SIGNALING PORT .. command.
Command Example
To create, configure, and enable a SIP signaling port on the MNA that uses IP address 128.99.55.6,
and adds a default static route to the router on this NIF:
% CREATE SIP SIGNALING PORT 1 IPADDRESS 128.99.55.6
% CONFIGURE SIP SIGNALING PORT 1 INTERFACE mgtnif
% CONFIGURE SIP SIGNALING PORT 1 STATE enabled
% CONFIGURE IP ROUTE ADD MGMT MIF SHELF 1 PORT 1 ..
IPADDRESS 0.0.0.0 MASK 0.0.0.0
NEXTHOP 128.6.254.240
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Notice that this SIP signaling port defaults to SIGNALING ZONE INTERNAL, Zone ID 0, and
because it is defined on a mgtnif INTERFACE, it cannot have an attached NIFGROUP.
----------------------------------------------------------
SIP SIG PORT STATISTICS
----------------------------------------------------------
SIP Signaling: 1
SIP Signaling IP Address: 128.99.55.6
SIP Signaling IP Port: 5060
Call Leg Rate: 0
Number Of Call Legs Originating: 0
Number Of Call Legs Terminated: 0
Number Of Inbound Registrations: 0
Number Of Outbound Registrations: 0
PDUs Sent: 0
PDUs Received: 0
BYTEs Sent: 0
BYTEs Received: 0
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
To show a SIP signaling port configuration that includes a default SIP signaling port, another SIP
signaling port using SIGNALING ZONE SIT_IAD_A, NIFGROUP outside1, and another SIP
signaling port using SIGNALING ZONE SIT_IAD_B, NIFGROUP outside2:
% SHOW SIP SIGNALING PORT ALL ADMIN
Node: TPUBS Date: 2005/11/30 20:51:30 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
To show the statistics generated by the SIP signaling ports described above:
% SHOW SIP SIGNALING PORT ALL STATISTICS
Node: TPUBS Date: 2005/11/30 21:15:30 GMT
Zone: GMTMINUS05-EASTERN-US
----------------------------------------------------------
SIP SIG PORT STATISTICS
----------------------------------------------------------
SIP Signaling: 1
SIP Signaling IP Address: 10.160.100.233
SIP Signaling IP Port: 4060
Call Leg Rate: 0
Number Of Call Legs Originating: 3
Number Of Call Legs Terminated: 2
Number Of Inbound Registrations: 20912
Number Of Outbound Registrations: 20835
PDUs Sent: 22179
PDUs Received: 1381
BYTEs Sent: 8966044
BYTEs Received: 546749
----------------------------------------------------------
SIP SIG PORT STATISTICS
----------------------------------------------------------
SIP Signaling: 2
SIP Signaling IP Address: 10.160.105.233
SIP Signaling IP Port: 4061
Call Leg Rate: 0
Number Of Call Legs Originating: 0
Number Of Call Legs Terminated: 0
Number Of Inbound Registrations: 978
Number Of Outbound Registrations: 963
PDUs Sent: 2042
PDUs Received: 2042
BYTEs Sent: 611421
BYTEs Received: 847739
----------------------------------------------------------
SIP SIG PORT STATISTICS
----------------------------------------------------------
SIP Signaling: 3
SIP Signaling IP Address: 10.160.105.234
SIP Signaling IP Port: 4061
Call Leg Rate: 0
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Port
Num Interface Name Status
---- ------------------------ -------------
1 ENET-1-3-1 AVAILABLE
1 ENET-1-3-2 AVAILABLE
To create, configure, and enable a SIP signaling port on the PNS40 in slot 3 that uses IP address
128.127.50.224:
% CREATE SIP SIGNALING PORT 1 IPADDRESS 128.127.50.224
% CONFIGURE SIP SIGNALING PORT 1 INTERFACE nif
% CONFIGURE SIP SIGNALING PORT 1 SLOT 3
% CONFIGURE SIP SIGNALING PORT 1 STATE enabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
These objects specify the authorized Application Servers for signaling between this GSX and other
Application Servers.
The CONFIGURE SIP SIGNALING SIP STATISTICS command instructs the GSX to maintain
per dialog/transaction statistics for basic SIP responses and requests for completed calls and
transactions. The SHOW SIP SERVICE .. STATISTICS commands display SIP statistics for
current and configured time intervals. See "SIP Service" on page 3–437 for more information.
The MAXIMUM PDU SIZE commands support an increase in the size of SIP Protocol Data Units
(PDUs) that are received, processed, and/or generated by the GSX. You may configure the
maximum size of the SIP PDU supported by the GSX to either 2KB (the default) or 3KB. To
specify a maximum SIP PDU size of 3072 bytes, issue the commands:
CONFIGURE SIP SIGNALING CONTROLS MAXIMUM PDU SIZE PDUSIZE3KB
CONFIGURE SIP SIGNALING CONTROLS MAXIMUM PDU SIZE STATE enabled
To specify a maximum SIP PDU size of 2048 bytes, issue the command:
CONFIGURE SIP SIGNALING CONTROLS MAXIMUM PDU SIZE STATE disabled
The default value for the MAXIMUM PDU SIZE STATE parameter is disabled.
To modify the MAXIMUM SIP PDU SIZE parameter value, there must be no active calls or
registrations on the system. This is to prevent the software from allocating a 2KB buffer, and then
later attempting to use it as a 3KB buffer.
NOTE
Configuring a SIP PDU size of 3072 bytes may reduce call throughput.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Command Parameters
Field
Parameter Length Description
loopdetection N/A Specfies whether or not the SIP Stack will perform loop
detection on incoming INVITE messages:
• enabled (default) - SIP Stack performs loop dectection on
incoming INVITE messages.
• disabled - Do not perform loop detection on incoming
INVITE messages but rather allow the SIP signaling group
to process the INVITE message.
sipstatistics N/A Specifies whether the GSX will collect SIP statistics for all SIP
service groups:
• enabled - the GSX collects SIP statistics.
• disabled (default) - the GSX does not collect SIP
statistics.
contactparam N/A Specifies whether a Registrar supports parameters in the
Contact header:
• enabled - parameters in the Contact header are supported.
• disabled (default) - parameters in the Contact header are
not supported.
supresserror N/A Specifies whether the GSX will suppress the Error-Info header
in response to a request message with a syntax error:
• enabled - the GSX will not include the Error-Info header in
response message.
• disabled (default)
rnie N/A Specifies whether the GSX sends a Redirecting Number
Information Element (RNIE) in the egress leg of the call per
RFC3398 when the R-URI and the To header differ:
• enabled
• disabled (default)
maxpdusize N/A Specifies the maximum PDU size that will be recognized by the
GSX software:
• PDUSIZE2KB (default) - 2048 bytes
• PDUSIZE3KB - 3072 bytes
maxpdustate N/A Specifies whether a maximum PDU size of 3072 bytes is
recognized by the GSX software:
• enabled - A maximum PDU size of 3072 bytes is in effect if
the value of MAXIMUM PDU SIZE is PDUSIZE3KB.
• disabled (default) - The maximum PDU size recognized
by the GSX software is 2048 bytes.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Command Example
To display the size of the protocol data units currently recognized by the GSX software:
% SHOW SIP SIGNALING CONTROLS MAXIMUM PDU STATUS
Node: TPUBS Date: 2007/11/07 00:58:34 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
The SIP SIGNALING REGISTRATION facility enables NBS to relay SIP endpoint registration
information between these endpoints and the REGISTRAR, which can be an ASX. The SIP
SERVICE REGISTRATION EXPIRES parameter configures the time span allowed for an
Integrated Access Device (IAD) before requiring re-registration.
The REGISTRAR’s default IPADDRESS is 0.0.0.0, PORTNUM 0. This, or any other configured
address, is overridden by per-transaction routing data from the PSX.
The DELETE command allows you to manually delete a SIP registration by specifying its
Registration ID (REGID).
The RESET and RESET_ALL command resets certain registration counters as explained in the
command examples at the end of this section.
The SHOW commands display registration configuration, status, and statistical information. See the
command examples at the end of this section for further detail.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Command Parameters
Field
Parameter Length Description
ipaddress N/A The default 32-bit IP address of the REGISTRAR specified in
dotted decimal form (for example 128.127.50.224).
The default value is 0.0.0.0.
portnum N/A The logical port number of the UDP port to use for the
REGISTRAR.
The default value is 0.
shelf N/A The shelf number on which the registration statistics are being
sought or being reset, in the GSX node configuration. In this
release, one shelf is supported. Must be 1.
Note: This parameter does not apply to GSX4000 series
switches.
slot N/A The slot number occupied by the server module for which
registration statistics are being sought or being reset. This
number must be 3-16.
Note: This parameter does not apply to GSX4000 series
switches.
admin-state N/A The administrative state of the SIP registration configuration:
• disabled (default) - Not active, and able to be configured.
• enabled - Active.
Changes to IPADDRESS and PORTNUM are permitted only
while the STATE is disabled; these changes are applied only
when the STATE is enabled.
aor 1-64 Specifies the Address of Record (AOR) for which registration
information is to be displayed. This is typically the phone
number associated with an Integrated Access Device (IAD)
such as “+9786148000” or “7326253003*1234”.
regid N/A Specifies the Registration ID (REGID) for which registration
information is to be displayed or deleted. This is an integer key
that is unique to each registration session that is stored on a
particular service module. This number is generated internally
by the GSX to map to the AOR of the registrant.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Command Example
To configure and activate the NBS REGISTRAR with an IPADDRESS of 10.160.100.170 and
a (well known) PORTNUM of 5060:
% CONFIGURE SIP SIGNALING REGISTRATION REGISTRAR ..
IPADDRESS 10.160.100.170 PORTNUM 5060
% CONFIGURE SIP SIGNALING REGISTRATION STATE enabled
To reset the Registration Attempts and Accumulative Completions (above) for all SIP
registration statistics:
% CONFIGURE SIP SIGNALING REGISTRATION COUNTS SHELF 1 RESET_ALL
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Shelf: 1
Slot: 9
Registration ID: 0x0003B2
Address of Record: 19786148000
Contact-URI: 19786148000@sonusnet.com
Next-hop TSAP: 20.1.1.1:5000
Registrar TSAP: 192.1.1.1:4000
External Expiration Time: 60
Internal Expiration Time: 3600
State: Completed
Creation Time: GMT-05:00-Eastern,01/26/2005,21:21:23
NOTE
The command above is used for a shelf wide search of a single registration record
fully matching the supplied AOR pattern. Wild card matching is not recognized.
Registration
Shelf Slot ID State AOR
----- ---- ------------ ------------ ------------------------------
1 9 0x0003B2 Completed +19786148000
1 9 0x000C48 Initiating 7326253003*1234
1 9 0x000577 Refreshing 2024441212
NOTE
The command above is used when the AOR search failed to find the intended
record. It lists all the registration records on a specified slot. The use of this
command should be limited when there are tens of thousands of registration
sessions on the server module. Displaying many records may impact performance
on the MNS.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
To display the registration status of REGID 0x03B2, whose repository uses server resources on
slot 9:
% SHOW SIP SIGNALING REGISTRATION SHELF 1 SLOT 9 REGID 0x3B2 STATUS
Node: TPUBS Date: 2005/07/11 18:34:16 GMT
Zone: GMTMINUS05-EASTERN-US
Shelf: 1
Slot: 9
Registration ID: 0x0003B2
Address of Record: 19786148000
Contact-URI: 19786148000@sonusnet.com
Next-hop TSAP: 20.1.1.1:5000
Registrar TSAP: 192.1.1.1:4000
External Expiration Time: 60
Internal Expiration Time: 3600
State: Completed
Creation Time: GMT-05:00-Eastern,01/26/2005,21:21:23
NOTE
The above command should be used in conjunction with the previous SUMMARY
command. Lookup the REGID on the appropriate line on the summary output and
then display the detailed status of the registration session.
To ease debugging of call failure problems, a small number of the most recently terminated
registration sessions are saved. The notes above pertaining to status displays also apply to
displaying deleted registration records.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Shelf: 1
Slot: 9
Registration ID: 0x0003B2
Address of Record: 19786148089
Contact-URI: 19786148089@sonusnet.com
Next-hop TSAP: 20.1.1.1:5000
Registrar TSAP: 192.1.1.1:4000
Termination Reason: External Timer Expired
Creation Time: GMT-05:00-Eastern,01/26/2005,21:21:23
Termination Time: GMT-05:00-Eastern,01/26/2005,22:15:48
Registration Termination
Shelf Slot ID Reason AOR
----- ---- ------------ ------------------- ------------------------
1 9 0x0003B2 Ext. Timer Expired +19786148000
1 9 0x000C48 Endpoint Initiated 7326253003*1234
1 9 0x000577 Int. Timer Expired 2024441212
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Shelf: 1
Slot: 9
Registration ID: 0x0003B2
Address of Record: 19786148089
Contact-URI: 19786148089@sonusnet.com
Next-hop TSAP: 20.1.1.1:5000
Registrar TSAP: 192.1.1.1:4000
Termination Reason: External Timer Expired
Creation Time: GMT-05:00-Eastern,01/26/2005,21:21:23
Termination Time: GMT-05:00-Eastern,01/26/2005,22:15:48
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
SIP Service
This object binds a SIP service to an IP trunk group and assigns a name and properties to this
binding.
SIP Methods
The METHODS parameter provides a means of disabling GSX software support for particular SIP
messages. For SIP calls in some environments, the received SIP messages,
• OPTIONS
• REFER
• SUBSCRIBE
• NOTIFY
• INFO
• REGISTER
• MESSAGE
• PUBLISH
are not recognized and supported. This facility allows you to similarly disable support for these
messages in the SIP GSX software. When support for one of these SIP message types is disabled,
the message is rejected with a 405 code.
In addition to this GSX object to control handling of the SIP REFER message, the PSX IP
Signaling Profile may be configured to allow/reject the REFER message on a per call basis. In all
cases of a conflict between the GSX setting and the PSX setting for the REFER message, the
REFER message will be rejected. The REFER message will be allowed and processed normally
only if it is allowed in both the PSX IP Signaling Profile and the SIP Service METHODS parameter
on the GSX.
In addition, you can specify the timers and retry counts for SIP signaling between this GSX and
other Application Servers, using the TIMER and RETRY parameters. These timer intervals are
applied on a per call basis; a change takes effect immediately.
SIP Statistics
The SHOW SIP SERVICE ... STATISTICS commands allow you to examine SIP statistics for
basic SIP responses and requests for completed calls and transactions. Similar to trunk group
statistics, SIP statistics are available on a real time (CURRENT) or on a historical (INTERVAL) basis.
By default, the GSX maintains four 15-minute intervals of data, so that at any time the previous
hour’s data is available.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
However, you may configure the number of intervals and the size of the intervals on the GSX for
SIP and Performance Statistics using the CONFIGURE PERFORMANCE STATISTICS...
commands. See "Performance Statistics" on page 3–984 for more information on configuring
these intervals.
The GSX/NBS can transport SIP signaling over TCP, UDP, or TLS/TCP. Acceptable transport
types for Ingress SIP signaling may be specified on a Signaling Zone or SIP Service group basis.
The transport types used for Egress SIP signaling may be specified by the PSX in its routing
response, or may be determined by the GSX/NBS on a SIP Service basis, or may be queried from
an external DNS server.
The GSX/NBS uses the following methods of determining acceptable Ingress SIP transport types
and the utilized Egress SIP transport types.
Ingress: When a SIP message arrives at a SIP signaling port via UDP, TCP, or TLS/TCP transport
type, it is subjected to these tests:
1. The arriving transport type is compared to the list of allowed Transport Protocols configured
for the Signaling Zone (default = UDP, may also include TCP and/or TLS/TCP):
a. If the transport type is not allowed, then the message is silently discarded and logged.
b. If the transport type is allowed, or there is no associated Zone, then it goes to the next test:
2. The arriving transport type is compared to the prioritized Transport Preference(s) if configured
for the SIP Service group:
a. If the transport type is not one of the preferred types, then the message is silently discarded
and logged.
b. If the transport type is one of the preferred types, or there are no configured preferences,
then the transport associated with the incoming message is accepted.
Egress: The GSX/NBS uses the following criteria to determine the transport type to use when
sending an Egress SIP message:
1. If the PSX policy response for the call has an Egress IP Signaling Profile containing Transport
Type preferences, then use Transport Type 1 if there is a port available that supports it;
otherwise use Transport Type 2 if supported; otherwise use Transport Type 3 if supported;
otherwise use Transport Type 4 if supported; otherwise:
2. If the SIP Service group is configured with Transport Type preferences, then use the 1st
Preference transport type if there is a port available that supports it; otherwise use the 2nd
Preference if supported; otherwise use the 3rd Preference if supported; otherwise:
3. If DNS support is enabled in the SIP Service group, send a DNS NAPTR (Name Authority
Pointer) query and use the transport type specified in the response. If DNS is not configured or
the query is unsuccessful, then:
4. Use UDP.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Direct Media
Direct Media is intended for Integrated Access Device (IAD) to IAD calls where the NBS is
positioned between each IAD and its registrar/application server. In these configurations, if the
IADs share a common codec and do not need the NBS to transcode, then media can flow directly
between the IADs as shown in Figure 3–5.
The Direct Media feature allows the NBS to set up calls between two endpoints so that media can
be exchanged directly without consuming bandwidth to and from the NBS. The endpoints could be
on the same IP subnet, in the same IP network, or on different IP networks. However, media
packets from each IAD must be able to reach the other IAD without going through the NBS.
Note that it is not necessary that the calling and called IAD be on the same NBS. Direct Media can
also operate when a call passes through two separate NBSs.
If the Application Server is an ASX, then the ASX “SDP Session-Attribute Transparency” feature
must be enabled for those endpoints. For more information, see the section, “SIP Hardware” in
Appendix A, Service Provider, of the Sonus ASX/ADS Access Solution Provisioning Guide.
T he N B S on ly se es
th e sign a lin g (a s tw o
se p a ra te ca lls ).
G S X 9 0 00
S ig n alin g
S ig n alin g
ASX
Signa
Signaling
ling
RT H I T AC H I
P
RTP
IA D
H I T AC H I
IA D
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
The following conditions must be met for Direct Media to function properly:
• The DIRECT MEDIA parameter must be enabled in the SIP SERVICE groups for both the
calling IAD and the called IAD. This parameter specifies whether Direct Media should be
attempted for calls to or from endpoints in the service group. If enabled, the GSX will attempt
to set up a media path such that media flows directly between two Direct Media-enabled
endpoints in the same Media Zone.
• The MEDIA ZONE parameter in both SIP SERVICE groups (for the calling and called IADs)
must match. Only calls with the same media zone are eligible for Direct Media. This
parameter specifies the name of an existing ZONE, created using the ZONE configuration
object. For more information, see "Zone" on page 3–511.
In an environment where calls pass through different NBSs, the ZONE IDENTIFIER
configured for those zones must match.
• Direct Media endpoints must be enabled on the PSX Manager for all call legs (in both the
Packet Service Profile facing the calling IAD and the called IAD, as well as the Packet Service
Profiles facing the ASX, using the Use Direct Media flag in the Flags section).
• Direct Media endpoints must be enabled on the PSX Manager for all call legs associated with
ASX (in the IP Signaling Profiles facing the ASX, using the Send Direct Media Info in SDP
Attribute flag in the Common IP Attributes section).
NOTE
In order for Direct Media to work properly, the Application Server must not remove
any SDP lines associated with unknown parameters. Specifically, if the Application
Server receives an SDP with an unknown session-level attribute, it must pass this
attribute and its value, unchanged to the other leg.
To determine whether a call is a Direct Media call, issue the SHOW CALL DETAIL GCID <gcid>
command.
Operational State
You may temporarily remove and restore this service by toggling its operational state between
INSERVICE and OUTOFSERVICE. When you remove service in this manner you could disrupt
existing calls, so you will be prompted to affirm your command. The mechanisms used to carry out
these configuration changes are summarized below.
• enabled
• disabled
• inservice
• outofservice
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
TABLE 3–105
From
(operational
state) Changing to (operational state)
inservice outofservice
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Command Parameters
Field
Parameter Length Description
sipservname 1-23 The name of the SIP service you are configuring.
tgname 1-23 The name of the IP trunk group to which this SIP service
belongs.
tpackagename 1-23 The name of a tone package to be used by the SIP service.
See "Tone Package" on page 3–1201.
nifgroup 1-23 The name of the NIFGROUP that is being associated with
this SIP SERVICE group. A NIFGROUP is a named group
of physical packet based interfaces. If present, the media
traffic on the IP TRUNK GROUP that is assigned to this SIP
SERVICE group is directed through the NIFs that make up
this NIFGROUP. If this parameter is not specified, then the
default null NIFGROUP is used. The null NIFGROUP
includes all defined NIFs.
signalingzone 1-23 The name of the SIGNALING ZONE that is associated with
the signaling port used for this service group.
You create a ZONE and assign an optional ZONE
IDENTIFIER using the ZONE configuration object (see
"Zone" on page 3–511). Must be 1-23 characters.
If this parameter is not specified, then the default
SIGNALING ZONE is INTERNAL, Zone ID 0.
saf_state N/A Specifies whether or not the GSX will perform IP source
address filtering on incoming media packets for the IP trunk
group that uses this SIP service group. The source address
to filter on is supplied during call signaling.
• disabled (default) - The service group does not filter the
incoming media stream.
• enabled - The service group will only accept incoming
media packets whose source address matches the
destination address of the outbound packets.
dctprofile 1-23 The name of a Disconnect Treatment Profile that will be used
to map a disconnect reason code to a Disconnect Signaling
Sequence Profile (SSP) for the ISUP service. See
"Disconnect Treatment Profile" on page 3–1162.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Field
Parameter Length Description
asupvtimeout N/A When answer supervision is enabled, specifies the timeout
period, in seconds, from the egress receiving the first
backwards message from the called party exchange (SIP
180 - “Ringing," and SIP 183 - “Progress") until the call is
answered. If the timeout period expires, the answer
supervision action specified is triggered.
Must be 0-1000, default is 300 (seconds). A value of 0
disables this timer.
timeoutaction N/A Specifies the action to take when ANSWER SUPERVISION
TIMEOUT is enabled and the timer, Tanswer, expires:
• release (default) - Release the call.
• trapAndRestart - Send a trap and restart the timer,
Tanswer. This action will repeat continuously until
cancelled by a received network disconnect, user
intervention, or a received answer message.
Whenever a 18x backwards message is received, Tanswer
is restarted but a trap does not occur. When a trap is sent, it
contains the following details for the call:
• Ingress Trunk Group
• Ingress Circuit End Point
• Egress Trunk Group
• Egress Circuit End Point
• Called Number
• Calling Number
drytimeout N/A The time (in minutes) to wait for all calls to complete before
placing the SIP service in outOfService oper-state.
Must be 0-1440 (minutes), default is 0. A value of 0 means
wait indefinitely.
naptsignaling N/A Specifies whether or not the devices on the TRUNK GROUP
associated with this service require NAPT support for
signaling:
• disabled (default) - Send signaling packets as dictated
by the SIP signaling from the peer.
• enabled - Send signaling packets to the learned source
address and port of inbound REGISTERs from the peer.
naptmedia N/A Specifies whether or not the devices on the TRUNK GROUP
associated with this service require NAPT support for media:
• disabled (default) - Send RTP packets as negotiated by
the SIP signaling from the peer.
• enabled - Send RTP packets to the learned source
address and port of the inbound RTP stream.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Field
Parameter Length Description
registrationexpires N/A The time interval (in seconds) for an Integrated Access
Device (IAD) before a SIP re-registration is required. Must be
15-65535 (seconds), default is 60.
As you reduce the length of this interval, you increase the
registration traffic between the IADs and the NBS.
registrationrequire N/A Specifies whether the IP TRUNK GROUP to which this SIP
d SERVICE group belongs requires registration between
endpoints:
• disabled (default) - Registration is not required between
endpoints.
• enabled - Registration is required between endpoints.
regregistrarminexp N/A Specifies the minimum registrar timeout value, which
overrides the refresh rate offered by the endpoint device,
when the endpoint device register is being relayed to the
registrar. Must be 0-65535; default is 3600.
The GSX sends the registrar the configured mimimum
registrar timer expiration value in the SIP service group
associated with the trunk group facing the registrar, or the
refresh timer value received from the endpoint (if present),
whichever is longer.
regredirectmethod N/A Specifies the default method for redirecting calls and
registrations for this SIP SERVICE group:
• none (default) - No preference among the redirection
methods.
• redir3xx - SIP 3XX redirection message.
This parameter is specified on the PSX on a per-peer-device
basis, and that setting always overrides the GSX setting.
parsebgid N/A Specifies whether or not to direct the PSX to process the
digits after a “*” or after a “#” as a Business Group ID (BGID):
• disabled (default) - Pass the entire string, as is, to the
PSX.
• enabled - Pass only the digits after the “*” or after the “#”
to the PSX to be processed separately.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Field
Parameter Length Description
congestionreject N/A When SIP calls are rejected due to congestion, specifies the
method by which the calls are rejected:
• release (default) - Respond to the INVITE with a 100
TRYING, followed by a 503 Service Unavailable message.
The 503 Release message may be delayed via the
CONGESTION RELEASE TIMEOUT.. If the RELEASE
parameter is disabled, then the 503 message is sent
immediately.
• ignore - Respond to the INVITE with a 100 TRYING, and
then discard the INVITE. When the CANCEL message is
subsequently received, a 481 Call Leg/Transaction Does
Not Exist is issued.
• discard - Do not send any response to the INVITE. The
far end will typically issue a RE-INVITE after some
timeout, but will eventually give up.
congestionreleaseto N/A The time (in seconds) to wait to release a call when that call
was rejected due to congestion. This parameter effectively
prevents the machine congestion level from escalating due
to rapid repeated call attempts by equipment that does not
support congestion detection. Must be 0-5 (seconds), default
is 0. A value of 0 disables this timer.
If this value is nonzero, the timer is started when a call is
rejected due to congestion. When the timer expires, the
network release is sent and the call resources are de-
allocated. If a network release is received during the delay,
the timer is stopped and the call resources are de-allocated.
congrtmaxtime N/A The maximum time (in seconds) for the RETRYAFTER
parameter. When the RETRYAFTER MINIMUM and
RETRYAFTER MAXIMUM are appropriately configured to
nonzero values, then the 503 Service Unavailable message
that is sent because the call was rejected due to congestion
will include a retry-after parameter. The value of that
parameter will be chosen randomly from the range
established by RETRYAFTER MINIMUM and MAXIMUM. If
the far end SIP equipment supports this parameter, the retry
for the failed call will be delayed by that number of seconds.
Must be 0-120 (seconds) and must be equal or greater than
RETRYAFTER MINIMUM.
To disable the retry-after parameter, set both MINIMUM and
MAXIMUM to 0. The retry-after parameter will not be will not
be inserted into the 503 message.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Field
Parameter Length Description
congrtmintime N/A The minimum time (in seconds) for the RETRYAFTER
parameter. When the RETRYAFTER MINIMUM and
RETRYAFTER MAXIMUM are appropriately configured to
nonzero values, then the 503 Service Unavailable message
that is sent because the call was rejected due to congestion
will include a retry-after parameter. The value of that
parameter will be chosen randomly from the range
established by RETRYAFTER MINIMUM and MAXIMUM. If
the far end SIP equipment supports this parameter, the retry
for the failed call will be delayed by that number of seconds.
Must be 0-120 (seconds) and must be less than or equal to
RETRYAFTER MAXIMUM.
To disable the retry-after parameter, set both MINIMUM and
MAXIMUM to 0. The retry-after parameter will not be will not
be inserted into the 503 message.
arsprofile N/A The Address Reachability Service (ARS) profile name for this
service group. If none is assigned, there is no reachability
service enforced.
See "Address Reachability Service (ARS) Profile" on
page 3–507 for information on configuring the ARS.
usecpfrompai N/A Specifies whether the GSX accepts or discards Calling Party
information from the PAI header, when generating the
Calling-Party-ID for PSTN:
• enabled (default) - the GSX accepts Calling Party
information from the PAI header.
• disabled - the GSX discards the calling name and
calling number from the PAI header as if it did not exist.
The Calling Party information from the next header in
order of priority (the PPI header) is then processed.
usecpfromppi N/A Specifies whether the GSX accepts or discards the Calling
Party information from the PPI header, when generating the
Calling-Party-ID for PSTN:
• enabled (default) - the GSX accepts Calling Party
information from the PPI header.
• disabled - the GSX discards the calling name and
calling number from the PPI header as if it did not exist.
The Calling Party information from the next header in
order of priority (the RPI header) is then processed.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Field
Parameter Length Description
usecpfromrpi N/A Specifies whether the GSX accepts or discards the Calling
Party information from the RPI header, when generating the
Calling-Party-ID for PSTN:
• enabled (default) - the GSX accepts Calling Party
information from the RPI header.
• disabled - the GSX discards the calling name and
calling number from the RPI header as if it did not exist.
The Calling Party information from the next header in
order of priority (the FROM header) is then processed.
usecpfromfrom N/A Specifies whether the GSX accepts or discards the Calling
Party information from the FROM header, when generating
the Calling-Party-ID for PSTN:
• enabled (default) - the GSX accepts Calling Party
information from the FROM header.
• disabled - the Calling-Party-ID for PSTN will be left
empty if there are no PAI/PPI/RPI headers present.
cpcpara N/A Specifies CPC Parameter mapping for SIP-to-ISUP calls:
• default - current behavior.
• paitel - only map CPC parameters received in PAI tel
header.
• fromheader - only map CPC parameters received in
FROM header.
privacyparam N/A Specifies Privacy Parameter mapping:
• default - current behavior (map ID, HEADER, and
USER to restrict).
• idonly - map ID parameter only to restrict.
isupmime N/A Specifies whether the ISUP MIME bodies received in SIP
INVITE request messages will transit transparently for SIP-I
to SIP-I calls:
• disabled (default) - the GSX will decode the ISUP MIME
body on the received leg and encode the MIME body on
the sending leg.
• enabled - the GSX will handle the ISUP MIME bodies
transparently. That is, the encoding and decoding routines
will not take place and the ISUP MIME message body
received during during the SIP-I to SIP-I call will be
transited end-to-end unmodified.
routeset N/A Specifies which routing source to use:
• stored - use the Stored Path or Service-Route
information stored in the Registration Control Block (RCB)
for routing.
• received - use the received Route Set for routing
• disabled (default) - use the current PSX-based routing.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Field
Parameter Length Description
rphprofile 1-23 Specifes a SIP Service Resource Priority Header (RPH)
profile to attach to this service group. Must be 1-23
characters. Multiple SIP Service groups can point to the
same SIP Service RPH profile.
See "SIP Service Resource Priority Header Profile" on
page 3–479 for more information.
Note: Enabling the SIP Service RPH profile affects all the
SIP Service Groups that are configured to use that profile. If
you do not want the SIP RPH processing for some of those
SIP service groups, they must first be reconfigured to point to
a new SIP Service RPH profile whose state is disabled.
ldcaction N/A Specifies the action to take if the Long Duration Call (LDC)
timer expires. The call may be released, a SNMP trap may
be generated, or both:
• noAction (default) - take no action on LDC timer expiry
(a debug log entry will be generated).
• trap - generate an SNMP trap.
• release - automatic call disconnect without generation of
a trap.
• trapAndRelease - generate an trap and release the call.
ldcemergcalls N/A Specifies whether emergency calls should be excluded from,
or included in Long Duration Call (LDC) disconnect
procedures:
• include
• exclude (default)
Note: Emergency call exclusion relies on the PSX call type
or other protocol-specific criteria to identify the call as an
“emergency” call.
ldcrelcause N/A Specifies the GSX disconnect reason used to release the call
if the call is released due to Long Duration Call (LDC) timer
expiry. Must be 1 to 127; default is 41 (Temporary Failure).
ldctimeout N/A Specifies the timeout value of the Long Duration Call (LDC)
timer in minutes. Must be 0 or 60-2880. A value of 0 disables
the timer; a value of 60-2880 sets the timer. Default is 0.
vartype N/A Specifies the type of SIP/SIP-T functionality to invoke when a
message is processed:
• sonus (default)
• ttc (for future use)
• q1912 - Q1912.5 standard
• uk - UK TSG spec 17
• mgcf - For Media Gateway Control Function behavior
when processing SIP<->ISUP interworking calls.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Field
Parameter Length Description
trustsrc N/A When VARIANT TYPE is set to q1912 or UK, specifies
whether the SIP message from a trusted source and the
FROM header can be used to map to the ISUP parameters
• enabled (default)
• disabled
comediarole N/A Specifies whether the SDP offer sent by GSX will include a
direction attribute line as defined by the Connection-Oriented
Media (COMEDIA) draft:
• none - the SDP offer will not include a direction attribute
line.
• active - the SDP offer will include “a=direction:active”
attribute line.
• passive - the SDP offer will include “a=direction:passive”
attribute line.
mediazone 1-23 Specifies the name of the Media Zone to which this SIP
Service Group is bound. The name specified must be the
name of an already existing ZONE, created using the ZONE
configuration object. Must be 1-23 characters.
For use with the Direct Media feature only.
Note: The Media Zone name will be mapped to the
configurable ZONE IDENTIFIER using the ZONE
configuration object (see "Zone" on page 3–511).
directmedia N/A This specifies whether or not Direct Media should be
attempted for calls to or from endpoints in this service group.
If enabled, the GSX will attempt to set up a media path such
that media flows directly between two Direct Media-enabled
endpoints in the same Media Zone.
• enabled
• disabled (default)
Note: The DIRECT MEDIA parameter can not be configured
unless the SIP SERVICE group is disabled.
filterprofile N/A Specifies the SIP FILTER PROFILE to associate with this
SIP Service Group for Receive Side Filtering. For
information, see "SIP Filter Profile" on page 3–464.
cpcsipprofileindex N/A Specifies the index of the CPC_TO_SIP CAUSEMAP
PROFILE that will be applied to calls that have not yet
received a CPC_TO_SIP Profile from the PSX. Must be 1-
16; default is 1. For information, see "SIP/CPC Cause Code
Mapping Profiles" on page 3–487.
sipcpcprofileindex N/A Specifies the index of the SIP_TO_CPC CAUSEMAP
PROFILE that will be applied to calls that have not yet
received a SIP_TO_CPC Profile from the PSX. Must be 1-
16; default is 1. For information, see "SIP/CPC Cause Code
Mapping Profiles" on page 3–487.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Field
Parameter Length Description
datapathpassthru N/A Specifies whether the GSX will transparently pass media
direction (Data Path Mode) received from a peer in the Offer
SDP with 0 RTP IP.
• enabled - Set SDP media direction per peer's offer SDP
for 0.0.0.0 RTP IP; e.g., GSX will honor and answer with
a=sendrecv/recvonly/inactive/inactive media direction if
the peer offers a=sendrecv/sendonly/recvonly/inactive
with a zero IP address. Similarly, GSX will offer
a=sendrecv/sendonly/inactive/inactive media direction to
opposite packet peer.
• disabled (default) - Existing dataPathmode handling:
GSX will always answer with a=inactive on receipt of Offer
SDP from peer containing a zero IP address. Also, the
GSX will offer a=inactive to the opposite packet peer.
factorvalue N/A Specifies the factor value used to interwork the SIP Max
Forwards Header and the ISUP Hop counter parameter.
Must be 1-50; default is 1. For more information, see "ISUP-
to-SIP Interworking" on page 6–256.
maxfwds N/A Specifies the default value for the Max Forwards Header.
Must be 1-100; default is 30 for the UK, otherwise the default
is 70. For more information, see "ISUP-to-SIP Interworking"
on page 6–256.
validation N/A Specifies if route validation should be performed for the
received message and whether the message should be
validated to ensure it is SIP-only or SIP-I. The call is released
if validation is done and an invalid message type is received.
This applies to forwards and backwards messages until
speech:
• noValidation
• sipOnly
• sipI
For more information, see "ISUP-to-SIP Interworking" on
page 6–256.
overlapaddr N/A For SIP-to-ISUP overlap dialing, specifies whether Overlap
Address Signaling is supported:
• enabled
• disabled (default)
For more information, see "ISUP-to-SIP Interworking" on
page 6–256.
overlapmindig N/A For SIP-to-ISUP overlap dialing, specifies the minimum
number of digits that must be received before sending a
routing request to the PSX, if Overlap Addressing is
supported. Must be 0 - 30; default is 0.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Field
Parameter Length Description
overlaptoiw3 N/A For SIP-to-ISUP overlap dialing, specifies the Time (in
seconds) between receiving a 484 Address Incomplete
message if there are no outstanding INVITE transactions and
the receipt of fresh address information. Must be 4 - 6
seconds; default is 4. For more information, see "ISUP-to-
SIP Interworking" on page 6–256.
toiw2timer N/A Specifies the time in seconds between sending an INVITE
and receiving a backward message when OVERLAP
ADDRESSING is enabled. Must be 4 - 14 seconds; default is
0. If The VARIANT TYPE is set to UK, MGCF, or Q1912, the
default is 4. For more information, see "ISUP-to-SIP
Interworking" on page 6–256.
t1timer N/A The SIP protocol retransmission timer T1 (in milliseconds).
Once configured, this value applies to future, but not
currently active, SIP calls. Must be 1-10000, default is 500
(milliseconds).
t2timer N/A The SIP protocol retransmission timer T2 (in milliseconds).
Once configured, this value applies to future, but not
currently active, SIP calls. Must be 1-65535, default is 4000
(milliseconds) or 4 seconds.
sessionkeepalive N/A The SIP protocol session keep-alive timer (in seconds). This
parameter takes effect immediately and will affect all
subsequent SIP calls. Must be 0 or 120-65535, default is
1800 (seconds). A value of 0 causes keep-alive to be turned
off.
This timer allows the GSX to support Draft-ietf-sip-session-
timer-10.
minse N/A The content of the Min-SE header field. When present, this
field indicates the minimum value for the session interval, in
seconds. When used in an INVITE or UPDATE request, it
indicates the smallest value of the session interval that can
be used for that session. When present in a request or
response, its value must not be less than 90-65535. Default
is 90 (seconds).
sesstermdeltatime N/A The time, in seconds, before the end of the session interval,
that a SIP user agent that hasn’t received any refresh
request from its peer should send a BYE message to the
peer to take the session down. Must be 0-65535 (seconds),
default is 0.
general N/A The number of retransmissions for all SIP messages except
BYE, CANCEL, and INVITE. This parameter takes effect
immediately and will affect all subsequent SIP calls. Must be
4-12, default is 7.
cancel N/A The number of retransmissions for SIP CANCEL messages.
This parameter takes effect immediately and will affect all
subsequent SIP calls. Must be 0-12. A value of 0 means no
retransmission of any CANCEL message.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Field
Parameter Length Description
invite N/A The number of retransmissions for SIP INVITE messages.
This parameter takes effect immediately and will affect all
subsequent SIP calls. Must be 0-6. A value of 0 means no
retransmission of any INVITE message.
The GSX SIP stack supports RFC 3261 Timer B. Timer B
controls the maximum number of retransmissions of INVITE,
by expired time. The value of this timer is 64 times (the value
of Timer) T1. This timer is started for every egress INVITE
transaction, and cancelled every time the retry count expires.
If this timer expires before the specified retry count is
reached, then retries are terminated, even if the specified
retry count has not expired.
bye N/A The maximum number of retransmissions for SIP BYE
messages. This parameter takes effect immediately and will
affect all subsequent SIP calls. Must be 0-12. A value of 0
means no retransmission of any BYE message.
keepallive_retry422 N/A Specifies the maximum retries of SIP session keepalives
allowed upon receipt of a 422 response. This limit is applied
when the SIP Service Group is enabled. The call is cleared
upon receipt of the next keepalive response after the
configured value. The count will restart when any other
keepalive response is received. Must be 0-12, default is 5.
keepallive_retry491 N/A Specifies the maximum retries of SIP session keepalives
allowed upon receipt of a 491 response. This limit is applied
when the SIP Service Group is enabled. The call is cleared
upon receipt of the next keepalive response after the
configured value. The count will restart when any other
keepalive response is received. Must be 0-12, default is 5.
options N/A Specifies how a SIP OPTIONS message that is received
should be handled:
• allow (default) - Process the SIP OPTIONS message in
the normal fashion.
• reject - Respond to the received message with a 405
response code. No additional information (such as an
ErrorInfo header) will be provided in the rejection.
refer N/A Specifies how a SIP REFER message that is received should
be handled:
• allow (default) - Process the SIP REFER message in the
normal fashion.
• reject - Respond to the received message with a 405
response code. No additional information (such as an
ErrorInfo header) is provided in the rejection.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Field
Parameter Length Description
subscribe N/A Specifies how a SIP SUBSCRIBE message that is received
should be handled:
• allow (default) - Process the SIP SUBSCRIBE message
in the normal fashion.
• reject - Respond to the received message with a 405
response code. No additional information (such as an
ErrorInfo header) is provided in the rejection.
notify N/A Specifies how a SIP NOTIFY message that is received
should be handled:
• allow (default) - Process the SIP NOTIFY message in the
normal fashion.
• reject - Respond to the received message with a 405
response code. No additional information (such as an
ErrorInfo header) is provided in the rejection.
info N/A Specifies how a SIP INFO message that is received should
be handled:
• allow (default) - Process the SIP INFO message in the
normal fashion.
• reject - Respond to the received message with a 405
response code. No additional information (such as an
ErrorInfo header) is provided in the rejection.
register N/A Specifies how a SIP REGISTER message that is received
should be handled:
• allow (default) - Process the SIP REGISTER message in
the normal fashion.
• reject - Respond to the received message with a 405
response code. No additional information (such as an
ErrorInfo header) is provided in the rejection.
message N/A Specifies how a SIP MESSAGE message that is received
should be handled:
• allow (default) - Process the SIP METHOD message in the
normal fashion.
• reject - Respond to the received message with a 405
response code. No additional information (such as an
ErrorInfo header) is provided in the rejection.
publish N/A Specifies how a SIP PUBLISH message that is received
should be handled:
• allow (default) - Process the SIP PUBLISH message in
the normal fashion.
• reject - Respond to the received message with a 405
response code. No additional information (such as an
ErrorInfo header) is provided in the rejection.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Field
Parameter Length Description
admin_state N/A The administrative state of this SIP service:
• disabled (default) - Not active, and able to be
configured.
• enabled - Active.
interval N/A Specifies the interval for which SIP statistics are sought, set
when configuring trunk group performance statistics. The
number 1 selects the most recent interval, the number 2
selects 2 intervals ago, and so on. Must be 1-12.
See "Performance Statistics" on page 3–984 for information
on setting intervals for PERFORMANCE STATISTICS.
dns N/A Specifies the DNS query types:
• a-only (default) - a DNS query will be made for all A
(Address) records.
• a-srv-naptr - a DNS query will be made for all A, SVR,
and NAPTR records (Address, Location of Services, and
Naming Authority Pointer).
cbprof 1-23 The index number of the CRANKBACK PROFILE to use with
this H323 service group. This must specify a valid Call
Crankback profile index, in the range 1-10. The default is 1,
or Call Crankback Profile default. See"Call Crankback
Profile" on page 3–1171.
tcp_rtry N/A For SIP over TCP, the time (in seconds) that the GSX should
wait, after sending an unacknowledged message (such as a
request, final response, or reliable provisional response),
until retrying to send the message using a different flow or to
a different destination. Range 0-15 seconds, default = 6
seconds.
nattcp_kal N/A The refresh rate for SIP registrations established over a TCP
connection. Range 15-300 seconds, default = 240 seconds
(4 minutes.)
natudp_kal N/A The refresh rate for SIP registrations established over a UDP
connection. Range 15-300 seconds, default = 60 seconds.
fst_rfsh N/A Specifies whether to force fast SIP registration refresh
expiration, as follows:
• false (default) - Use the REGISTRATION EXPIRES
keepalive timeout value.
• true - Use the NATOVERTCP or NATOVERUDP keepalive
timeout value, depending on the protocol.
redir N/A Specifies whether to allow SIP redirection of incoming calls:
• enabled (default) - Enable redirection of inbound SIP
calls landing on the MNS20 card;
• disabled - Don’t redirect inbound SIP calls.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Field
Parameter Length Description
trns_pref N/A Specifies the first, second, and third preference for SIP
transport type:
• none (default) - Transport selection falls through to other
sources.
• tcp - Use SIP over TCP
• udp - Use SIP over UDP
• tls-tcp - Use SIP over TLS/TCP
transmitprofile N/A Specifies the SIP TRANSMIT PROFILE to associate with
this SIP Service Group for Transmit Side Filtering. For
information, see "SIP Transmit Profile" on page 3–468.
tmr64k N/A Specifies whether or not to set the forward call indicator/
backward call indicator (FCI/BCI) values in initial address/
address complete messages (IAM/ACM) according to the
Transmission Medium Required (TMR) value of the IAM for a
SIP<->ISUP interworking call:
• enabled - Check the TMR value before setting the FCI/
BCI values.
• disabled (default) - Do not check the TMR value to set
FCI/BCI.
preconditions_recei N/A Specifies the preconditions validation and set up when a SIP
ve INVITE has been received and an egress call leg needs to
be set up:
• none (default) - Ignore preconditions in the SIP INVITE
and proceed with set up.
• supported - If preconditions are present in the SIP
INVITE, use them and proceed with set up; if no
preconditions are present in the SIP INVITE, ignore
preconditions and proceed with set up.
• required - If preconditions are present in the SIP
INVITE, use them and proceed with set up; if no
preconditions are present in the SIP INVITE, reject the
INVITE with 421, “extension required”.
This parameter is examined only for interworking calls. This
parameter supports Media Gateway Control Function
(MGCF) compliance.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Field
Parameter Length Description
preconditions_trans N/A Specifies the preconditions to use when a SIP egress call leg
mit needs to be set up:
• none (default) - Ignore preconditions, do not insert either
a “supported” or “required” header.
• optional - Request preconditions, inserting a
“supported” SIP header and optional strength desired
status attributes in SDP
• required - Request preconditions, inserting a “required”
SIP header and mandatory strength desired status
attributes in SDP.
This parameter is examined only for interworking calls. This
parameter supports MGCF compliance.
strictparsing N/A Specifies whether strict specification compliance for SIP
parsing is enabled. Use for strict compliance testing only.
• enabled
• disabled (default)
appl_headers N/A Specifies whether P-Charging-Vector headers be included in
all SIP messages (including messages generated by the SIP
stack):
• enabled - include P-Charging-Vector headers.
• disabled (default) - do not include P-Charging-Vector
headers universally in SIP messages.
inter_op_id 1-23 Specifies an InterOperatorID to insert into the P-Charging-
Vector header instead of the Carrier Code (which is inserted
in the absence of this parameter). This string is inserted into
the INVITE message for ISUP originated calls. This string is
inserted into the 1XX/2XX message of SIP originated calls.
uri_pres_pref N/A Specifies the Control of Scheme behavior to apply to the SIP
headers:
• none (default) - Use the existing Control of Scheme
behavior of no preference.
• sip - Convert all TEL scheme headers to SIP scheme.
• tel - Convert all SIP scheme headers to TEL scheme
(only applicable if the user portion is an E.164 number).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Command Example
To create, configure, and enable SIP service group MySipIpSrvcGrp on IP trunk group iptg1,
using source address filtering:
% CREATE SIP SERVICE MySipIpSrvcGrp
% CONFIGURE SIP SERVICE MySipIpSrvcGrp TRUNK GROUP iptg1
% CONFIGURE SIP SERVICE MySipIpSrvcGrp SOURCE ADDRESS FILTERING enabled
% CONFIGURE SIP SERVICE MySipIpSrvcGrp STATE enabled
% CONFIGURE SIP SERVICE MySipIpSrvcGrp MODE inService
-----------------------------------------------------------------------
SIP Service : MySipIpSrvcGrp
-----------------------------------------------------------------------
Admin State : ENABLED
Mode : INSERVICE
Action : DRYUP
Dryup Timeout (min) : 5
Trunk Group : IPTG1
Disc Treatment : sipDefault
Tone Package : default
Source Address Filtering : ENABLED
Ans Supervision Timeout : 300
Ans Supervision Timeout Action : RELEASE
Registration Expires (Default) : 3600
Signaling Zone : INTERNAL
Media Zone : INTERNAL
Media NIF Group :
NAPT for Signaling : DISABLED
NAPT for Media : DISABLED
Parse Embedded BGID : DISABLED
Congestion Reject Method : RELEASE
Congestion Retry Timer Min (sec) : 10
Congestion Retry Timer Max (sec) : 30
Congestion Release Timeout (sec) : 0
SIP Timer T1 (msec) : 500
SIP Timer T2 (msec) : 4000
SIP Session Keepalive Timer (sec) : 1800
SIP Session Term Delta Time (sec) : 0
SIP Minimum Session Timer (sec) : 90
Retry Count for SIP Messages : 7
Retry Count for INVITE Message : 6
Retry Count for BYE Message : 3
Retry Count for CANCEL Message : 3
Session keepalive retry on 422 : 5
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
-------------------------------------
SIP Service Status
------------------------ ------------
defaultSipIpSrvcGrp AVAILABLE
MySipIpSrvcGrp AVAILABLE
To set the retry counters to 5 for SIP messages and 2 for SIP BYE and CANCEL messages:
% CONFIGURE SIP SERVICE MySipIpSrvcGrp RETRY GENERAL 5 BYE 2 CANCEL 2
INVITE 6
To set the timers to 600 for T1, 6000 for T2, and 220 for session keep-alive:
% CONFIGURE SIP SERVICE MySipIpSrvcGrp TIMER T1 600 T2 6000
SESSIONKEEPALIVE 220
To change the default configuration of the SIP METHODS to reject the SIP OPTIONS, REFER,
SUBSCRIBE, NOTIFY, INFO, and REGISTER messages and respond to each of them with a 405
code:
% CONFIGURE SIP SERVICE MySipIpSrvcGrp METHODS OPTIONS reject ..
REFER reject SUBSCRIBE reject NOTIFY reject INFO reject ..
REGISTER reject
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
The SIP Filter Profile object creates and configures a SIP Filter Profile for Receive Side Filtering,
which enables processing control of optional SIP headers within SIP Messages at the header level
upon receipt of the message. Receive Side Filtering allows you to indicate that certain headers
should not be passed transparently through the GSX/NBS, regardless of the transparency setting
on the sending side.
In addition, Receive Side Filtering stops processing of the header information. Information
received on the ingress side can still be used regardless of transparency settings. Filtering of the
SIP header goes beyond that and in effect treats the header as if it was never received.
After creating a SIP Filter Profile, the SIP Message headers listed below will not be filtered for
that SIP Filter Profile unless they are explicitly configured as enabled. For example, the
following commands enable filtering for DIVERSION and PRIVACY headers for
fltrprofile1:
You then associate a SIP Filter Profile with a SIP Service group using the command:
% CONFIGURE SIP SERVICE svcgroup1 FILTER PROFILE fltrprofile1
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
MAX_FORWARDS header
MIN_EXPIRES header
HEADER MIN_SE header
P_ASSERTED_ID header
P_CARRIER_INFO header
P_CHARGING_VECTOR header
P_K_ADN header
P_PREFERRED_ID header
P_SIG_INFO header
P_SVC_INFO header
P_TERM_CA header
PATH header
P_CDR_INFO header
P_CHARGE_INFO header
PKCFL header
CPKCFO header
PRIVACY header
PROXY_AUTHORIZATION header
PROXY_REQ header
REASON header
REMOTE_PARTY header
REPLACES header
REPLY_TO header
REQUEST_BY header
REQUIRED header
RESOURCE_PRIORITY header
RETRY_AFTER header
ROUTE header
SERVICE_ROUTE header
SESSION_EXPIRES header
SUBSCRIPTION_STATE header
SUPPORTED header
TIME_STAMP header
UNKNOWN header
UNSUPPORTED header
WWWAUTHENTICATE header
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
ACCEPTCONTACT header
Command Parameters
Field
Parameter Length Description
filterprofile 1-23 Specifies the name of the SIP Filter Profile you are
configuring. Must be 1-23 characters.
header N/A Specifies whether the named individual optional SIP header
should be filtered when the message is processed:
• enabled - filter this message header.
• disabled (default) - do not filter this message header.
Command Examples
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
The SIP Transmit Profile object creates and configures a SIP Profile for Transmit Side Filtering.
This profile establishes the optional SIP headers within SIP messages that should be included in
outbound SIP messages. Transmit Side Filtering allows you to specify exactly which SIP headers
should be included in outbound SIP messages, regardless of the transparency setting on the receive
side.
In the absence of a SIP Transmit Profile, SIP message headers that are present in the received SIP
messages are passed through to the outbound SIP messages; SIP message headers that are absent
in received SIP messages are correspondingly absent in outbound SIP messages.
When a SIP Transmit Profile is created, certain SIP message headers may be enabled, such as
DIVERSION and PRIVACY for the profile stprofile, as shown below:
% CONFIGURE SIP TRANSMIT PROFILE stprofile HEADER DIVERSION enabled
% CONFIGURE SIP TRANSMIT PROFILE stprofile HEADER PRIVACY enabled
This will force a DIVERSION and PRIVACY header on all outbound SIP messages. If these
headers were present in the received SIP message, they are passed through in the outbound
message. If these headers were absent in the received SIP message, they are added to the outbound
message.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
MAX_FORWARDS max_forwards
MIN_EXPIRES max_expires
MIN_SE min_se
P_ASSERTED_ID p_asserted_id
P_CARRIER_INFO p_carrier_info
P_CHARGING_VECTOR p_charging_vector
P_K_ADN p_k_adn
P_PREFERRED_ID p_preferred_id
P_SIG_INFO p_sig_info
P_SVC_INFO p_svc_info
P_TERM_CA p_term_ca
PATH path
P_CDR_INFO p_cdr_info
P_CHARGE_INFO p_charge_info
PKCFL pkcfl
PKCFO pkcfo
PRIVACY privacy
PROXY_AUTHORIZATION proxy_authorization
PROXY_REQ proxy_req
REASON reason
REMOTE_PARTY remote_party
REPLACES replaces
REPLY_TO reply_to
REQUEST_BY request_by
REQUIRED required
RESOURCE_PRIORITY resource_priority
RETRY_AFTER retry_after
ROUTE route
SERVICE_ROUTE service_route
SESSION_EXPIRES session_expires
SUBSCRIPTION_STATE subscription_state
SUPPORTED supported
TIME_STAMP time_stamp
UNKNOWN unknown
UNSUPPORTED unsupported
WWWAUTHENTICATE wwwauthenticate
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
ACCEPTCONTACT acceptcontact
Command Parameters
Field
Parameter Length Description
siptransmitprof 1-23 Specifies the name of the SIP Transmit Profile you are
creating or configuring. Must be 1-23 characters.
accepted N/A Specifies whether or not to include the Accept Header in
outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
accept_resource_inf N/A Specifies whether or not to include the Accept Resource
o Priority Header in outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
alert_info N/A Specifies whether or not to include the Alert Info Header in
outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
allowed N/A Specifies whether or not to include the Allowed Header in
outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
also N/A Specifies whether or not to include the Also Header in
outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Field
Parameter Length Description
anonymity N/A Specifies whether or not to include the Anonymity Header in
outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
authorization N/A Specifies whether or not to include the Authorization Header
in outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
callconnectid N/A Specifies whether or not to include the Call Connect ID
Header in outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
content_disp N/A Specifies whether or not to include the Content Disposition
Header in outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
diversion N/A Specifies whether or not to include the Diversion Header in
outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
error N/A Specifies whether or not to include the Error Header in
outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
error_info N/A Specifies whether or not to include the Error Info Header in
outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
event N/A Specifies whether or not to include the Event Header in
outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Field
Parameter Length Description
expire N/A Specifies whether or not to include the Expires Header in
outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
max_forwards N/A Specifies whether or not to include the Max Forwards
Header in outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
min_expires N/A Specifies whether or not to include the Min Expires Header in
outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
min_se N/A Specifies whether or not to include the Min SE Header in
outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
p_asserted_id N/A Specifies whether or not to include the P Asserted ID Header
in outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
p_carrier_info N/A Specifies whether or not to include the P Carrier Info Header
in outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
p_charging_vector N/A Specifies whether or not to include the P Charging Vector
Header in outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
p_k_adn N/A Specifies whether or not to include the P K Adn Header in
outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Field
Parameter Length Description
p_preferred_id N/A Specifies whether or not to include the P Preferred ID
Header in outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
p_sig_info N/A Specifies whether or not to include the P Sig Info Header in
outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
p_svc_info N/A Specifies whether or not to include the P Svc Info Header in
outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
p_term_ca N/A Specifies whether or not to include the P Term CA Header in
outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
path N/A Specifies whether or not to include the Path Header in
outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
p_cdr_info N/A Specifies whether or not to include the PCdrInfo Header in
outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
p_charge_info N/A Specifies whether or not to include the PChargeInfo Header
in outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
pkcfl N/A Specifies whether or not to include the PKCfl Header in
outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Field
Parameter Length Description
pkcfo N/A Specifies whether or not to include the PKCfo Header in
outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
privacy N/A Specifies whether or not to include the Privacy Header in
outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
proxy_authorization N/A Specifies whether or not to include the Proxy Authorization
Header in outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
proxy_req N/A Specifies whether or not to include the Proxy Req Header in
outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
reason N/A Specifies whether or not to include the Reason Header in
outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
remote_party N/A Specifies whether or not to include the Remote Party Header
in outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
replaces N/A Specifies whether or not to include the Replaces Header in
outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
reply_to N/A Specifies whether or not to include the Reply To Header in
outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Field
Parameter Length Description
request_by N/A Specifies whether or not to include the Request By Header in
outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
required N/A Specifies whether or not to include the Required Header in
outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
resource_priority N/A Specifies whether or not to include the Resource Priority
Header in outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
retry_after N/A Specifies whether or not to include the Retry After Header in
outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
route N/A Specifies whether or not to include the Route Header in
outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
service_route N/A Specifies whether or not to include the Service Route Header
in outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
session_expires N/A Specifies whether or not to include the Session Expires
Header in outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
subscription_state N/A Specifies whether or not to include the Subscription State
Header in outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Field
Parameter Length Description
supported N/A Specifies whether or not to include the Supported Header in
outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
time_stamp N/A Specifies whether or not to include the Time Stamp Header
in outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
unknown N/A Specifies whether or not to include Unknown Headers in
outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
unsupported N/A Specifies whether or not to include the Unsupported Header
in outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
wwwauthenticate N/A Specifies whether or not to include the WWWAuthenticate
Header in outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
acceptcontact N/A Specifies whether or not to include the Accept-Contact
Header in outbound SIP messages:
• enabled - Include this message header.
• disabled (default) - Pass through, but do not add, this
message header.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Command Examples
To create a SIP TRANSMIT PROFILE, xyz, with default settings for all optional headers and
then display the values of these defaults:
% CREATE SIP TRANSMIT PROFILE xyz
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Request By DISABLED
Required DISABLED
Resource Priority DISABLED
Retry After DISABLED
Route DISABLED
Service Route DISABLED
Sess Expires DISABLED
Subscription State DISABLED
Supported DISABLED
Time Stamp DISABLED
Unknown DISABLED
Unsupported DISABLED
WWWAuthenticate DISABLED
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
The SIP Service Resource Priority Header (RPH) can be used for marking SIP calls as priority
calls. For ingress SIP calls, if the INVITE message contains this header with particular namespace
values, and the SIP RPH profile configuration indicates that RPH is enabled, then the call is
accepted and treated as a High Probability of Completion (HPC) call.
In the reverse direction, if the Calling Party Category (CPC) of an egress call is National Security/
Emergency Preparedness (NSEP) and the SIP service group configuration indicates that RPH is
enabled, then the egress INVITE includes this header with the appropriate namespace value.
The SIP Service RPH profile determines which treatment to give to the Resource Priority Header
for a SIP Service group. Use the CONFIGURE SIP SERVICE sipservice RESOURCE
PRIORITY HEADER PROFILE rphprofile command to bind an RPH profile to a SIP Service
group. Multiple SIP Service groups can point to the same profile.
For more information, see "High Probability of Completion (HPC) Features" on page 6–237.
NOTE
The use of the GETS Software is restricted in the U.S. and U.S. TERRITORIES to
NS/EP users authorized by the Office of the Manager, National Communications
System (OMNCS). See "GETS Software" on page xxviii.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Command Parameters
Field
Parameter Length Description
rphprofile 1-23 The name of the SIP Service Resource Priority Header
(RPH) profile you are configuring. Must be 1-23 characters.
etsstate N/A Specifies whether the Resource Priority Header is used or
generated, when supporting High Probability of Completion
(HPC) network capability. For more information, see "SIP
Resource Priority Header" on page 6–239.
• disabled (default)
• enabled
Note: Enabling this will affect all the SIP Service Groups that
are configured to use this profile. If you do not want SIP RPH
processing for some of those SIP service groups, they must
first be reconfigured to point to a new SIP Service RPH
profile whose state is disabled before enabling this profile.
417respaction N/A Specifies the GSX behavior upon receiving the 400 Bad
Request response containing the 417 value in the Reason
header when supporting High Probability of Completion
(HPC) network capability:
• resendnoets (default) - the GSX will re-attempt the call
without the RPH header.
• reject - the GSX will not re-attempt the call.
• resendetsdefault - the GSX will re-attempt the call
with the Resource Priority Header (RPH) header with the
default Emergency Telecommunications Service (ETS)
value configured for the egress Trunk/Service Group.
inclacceptin417 N/A Specifies whether the GSX will include the Accept-Resource-
Priority header when sending a 417 response (when
supporting HPC network capability):
• disabled (default)
• enabled
inclrequire N/A Specifies whether a Require: Resource-Priority will be
included in an egress INVITE (when supporting HPC network
capability):
• disabled (default)
• enabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
TABLE 3–109 SIP Service Resource Priority Header Profile Parameters (Continued)
Field
Parameter Length Description
rejectnotets N/A Specifies whether a call with a Resource Priority Header
(RPH) but a non-ETS Directory Number (DN) is accepted
(when supporting HPC network capability):
• disabled
• enabled (default)
When enabled, the SIP response is 403 (Forbidden) with two
reason header fields:
-- A 417 (RPH header) code for SIP
-- A Reason Header Q.850 value of 21 (Call Rejected)
The response will not contain an RPH with ETS.
default N/A Specifies the default value used for the ETS namespace
(when supporting HPC network capability). Must be 0-4;
default is 0.
useincets N/A Specifies whether the GSX will accept the received ETS
value or always override with the default (when supporting
HPC network capability):
• disabled (default)
• enabled
usewps N/A Specifies whether the ETS value will be taken from Wireless
Priority Service (WPS) precedence or from the configured
default (when supporting HPC network capability):
• disabled (default)
• enabled
400with417stats N/A Specifies...
• disabled
• enabled (default)
417stats N/A Specifies whether to tally the number of calls rejected with
incoming and outgoing SIP 417 response codes:
• disabled
• enabled (default)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
TABLE 3–109 SIP Service Resource Priority Header Profile Parameters (Continued)
Field
Parameter Length Description
etscpcprec N/A Specifies how the call should be handled when the ets value
in the SIP RPH and a CPC parameter in the associated
ISUP-MIME indicate different handling:
• ets - handle the call as indicated by the SIP RPH ets
value.
• cpc - handle the call as indicated by the ISUP-MIME CPC
parameter
• hpc (default) - handle the call as an HPC call if either the
SIP RPH ets or the ISUP-MIME CPC parameter indicate
priority handling
wpsmlppprec N/A Determines how the call should be handled when the wps
value in the SIP RPH and a MLPP parameter in the
associated ISUP-MIME indicated different handling:
• wps - handle the call as indicated by the SIP RPH wps
value.
• mlpp - (default) - handle the call as indicated by the ISUP-
MIME MLPP parameter.
Command Examples
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
These commands display SIP Resource Priority Header (RPH) statistics for current and interval
reporting.
The SIP RPH CURRENT and INTERVAL statistics include the following:
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Command Parameters
Field
Parameter Length Description
shelf N/A Specifies the shelf number in the GSX node configuration. In
this release, one shelf is supported. Must be 1.
interval N/A Specifies the interval for which the set of statistics is available.
1 is the most recently completed interval, and N is the interval
immediately preceding the one identified by N-1. Must be 1-12.
Command Examples
MESSAGE STAT
-------------------------------------------------
ETS INVITE OUT: - 0
ETS 18x OUT: - 0
ETS 182 OUT: - 0
ETS 2xx OUT: - 0
ETS 4xx OUT: - 0
ETS 4xx with 417 OUT: - 0
ETS 408 OUT: - 0
ETS 417 OUT: - 0
ETS 486 OUT: - 0
ETS INVITE IN: - 0
ETS INVITE ETS DN IN: - 0
ETS 400 with 417 IN: - 0
ETS 417 IN: - 0
ETS 420 IN: - 0
ETS 403 IN: - 0
ETS LOG COUNT: - 0
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
MESSAGE STAT
-------------------------------------------------
ETS INVITE OUT: - 0
ETS 18x OUT: - 0
ETS 182 OUT: - 0
ETS 2xx OUT: - 0
ETS 4xx OUT: - 0
ETS 4xx with 417 OUT: - 0
ETS 408 OUT: - 0
ETS 417 OUT: - 0
ETS 486 OUT: - 0
ETS INVITE IN: - 0
ETS INVITE ETS DN IN: - 0
ETS 400 with 417 IN: - 0
ETS 417 IN: - 0
ETS 420 IN: - 0
ETS 403 IN: - 0
ETS LOG COUNT: - 0
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
The CAUSEMAP PROFILEs, SIP_TO_CPC and CPC_TO_SIP, provide customized tables on the
GSX to use to map cause codes between SIP and Q850 cause codes. Previously, these mappings
were hard coded in the GSX. The custom mappings can be selected on a per route basis, on egress
trunks, as well as on a per call basis, on ingress trunks, via the IP PROFILE on the PSX. Three
default or base profiles are available to either use as is, or to build upon for SIP to CPC mapping:
• DefaultSipCpc - based on the current Sonus hard coded mappings and recommended to
achieve “backwards” compatibility. Index is 1.
• DefaultQ1912SipCpc - based on Q1912.5. Index is 2.
• DefaultRFC3398SipCpc - based on RFC 3398. Index is 3.
The three corresponding default profiles for CPC to SIP mapping are:
• DefaultCpcSip - based on the current Sonus hard coded mappings and recommended to
achieve “backwards” compatibility. Index is 1.
• DefaultQ1912CpcSip - based on Q1912.5. Index is 2.
• DefaultRFC3398CpcSip - based on RFC 3398. Index is 3.
These default profiles may not be altered under any circumstances. However, when you create a
new profile, it is populated using a base profile that you specify and thereafter you may add,
delete, and modify entries. Up to 13 new profiles may be created. Each profile has a unique index
(an integer in the range 1-16) associated with it. The base profiles take indices 1-3. The index of
the desired profile is configured on the PSX on the ingress and egress IP PROFILEs. The PSX
then passes that index value to the GSX. By default the PSX passes the value 1 to the GSX, which
is the Sonus Default Mappings profile. If the PSX passes an index for a profile that does not exist
on the GSX, the Sonus Default Mappings profile will be used.
The following special case handling is performed for cause codes that are not present in the active
CAUSEMAP PROFILE:
• Cause code 22 (“number changed”) - If this code is received, then if there are diagnostics in
the REL with the new called party number, the REL will be mapped to a 301 and the new
called party number will go in the contact header, otherwise it will be mapped into a 410. This
is the default behavior for profiles based upon DefaultRFC3398SipCpc because cause code
22 is absent from that profile.
• Cause code 21 (“call rejected”) - If this code is received, and location is set to “user”, then 603
is sent, otherwise 403 is sent. This is the default behavior for profiles based upon
DefaultRFC3398SipCpc because cause code 21 is absent from that profile.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
• Cause code 34 (“no circuit available”) - If this code is received, then if there are diagnostics in
the REL that indicate CCBS possible, 486 is sent, otherwise 480 is sent. This is the default
behavior for profiles based upon DefaultQ1912SipCpc because cause code 34 is absent
from that profile.
This behavior is achieved by deleting the relevant cause code from the new profile.
Command Syntax
SIP_TO_CPC
CREATE CAUSEMAP SIP_TO_CPC PROFILE sipcpcprofile INDEX index ..
BASEPROFILE baseprofile
CREATE CAUSEMAP SIP_TO_CPC PROFILE sipcpcprofile SIPCAUSE sipcause ..
CPCCAUSE cpccause
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
CPC_TO_SIP
CREATE CAUSEMAP CPC_TO_SIP PROFILE cpcsipprofile INDEX index ..
BASEPROFILE baseprofile
CREATE CAUSEMAP CPC_TO_SIP PROFILE cpcsipprofile CPCCAUSE cpccause ..
SIPCAUSE sipcause
SIPCAUSE sipcause Q850REASON q850reason
Command Parameters
Field
Parameter Length Description
sipcpcprofile 1-23 The name of a SIP_TO_CPC CAUSEMAP PROFILE. This
name cannot start with the string “default”.
index N/A A unique profile identifier. The base profile indices are:
• DefaultCpcSip/DefaultSipCpc - 1
• DefaultQ1912CpcSip/DefaultQ1912SipCpc - 2
• DefaultRFC3398CpcSip/DefaultRFC3398SipCpc - 3
For a new profile, this value must be in the range 4-16.
This identifier is specified in the ingress and egress IP
PROFILEs on the PSX in order to access and use the intended
GSX CAUSEMAP profile.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Field
Parameter Length Description
baseprofile 1-23 The name of one of the three fixed, default CAUSEMAP
PROFILEs that the new CAUSEMAP PROFILE that is being
created will be based upon. These CPC-to-SIP base profiles are:
• DefaultCpcSip - current Sonus Mappings.
• DefaultQ1912CpcSip - based on Q1912.5.
• DefaultRFC3398CpcSip - based on RFC3398.
These SIP-to-CPC base profiles are:
• DefaultSipCpc - current Sonus Mappings.
• DefaultQ1912SipCpc - based on Q1912.5.
• DefaultRFC3398SipCpc - based on RFC3398.
The base profiles cannot be modified. The base profile that you
designate will be copied to the profile that you create. Additions,
modifications, and deletions may subsequently be applied to the
new profile via the CONFIGURE command.
sipcause N/A A valid SIP cause value. Must be 300-606.
cpccause N/A A valid Q850 cause value. Must be 1-255.
cpcsipprofile 1-23 The name of a CPC_TO_SIP CAUSEMAP PROFILE. This
name cannot start with the string “default”.
cancelcause N/A The Q850 cause value that the SIP CANCEL message should
generate. RFC3398 specifies 16 (normal clearing), whereas
Q1912.5 specifies 31 (normal unspecified). The respective
default profiles contain these mappings but this provides a user
override to the default mapping. Must be 1-127.
byeloc N/A Specifies the location value to use for the SIP REL message
when a SIP BYE message is received:
• user
• localPrivateNetwork
• localLocalNetwork
• transitNetwork
• remoteLocalNetwork
• remotePrivateNetwork
• localInterfaceControlledByThisSigLink
• internationalNetwork
• networkBeyondPoint - default in DefaultQ1912SipCpc
and in DefaultRFC3398SipCpc.
• privateBranchExchange
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Field
Parameter Length Description
cancelloc N/A Specifies the location value to use for the SIP REL message
when a SIP CANCEL message is received:
• user
• localPrivateNetwork
• localLocalNetwork
• transitNetwork
• remoteLocalNetwork
• remotePrivateNetwork
• localInterfaceControlledByThisSigLink
• internationalNetwork
• networkBeyondPoint - default in DefaultQ1912SipCpc
and in DefaultRFC3398SipCpc.
• privateBranchExchange
msgxxloc N/A Specifies the location value to use for the SIP REL message
when a SIP 3XX, 4XX, 5XX, or 6XX message is received:
• user - default in DefaultRFC3398SipCpc for SIP 6XX
messages.
• localPrivateNetwork
• localLocalNetwork - default in DefaultRFC3398SipCpc
for SIP 4XX and 5XX messages.
• transitNetwork
• remoteLocalNetwork
• remotePrivateNetwork
• localInterfaceControlledByThisSigLink
• internationalNetwork
• networkBeyondPoint - default in DefaultQ1912SipCpc
for SIP 4XX, 5XX, and 6XX.
• privateBranchExchange
unrecaction N/A Specifies the SIP cause value to use when an unrecognized
ISUP cause value is received (a value that is not present in the
CPC_TO_SIP CAUSEPROFILE):
• q1912Procedure - Use the default value of the ISUP class of
the unrecognized cause code and map that value to the SIP
cause value, the default in DefaultQ1912CpcSip. See
Table 7–8 on page 7–40, "Mapping by Cause Code Class".
• rfc3398Procedure - Use SIP 500 message (SERVER
INTERNAL ERROR), the default in
DefaultRFC3398CpcSip.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Field
Parameter Length Description
q850reason N/A Specifies the Reason Header Q.850 value to include in the SIP
message (when the INCLUDEQ850REASON parameter is
enabled). Also indicates the cause code value to include in MIME
encapsulated ISUP, if the call uses SIP-I signaling. Must be 0-
127; default is 0.
A value of 0 indicates that the Reason Header Q.850 value
should be equal to the predefined ISUP mapping associated with
the CPCCAUSE value. If no predefined ISUP mapping exists (as
for internal cause codes 151-159), the ISDN mapping is used.
Note: This parameter applies to CAUSEMAP CPC_TO_SIP
PROFILES only.
inclq850reas N/A Specifies whether SIP error messages associated with this
profile will include a Reason Header Q.850 value taken from the
Q850REASON parameter.
• enabled - SIP error messages associated with this profile will
include a Reason Header Q.850 value taken from the
Q850REASON parameter.
• disabled (default) - the SIP error messages will not include a
Q850REASON value.
Command Example
To add an entry to the profile created above that maps SIP message code 402 to Q850 cause code
31:
% CONFIGURE CAUSEMAP SIP_TO_CPC PROFILE StcAtt1 SIPCAUSE 402 CPCCAUSE 31
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
To display a the mappings that comprise the SIP_TO_CPC CAUSEMAP PROFILE StcAtt1:
% SHOW CAUSEMAP SIP_TO_CPC PROFILE StcAtt1 ADMIN
Node: TPUBS Date: 2005/08/30 17:01:12 GMT
Zone: GMT
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
To display the CPC code that is generated by SIP message code 482 in the SIP_TO_CPC
CAUSEMAP PROFILE StcAtt1:
% SHOW CAUSEMAP SIP_TO_CPC PROFILE StcAtt1 SIP-CAUSE 482
Node: TPUBS Date: 2005/01/13 22:48:19 GMT
Zone: GMTMINUS05-EASTERN-US
To map the SIP CANCEL message to a REL with cause 16 (as specified by RFC3398) in the
SIP_TO_CPC CAUSEMAP PROFILE StcAtt1:
% CONFIGURE CAUSEMAP SIP_TO_CPC PROFILE StcAtt1 CANCELCAUSE 16
To map a SIP 3XX message to a call release and set the REL location to transitNetwork:
% CONFIGURE CAUSEMAP SIP_TO_CPC PROFILE StcAtt1 MSG3XXLOC transitNetwork
To add an entry to the profile created above that maps Q850 cause code 31 to SIP message code
402:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
To display a the mappings that comprise the CPC_TO_SIP CAUSEMAP PROFILE CtsAtt1:
% SHOW CAUSEMAP CPC_TO_SIP PROFILE CtsAtt1 ADMIN
Node: TPUBS Date: 2005/08/30 17:25:52 GMT
Zone: GMT
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
To display the SIP message code that is generated by CPC code 28 in the CPC_TO_SIP
CAUSEMAP PROFILE CtsAtt1:
% SHOW CAUSEMAP CPC_TO_SIP PROFILE CtsAtt1 CPC-CAUSE 28
Node: TPUBS Date: 2005/01/13 22:48:19 GMT
Zone: GMTMINUS05-EASTERN-US
To map unrecognized ISUP cause values to SIP message 500 (SERVER INTERNAL ERROR), as
specified by RFC3398, in the CPC_TO_SIP CAUSEMAP PROFILE CtsAtt1:
UNRECACTION rfc3398Procedure
The following procedure outlines the steps for a sample CAUSEMAP PROFILE:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
3. Configure the following CPCCAUSE and SIPCAUSE mapping values for this profile:
% CONFIGURE CAUSEMAP CPC_TO_SIP PROFILE cpcsipprofile1
CPCCAUSE 3 SIPCAUSE 488 Q850REASON 3
% CONFIGURE CAUSEMAP CPC_TO_SIP PROFILE cpcsipprofile1
CPCCAUSE 17 SIPCAUSE 486 Q850REASON 17
% CONFIGURE CAUSEMAP CPC_TO_SIP PROFILE cpcsipprofile1
CPCCAUSE 34 SIPCAUSE 503 Q850REASON 34
% CONFIGURE CAUSEMAP CPC_TO_SIP PROFILE cpcsipprofile1
CPCCAUSE 42 SIPCAUSE 503 Q850REASON 42
% CONFIGURE CAUSEMAP CPC_TO_SIP PROFILE cpcsipprofile1
CPCCAUSE 65 SIPCAUSE 488 Q850REASON 29
% CONFIGURE CAUSEMAP CPC_TO_SIP PROFILE cpcsipprofile1
CPCCAUSE 128 SIPCAUSE 503 Q850REASON 42
% CONFIGURE CAUSEMAP CPC_TO_SIP PROFILE cpcsipprofile1
CPCCAUSE 150 SIPCAUSE 488 Q850REASON 3
% CONFIGURE CAUSEMAP CPC_TO_SIP PROFILE cpcsipprofile1
CPCCAUSE 152 SIPCAUSE 503 Q850REASON 42
% CONFIGURE CAUSEMAP CPC_TO_SIP PROFILE cpcsipprofile1
CPCCAUSE 158 SIPCAUSE 408 Q850REASON 102
% CONFIGURE CAUSEMAP CPC_TO_SIP PROFILE cpcsipprofile1
CPCCAUSE 159 SIPCAUSE 403 Q850REASON 21
% CONFIGURE CAUSEMAP CPC_TO_SIP PROFILE cpcsipprofile1
CPCCAUSE 102 SIPCAUSE 408 Q850REASON 102
% CONFIGURE CAUSEMAP CPC_TO_SIP PROFILE cpcsipprofile1
CPCCAUSE 155 SIPCAUSE 503 Q850REASON 34
4. Associate this CAUSEMAP Profile with the appropriate IP Signaling Profile on the
PSX.
5. Associate the CAUSEMAP Profile with the appropriate SIP SERVICE group:
% CONFIGURE SIP SERVICE servicename CPCSIPPROFILEINDEX 4
6. Create a CAUSEMAP SIP-to-CPC profile:
% CREATE CAUSEMAP SIP_TO_CPC PROFILE sipcpcprofile1
INDEX index# BASEPROFILE baseprofilename
7. Configure the following CPCCAUSE and SIPCAUSE mapping values for this profile:
% CONFIGURE CAUSEMAP SIP_TO_CPC PROFILE sipcpcprofile1
SIPCAUSE 503 CPCCAUSE 34
8. Associate the CAUSEMAP Profile with the appropriate IP Signaling Profile on the
PSX.
9. Associate the CAUSEMAP Profile with the appropriate SIP SERVICE group:
% CONFIGURE SIP SERVICE servicename SIPCPCPROFILEINDEX 4
End of Procedure
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
The RTPSERVER PROFILE is a table of trusted SIP Servers maintained on the GSX. For PSTN
to SIP calls in certain environments, the receipt of a SIP response such as “18x” from the peer
directs the GSX to decide whether or not to open the media path (for early cut through). When a
SIP 18x response with SDP is received from the peer, the IP address contained in the “c” line of
the received SDP is compared against IP addresses in the DEFAULT RTPSERVER PROFILE. If a
longest match is found (Classless InterDomain Routing or CIDR based), the call is cut through.
Otherwise, the GSX does not cut through the call.
Currently, the DEFAULT RTPSERVER PROFILE, containing a single entry of 0.0.0.0/0.0.0.0 (the
default), is auto-created when the GSX software is initialized. No other RTPSERVER PROFILE
tables may be created. The default entry (0.0.0.0/0.0.0.0) will cause all peers to be trusted and the
previous GSX behavior for SIP 18x response codes will be maintained, that is the receipt of 18x
with SDP will always cause the call to be cut through. New entries to DEFAULT RTPSERVER
PROFILE will have no effect until the default entry is deleted. Then the IP addresses of valid SIP
Servers for selective early cut through (or trusted peers) can be added to and removed from this
table. The maximum number of entries that can be configured in DEFAULT RTPSERVER PROFILE
is 512.
The network mask (NETMASK) allows a range of IP addresses to be summarized with one entry.
See the relevant command example below.
Command Syntax
Command Parameters
Field
Parameter Length Description
ipaddress N/A The 32-bit IP address of a trusted SIP Server in dotted decimal
form (for example 128.127.50.224).
netmask N/A The 32-bit subnet mask in dotted decimal form (for example
255.255.255.0)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Command Example
To remove the default entry from the DEFAULT RTPSERVER PROFILE (and effectively enable
this table for selective early cut through):
To add a specific SIP Server with an IP address of 128.127.50.224 and a subnet mask of
255.255.255.255 to the DEFAULT RTPSERVER PROFILE:
% CONFIGURE RTPSERVER PROFILE DEFAULT ADD IPADDRESS 128.127.50.224 ..
NETMASK 255.255.255.255
To delete the specific SIP server that was added in the previous example:
% CONFIGURE RTPSERVER PROFILE DEFAULT DELETE IPADDRESS 128.127.50.255 ..
NETMASK 255.255.255.255
To specify a range of SIP Server hosts within the IP address 128.127.50.1 to 128.127.50.255 in
the DEFAULT RTPSERVER PROFILE:
% CONFIGURE RTPSERVER PROFILE DEFAULT ADD IPADDRESS 128.127.50.0 ..
NETMASK 255.255.255.0
To display the configuration of the DEFAULT RTPSERVER PROFILE after the default entry has
been removed and new entries have been added:
% SHOW RTPSERVER PROFILE DEFAULT ADMIN
Node: TPUBS Date: 2005/06/20 19:14:51 GMT
Zone: GMTMINUS05-EASTERN-US
Profile Name Network Address Network Mask
----------------------------------------------------------------
default 128.127.50.224 255.255.255.255
default 128.127.51.224 255.255.255.255
default 128.127.52.224 255.255.255.255
default 128.127.50.0 255.255.255.0
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
This object creates and configures a profile for implementing the Transport Layer Security (TLS)
protocol for use with SIP over TLS. TLS is an IETF protocol for securing communications across
an untrusted network. Normally, SIP packets travel in plain text over TCP or UDP connections;
Secure SIP is a security measure that uses TLS, the successor to the Secure Sockets Layer (SSL)
protocol.
To add a TLS protection-level policy, you create a TLS PROFILE and configure each of the
parameters. The TLS PROFILE named in a ZONE configuration object controls TLS behavior for
all SIP Signaling Ports in the ZONE. An instance of a TLS profile called defaultTlsProfile is
present by default, and is used by default by each ZONE; however, additional TLS profile instances
may be created and used. The settings within the defaultTlsProfile may be modified. Also,
the supported transport protocols must be set to allow SIP over TLS over TCP.
For more information on TLS, see "SIP Over Transport Layer Security Protocol" on page 6–251.
TLS session statistical and status information is available using certain SHOW SIP SIGNALING
PORT commands, for example:
For a complete list of TLS statistic and status commands, see "SIP Signaling Port" on page 3–416.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
CLIENT_CERTIFICATE_NAME clientcertname
Command Parameters
Field
Parameter Length Description
tlsprofile 1 - 23 The name assigned to this Transport Layer Security (TLS)
profile. Must be 1 - 23 characters.
highlvltimer N/A Specifies the time in which the client must complete
authentication in a higher-level protocol after the TLS connection
is established (in cases where a client does not authenticate
itself within TLS). This is used for an access scenario with server
only authentication. Must be 1 - 60 seconds; default is 5.
handshtimer N/A Specifies the time in which the TLS handshake must be
completed. The timer starts when the TCP connection is
established. Must be 1 - 60 seconds; default is 5.
resumetimer N/A Specifies the TLS session resumption period for which cached
sessions are retained (in seconds). TLS allows successive
connections to be created within one TLS session and the
resumption of a session after a TLS connection is closed or after
a server card failover, without repeating the entire authentication
and other setup steps for each connection, except when the
space must be reclaimed for a new session.
Must be 0 - 86,400 seconds; default is 3600.
ciphersuite1 N/A Specifies the first TLS cipher suite preference for this TLS profile:
• nosuite - do not use any cipher suites.
• rsa-with-null-sha
• rsa-with-aes-128-cbc-sha (default)
• rsa-with-3des-ede-cbc-sha
You can select up to three cipher suites. If you configure only one
or two cipher suites, you specify nosuite for the remaining
cipher suite preferences (CIPHER_SUITE2 and/or CIPHER_
SUITE3).
For more information on supported cipher suites listed here, see
the section, "Cipher Suites" in "SIP Over Transport Layer
Security Protocol" on page 6–251.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Field
Parameter Length Description
ciphersuite2 N/A Specifies the second TLS cipher suite preference for this TLS
profile:
• nosuite (default) - do not use any cipher suites.
• rsa-with-null-sha
• rsa-with-aes-128-cbc-sha
• rsa-with-3des-ede-cbc-sha
You can select up to three cipher suites. If you configure only one
or two cipher suites, you specify nosuite for the remaining
cipher suite preferences (CIPHER_SUITE2 and/or CIPHER_
SUITE3).
ciphersuite3 N/A Specifies the third TLS cipher suite preference for this TLS
profile:
• nosuite (default) - do not use any cipher suites.
• rsa-with-null-sha
• rsa-with-aes-128-cbc-sha
• rsa-with-3des-ede-cbc-sha
You can select up to three cipher suites. If you configure only one
or two cipher suites, you specify nosuite for the remaining
cipher suite preferences (CIPHER_SUITE2 and/or CIPHER_
SUITE3).
clientsvrrole N/A Specifies which role the GSX/NBS will act in for this TLS profile:
• server
• clientandserver
clientauth N/A Indicates whether or not a TLS client is forced to authenticate
itself within TLS. If set to false, the client is not required to
authenticate itself at the TLS layer but must complete
authentication within a higher-lever protocol after the TLS
connection is established (i.e. SIP registration):
• true
• false
Note: This parameter applies when the GSX is acting in the TLS
server role only.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Field
Parameter Length Description
servercertname N/A Specifies the name of the Server Certificate to be used by this
TLS profile, created using the SECURITY PKI configuration
object. Must be 1-23 characters or none.
For more information on creating Server Certificates, see
"Security Public Key Infrastructure (PKI) Certificates" on page 3–
38.
clientcertname N/A Specifies the name of the default Client Certificate to be used by
this TLS profile, created using the SECURITY PKI configuration
object. Must be 1-23 characters or none.
For more information on creating Client Certificates, see
"Security Public Key Infrastructure (PKI) Certificates" on page 3–
38.
Command Examples
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
When functioning as a Network Border Switch (NBS), the GSX can interoperate with Broadsoft
Application Servers when configured in the active/standby server configuration. This support is
achieved by configuring active/standby Broadsoft hosts in a GSX "local host" table. The LOCAL
NAME SERVICE object provides this functionality.
BroadWorks Application Servers are deployed in primary/secondary cluster mode. Under normal
operation, the primary Application Server handles all traffic. When there is a server or network
failure, subscribers are automatically rolled over to the secondary Application Server on the next
call (either originating or terminating) that involves a subscriber. The NBS supports routing calls
and registrations to an application server based on the cluster domain name by using an “A” record
lookup to resolve to the application server’s signaling IP address.
You create and configure Local Name Service Records on the NBS using the commands CREATE
LOCAL NAME SERVICE and CONFIGURE LOCAL NAME SERVICE. You add Record Data for the
Local Name Service Records (including Resource Record type, IP address, and priority) using the
CONFIGURE LOCAL NAME SERVICE recordname ADD TYPE .. command.
Fail-Over Functionality
In order to achieve efficient device fail over to the backup/secondary Application Server, the NBS
uses the Address Reachability Service to determine if a server is reachable, providing the ability to
“blacklist” a server IP address if it is found to be unreachable. For information on using this
service, see "Address Reachability Service (ARS) Profile" on page 3–507.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Command Parameters
Field
Parameter Length Description
recordname 1 - 23 The name assigned to this local name service record.
hostname 1 - 63 The host name assigned to this local name service record. The
HOSTNAME must be unique across all records.
order N/A Specifies the lookup ORDER of this local name service record:
• priority (default) - the lookup order is according to the
record data entries' priority assignment.
• roundrobin - the lookup order is in a circular “round robin”
fashion.
mode N/A Specifies the service mode of this local name service record:
• outofservice - all record data entries will be skipped in a
record query.
• inservice (default) - all inservice record data entries will be
returned on a record query.
type N/A Specifies the record TYPE of this local name service record:
• a (default) - A (address) record. The address record provides
the name-to-address mapping for the zone.
ipaddress N/A Specifies the 32-bit IP address of the local name service record
in dotted decimal form (for example 128.127.50.224).
index N/A Specifies the unique INDEX number assigned to the local name
service record data, and as shown in the SHOW LOCAL NAME
SERVICE command. Use this number when modifying or
deleting a local name service record data.
priority N/A Specifies the PRIORITY of the “A” records; used for maintaining
a fixed priority. Must be 0-100.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
As described in the previous section ("Local Name Service" on page 3–505), in order to achieve
efficient device failover to the backup/secondary Application Server, the NBS uses the Address
Reachability Service (ARS) to determine if a server is reachable, providing the ability to
“blacklist” a server IP address if it is found to be unreachable, as well as the ability to remove the
server from the blacklisted state. ARS profiles can be created to configure variants of blacklisting
and recovery Algorithms. These ARS profiles can be assigned to Service groups to enforce the
blacklisting and recovery of the servers in the service group.
You use the CREATE and CONFIGURE ADDRESS REACHABILITY SERVICE PROFILE
commands to create and configure the ARS profile. You use the BLACKLISTING ALGORITHM
commands to specify the type of timeout trigger, number of timeouts, and duration of the timeouts.
You use the RECOVERY ALGORITHMS (either PROBE or TIMER) commands to configure the
parameters under which it will be removed from the blacklist. Only one recovery algorithm can be
configured for a profile but not both.
After configuring and enabling the ARS profile, the following command assigns the ARS profile
to a SIP SERVICE GROUP:
CONFIGURE SIP SERVICE <sip service> ADDRESS REACHABILITY ..
SERVICE PROFILE <profile name>
To unassign a ARS profile from the SIP service group, set the ARS profile to an empty string
("").
To delete an ARS profile, use the DELETE ADDRESS REACHABILITY SERVICE PROFILE
command. You cannot delete an ARS profile unless it is no longer referenced in any SIP service
groups.
Endpoint Recovery
You can manually override the blacklisting/recovery algorithm and release a specified endpoint
from any ARS state (monitoring or blacklisted) using the ENDPOINT RECOVERY commands. To
prevent the endpoint(s) from entering any ARS state again, the ARS profile assigned to the SIP
service group associated with the endpoint should first be removed. Any change in the ARS profile
becomes effective only from the next call for the service group. Any previously monitored or
blacklisted server will continue to use the old profile data
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Command Parameters
Field
Parameter Length Description
arsprofile 1 - 23 Specifies the name assigned to this Address Reachability
Service (ARS) profile.
blacklistalg N/A Specifies the type of BLACKLISTING ALGORITHM for this ARS
profile:
• timeouts - the timeout of the specified SIP message will be
used for blacklisting the server. The algorithm TYPE, NUMBER
OF TIMEOUTS, and DURATION attributes for this parameter
must also be specified.
timeoutstype N/A Specifies the TYPE of timeout trigger for the blacklisting
TIMEOUTS algorithm:
• sip-invite - use SIP INVITE messages as a timeout
trigger.
timeouts N/A Specifies the NUMBER OF TIMEOUTS events that should occur
before blacklisting the address. Must be 1-32.
timeoutdur N/A Specifies the DURATION (in seconds) in which the specified
number of timeouts should occur. Must be 1-3600.
recoveryalg N/A Specifies the type of recovery algorithm used after an IP address
has been blacklisted:
• probe (default) - the ARS initiates an active “ping” to the
blacklisted server until it gets a response. Once a response is
received, the address is removed from the blacklist. The
METHOD, INTERVAL, NUMBER OF RESPONSES, and
DURATION attributes for the this parameter must also be
specified.
• timer - the ARS removes the entry for the blacklist after a
configured duration.
recprobemethod N/A Specifies the probe (ping) METHOD for blacklist recovery:
• sip options - use a SIP OPTIONS request.
recprobeinterv N/A Specifies the probe INTERVAL (in seconds) for blacklist
recovery. Must be 1 - 600 (default is 1).
recproberesp N/A Specifies the NUMBER OF RESPONSES that should occur before
removing the entry from the blacklist. Must be 1 - 32 (default is
1).
recprobedur N/A Specifies the DURATION (in seconds) in which the specified
number of probe responses should occur. Must be 1-3600
(default is 1).
recovtimerdur N/A Specifies the DURATION (in seconds), for which the IP address
will remain blacklisted. Must be 1-3600
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Field
Parameter Length Description
sigzone N/A Specifies the Zone ID (a non-negative integer) assigned to a
SIGNALING ZONE of the endpoint(s) being recovered. Must be 0
- 2048.
See "Zone" on page 3–511 for information on creating a ZONE
object. To display the zone names and ID assignments, use the
SHOW ZONE SUMMARY command.
ipaddr N/A Specifies the 32-bit IP address of the endpoint being recovered
in a Signaling Zone in dotted decimal form (for example
128.127.50.224).
portnum N/A Specifies the signaling port number of which endpoints are being
recovered.
adminstate N/A Specifies the administrative state of the ARS profile:
• disabled (default) - the ARS profile is not active. The ARS
profile must be disabled before making changes.
• enabled - the ARS profile is active.
shelf N/A Specifies the SHELF number when determining the STATUS of
endpoints in a signaling zone. Must be 1.
slot N/A Specifies the SLOT number of the when determining the
STATUS of endpoints in a signaling zone. Must be 3-16.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Zone
A ZONE is used to group a set of objects unique in a particular customer environment. For
example, a set of SIP and/or H.323 signaling ports and service groups can be assigned to the same
zone. A zone can also be used for a Direct Media application, allowing the NBS to set up calls
between two endpoints so that media can be exchanged directly. A MEDIA ZONE is specified in the
SIP SERVICE group. A zone can be used as a signaling zone only, a media zone only, or both. For
more information on Direct Media, see "Direct Media" on page 3–439.
You can optionally specify a ZONE IDENTIFIER when creating a ZONE object, which can be
changed at a later time. If a zone ID is not specified when creating the ZONE object on the GSX, an
ID is automatically assigned, starting with an ID value of 1. A default zone (INTERNAL) is
automatically generated with a fixed ID of 0. This zone can never be changed or deleted. All SIP
and H.323 signaling ports and service groups of a non-NBS GSX operate in this zone.
After configuring a ZONE and IDENTIFIER, you assign SIP or H.323 Signaling Ports to the zone
using the SIGNALING ZONE parameter in each configuration object. You can use the same zone in
both types of signaling ports (see "SIP Signaling Port" on page 3–416 and "H323 Signaling Port"
on page 3–399).
A zone can also be referenced by a SIP or H.323 Service Group (using the optional SIGNALING
ZONE parameter). See "SIP Service" on page 3–437 or "H323 Service" on page 3–408 for more
information.
In an NBS overlap address environment in which calls from the trusted network to SIP servers and
H.323 gateways in the untrusted network are routed via IP address rather than trunk group name
during source gateway routing, IP addresses may not be unique, and may cause the NBS to select
an incorrect egress trunk group.
Deleting a Zone
You delete a zone using the DELETE ZONE <zonename> command. You must de-reference all
objects (SIP/H323 signaling ports and service groups) assigned to a zone before deleting a zone.
To eliminate potential ambiguities when routing on the PSX using virtual trunk groups, the Zone
Index Profile of the PSX Manager allows you to provision universal signaling zones in which SIP
servers and H.323 gateways can reside and retain unique IP addresses. With this, the zone ID of
the SIP server or H.323 gateway is returned in each route during a policy request. With a matching
zone ID configured, the GSX is able to lookup the correct egress virtual trunk group in the zone. If
a Zone Index Profile is not provisioned on the PSX for a SIP server or H.323 gateway, the GSX
will assume the default zone ID of 0 (INTERNAL).
For an example of how a ZONE is used in SIP signaling, see the NBS Provisioning Guide.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Gateway-to-Gateway Signaling
Command Syntax
Command Parameters
Field
Parameter Length Description
zonename 1-23 Specifies the name of the zone. Must be 1-23 characters.
zoneid N/A Specifies the unique non-negative integer ID for this ZONE. Must
be 0-2048. If an ID is not configured, the GSX automatically
assigns a sequential value, starting with “1.”
timeout N/A The maximum time (in seconds) allowed for the GSX to
establish an outbound TCP connection. Range 0-180 seconds,
default = 5 seconds. This value should be kept small because
timely detection of failure to establish a connection allows the
GSX to proceed with its overall retry strategy.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Gateway-to-Gateway Signaling CLI Reference
Field
Parameter Length Description
transprotocol N/A Specify the allowed transport protocol(s) for the SIP signaling
zone as follows:
• sip-udp (default) - SIP over UDP
• sip-tcp - SIP over TCP
• sip-tls-tcp - SIP over TLS/TCP. Port = configured UDP/
TCP port number + 1.
You can select more than one of the protocols by using the "|"
between selections.
tlsprofile 1-23 Specifies the name of the Transport Layer Security (TLS) profile
when sip-tls-tcp is specified as the transport protocol
(TRANSPORT_ PROTOCOLS. The TLS Profile (see "Transport
Layer Security Profile" on page 3–500) controls the TLS
behavior of the SIP signaling ports for this zone. By default, this
is defaultTlsProfile. Must be 1-23 characters.
Command Example
ID Zone Name
----- --------------------
0 INTERNAL
1 INTERNAL_1
2 INTERNAL_2
3 EXTERNAL_1
4 EXTERNAL_2
5 EXTERNAL_3
6 EXTERNAL_4
-----------------------------------------------------
Zone Name: INTERNAL
-----------------------------------------------------
Zone ID: 0
TCP Connect Timeout: 5
Transport Protocols: SIP-UDP
TLS Profile Name: defaultTlsProfile
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference DNS Server
DNS Server
This object creates and configures a DNS Server, a DNS Client capable of communicating with
external DNS servers to resolve domain names.
A maximum of eight (8) DNS servers can be created. The DNS Client sends the query to the server
with highest priority (lower value) first, and in case of a timeout, the query is resent to the server
with the next highest priority. For servers with the same priority, the selection is distributed based
on the weight value. Priority and weight values are configurable. You can also configure recursion
preference (recursion involves assistance from other DNS servers to help resolve the query).
To configure the PRIORITY, WEIGHT, and RECURSION preference, use the commands:
% CONFIGURE DNS SERVER dnsserver PRIORITY priority
% CONFIGURE DNS SERVER dnsserver WEIGHT weight
% CONFIGURE DNS SERVER dnsserver RECURSION DESIRED <yes | no>
To configure retransmission counts and timers, and iteration counts for all DNS servers, use the
GLOBAL PARAMETERS commands:
Server Statistics
To display the statistics for all DNS servers, use the following command. Servers that have not
been queried are not displayed.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
DNS Server CLI Reference
Local Cache
The DNS Local Cache can store up to 2K of records on the MNS10 and 4K of records on the
MNS20 and up to a maximum of four record entries for a given domain name and type (including
locally configured records). The following record types can be saved:
• A (Address)
• SRV (Location of Services)
• NS (Name Server)
• NAPTR (Naming Authority Pointer) records.
To search and display a summary of records in the local DNS cache, use the following command.
An asterisk (*) is shown against records created using Local Name Service. The domain name can
be truncated.
To display the record details, use the following command. The TTL value displayed shows the
remaining time for the record. Records created using the Local Name Service can also be
displayed using this command. The TTL value for those records will be 0.
To purge all Record Data associated with the domain name and query type, use the following
command. Records created using Local Name Service will not be deleted using this command.
% CONFIGURE DNS ENTRY DOMAIN domainname TYPE type DELETE
To fully support RFC 3263 (SIP: Locating SIP Servers), the GSX uses various DNS procedures to
resolve a SIP Uniform Resource Identifier (URI) into the IP address, port, and transport protocol
of the next hop to contact. Note that the GSX does not use DNS procedures for sending SIP
responses.
When a SIP endpoint (like a UAC, for example) needs to send a request to a resource identified by
a SIP or Secure SIP (SIPS) URI, it needs to resolve that URI into the IP address, port, and transport
protocol. This URI can identify the desired resource to which the request is targeted (in which
case, the URI is found in the Request-URI), or it can identify an intermediate hop towards that
resource (in which case, the URI is found in the Route header).
For a SIP call where the transport is not known, or cannot be derived from the URI, the SIP
endpoint should perform a Naming Authority Pointer (NAPTR) query for the domain name in the
URI. Once the transport protocol is found from the records returned by the NAPTR query, the
client can then use Location of Services (SRV) query on the protocol to target host FQDN and port
number. Finally, the client can then perform an Address (A) record query to resolve the domain
names returned by the SRV query to obtain the IP address of the server.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference DNS Server
To configure the type of DNS support for a specified SIP Service group -- either Address record
queries only (A-ONLY), or A, SRV, and NAPTR queries (A-SRV-NAPTR) -- use the command:
% CONFIGURE SIP SERVICE sipservicegrp DNS SUPPORT type
Query type A-ONLY is the default value. See "SIP Service" on page 3–437 for instructions on
configuring SIP Service groups.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
DNS Server CLI Reference
Command Parameters
Field
Parameter Length Description
dnsserver 1-32 Specifies the name of this DNS Server Entry. Must be 1-23
characters.
ipaddress N/A Specifies the 32-bit IP address of the DNS Server in dotted
decimal form (for example 128.127.50.224).
domainname 1-120 Specifies the domain name of the DNS Entry Record. Must be 1-
120 characters.
type N/A Specifies the type of DNS entry record query:
• a - address query.
• ns - name server query.
• srv - location of services query.
• naptr - naming authority pointer query.
priority N/A Specifies the DNS record data priority. Must be 0-100; default is
0.
weight N/A Specifies the DNS service record data weight. Must be 0-100,
default is 0.
recursion N/A Specifies whether recursion is desired for the DNS Server:
• no (default)
• yes
state N/A Specifies the Administrative state of DNS Server configuration:
• enabled
• disabled (default)
retranscount N/A Specifies the global retransmission count limit for DNS iterations
of server requests. Must be 0-10, default is 2.
retranstimer N/A Specifies the global retransmission timer value for DNS iterations
of server requests. Must be 100 to 10000; default is 500.
itercount N/A Specifies the global iteration count limit for DNS iterations of
server requests. Must be 0-32; default is 8.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference DNS Server
Command Examples
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
DNS Server CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Accounting
Accounting
Accounting is a particular type of event logging. The sections below explain the CLI commands
that initiate and monitor call accounting. See "Call Accounting" on page 7–1 for a detailed
discussion of this GSX facility.
Accounting
This object allows you to create, configure and capture call accounting information. When using
NFS (DSI Level 0)-based event logging, this information is stored in the system event logs in the /
ACT subdirectory of the GSX system tree (see Figure 6–15 on page 6–91, "GSX System Tree").
When using stream-based logging to the DSI, the files are stored on the Log Server in the /dsi/
dirData/<gsxnode> directory.
Additional detail about statistics that are displayed by SHOW ACCOUNTING .. commands is
contained in Table 3–119, "Accounting Statistics" below.
Selectable CDRs
When using Stream-based logging to the DSI (instead of NFS/DSI Level 0-based logging), the
selectable CDR feature allows you to select only the CDR fields necessary to your application and
deployment. Each field is assigned a unique identifying number. The field numbers for each CDR
field are listed in Table 7–3 in the "Accounting Records Summary" on page 7–9. The
provisioning for the Selectable CDR feature is provided on the DSI Stream Server.The GSX only
generates CDR records selected by the configuration data defined at the DSI Stream Server. For
more information on using the Selectable CDR feature, see the Sonus DSI Administration and
Maintenance Guide.
To display which CDR fields you have selected for each record type, (START, STOP, ATTEMPT,
and INTERMEDIATE) use the SHOW ACCOUNTING SELECTABLE CDR POPULATION ..
commands. These show commands list CDR record type, field number, and whether that field
number is selected or deselected.
Statistic Description
Total Call This is the total number of Call Attempts made on this GSX since the last reboot,
Attempts MNS switchover, or GNS switchover. This includes Call Attempts from PSTN as
well as IP side. This includes Call Attempt Completions as well as Failures.
Total Call This is the total number of call attempts made on this GSX since the last reboot,
Attempt MNS switchover, or GNS switchover, which did not reach the completion state
Failures
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting CLI Reference
Statistic Description
Total Call This is the total number of call attempts made on this GSX since the last reboot,
Completions MNS switchover, or GNS switchover, which reached the completion state.
Otherwise stated, these are calls that were answered (by detecting an ANM or
CONNECT message).
Total Call This is the total number of call attempts made on this GSX since the last reboot,
Attempts MNS switchover, or GNS switchover, which received Blocking/Screening
Blocked or Treatment by the PSX, and hence were released by the GSX. Typically there
Screened would have been an announcement or tone played to the calling party before the
call was released by the GSX.
Call Attempt This is the current call arrival rate into the GSX, in calls/sec. It is computed every
Rate in Calls/ minute. This statistic is always:
sec in Last
(Number of Call Attempts in Last One Minute)/ 60
One Minute
Busy Hour This is identical to Total Call Attempts for the first hour of operation following a
Call Attempt reboot, MNS switchover, or GNS switchover.
Rate
Thereafter, this statistic is a weighted average calculation aimed at providing the
number of call attempts made in the last one hour. It is computed every one
minute, counting the calls in the last minute and applying the old Busy Hour Call
Attempt Rate (BHCA) as follows:
New BHCA = [Old BHCA * 0.9)] + [(Number Of Calls In Last One Minute) * 6]
This effectively gives the previous BHCA a 90 % weight, and the BHCA over the
last one minute a 10% weight.
Average Call This is the Average Service Time, or the time from when a call is answered until
Duration in it is released. Also known as “talk time”.
seconds
This is an average that uses all calls established since the last reboot, MNS
switchover, or GNS switchover.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Accounting
Command Syntax
NOTE
The following RESET command restores the default values of all ACCOUNTING
parameters.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting CLI Reference
Command Parameters
Field
Parameter Length Description
generate N/A The type of calls for which accounting records should be logged
on this GSX:
• origination (default) - Log accounting records for which
this GSX is the originating gateway.
• destination - Log accounting records for which this GSX is
the destination gateway.
• allcalls - Log accounting records for all calls.
• none - Log no accounting records.
For SIP and H323 calls, accounting records are generated for all
calls (ingress and egress), unless this value is none.
admin-state N/A The administrative state of accounting logging:
• disabled (default) - not activated.
• enabled - activated.
interval N/A The time (in seconds) for generating intermediate call records in
MODE interval. Must be 5-86400, default is 60. Not
meaningful unless admin-state is enabled.
ssinherfirst N/A Specifies whether the second stage accounting record of a two-
stage call will inherit specific field values from the first stage of
the call:
• true - fields are inherited from the first stage fields
• false (default) - fields are not inherited from the first stage
fields
See "Final ATTEMPT Indicator Field" on page 7–150 for a list of
fields that may be inherited, subject to this parameter.
popnplnpnum N/A Specifies whether an LNP lookup that returned the same
number as the number that was searched on (or a non-ported
LNP number) should cause that number to be placed into the
associated accounting record fields:
• true (default) - Place the non-ported LNP number into the
associated accounting record fields.
• false - Do not place the non-ported LNP number into the
associated accounting record fields and instead place a null
field (“”) into the record.
See "Called Number Before Translation #1 Field" on page 7–51
and "Called Number Before Translation #2 Field" on page 7–52
for detail about the associated accounting record fields.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Accounting
Field
Parameter Length Description
mode N/A Specifies the method by which intermediate records are
generated:
• interval (default) - Generate an intermediate record each
INTERVAL seconds throughout the call.
• telcordia - Generate an intermediate record whenever the
call exceeds 24 hours and the GENERATION TIME (of day) is
reached.
logfileformat N/A Specifies the accounting file format in which to write all
subsequent accounting records:
• DEFAULT (default) - use the standard Release 6.00 format,
designated by Version Number “26” in the accounting log file
header.
• PATCHRELEASE - The accounting file format for the latest
Patch Release to Release 6.00.
When this action causes a change to the existing accounting file
format, you will be warned of the consequences and prompted to
continue. Upon continuing, the old accounting file will be
immediately closed. The new accounting file will not be opened
until a recordable call event occurs, causing a START, STOP,
ATTEMPT, or INTERMEDIATE accounting record to be
generated. See "Accounting Files" on page 7–2 for more detail
about accounting file naming conventions.
tod 1-10 Specifies the time of day at which to generate an intermediate
record in MODE telcordia. The record is generated when this
time of day is reached and the call has also been active for over
24 hours. This text string must be in the format hh:mm:ss.s. This
must be GMT time, not local time.
Not meaningful unless admin-state is enabled.
trap-state N/A Specifies whether or not to generate a system trap whenever an
INTERMEDIATE record is written:
• disabled (default) - Do not generate a system trap when an
INTERMEDIATE record is written.
• enabled - Generate a trap that contains global call ID,
ingress and egress trunk types, ingress and egress circuit end
points, calling party number, and called party number when
an INTERMEDIATE record is written.
start-state N/A Specifies whether or not to log START records:
• disabled - Do not log accounting START records.
• enabled (default) - Log accounting START records.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting CLI Reference
Field
Parameter Length Description
gw-info-state N/A Specifies whether or not to correlate specific fields in the STOP
and ATTEMPT accounting records on GSX-GSX calls. The
correlation is between the ingress (originating) GSX and the
egress (destination) GSX. When this correlation is enabled, a
positive Remote GSX Billing Indicator is logged. See "Remote
GSX Billing Indicator Field" on page 7–151.
• disabled (default) - Leave the Remote GSX Billing
Indicator field empty and do not propagate billing information
from the destination GSX to the originating GSX.
• enabled - Populate the Remote GSX Billing Indicator field
with (boolean) 0 or 1 and propagate billing information from
the destination GSX to the originating GSX for GSX-GSX
calls, as described in "Remote GSX Billing Indicator Field" on
page 7–151.
If this parameter is disabled on the originating GSX, then billing
information will not be propagated from the destination GSX to
the originating GSX on GSX-GSX calls.
e_attempt_state N/A Specifies whether or not to generate early ATTEMPT records.
An early ATTEMPT record is associated with an early call
disconnect, before the policy request is sent.
• disabled (default) - Do not generate early ATTEMPT
records.
• enabled - Generate early ATTEMPT records.
recordtype N/A Specifies the CDR record type fields selected when using the
Selectable CDR feature for Streaming Logging to the DSI:
• start - shows the selected START record CDR fields.
• stop - shows the selected STOP record CDR fields.
• attempt - shows the selected ATTEMPT record CDR fields.
• intermediate - shows the selected INTERMEDIATE record
CDR fields.
Note: This parameter/functionality is not available on the
GSX9000.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Accounting
Command Example
To direct the capture of intermediate accounting records, using interval mode, at 15 second
intervals:
% CONFIGURE ACCOUNTING GENERATE origination
% CONFIGURE ACCOUNTING INTERMEDIATE RECORDS MODE interval
% CONFIGURE ACCOUNTING INTERMEDIATE RECORDS STATE enabled
% CONFIGURE ACCOUNTING INTERMEDIATE RECORDS INTERVAL 15
To direct the capture of intermediate accounting records, using telcordia mode, at 24 hour intervals
at 3:30PM:
% CONFIGURE ACCOUNTING GENERATE origination
% CONFIGURE ACCOUNTING INTERMEDIATE RECORDS MODE telcordia
% CONFIGURE ACCOUNTING INTERMEDIATE RECORDS STATE enabled
% CONFIGURE ACCOUNTING INTERMEDIATE RECORDS TELCORDIA LONG ..
DURATION GENERATION TIME 15:30:00.0
NOTE
In general, the intermediate record will be written more than 24 hours after the call
begins. For example, if the call begins at noon, at the first occurrence of 3:30PM,
the call would not yet have been active for 24 hours so the intermediate record
would not be written. At 3:30PM on the next day, the first intermediate record
would be written.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting CLI Reference
------------------------------------------------------
Accounting Summary Statistics
------------------------------------------------------
Total Number of Call Attempts: 299460
Total Number of Call Completions: 296593
Total Number of Call Attempt Failures: 2867
Total Number of Call Attempt Blocked/Screened: 0
Busy Hour Call Attempt Rate: 23841
Call Attempt Rate in Calls/sec in Last One Minute: 13
Average Call Duration in seconds : 24
--------------------------------------------------------
Accounting Configuration
--------------------------------------------------------
Accounting LogTo: EVENTLOG
Accounting Generate: ALLCALLS
Accounting 2nd Stage Records Inherit 1st Stage: FALSE
Accounting Populate Non-Ported LNP Lookups: TRUE
Accounting Start Acct State: ENABLED
Accounting Intermediate Trap State: DISABLED
Accounting Populate Remote GSX Info State: DISABLED
Accounting Intermediate Acct State: DISABLED
Accounting Intermediate Acct Mode: INTERVAL
Accounting Intermediate Acct Interval (in seconds): 15
Accounting Telcordia Long Duration Record Gen Time: 00:00:00.0 GMT
Accounting Log File Format: DEFAULT
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Accounting
To force a new accounting file, and file format, that is (hypothetically) associated with a Release
V06.00 Patch Release (such as Release V06.00.03):
% CONFIGURE ACCOUNTING LOG FILE FORMAT PATCHRELEASE
This command will roll the accounting file and modify its format. -
Confirm (y/n): y
NOTE
The warning/prompt message shown above will always accompany this command.
To display which CDR fields you have selected for each record type, (START, STOP, ATTEMPT,
INTERMEDIATE, REBOOT, and SWITCHOVER).
START STOP
RECORD RECORD
--------------------------------------------------------------------
1 SELECTED 1 SELECTED
2 SELECTED 2 SELECTED
3 SELECTED 3 SELECTED
4 SELECTED 4 SELECTED
5 SELECTED 5 SELECTED
6 SELECTED 6 SELECTED
..
162 SELECTED 162 SELECTED
163 SELECTED 163 SELECTED
ATTEMPT INTERMEDIATE
RECORD RECORD
------------------------------------------------------------------------
1 SELECTED 1 DESELECTED
2 SELECTED 2 DESELECTED
3 SELECTED 3 DESELECTED
4 SELECTED 4 DESELECTED
5 SELECTED 5 DESELECTED
6 SELECTED 6 DESELECTED
7 SELECTED 7 DESELECTED
..
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting CLI Reference
This object designates the local time zone for the GSX you are configuring.
Command Syntax
Command Parameter
localtzone is the time zone in which the GSX is located. Valid values are:
• gmtMinus12-Eniuetok
• gmtMinus11-MidwayIsland
• gmtMinus10-Hawaii
• gmtMinus09-Alaska
• gmtMinus08-Pacific-US
• gmtMinus07-Arizona
• gmtMinus07-Mountain
• gmtMinus06-Central-US
• gmtMinus06-Mexico
• gmtMinus06-Saskatchewan
• gmtMinus05-Bogota
• gmtMinus05-Eastern-US
• gmtMinus05-Indiana
• gmtMinus04-Atlantic-Canada
• gmtMinus04-Caracas
• gmtMinus03-BuenosAires
• gmtMinus02-MidAtlantic
• gmtMinus01-Azores
• gmt
• gmtPlus01-Berlin
• gmtPlus02-Athens
• gmtPlus03-Moscow
• gmtPlus0330-Tehran
• gmtPlus04-AbuDhabi
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Accounting
• gmtPlus0430-Kabul
• gmtPlus05-Islamabad
• gmtPlus0530-NewDelhi
• gmtPlus06-Dhaka
• gmtPlus07-Bangkok
• gmtPlus08-Beijing
• gmtPlus09-Tokyo
• gmtPlus0930-Adelaide
• gmtPlus10-Guam
• gmtPlus11-Magadan
• gmtPlus12-Fiji
• gmtMinus08-Alaska-DST
• gmtMinus07-Pacific-US-DST
• gmtMinus06-Mountain-DST
• gmtMinus05-Central-US-DST
• gmtMinus04-Eastern-US-DST
• gmtMinus03-Atlantic-Canada-DST
NOTE
Time zone values ending in “-DST” (Daylight Saving Time) are not typically used in
GSX provisioning as these are non-standard time zone values. Any consumer of
GSX CAM data should resolve time points based on the local time zone value
recorded in the CAM record in conjunction with adjustment as necessary for DST
rules during appropriate time periods. It is also noted for clarity that the
provisioned time zone value within GSX is a static configuration. Thus, assuming
GSX is provisioned with a standard time zone value, the CAM data that GSX
records will not be dynamically adjusted to reflect a "-DST" variant time of that
same time zone during the time of year when DST rules are in effect. Provisioning
of GSX with "-DST" variant time zone values should be undertaken with caution.
Please consult your Customer Support representative should you have any
additional questions.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting CLI Reference
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Trunk Groups
Trunk Groups
Carrier
This object specifies a carrier. The carrier name is a parameter for trunk group profiles and trunk
groups.
Command Syntax
Command Parameters
Field
Parameter Length Description
carriername 1-23 The name of the carrier that is being configured by this object.
carriercode 1-4 A code to be associated with this carrier. May be up to four
numeric digits.
networktype N/A The type of network identification for this carrier code:
• ccitt
• national (default)
• other
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Trunk Groups CLI Reference
Field
Parameter Length Description
networkplan N/A The network identification plan for this carrier code:
• C-UNKNOWN
• C-PUBLIC_DATA_NETWORK
• C-LAND_MOBILE_NETWORK
• C-RESERVED1
• C-RESERVED2
• N-UNKNOWN2
• N-3_DIGIT_CARRIERCODE
• N-4_DIGIT_CARRIERCODE (default)
• N-RESERVED1
• N-RESERVED2
admin-state N/A The administrative state of this carrier:
• disabled (default) - Not active.
• enabled - Active.
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Trunk Groups
This object creates a template for the trunk group object (below). Trunk groups that are configured
with a profile will silently take every parameter value specified in the profile unless explicitly
overridden.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Trunk Groups CLI Reference
Command Parameters
Field
Parameter Length Description
profilename 1-23 The name of the profile that can be applied to a trunk group object.
selection N/A The method of hunting through service groups for trunk groups:
• leastcost (default) - Examine the least cost service group
first, then the next least, and so on. Once the service group has
been selected, the hunting algorithm configured for that service
group will be applied. The service group with the least cost will
be filled up before sending calls to service groups with higher
costs.
• configured - Hunt in the order specified in the configuration
for each individual service that is contained in the trunk group.
Calls will be assigned to the least busy service first. Once the
service is selected, the hunt algorithm for that service group will
be applied. Service group cost is irrelevant when using this
value.
• circularforward - All resources are placed into a circular
queue and each successive call is assigned to the next
channel, moving from lowest position shelf/slot/port/channel to
the highest position. Using this value at this level overrides the
hunt method specified at the service group level.
• circularbackward - All resources are placed into a circular
queue and each successive call is assigned to the next
channel, moving backwards from the highest position shelf/slot/
port/channel to the lowest position. Using this value at this level
overrides the hunt method specified at the service group level.
reserved N/A The percent of channels reserved for inbound calls in PSTN trunk
groups. Must be 0-100, in increments of 5. Default is 0.
This parameter is overridden if CIRCUIT RESERVATION STATE is
enabled, see "Trunk Group" on page 3–538.
carrier 1-23 The name of the carrier that is assigned to this trunk group.
ss7nodename 1-23 The name of the SS7 node that provides SS7 signaling for this
trunk group.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Trunk Groups
Field
Parameter Length Description
sfg-type N/A The type of Simulated Facility Group (SFG) used by this trunk
group:
• none (default) - No SFG of any type will be used by this trunk
group.
• ni2 - The SFG(s) used by this trunk group will be provided with
default facility coding values according to National ISDN 2.
• dms - The SFG(s) used by this trunk group will be provided with
default facility coding values according to Nortel NIS-A211-1.
• user - One SFG may be created for this trunk group. The
underlying service type of that SFG will be user, to
accommodate calls that act as the user side of the user-network
interface.
silcstate N/A The administrative state of Selective Incoming Load Control
(SILC), a control that cancels specified percentages of incoming
calls for machine congestion levels MC1 and MC2:
• enabled - SILC control is active
• disabled (default) - SILC control is not in effect
l1calls N/A Specifies the percentage of ingress calls that are permitted on this
trunk group when SILC STATE is enabled and the congestion
level is MC1. Must be 0-100, default is 75.
l2calls N/A Specifies the percentage of ingress calls that are permitted on this
trunk group when SILC STATE is enabled and the congestion
level is MC2. Must be 0-100, default is 25.
admin-state N/A The administrative state of this trunk group profile:
• disabled (default) - Not active.
• enabled - Active.
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Trunk Groups CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Trunk Groups
Trunk Group
This object allows you to associate service groups with trunk groups between switching systems.
Trunk group TYPEs are PSTN or IP. PSTN trunks are unchanged from previous trunk groups. IP
trunk groups are of TYPE ipSelected or ipLinked. IpSelected (or child) trunk groups are able
to process calls. IpLinked (or parent) trunk groups are used to form IP trunk group hierarchies,
made up of both types of IP trunk groups.
An IP trunk group defines a group of one or more IP signaling peers. The IP NETWORK SELECTOR
TABLE parameter within a trunk group defines the subnet used by these IP signaling peers.
An IP trunk group hierarchy may be defined by associating PARENT IP TRUNK GROUPs with
selected (child) or other linked (parent) trunk groups. In these arrangements, all parent and child
trunk groups in the hierarchy must be in service to complete a call that uses any member of the
hierarchy. This structuring may be used to allow parent trunk groups to manage call and IP
bandwidth resources, while allowing the child trunk group to manage DSP resources.
The MASTER TRUNK GROUP provides a similar mechanism for hierarchically organizing trunk
group. The MASTER TRUNK GROUP, however, may supply call and bandwidth resources to "slave"
trunk groups on multiple GSXs (whereas parent and child trunk groups must reside on the same
GSX). This mechanism may be used to provide a uniform view of a Point of Presence (POP) near
end resources to far end switches.
IP trunk groups also offer traffic controls and Packet Outage Detection controls.
The SHOW TRUNK GROUP DIRECTION ALL STATUS command does not include IP trunk groups in
its display. This is because the DIRECTION parameter is more granular and therefore more
meaningful for PSTN trunk groups than IP trunk groups. Each PSTN trunk group has physical
channels (DS0s) that are individually dedicated as incoming, outgoing, or both ways. An IP trunk
group however is globally dedicated as incoming, outgoing, or both ways. There are no
corresponding sub-channels, assigned some to one direction and some to another. Therefore, the
DIRECTION statistics are not meaningful to IP trunk groups as they are to PSTN trunk groups. For
this reason, IP trunk groups are excluded from the SHOW .. DIRECTION .. STATUS command.
Use SHOW TRUNK GROUP STATUS to display IP trunk group inbound and outbound call statistics.
These commands are shown in the command examples that follow this section.
The POLICER MAX CALL and POLICER MAX REGISTRATION objects provide IP trunk group
policing on SIP calls and registrations. The “single token bucket” paradigm is used by these
policers. See "IP Traffic Policing" on page 3–230 for a description of this mechanism.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Trunk Groups CLI Reference
The HIGH PROBABILITY OF COMPLETION (HPC) objects provide a method for linking an HPC
trunk group profile to a trunk group. Configuration of HPC parameters is acheived using the HIGH
PROBABILITY OF COMPLETION SHELF (seepage 3–122) and the HIGH PROBABILITY OF
COMPLETION TRUNK GROUP PROFILE (see page 3–126) objects. See "High Probability of
Completion (HPC) Features" on page 6–237 for more information on this capability.
• enabled
• disabled
• inservice
• outofservice
TABLE 3–123
From
(operational
state) Changing to (operational state)
inservice outofservice
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Trunk Groups
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Trunk Groups CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Trunk Groups
NOTE
See "TRUNK MEMBER" on page 3–851 for additional detail on this object.
Command Parameters
The parameter values described below may be changed without taking the underlying trunk group
out of service and disabling it, except where explicitly noted otherwise.
Field
Parameter Length Description
tgname 1-23 The name of the trunk group being configured. You must
observe the following restrictions:
• To avoid a conflict with PSX trunk group naming conventions,
do not use a period (“.”) in this name.
• To avoid a conflict with Sonus Circuit Test Packages, do not
use the string “SENDTL” (case insensitive) at the beginning of
this name.
profilename 1-23 The name of the trunk group profile to apply to this trunk group.
Any unspecified trunk group parameters will inherit their values
from this profile, when the profile is applied via the CONFIGURE
command. Subsequent configuration changes made to the
underlying profile will not impact the trunk group unless the
profile is reapplied.
The trunk group must be disabled to change this parameter
value.
SS7nodename 1-23 The name of the SS7 node that provides SS7 signaling for this
trunk group.
The trunk group must be disabled to change this parameter
value.
tg-type N/A Specifies the type of trunk group being created:
• pstn (default) - CAS, ISUP, or ISDN.
• ipSelected - A child IP trunk.
• ipLinked - A parent IP trunk.
carrier 1-23 The name of the carrier that supports this trunk group.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Trunk Groups CLI Reference
Field
Parameter Length Description
selection N/A The method of hunting through service groups for trunk
resources:
• leastcost (default) - examine the least cost service group
first, then the next least etc.
• configured - examine service groups in the order that they
were configured.
• circularforward - the search for an available resource
proceeds through all service groups in the order that they
registered to the trunk group. This selection overrides the
hunt method for the service group.
• circularbackward - the search for an available resource
proceeds through all service groups in the opposite (reverse)
order that they registered to the trunk group. This selection
overrides the hunt method for the service group.
The trunk group must be disabled to change this parameter
value.
newtgname 1-23 The new name of the trunk group. When an inService trunk
group is renamed, the tgname string is saved in ALTERNATE
NAME and this string replaces tgname. Either name may then be
used to access this trunk group. The new trunk group name
remains in effect indefinitely. The old trunk group name remains
in effect until the number of seconds specified in RENAME TIMER
expire.
renametimer N/A The amount of time in seconds that the previous trunk group
name, saved in ALTERNATE NAME, will be accepted when a trunk
group is renamed. During this time, the previous trunk group
name cannot be used for the name of another trunk group. Must
be 0-3600 (seconds), default is 10.
If you set this value to 0, then the previous trunk group name
remains in effect indefinitely, along with the new trunk group
name.
The old trunk group name remains in effect until the number of
seconds specified in RENAME TIMER expire or until applying the
ALTERNATE NAME NONE object, setting the alternate trunk group
name to none.
reserved N/A The percent of channels reserved for inbound calls in PSTN
trunk groups. Must be 0-100, in increments of 5. Default is 0.
This parameter is overridden by INCOMING CALL if CIRCUIT
RESERVATION STATE is enabled.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Trunk Groups
Field
Parameter Length Description
crstate N/A The state of the circuit reservation feature:
• disabled (default)
• enabled
Circuit reservation is in effect on this trunk group when this
parameter is enabled and the PRIORITY CALL, INCOMING
CALL, and OUTGOING CALL parameters (below) specify the
allocation of priority, incoming, and outgoing calls.
priority N/A The minimum number of priority call circuits to be reserved for
this trunk group. Must be 0-100, default is 1.
This value is ignored if crstate is disabled.
incoming N/A The minimum number of incoming call circuits to be reserved for
this trunk group. Must be 0-128, default is 1.
This value is ignored if crstate is disabled.
sfg-type N/A The type of Simulated Facility Group (SFG) used by this trunk
group:
• none (default) - No SFG of any type will be used by this trunk
group.
• ni2 - The SFG(s) used by this trunk group will be provided
with default facility coding values according to National ISDN
2.
• dms - The SFG(s) used by this trunk group will be provided
with default facility coding values according to Nortel NIS-
A211-1.
• user - One SFG may be created for this trunk group. The
underlying service type of that SFG will be user, to
accommodate calls that act as the user side of the user-
network interface.
outgoing N/A The minimum percentage of outgoing call circuits to be reserved
for this trunk group. This percentage is applied to the total
number of circuits less the circuits reserved for incoming calls
less the circuits reserved for priority calls. Must be 0-100, default
is 10%.
For example, if the trunk group consists of 100 circuits, with 20
reserved for incoming and 10 reserved for priority, then a value
of 10% would be applied to (100-20-10) or 70 and 7 total circuits
would be reserved for outgoing calls.
This value is ignored if crstate is disabled.
oper-state N/A The operational state of the trunk group:
• outofservice - The trunk group is prevented from carrying
new calls, and may enter the disabled administrative state.
• inservice (default) - The trunk group can carry new calls.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Trunk Groups CLI Reference
Field
Parameter Length Description
admin-state N/A The administrative state of this trunk group:
• disabled (default) - Not activated, able to be deleted.
• enabled - Activated, available for immediate use.
action N/A The method by which active calls on this trunk group are
processed when oper-state goes to outofservice:
• dryup (default) - all calls are allowed to complete until
TIMEOUT expires.
• force - all calls are dropped immediately.
timeout N/A The time (in minutes) to wait to place the trunk group in the
outofservice operational state. Must be 0-1440, default is 5.
A value of 0 causes the change immediately.
tmember-no N/A A number that uniquely identifies this circuit endpoint within the
trunk group. The GSX software maintains a list of available trunk
member numbers for every trunk group. Must be 0-65535.
number 4 Specifies a unique number that may be assigned to the trunk
group by the customer and used for circuit validation testing
purposes. Default value is “0000”.
silcstate N/A The administrative state of Selective Incoming Load Control
(SILC), a control that cancels specified percentages of incoming
calls for machine congestion levels MC1 and MC2:
• enabled - SILC control is active
• disabled (default) - SILC control is not in effect
l1calls N/A Specifies the percentage of ingress calls that are permitted on
this trunk group when SILC STATE is enabled and the
congestion level is MC1. Must be 0-100, default is 75.
l2calls N/A Specifies the percentage of ingress calls that are permitted on
this trunk group when SILC STATE is enabled and the
congestion level is MC2. Must be 0-100, default is 25.
piptgroup 1-23 Specifies the parent IP trunk group.
Used to build a hierarchy of IP trunk group relationships.
ipclimit N/A Maximum number of calls allowed for an IP trunk group. Must be
UNLIMITED or 0-2147483647 as follows:
• UNLIMITED - do not enforce any limit
• 0 - do not allow any calls
• non-zero - allow up to the specified number of calls
Default is -1, or no limit on calls.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Trunk Groups
Field
Parameter Length Description
ipbwlimit N/A Maximum amount of bandwidth allowed for this IP trunk group in
units of 1K bits per second. Must be -1 or 0-2147483647 as
follows:
• -1 - do not enforce any limit
• 0 - do not allow any calls
• non-zero - allow up to the specified number of 1K bits per
second
Default is -1, or no limit on bandwidth.
direction N/A The direction of calls on this IP trunk group. This object is only
valid for IP trunk groups:
• inComing - inbound.
• outGoing - outbound.
• bothWays (default) - inbound and outbound.
nstablename 1-23 Specifies the name of the Network Selector Table. Each entry in
this table is a network selector that specifies the group of
signaling peers that use a particular IP trunk group.
mindur N/A Specifies the minimum period of outage for a call, in
milliseconds, for that call to be counted as part of the packet
outage detection algorithm. Must be 0-65535, default is 6000
(milliseconds).
mincalls N/A Specifies, for the current interval, the number of calls with
outages that are required to declare a packet outage event. Must
be 0-65535, default is 1000 (calls).
podinterval N/A Specifies the time interval, in minutes, for detecting packet
outages via the packet outage detection algorithm. Must be 5-
1440, default is 15 (minutes).
This object is only valid for IP trunk groups.
bwlimitreduc N/A Specifies the amount to reduce the bandwidth limit (as a
percentage of the configured limit) when a packet outage is
detected. Must be 0-100, default is 50 (percent).
podstate N/A Specifies the administrative state of packet outage detection:
• enabled - automatic bandwidth reduction will occur when a
packet outage is detected
• disabled (default) - packet outages are not detected and the
maximum bandwidth limit is restored
mtgname 1-23 The name of the master trunk group to which the underlying
trunk group belongs as a “slave”. Every trunk group either
belongs to a master trunk group in this manner, or does not
(MASTER TRUNK GROUP NAME NONE).
If a master trunk group is specified for an IP trunk group, then
bandwidth resources controlled by the master must be allocated
for all calls that will use the underlying IP trunk group.
This name may not contain a period (“.”).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Trunk Groups CLI Reference
Field
Parameter Length Description
mcperreq N/A Specifies the number of additional calls requested by the
underlying slave IP trunk group from the master after the slave
has reached its IP CALL LIMIT. This parameter acts as a
threshold for requesting or freeing call allocation. When the
number of available calls is less than this value, the next call is
allocated from the master IP trunk group resources. When the
number of available calls is greater than twice this value, calls
allocated on the master IP trunk group are freed.
Must be UNLIMITED or 0-2147483647 as follows:
• UNLIMITED - do not enforce any limit
• 0 - do not allow any calls
• non-zero - allow up to the specified number of calls
Default is 100.
mbwperreq N/A Specifies the amount of additional bandwidth requested by the
underlying slave IP trunk group from the master after the slave
has reached the IP BANDWIDTH LIMIT. This parameter acts as
a threshold for requesting or freeing bandwidth allocation. When
the amount of available bandwidth on an IP trunk group is less
than the value of this parameter, the next call allocates
bandwidth from the master IP trunk group resources. When the
amount of available bandwidth is greater than twice this value,
bandwidth allocated on the master IP trunk group is freed.
Must be UNLIMITED or 0-2147483647 as follows:
• UNLIMITED - do not enforce any bandwidth limit
• 0 - do not allow any bandwidth allocation
• non-zero - allow up to the specified amount of bandwidth
allocation (in units of 1K bits per second)
Default is 6400 (in units of 1K bits per second).
maxcallburst N/A In terms of the “single token bucket” IP policing paradigm, this is
the “bucket size” used by the call policer, in number of calls.
These “credits” reside in the “bucket”. Each received call causes
this credit balance to be decremented by 1. These credits are
restored once a second by the POLICER MAX CALL RATE.
If a call is received while the credit balance is zero, the call is
dropped and a Trunk Group Automatic Control Active Notification
is added to the system event log.
Must be 0-200, default is 0. A value of 0 disables the SIP call
policer.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Trunk Groups
Field
Parameter Length Description
maxcallrate N/A In terms of the “single token bucket” IP policing paradigm, this is
the “fill rate” used by the call policer, in number of calls per
second. This number of calls is added to the bucket credit
balance every second. A call is dropped if the credit balance is
zero when it is received. In order for calls to be dropped, they
must be received at a rate that exceeds this fill rate such that the
credits are reduced to zero.
The bucket credit balance will never grow larger than the initially
configured MAX CALL BURST, regardless of the size of this
increment.
Must be 0-100, default is 0. A value of 0 disables the call policer.
maxregistratio N/A In terms of the “single token bucket” IP policing paradigm, this is
nburst the “bucket size” used by the SIP registration policer, in number
of SIP registrations. These “credits” reside in the “bucket”. Each
successful SIP registration causes this credit balance to be
decremented by 1. These credits are restored once a second by
the POLICER MAX REGISTRATION RATE.
If a SIP registration is attempted while the credit balance is zero,
the registration is abandoned and a Trunk Group Automatic
Control Active Notification is added to the system event log.
This policer is applied only to new registrations (that contain a
new Address of Record). Refresh registrations are not policed.
Must be 0-200, default is 0. A value of 0 disables the SIP
registration policer.
maxregistratio N/A In terms of the “single token bucket” IP policing paradigm, this is
nrate the “fill rate” used by the SIP registration policer, in number of
SIP registrations per second. This number of SIP registrations is
added to the bucket credit balance every second. A SIP
registration is abandoned if the credit balance is zero when it is
received. In order for SIP registrations to be abandoned, they
must be attempted at a rate that exceeds this fill rate such that
the credits are reduced to zero.
The bucket credit balance will never grow larger than the initially
configured MAX REGISTRATION BURST, regardless of the size
of this increment.
This policer is applied only to new registrations (that contain a
new Address of Record). Refresh registrations are not policed.
Must be 0-100, default is 0. A value of 0 disables the SIP
registration policer.
lptrgrprofile 1-23 Specifies the name of the Local Policy Trunk Group Profile when
the GSX is operating in Local Policy mode.
See Chapter 4, "Using the GSX in Local Policy Mode" and "Local
Policy Trunk Group Profile" on page 4–23 for more information.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Trunk Groups CLI Reference
Field
Parameter Length Description
hpcprofile 1-23 Specifies the name of the High Probability of Completion (HPC)
trunk group profile. Must 1-23 characters.
The default is defaultcallqueuing if the trunk group type is
pstn, or defaultintipqueuing if the trunk group type is
either ipLinked or ipSelected.
See "High Probability of Completion Shelf" on page 3–122 and
"High Probability of Completion (HPC) Trunk Group Profile" on
page 3–126 for more information.
earlyacm N/A Specifies whether an ACM or SIP-18x will be sent when an HPC
call is queued (when supporting HPC network capability):
• on - an ACM or SIP-18x message will be sent when a call is
queued.
• off - an ACM or SIP-18x message will not be sent when a
call is queued.
• usedefault (default) - use the default setting on the shelf-
wide HPC early ACM setting.
oversub N/A Specifies the percentage over the configured allowed
resources for an IP trunk group that HPC calls can consume
before being queued. Must be 0-100; default is 10.
This parameter is used when supporting HPC network capability.
override N/A Specifies whether the IP oversubscription factor setting on this
trunk group overrides the oversubscription factor setting on the
associated trunk group profile:
• enabled - the IP oversubscription factor will be overridden by
the oversubscription factor specified by the HIGH
PROBABILITY OF COMPLETION IP OVERSUBSCRIPTION
FACTOR parameter.
• disabled (default) - the IP oversubscription factor will not be
overridden; the oversubscription factor specified in the
associated trunk group profile will be used.
This parameter is used when supporting HPC network capability.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Trunk Groups
Command Example
Outbound Calls
Total Calls In Calls Usages Resv Oper
Local Trunk Name Conf Avail Resv Usage no-pri pri State
----------------------- ------------ ----------- ------------------ -----------
defaultiptg UNLMT UNLMT 0 0 0 0 0 INSERVICE
TGISUP 2016 2016 0 0 0 0 0 INSERVICE
TGINET2 4032 4032 0 0 0 0 0 INSERVICE
INPRI 240 240 0 0 0 0 0 INSERVICE
iptg1 UNLMT UNLMT 0 0 0 0 0 INSERVICE
iptg2 UNLMT UNLMT 0 0 0 0 0 INSERVICE
Outbound Calls
Total Calls In Calls Usages Resv Oper
Local Trunk Name Conf Avail Resv Usage no-pri pri State
----------------------- ------------ ----------- ------------------ -----------
TGISUP 2016 2016 0 0 0 0 0 INSERVICE
Current ACL value => 0
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Trunk Groups CLI Reference
NOTE
The ACL value in the above display shows that the automatic congestion control
level in the TGISUP trunk group is greater than or equal to 0 (no congestion). This
value is always 0-3, with 3 representing the highest congestion. See "ISUP
Service" on page 3–826 for more detail on automatic congestion control.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Trunk Groups
To display the (ISUP) service group that is bound to trunk group TGISUP:
% SHOW TRUNK GROUP TGISUP SERVICEGROUPS
Node: TPUBS Date: 2004/09/20 21:49:23 GMT
Zone: GMTMINUS05-EASTERN-US
To display the (ISDN) service groups that are bound to trunk group INPRI:
% SHOW TRUNK GROUP INPRI SERVICEGROUPS
Node: TPUBS Date: 2004/09/20 21:52:18 GMT
Zone: GMTMINUS05-EASTERN-US
To rename trunk group tg1 to inbound-tg1, while allowing both names to be in effect
indefinitely to access the trunk group:
% CONFIGURE TRUNK GROUP tg1 NAME inbound-tg1 RENAME TIMER 0
To remove the old trunk group name (tg1) from the above example, so that it may no longer be
used to access the trunk group (but may be used as a new trunk group name):
% CONFIGURE TRUNK GROUP inbound-tg1 ALTERNATE NAME NONE
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Trunk Groups CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Trunk Groups
The commands below create, configure, and enable a hierarchical arrangement of IP trunk groups,
where the child (or ipSelected) trunk groups iptg1 and iptg2 belong to the parent (or
ipLinked) trunk group ipparent. iptg1 uses IP Network Selector Table table1 and iptg2
uses IP Network Selector Table table2.
% CREATE IP NETWORK SELECTOR TABLE table1
% CONFIGURE IP NETWORK SELECTOR TABLE table1 ADD NUMBER 10.99.0.0 ..
MASK 255.255.0.0
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Trunk Groups CLI Reference
The commands below create, configure, and enable three signaling gateway services:
gwiptg1 employs IP trunk group iptg1, while MyH323SrvcGrp and MySipIpSrvcGrp each
employ IP trunk group iptg2.
% CREATE GATEWAY SERVICE gwiptg1
% CONFIGURE GATEWAY SERVICE gwiptg1 TRUNK GROUP iptg1
% CONFIGURE GATEWAY SERVICE gwiptg1 STATE enabled
% CONFIGURE GATEWAY SERVICE gwiptg1 MODE inService
To add call admission controls to the parent trunk group and thereby causing call admission to be
managed exclusively by the linked trunk group ipparent:
% CONFIGURE TRUNK GROUP ipparent IP CALL LIMIT 2000
% CONFIGURE TRUNK GROUP ipparent IP BANDWIDTH LIMIT 200000
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Trunk Groups
To display the inbound and outbound call usages on all PSTN and IP trunk groups:
% SHOW TRUNK GROUP ALL STATUS
Node: TPUBS Date: 2004/09/30 21:05:18 GMT
Zone: GMTMINUS05-EASTERN-US
Outbound Calls
Total Calls In Calls Usages Resv Oper
Local Trunk Name Conf Avail Resv Usage no-pri pri State
----------------------- ------------ ----------- ------------------ -----------
defaultiptg UNLMT UNLMT 0 0 0 0 0 INSERVICE
TGISUP 2016 2016 0 0 0 0 0 INSERVICE
TGINET2 4032 1997 0 0 2035 0 0 INSERVICE
INPRI 240 240 0 0 0 0 0 INSERVICE
iptg1 1100 87 0 1013 0 0 0 INSERVICE
iptg2 600 80 0 520 0 0 0 INSERVICE
iptg3 600 99 0 501 0 0 0 INSERVICE
mom 2100 66 0 2034 0 0 0 INSERVICE
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Trunk Groups CLI Reference
To display channel DIRECTION statistics on all PSTN channels (note that despite the ALL
keyword, only PSTN channels are displayed):
% SHOW TRUNK GROUP DIRECTION ALL STATUS
Node: TPUBS Date: 2004/09/30 21:26:28 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Trunk Groups
This object is a member of the IP Trunk Group Selection Table. Each entry in a Network Selector
Table is a Network Selector; that is, one or more IP network addresses that specifies a range of IP
addresses in an IP network. Each Network Selector is a group of IP signaling peers, rather than an
individual signaling peer address. This is a result of each Network Selector being an IP network
number and an IP network mask. This structure allows an entry to represent a single host, if it is
defined appropriately.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Trunk Groups CLI Reference
Command Parameters
Field
Parameter Length Description
nstname 1-23 The name of the IP Network Selector Table being created or
configured. This name is used to bind this table to an IP Trunk
Group in the TRUNK GROUP object.
ipaddress N/A The 32-bit IP address specified in dotted decimal form (for
example 128.127.50.224). This is the IP network number in a
Network Selector.
subnet-mask N/A The 32-bit subnet mask in dotted decimal form (for example
255.255.255.0). This is the IP network mask in a Network
Selector.
sgtype N/A The type of signaling of interest in IP Trunk Group Selection Table
entries that meet all subsequent criteria:
• h323
• gateway
• sip
direction N/A The IP call leg of interest in IP Trunk Group Selection Table
entries that meet all subsequent criteria:
• ingress
• egress
sigzoneid N/A The non-negative integer that is assigned to a SIGNALING ZONE
which has been assigned to a SIP or H323 SIGNALING PORT.
The default SIGNALING ZONE, INTERNAL, takes a Zone ID of 0.
See "Zone" on page 3–511 for information on creating a ZONE
object. To display the zone names and ID assignments, use the
SHOW ZONE SUMMARY command.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Trunk Groups
Command Example
To create and configure an IP Network Selector in IP Network Selection Table nst1, that
represents the range of IP host addresses from 209.131.0.0 to 209.131.255.255:
% CREATE IP NETWORK SELECTOR TABLE nst1
% CONFIGURE IP NETWORK SELECTOR TABLE nst1 ..
ADD NUMBER 209.131.0.0 MASK 255.255.0.0
To configure an IP Network Selector in the above IP Network Selection Table nst1, that
represents the range of IP host addresses from 209.131.16.0 to 209.131.31.255:
% CONFIGURE IP NETWORK SELECTOR TABLE nst1 ..
ADD NUMBER 209.131.16.0 MASK 255.255.240.0
To display a summary of IP Network Selectors, the IP Trunk Groups that use them, and the
signaling gateway service types that use the IP trunks:
% SHOW IP NETWORK SELECTION TABLE SUMMARY
Node: TPUBS Date: 2004/09/21 15:46:15 GMT
Zone: GMTMINUS05-EASTERN-US
SG Type Signal. Direction Network Number Network Mask Trunk Group Name
Zone ID
-------- -------- --------- ---------------- --------------- ------------------
H323 0 INGRESS 10.88.0.0 255.255.0.0 iptg2
H323 0 INGRESS 10.99.7.6 255.255.255.255 iptg2
H323 0 EGRESS 10.88.0.0 255.255.0.0 iptg2
H323 0 EGRESS 10.99.7.6 255.255.255.255 iptg2
GATEWAY 0 INGRESS 10.99.0.0 255.255.0.0 iptg1
GATEWAY 0 EGRESS 10.99.0.0 255.255.0.0 iptg1
SIP 0 INGRESS 10.88.0.0 255.255.0.0 iptg2
SIP 0 INGRESS 10.99.7.6 255.255.255.255 iptg2
SIP 0 EGRESS 10.88.0.0 255.255.0.0 iptg2
SIP 0 EGRESS 10.99.7.6 255.255.255.255 iptg2
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Trunk Groups CLI Reference
This object defines a master trunk group from which call resources are allocated to all “slave”
trunk groups that belong to this “master”. Each master trunk group distributes resources for one of
two PROTOCOLs:
• PSTN resources such as ISUP circuits or ISDN B-Channels (not yet supported)
• IP resources such as amount of bandwidth and number of calls
A master trunk group may span multiple GSXs, providing a uniform view of Point of Presence
(POP) near end resources to far end switches.
The CONNECTION PORT, described in the following section, links a particular MASTER TRUNK
GROUP to each GSX that uses it.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Trunk Groups
Command Parameters
Field
Parameter Length Description
mtgname 1-23 The name of the master trunk group that is being created or
configured.
protocol N/A Specifies the type of resources that this master trunk group will
supply:
• ip (default) - resources for IP trunk groups
• pstn - resources for PSTN trunk groups (not yet supported)
maxcalls N/A The total number of calls that may be reserved and used by the
slave IP trunk groups that belong to this master:
• UNLIMITED - do not enforce any limit
• 0 - do not allow any calls
• 1-2147483647 - allow up to the specified number of calls
Default is 1000 (calls).
maxbandwidth N/A The total amount of bandwidth (in units of 1K bits per second)
that may be reserved and used by the slave IP trunk groups that
belong to this master:
• UNLIMITED - do not enforce any limit
• 0 - do not allow any calls
• 1-2147483647 - allow up to the specified amount of bandwidth
Default is 64000 (units of 1K bits per second).
cpindex N/A Specifies the connection port that is used by this master trunk
group. The specified connection port should be configured,
enabled, and in service.
Must be an ascending integer 0, 1, 2, ...
A value of 0 means there is no connection port for this master
trunk group.
admin-state N/A The administrative state of this master trunk group:
• disabled (default) - Not activated, able to be deleted.
• enabled - Activated, available for immediate use.
oper-state N/A The operational state of the master trunk group:
• outofservice - The master trunk group is prevented from
carrying new calls.
• inservice (default) - The master trunk group can carry new
calls.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Trunk Groups CLI Reference
Command Example
To configure, enable, and put into service the master IP trunk group masteriptg with a total call
limit of 50000 and a total bandwidth limit of 5000 MB/second, that will listen for signals on
logical port entry number 1:
% CONFIGURE MASTER TRUNK GROUP masteriptg ..
GLOBAL MAXIMUM CALLS 5000
GLOBAL MAXIMUM BANDWIDTH 500000
CONNECTION PORT INDEX 1
% CONFIGURE MASTER TRUNK GROUP masteriptg STATE enabled
% CONFIGURE MASTER TRUNK GROUP masteriptg MODE inService
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Trunk Groups
This object defines the IP link that makes a master trunk group available to multiple GSXs. You
may CREATE and CONFIGURE this connection instance, such that all master trunk groups may
share this connection. The HEALTHCHECK parameters provide a mechanism for detecting and
recovering from link outages.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Trunk Groups CLI Reference
Command Parameters
Field
Parameter Length Description
conn-port N/A Specifies the entry number of the Gateway Signal Listen Port that
is being created or configured.
ipaddress N/A The 32-bit IP address of the Gateway Signal Listen Port specified
in dotted decimal form (for example 128.127.50.224). This must
be a logical IP address, and is always interpreted as the IP
address of the server.
portnum N/A Port number of the master trunk group communication port. Must
be 1-65535, default is 4360.
Port numbers less than 5000 or greater than 40000 should be
used to avoid voice port numbers.
interface N/A Specifies which network interface to use for this master trunk
group communication port:
• mgtNif (default) - NIFs found on MNA modules.
• nif - NIFs found on PNA or MNA2X modules. This interface
may provide better redundancy protection.
role N/A Specifies the role of the communication port being configured:
• client (default) - The user of the master trunk group
communication port resources. In this role, a socket is created
and an initial attempt is made to contact the configured
IPADDRESS.
• server - The provider of the master trunk group
communication port resources. Only one server port is allowed
per GSX. In this role, the IPADDRESS is added as a secondary
address to the interface and a socket is created and listened in
on for incoming requests. Also, a local client entity is created as
well.
hcinterval N/A The time interval (in seconds) that a master trunk group health
check message will be sent to the peer. Must be 1-20, default is 2
(seconds).
hcignoreto N/A Specifies whether health check message timeouts will be ignored
by the GSX software:
• enabled - Ignore the timeout and do not mark the peer
inaccessible.
• disabled (default) - Recognize the timeout and mark the peer
inaccessible.
hctimeout N/A Specifies the health check timeout value (in seconds). If no health
check message is received from the peer for this time interval, the
peer is marked inaccessible. Must be 1-40, default is 20
(seconds).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Trunk Groups
Field
Parameter Length Description
admin-state N/A The administrative state of this master trunk group communication
port:
• disabled (default) - Not activated, able to be deleted.
• enabled - Activated, available for immediate use.
oper-state N/A The operational state of the master trunk group communication
port:
• outofservice - The port is prevented from carrying new calls.
• inservice (default) - The port can carry new calls.
Command Example
To create a master trunk group connection port that will listen for signals on logical port entry
number 1:
% CREATE MASTER TRUNK GROUP CONNECTION PORT 1
To configure, enable, and put into service this master trunk group connection port as a server,
using IP address 10.10.10.1 on a PNS NIF, TCP/IP port number 4375, a health check interval of 4
seconds and a health check timeout interval of 10 seconds:
% CONFIGURE MASTER TRUNK GROUP CONNECTION PORT 1 ..
IPADDRESS 10.10.10.1
PORTNUM 4375
INTERFACE nif
ROLE server
HEALTHCHECK INTERVAL 4
HEALTHCHECK TIMEOUT 10
% CONFIGURE MASTER TRUNK GROUP CONNECTION PORT 1 ..
STATE enabled
% CONFIGURE MASTER TRUNK GROUP CONNECTION PORT 1 ..
MODE inService
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Trunk Groups CLI Reference
This object designates the maximum trunk group resources in the system.
Command Syntax
Command Parameters
Field
Parameter Length Description
maxtrunks N/A Specifies the maximum number of TRUNK GROUPs that may be
configured and supported on this GSX. Must be 1-1024 for MNS10
based systems. Must be 1-2048 for MNS11 and MNS2x based
systems. Default is 250 on all systems.
NOTE
When you configure more than 250 trunk groups or service groups, call rate
performance could be negatively impacted. See the GSX 6.01 Software Release
Notes for additional detail.
Command Example
To increase the maximum number of trunk groups supported to 500 (from the default setting of
250):
% CONFIGURE TRUNK RESOURCES MAX TRUNKS 500
TG CARRIER
------- -------
500 250
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Trunk Groups
This object permits a trunk group consisting of PRI lines to control call by call service selection.
Without this feature, the PRI delivers multiple two way services on a demand basis without any of
the restrictions that characterize the Dedicated Services Access model that the PRI replaced. This
feature permits the combining of the controls of the Dedicated Services Access model with the
flexibility of the PRI.
By specifying call criteria in a Simulated Facility Group (SFG), calls on the underlying trunk
group with matching criteria are subject to the restrictions defined by the SFG. Calls that do not
match the criteria are not impacted, and therefore not restricted, by the SFG.
By associating and properly configuring an SFG with a trunk group, you can use the trunk for
public numbering plan calls, private numbering plan calls, calls requesting INWATS service, and
others, on a call by call basis. Each SFG is associated with one of these call services.
More than one SFG may be assigned to a trunk group. When a call requiring a particular type of
service is set up, a search is performed across the SFGs of the trunk group to find the best match
between the call requirements and trunk services.
For ingress calls, matching call criteria are sought in the following order:
• FACILITY CODING VALUE
• service type of private
• DIRECTION
• BEARER CAPABILITIES
• CARRIER CODE
For egress calls, matching call criteria are sought in the following order:
• DIRECTORY number
• service type of private
• DIRECTION
• BEARER CAPABILITIES
When multiple SFGs match, a best match is determined according to the hierarchy listed above.
Only matching calls are limited by these SFG parameters on a trunk group. For example, if a single
SFG is configured on a trunk group with BEARER CAPABILITIES of speech and an incoming
call with BEARER CAPABILITIES of audio31k occurs, the SFG is not applied and the call
proceeds without restriction.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Trunk Groups CLI Reference
You must properly configure the MAX ALLOCATION and the OVERFLOW .. parameters to limit the
calls of any particular service type on the trunk. When the SFG MAX ALLOCATION limit has been
reached, the call may be turned over to the control of another SFG as specified by the OVERFLOW
SFG index. This OVERFLOW SFG must be configured within the same trunk group as the original
SFG, and is subject to the following restrictions:
• The SFG TYPE (such as public, private, inWats, etc.) of the OVERFLOW SFG must match
exactly.
• The OVERFLOW SFG BEARER CAPABILITIES must contain at least all the BEARER
CAPABILITIES of the primary SFG, or they must be set to NONE.
• An SFG configured as oneWayxx cannot overflow into an SFG configured as twoWay.
In addition, the OVERFLOW SFG may be a “null” SFG (overflow index of "0") effectively rejecting
the call. As PRI lines are added to the trunk group, more calls are possibly subjected to SFG
criteria. Typically, in these cases the MAX ALLOCATION should be increased to avoid potential
call failures. The configuration of each SFG on each trunk group must be carefully considered to
create a set of simulated controls that achieve Dedicated Services Access behavior for call by call
processing.
This object is recognized only by trunk groups that are configured as ISDN PRIs. SFGs should not
be configured on trunk groups which contain CAS circuits as they are incompatible. ISUP trunk
groups ignore this object.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Trunk Groups
Command Parameters
Field
Parameter Length Description
sfgnum N/A The number or index of this simulated facility group (SFG) within
the associated trunk group. This uniquely defines this SFG. Must
be 1-127.
tgname 1-23 The name of the trunk group with which the SFG is associated.
Typically, this trunk group will serve as an ISDN PRI (see "Adding
an ISDN PRI" on page 6–100.)
servicetype N/A The type of service to be provided for calls that use this SFG on
this trunk (or ISDN PRI):
• public - This SFG is used for calls using a public numbering
plan.
• private - This SFG is used for calls using a private numbering
plan.
• inWats - This SFG is used for calls requesting an INWATS
service.
• outWats - This SFG is used for calls requesting an OUTWATS
service.
• user - This SFG is used for calls acting as the user side of a
user-network interface.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Trunk Groups CLI Reference
Field
Parameter Length Description
carrier 1-5 Specifies the network identification plan found in the Network
Specific Facilities (NSF) Information Element (IE) in the SETUP
message for the call. This carrier code will be associated with this
SFG. For incoming calls it is used for service selection. For
outgoing calls it is used to code the NSF IE.
A match occurs when:
• The carrier code in the SETUP message is identical to the value
specified for this parameter. This is considered a superior
match to the two following cases.
• A value is specified for this parameter, but no carrier code is
present in the SETUP message.
• A carrier code is present in the SETUP message, but this
parameter is not specified or this parameter is specified with the
value NONE.
A non-match occurs only when both this parameter and the
SETUP message contain dissimilar carrier codes.
May be up to four numeric digits.
fcv 8 Specifies the facility coding value found in the NSF IE in the
SETUP message for the call. For incoming calls it is used for
service selection. For outgoing calls it is used to code the NSF IE.
A match occurs when:
• The facility coding value in the SETUP message is identical to
the value specified for this parameter.
• The facility coding value is not present in the SETUP message
and the value specified for this parameter is all zeroes.
A non-match occurs when both this parameter and the SETUP
message contain dissimilar facility coding values or when this
parameter is not present.
This is an eight bit field, expressed as a decimal number from 0-
127. For example, the eight bit field 00100110 is specified by the
decimal value 38.
servicepar N/A Specifies the service parameter value for the NSF IE in the
SETUP message for the call. For incoming calls it is used for
service selection. For outgoing calls it is used to code the NSF IE.
A match occurs when:
• The service parameter value in the SETUP message is identical
to the value specified for this parameter.
• The service parameter is not present in the SETUP message
and the value specified for this parameter is zero.
A non-match occurs when both this parameter and the SETUP
message contain dissimilar values or when this parameter is not
present.
Must be 0-32767.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Trunk Groups
Field
Parameter Length Description
direction N/A The call direction used by this SFG:
• twoWay - This SFG is used for calls in either direction.
• oneWayIn - This SFG is used for calls in the inbound direction.
• oneWayOut - This SFG is used for calls in the outbound
direction.
bearercap N/A Specifies the bearer capability used for this SFG:
• speech - speech
• audio31k - 3.1K Hz audio
• data56k - circuit mode 64K bps Unrestricted Digital
Information Rate adapted for 56K bps
• data64k - circuit mode 64K bps Unrestricted Digital
Information
A match occurs when:
• The call type meets the specified criteria.
• The value specified for this parameter is NONE.
A non-match occurs when the call doesn’t meet the specified
criteria or when this parameter is not present.
maxalloc N/A The maximum number of criteria matching calls that can use this
SFG on this trunk group. For practical purposes, this must be less
than the total number of simultaneous calls that can be processed
by the GSX using these resources; default value is 9999.
dirnum 1-23 The directory number to be used for this SFG. For outgoing calls,
this is an OUTWATS billing number. For incoming calls, this is a
number to be matched for an INWATS service.
If this parameter is not present, or NONE is the specified value,
originating calls will not be supplied with a billing number.
Terminating INWATS calls will require that this number be
configured.
oversfg N/A The number or index of the SFG to use when this SFG reaches its
maximum allocation of matching criteria calls. If this value is set to
0, or the designated SFG doesn’t exist, then new calls are rejected
on this trunk group when this SFG reaches its maximum
allocation. Must be 0-127, default is 0.
admin-state N/A The administrative state of this Simulated Facility Group:
• disabled (default) - Not active, able to be configured.
• enabled - Active.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Trunk Groups CLI Reference
Command Example
To display all statistics associated with all defined SFGs (which in this case is one):
% SHOW SIMULATED FACILITY GROUP ALL STATISTICS
Node: TPUBS Date: 2002/01/16 21:49:45 GMT
Zone: GMTMINUS05-EASTERN-US
SFG Current
Local Trunk Name Index Carrier Type Usage Attempts Failures
-------------------- ----- ------- ------- ---------- ---------- -------
tg2 1 PUBLIC 0 4 0
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Trunk Groups
DS1 Ports
Command Syntax
Command Parameters
Field
Parameter Length Description
circuittype 1-23 The type of circuit you wish to assign to the DS1:
• t1
• e1
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Trunk Groups CLI Reference
14 T1
15 T1
16 T1
17 T1
18 T1
19 T1
20 T1
21 T1
22 T1
23 T1
24 T1
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference T1 Circuits
T1 Circuits
These objects specify the T1 links connected to the Circuit Network Adapters on the GSX9000,
and Gateway Network Adapters (GNA10) on the GSX4010.
Before configuring T1 circuits on a GSX4010 switch, you configure the DS1 mode to specify
which circuit type will be used (T1 or E1). See the "DS1 Ports" object on page 3–574 for more
information.
T1 Profile
This object creates a template for the T1 objects (below). T1 objects that are configured with a
profile will silently take every parameter value specified in the profile unless explicitly overridden.
PERFMON Thresholds
The Performance Monitor (PERFMON) THRESHOLD parameters shown below are for specific types
of interface error conditions. Error counts of this magnitude will trigger an event log entry or trap
notification for each threshold level (MAJOR, CRITICAL, or MINOR) of each associated type of
error, for an interval of either fifteen minutes or twenty-four hours. When you configure a
threshold for an individual error type, the identical threshold value is established at both the near
and far end of the T1 circuit. You may specify the threshold level, the threshold value, the error
type, the interval length, and the error level (line or path). (Line error levels are detectable only for
certain error types on T1 spans serviced by CNS10s, CNS40s, and CNS45s; all other T1 spans
detect these errors on a path level only. You may zero out (PERFMON RESET) the accumulated
counts for these errors on the near or far end, for either interval, and for either error level. The
counts for all the error types, rather than for individual error types, will be zeroed out.
By default, only MAJOR threshold levels are reported when the T1 PROFILE is enabled. To
include MINOR and CRITICAL threshold levels in the reporting you must enable TCA REPORT
MINORCRITICAL. Enabling MINORCRITICAL will also enable the reporting of the beginning
of a new performance monitoring time interval (15 minutes or 24 hours). These interval crossings
will not otherwise be reported.
By default, when a span is taken out of service for any reason, threshold crossing events for that
span are not reported until the span is placed back into service. You may override this policy and
cause continued reporting of threshold crossing events on spans that are out of service by enabling
TCA REPORT DS1OOS. This applies whether the span was taken out of service manually or
automatically (by exceeding MAJOR threshold levels).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
T1 Circuits CLI Reference
Threshold crossing alerts may be selectively enabled or disabled for each error type via TCA
FILTER. See "Alarm and Threshold Crossing Reporting Hierarchies" on page 6–163 for more
information.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference T1 Circuits
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
T1 Circuits CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference T1 Circuits
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
T1 Circuits CLI Reference
Command Parameters
Field
Parameter Length Description
t1profile 1-23 The name of the profile that can be applied to a T1 object.
buildout N/A The length of T1 wire that must be driven, expressed in
increments of 110 feet. This is the length between the GSX and a
repeater or patch panel:
• 0_110ft
• 110_220ft (default)
• 220_330ft
• 330_440ft
• 440_550ft
• 550_660ft
Note that this parameter is not accessible on spans that belong to
a T3 circuit. Those spans must be configured via the T3 object,
see "T3" on page 3–648.
linetype N/A The frame format used on the T1:
• ESF (default)
• D4
coding N/A The T1 line coding:
• AMI
• B8ZS (default)
Note that this parameter is not accessible on spans that belong to
a T3 circuit. Those spans must be configured via the T3 object,
see "T3" on page 3–648.
signaling N/A Signaling used for this T1:
• none (default)
• robbedBit - In-band signaling achieved by stealing bits from
the speech path; required by CAS services.
idlecode N/A This value is inserted in an idle channel. Must be 0-255, default is
127 (0x7F).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference T1 Circuits
Field
Parameter Length Description
avchannels N/A The set of available channels for this T1. Maximum range is 1-24,
default is 1-24 (a full T1). Any discrete set of channels within this
range may be specified as discussed below.
All CLI ranges specify a comma-separated list of numbers and/or
ranges. A range consists of two numbers separated by a dash, for
example, 5-8. An increment can be specified after a range with the
notation, +<incr>, for example 4-10+2. No spaces are permitted in
the expression. All values and ranges must be in numerically
ascending order. Thus the expression:
1,3,5,8-12+2,14-16
is a valid range specification for the numbers:
1,3,5,8,10,12,14,15, and 16.
admin-state N/A The administrative state of this T1 profile:
• disabled (default) - Not activated, able to be configured or
deleted.
• enabled - Activated, available for immediate use.
cvl15 N/A Line Code Violations (MAJOR, MINOR, or CRITICAL) threshold
value for a 15 minute interval. This number must be 1-16,383,
default is 13,340.
A line code violation is an occurrence of either of the following
conditions:
• a pulse of the same polarity as the previous pulse
• more than 15 contiguous zeroes in AMI coding or more than 7
contiguous zeros in B8ZS coding
This error is detectable only at the near end of T1 spans (CNS10,
CNS40, and CNS45 T1 spans on a GSX9000). It is not detectable
at the far end of T1 spans. It is not detectable at either end of the
logical T1 spans serviced by any other CNS modules.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
T1 Circuits CLI Reference
Field
Parameter Length Description
esl15 N/A Line Errored Seconds (MAJOR, MINOR, or CRITICAL) threshold
value for a 15 minute interval. This number must be 1-900, default
is 65.
An Errored Second is a one second interval in which any one or
more of the following error conditions are present:
• path code violation
• out of frame defect
• controlled slip event
• Alarm Indication Signal (AIS) defect - the AIS is a signal
transmitted downstream informing that an upstream failure has
been detected. This signal replaces the normal traffic signal
when a maintenance alarm indication has been activated. AIS
seconds are a count of the number of seconds during which an
AIS signal was detected.
This error is detectable at both ends of T1 spans (CNS10, CNS40,
and CNS45 T1 spans on a GSX9000). It is not detectable at either
end of the logical T1 spans serviced by any other CNS modules.
sesl15 N/A Line Severely Errored Seconds (SES) (MAJOR, MINOR, or
CRITICAL) threshold value for a 15 minute interval. This number
must be 1-900, default is 10.
A Severely Errored Second is a one second interval in which any
one or more of the following error conditions are present:
• 320 or more path code violations (see below)
• out of frame defect
• AIS defect
This error is detectable only at the near end of T1 spans (CNS10,
CNS40, and CNS45 T1 spans on a GSX9000). It is not detectable
at the far end of CNS10 T1 spans. It is not detectable at either end
of the logical T1 spans serviced by any other CNS modules.
cvp15 N/A Path Code Violations (MAJOR, MINOR, or CRITICAL) threshold
value for a 15 minute interval. This number must be 1-16,383,
default is 13,296.
A path code violation is a frame synchronization bit error.
esp15 N/A Path Errored Seconds (MAJOR, MINOR, or CRITICAL) threshold
value for a 15 minute interval. This number must be 1-900, default
is 65.
sesp15 N/A Path Severely Errored Seconds (MAJOR, MINOR, or CRITICAL)
threshold value for a 15 minute interval. This number must be 1-
900, default is 10.
sasp15 N/A SEF/AIS Seconds (MAJOR, MINOR, or CRITICAL) threshold
value for a 15 minute interval. This number must be 1-900, default
is 2.
This error is detectable only at the Path level.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference T1 Circuits
Field
Parameter Length Description
sefsp15 N/A Severely Errored Framing Seconds (MAJOR, MINOR, or
CRITICAL) threshold value for a 15 minute interval. This number
must be 1-900, default is 2.
Severely Errored Framing (SEF) is a SONET defect which is the
first indication of trouble in detecting valid signal framing patterns.
Four consecutive errored framing patterns constitutes an SEF
defect. Severely Errored Framing Seconds are a count of the
number of seconds during which an SEF defect was present.
This error is detectable only at the Path level.
cssp15 N/A Controlled Slip Seconds (MAJOR, MINOR, or CRITICAL)
threshold value for a 15 minute interval. This number must be 1-
900, default is 1.
A Controlled Slip Second is a one second interval in which the
information bits received in a frame are replicated or deleted,
except during an unavailable second (see below).
This error is detectable only at the Path level.
uasp15 N/A Unavailable Seconds (MAJOR, MINOR, or CRITICAL) threshold
value for a 15 minute interval. This number must be 1-900, default
is 10.
An unavailable second is a one second interval in which the T1
interface is unavailable. This period could begin with the onset of
10 consecutive SESs or the onset of a condition leading to a
failure. The period ends at the onset of 10 consecutive seconds
without an SES.
This error is detectable only at the Path level.
cvlday N/A Line Code Violations (MAJOR, MINOR, or CRITICAL) threshold
value for a 24 hour interval. This number must be 1-1,048,575,
default is 133,400.
This error is detectable only at the near end of T1 spans (CNS10,
CNS40, and CNS45 T1 spans on a GSX9000). It is not detectable
at the far end of T1 spans. It is not detectable at either end of the
logical T1 spans serviced by any other CNS modules.
eslday N/A Line Errored Seconds (MAJOR, MINOR, or CRITICAL) threshold
value for a 24 hour interval. This number must be 1-65,535,
default is 648.
This error is detectable at both ends of T1 spans (CNS10, CNS40,
and CNS45 T1 spans on a GSX9000). It is not detectable at either
end of the logical T1 spans serviced by any other CNS modules.
seslday N/A Line Severely Errored Seconds (SES) (MAJOR, MINOR, or
CRITICAL) threshold value for a 24 hour interval. This number
must be 1-65,535, default is 100
This error is detectable only at the near end of T1 spans (CNS10,
CNS40, and CNS45 T1 spans on a GSX9000). It is not detectable
at the far end of T1 spans. It is not detectable at either end of the
logical T1 spans serviced by any other CNS modules.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
T1 Circuits CLI Reference
Field
Parameter Length Description
cvpday N/A Path Code Violations (MAJOR, MINOR, or CRITICAL) threshold
value for a 24 hour interval. This number must be 1-1,048,575,
default is 132,960.
espday N/A Path Errored Seconds (MAJOR, MINOR, or CRITICAL) threshold
value for a 24 hour interval. This number must be 1-65,535,
default is 648.
sespday N/A Path Severely Errored Seconds (MAJOR, MINOR, or CRITICAL)
threshold value for a 24 hour interval. This number must be 1-
65,535, default is 100.
saspday N/A SEF/AIS Seconds threshold value for a 24 hour interval. This
number must be 1-65,535, default is 17.
This error is detectable only at the Path level.
sefspday N/A Severely Errored Framing Seconds (MAJOR, MINOR, or
CRITICAL) threshold value for a 24 hour interval. This number
must be 1-65,535, default is 17.
This error is detectable only at the Path level.
csspday N/A Controlled Slip Seconds (MAJOR, MINOR, or CRITICAL)
threshold value for a 24 hour interval. This number must be 1-
65,535, default is 4.
This error is detectable only at the Path level.
uaspday N/A Unavailable Seconds (MAJOR, MINOR, or CRITICAL) threshold
value for a 24 hour interval. This number must be 1-65,535,
default is 10.
This error is detectable only at the Path level.
tcaf_state N/A Specifies the state of the threshold crossing alert filter for the
particular error type:
• disabled (default) - Do not generate a threshold crossing alert
event when the threshold is exceeded for this error type.
• enabled - Generate a threshold crossing alert event when the
threshold is exceeded for this error type.
See "Regulated Threshold Crossing Alert Reporting" on page 6–
166 for more information.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference T1 Circuits
Command Example
----------------------------------------------------------------------
T1 Profile
----------------------------------------------------------------------
Index: 1
State: DISABLED
Type: T1
Available Channels: 1-24
Line Type: ESF
Line Coding: B8ZS
Signaling Mode: NONE
Line Build Out: 110_220FT
Idle Code: 0x7f
-----------------------------------------------------------------------
T1 Threshold Configuration
-----------------------------------------------------------------------
15 Minute Intervals: Minor Major Critical TCA Filter
-----------------------------------------------------------------------
Line Code Violations: 10672 13340 16008 DISABLED
Line Errored Seconds: 52 65 78 DISABLED
Line Severely Errored Seconds: 8 10 12 DISABLED
Path Code Violations: 10637 13296 15955 DISABLED
Path Errored Seconds: 52 65 78 DISABLED
Path Severely Errored Seconds: 8 10 12 DISABLED
SAS Seconds: 1 2 3 DISABLED
Controlled Slip Seconds: 1 2 3 DISABLED
Unavailable Seconds: 8 10 12 DISABLED
------------------------------------------------------------------------
24 Hour Intervals: Minor Major Critical TCA Filter
------------------------------------------------------------------------
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
T1 Circuits CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference T1 Circuits
T1
This object specifies a T1 circuit that is supported by a Circuit Network Server (CNS) on the
GSX9000 and a Gateway Network Server (GNS) on a GSX4000 series switch. The T1 circuit is
assigned all 24 DS0 channels by default, but any subset of those channels may be specified.
T1 objects or spans are automatically created and named when a CNS/CNA module set is added to
the GSX9000 via the CREATE SERVER .. ADAPTER command. See the management object
"Server" on page 3–17 for additional information. On a GSX4010, 24 T1 objects or spans are
automatically created and named upon installation of the switch.
No additional T1 objects may be created nor may the automatically created (and possibly
renamed) T1s be directly deleted. These T1s are removed from a GSX9000 only when the CNS/
CNA module set is removed via the DELETE SERVER .. ADAPTER command.
Naming Conventions
GSX9000 – The default name of a T1 object that is serviced by a CNS10, CNS40, or CNS45 is
T1-shelf-slot-span, where span is the span number from 1-12. For example, T1-1-3-2
identifies the second T1 span on the T1 circuit that connects to the port on the CNA10 that resides
behind the CNS10 in slot 3 of shelf 1. This name may be changed via the CONFIGURE T1..NAME
command shown in the command syntax below. Renaming must be performed while the T1 is
disabled and before any other configuration commands are issued.
The default name of a T1 object that is serviced by a CNS30, CNS31, CNS60, CNS80, CNS85, or
CNS86 is T1-shelf-slot-port-span, where shelf is the shelf number, slot is the slot
number, port is the T3 index (always 1 for CNS30/CNS31/CNS71/CNS81/CNS86 or 1-3 for
CNS60/CNS80/CNS85), and span is the span number (1-28). For example, T1-1-3-1-2
identifies the second T1 span on the T3 circuit that connects to the port on the CNA30 that resides
behind the CNS30 or CNS31 in slot 3 of shelf 1. This name also may be changed via the
CONFIGURE T1...NAME command syntax below. Renaming must be performed while the T1 is
disabled and before any other configuration commands are issued.
The default name of a T1 object that is serviced by a CNS71, CNS81, or CNS86 is T1-shn-sln-
1-spn, where shn is the shelf number, sln is the slot number, and spn is the span number (1-84).
For example, T1-1-3-1-45 identifies the 45th T1 span on the OC-3 circuit that connects to the
port on the CNA70 via the CPIM71 in slot 3 of shelf 1. This name also may be changed via the
CONFIGURE T1...NAME command syntax below. Renaming must be performed while the T1 is
disabled and before any other configuration commands are issued.
GSX4000 – the default name of a T1 object serviced by the GNS15 does not include a shelf and
slot designation. Therefore the naming convention is T1-port, where port is the port number (1-
12). For example, T1-2 identifies the second T1 port that connects to the port on the GSX4000.
This name may be changed via the CONFIGURE T1..NAME command shown in the command
syntax below. Renaming must be performed while the T1 is disabled and before any other
configuration commands are issued.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
T1 Circuits CLI Reference
T1 Statistics
The STATISTICS associated with this object are kept for fifteen minute intervals, up to a total of
32 intervals or eight hours. INITIALIZE STATISTICS resets the current statistics for fifteen
minute intervals as well as for the DAY interval. SHOW .. STATISTICS always summarizes
statistics for the previous intervals since the GSX was booted, or the previous 32 intervals,
whichever is less. The DAY statistics are collected independently from the fifteen minute intervals.
These results always reflect the last 24 hours of activity. Thus, when the 32nd fifteen minute
interval expires and the first interval is overwritten, the DAY collection continues without
overwriting statistics that are 8 hours old. Statistics that are more than 24 hours old are
overwritten.
PERFMON Thresholds
The Performance Monitor (PERFMON) THRESHOLD parameters shown below are for specific types
of interface error conditions. Error counts of this magnitude will trigger an event log entry or trap
notification for each threshold level (MAJOR, CRITICAL, or MINOR) of each associated type of
error, for an interval of either fifteen minutes or twenty-four hours. When you configure a
threshold for an individual error type, the identical threshold value is established at both the near
and far end of the T1 circuit. You may specify the threshold level, the threshold value, the error
type, the interval length, and the error level (line or path). (Line error levels are detectable only for
certain error types on T1 spans serviced by CNS10s, CNS40s, and CNS45s; all other T1 spans
detect these errors on a path level only.) You may zero out (PERFMON RESET) the accumulated
counts for these errors on the near or far end, for either interval, and for either error level. The
counts for all the error types, rather than for individual error types, will be zeroed out.
By default, only MAJOR threshold levels are reported when the T1 is enabled. To include MINOR
and CRITICAL threshold levels in the reporting you must enable TCA REPORT
MINORCRITICAL. Enabling MINORCRITICAL will also enable the reporting of the beginning
of a new performance monitoring time interval (15 minutes or 24 hours). These interval crossings
will not otherwise be reported.
By default, when a span is taken out of service for any reason, threshold crossing events for that
span are not reported until the span is placed back into service. You may override this policy and
cause continued reporting of threshold crossing events on spans that are out of service by enabling
TCA REPORT DS1OOS. This applies whether the span was taken out of service manually or
automatically (by exceeding MAJOR threshold levels).
Threshold crossing alerts may be selectively enabled or disabled for each error type via TCA
FILTER. See "Alarm and Threshold Crossing Reporting Hierarchies" on page 6–163 for more
information.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference T1 Circuits
• enabled
• disabled
• inservice
• outofservice
The default operational state is outofservice, where all channels are available for maintenance
use. In this state you can configure the T1 to run the loopback sequences shown below in the
command syntax. Changing the operational state to inservice makes the channels available for
general use.
TABLE 3–132
From
(operational
state) Changing to (operational state)
inservice outofservice
The CONFIGURE T1 SHELF.. commands provide a means of changing the administrative and
operational states of all the T1s in an optical (or other) port with a single command.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
T1 Circuits CLI Reference
Command Syntax
NOTE
When issuing T1 commands on a GSX4000 series switch, omit the SHELF and
SLOT parameters.
CONFIGURE T1 t1name ..
PROFILE t1profile
BUILDOUT buildout
LINETYPE linetype
CODING coding
SIGNALING signaling
IDLECODE idlecode
AVAILABLE CHANNELS avchannels
ZEROSUPPRESSION zerosup
ECHO PROFILE ecprofile
CIRCUIT ID circuitid
CONFIGURE T1 t1name INITIALIZE STATISTICS
CONFIGURE T1 t1name LEGACY TRAPGENERATION trap-state
CONFIGURE T1 t1name NAME newt1name
CONFIGURE T1 t1name TIMEOUT timeout
CONFIGURE T1 t1name STATE admin-state
CONFIGURE T1 t1name SENDPATTERN pattern
CONFIGURE T1 t1name LOOPBACK NEAREND nearend
CONFIGURE T1 t1name LOOPBACK FAREND farend
CONFIGURE T1 t1name MODE oper-state
CONFIGURE T1 t1name MODE oper-state ACTION action
CONFIGURE T1 t1name MODE oper-state ACTION action TIMEOUT timeout
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference T1 Circuits
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
T1 Circuits CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference T1 Circuits
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
T1 Circuits CLI Reference
Command Parameters
Field
Parameter Length Description
t1name 1-23 The automatically assigned (and possibly changed) name of the
T1 span. See the beginning of this section for the structure of the
default name.
shelf N/A The shelf number in the GSX node configuration. In this release,
one shelf is supported. Must be 1.
Note: This parameter does not apply to GSX4000 series switches.
slotno N/A The slot number occupied by the circuit network module that
supports this T1. Must be 3-16.
Note: This parameter does not apply to GSX4000 series switches.
port N/A The CNS or GNS port number for the T1 spans referenced by this
command. Must be 1-12 for CNS10; 1 for CNS30/CNS31/CNS71/
CNS81/CNS86 on the GSX9000; and 1 for the GNS15. Must be 1-
3 for CNS60/CNS80/CNS85.
spanrange N/A The set of T1 spans referenced by this command. Must be:
• 1-12 for a CNS10
• 1-8 for a CNS20
• 1-12 for a CNS25
• 1-28 for a CNS30, CNS31, CNS60, CNS80, or CNS85
• 1-36 for a CNS40 or CNS45
• 1-84 for CNS71, CNS81, or CNS86 T1s
• 1-24 for a GSX4010
Any discrete set of spans within these ranges may be specified as
discussed below.
All CLI ranges specify a comma-separated list of numbers and/or
ranges. A range consists of two numbers separated by a dash, for
example, 5-8. An increment can be specified after a range with the
notation, +<incr>, for example 4-10+2. No spaces are permitted in
the expression. All values and ranges must be in numerically
ascending order. Thus the expression:
1,3,5,8-12+2,14-16
is a valid range specification for the numbers:
1,3,5,8,10,12,14,15, and 16.
t1profile 1-23 The name of the profile to be applied to this T1 object.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference T1 Circuits
Field
Parameter Length Description
buildout N/A The length of T1 wire that must be driven, expressed in
increments of 110 feet. This is the length between the GSX and a
repeater or patch panel:
• 0_110ft
• 110_220ft
• 220_330ft
• 330_440ft
• 440_550ft
• 550_660ft
Note that this parameter is not accessible on spans that belong to
a T3 circuit. Those spans must be configured via the T3 object,
see "T3" on page 3–648.
linetype N/A The frame format used on the T1:
• ESF
• D4
coding N/A The T1 line coding:
• AMI
• B8ZS
Note that this parameter is not accessible on spans that belong to
a T3 circuit. Those spans must be configured via the T3 object,
see "T3" on page 3–648.
signaling N/A Signaling used for this T1:
• none (default)
• robbedBit - In-band signaling achieved by stealing bits from
the speech path; required by CAS services.
idlecode N/A This value is inserted in an idle channel. Must be 0-255, default is
127 (0x7F).
avchannels N/A The set of available channels for this T1. Maximum range is 1-24,
default is 1-24 (a full T1). Any discrete set of channels within this
range may be specified as discussed below.
All CLI ranges specify a comma-separated list of numbers and/or
ranges. A range consists of two numbers separated by a dash, for
example, 5-8. An increment can be specified after a range with the
notation, +<incr>, for example 4-10+2. No spaces are permitted in
the expression. All values and ranges must be in numerically
ascending order. Thus the expression:
1,3,5,8-12+2,14-16
is a valid range specification for the numbers:
1,3,5,8,10,12,14,15, and 16.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
T1 Circuits CLI Reference
Field
Parameter Length Description
newt1name 1-23 A new name for a T1 span. The renaming operation will not be
allowed if the automatically created name is referenced by any
other configuration object. For CNS/CNA modules, this operation
should be performed right after the CNS/CNA module set is
configured via CREATE SERVER, if it is performed at all. On GNS
modules, perform this operation before configuring any other
configuration objects.
zerosup N/A Specifies the zero suppression control to be applied on this T1
span:
• none
• jamBit8
• signalFrameOnlyJamBit8
• gteZeroSuppression
• bellZeroSuppression
ecprofile 1-23 The name of an echo canceller profile to be applied to this T1
circuit. See "Echo Canceller Profile" on page 3–743.
circuitid 1-23 The name of the circuit ID.
oper-state N/A The operational state of this T1:
• inservice
• outofservice (default) - must be in this state to enter the
disabled admin-state.
admin-state N/A The administrative state of this T1:
• disabled (default) - Not activated. In this state the T1 can be
reconfigured or deleted.
• enabled - Available for immediate use. This activates a
configured or reconfigured T1.
trap-state N/A The state of legacy trap generation for this T1:
• disabled (default)
• enabled
action N/A The method by which active calls on this T1 are processed when
oper-state outofservice is requested:
• dryup (default) - all active calls are allowed to complete until
the timeout interval expires. When timeout expires the calls
are dropped.
• force - all calls are dropped immediately.
timeout N/A The time (in minutes) to wait to place the T1 in the
outofservice oper-state. Must be 0-1440, default is 5. A
value of 0 causes the change immediately.
pattern N/A Specifies the type of remote loopback to be applied on this switch
for this T1 span:
• none
• qrs - send a Quasi-Random Signal (QRS) test pattern.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference T1 Circuits
Field
Parameter Length Description
nearend N/A The type of local loopback to be applied on this switch for this T1
span:
• noloop (default) - not in the loopback state.
• payloadloop - the received signal is looped back for
retransmission after it has passed through the device’s framing
function.
• lineloop - the received signal at this interface does not go
through the device but is looped back out.
• inwardloop - the transmitted signal at this interface in looped
back and received by the same interface
farend N/A The type of remote loopback to be applied on this switch for this
T1 span:
• sendlinecode - send a request for a line loopback.
• sendpayloadcode - send a request for payload loopback.
• sendresetcode - send a loopback termination request.
interval N/A This number specifies the 15 minute interval for which you seek
statistics. Statistics are stored in “intervals” for every 15 minutes
since the GSX was booted. When 32 intervals (8 hours) are
accumulated, the next interval overwrites the earliest, so that no
more than 8 hours of statistics may be accessed.Interval 1 always
contains the most recent statistics and interval 32 (if existent) the
oldest. Must be 1-32.
cvl15 N/A Line Code Violations (MAJOR, MINOR, or CRITICAL) threshold
value for a 15 minute interval. This number must be 1-16,383,
default is 13,340.
A line code violation is an occurrence of either of the following
conditions:
• a pulse of the same polarity as the previous pulse
• more than 15 contiguous zeroes in AMI coding or more than 7
contiguous zeros in B8ZS coding
This error is detectable only at the near end of CNS10, CNS40,
and CNS45 T1 spans. It is not detectable at the far end of CNS10,
CNS40, or CNS45 T1 spans. It is not detectable at either end of
the logical T1 spans serviced by any other CNS module.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
T1 Circuits CLI Reference
Field
Parameter Length Description
esl15 N/A Line Errored Seconds (MAJOR, MINOR, or CRITICAL) threshold
value for a 15 minute interval. This number must be 1-900, default
is 65.
An Errored Second is a one second interval in which any one or
more of the following error conditions are present:
• path code violation
• out of frame defect
• controlled slip event
• Alarm Indication Signal (AIS) defect - the AIS is a signal
transmitted downstream informing that an upstream failure has
been detected. This signal replaces the normal traffic signal
when a maintenance alarm indication has been activated. AIS
seconds are a count of the number of seconds during which an
AIS signal was detected.
This error is detectable at both ends of CNS10, CNS40, or CNS45
T1 spans. It is not detectable at either end of the logical T1 spans
serviced by any other CNS module.
sesl15 N/A Line Severely Errored Seconds (SES) (MAJOR, MINOR, or
CRITICAL) threshold value for a 15 minute interval. This number
must be 1-900, default is 10.
A Severely Errored Second is a one second interval in which any
one or more of the following error conditions are present:
• 320 or more path code violations (see below)
• out of frame defect
• AIS defect
This error is detectable only at the near end of CNS10, CNS40, or
CN45 T1 spans. It is not detectable at the far end of CNS10,
CNS40, or CNS45 T1 spans. It is not detectable at either end of
the logical T1 spans serviced by any other CNS module.
cvp15 N/A Path Code Violations (MAJOR, MINOR, or CRITICAL) threshold
value for a 15 minute interval. This number must be 1-16,383,
default is 13,296.
A path code violation is a frame synchronization bit error.
esp15 N/A Path Errored Seconds (MAJOR, MINOR, or CRITICAL) threshold
value for a 15 minute interval. This number must be 1-900, default
is 65.
sesp15 N/A Path Severely Errored Seconds threshold value for a 15 minute
interval. This number must be 1-900, default is 10.
sasp15 N/A SEF/AIS Seconds (MAJOR, MINOR, or CRITICAL) threshold
value for a 15 minute interval. This number must be 1-900, default
is 2.
This error is detectable only at the Path level.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference T1 Circuits
Field
Parameter Length Description
sefsp15 N/A Severely Errored Framing Seconds (MAJOR, MINOR, or
CRITICAL) threshold value for a 15 minute interval. This number
must be 1-900, default is 2.
Severely Errored Framing (SEF) is a SONET defect which is the
first indication of trouble in detecting valid signal framing patterns.
Four consecutive errored framing patterns constitutes an SEF
defect. Severely Errored Framing Seconds are a count of the
number of seconds during which an SEF defect was present.
This error is detectable only at the Path level.
cssp15 N/A Controlled Slip Seconds (MAJOR, MINOR, or CRITICAL)
threshold value for a 15 minute interval. This number must be 1-
900, default is 1.
A Controlled Slip Second is a one second interval in which the
information bits received in a frame are replicated or deleted,
except during an unavailable second (see below).
This error is detectable only at the Path level.
uasp15 N/A Unavailable Seconds (MAJOR, MINOR, or CRITICAL) threshold
value for a 15 minute interval. This number must be 1-900, default
is 10.
An unavailable second is a one second interval in which the T1
interface is unavailable. This period could begin with the onset of
10 consecutive SESs or the onset of a condition leading to a
failure. The period ends at the onset of 10 consecutive seconds
without an SES.
This error is detectable only at the Path level.
cvlday N/A Line Code Violations (MAJOR, MINOR, or CRITICAL) threshold
value for a 24 hour interval. This number must be 1-1,048,575,
default is 133,400.
This error is detectable only at the near end of CNS10, CNS40, or
CNS45 T1 spans. It is not detectable at the far end of CNS10,
CNS40, or CNS45 T1 spans. It is not detectable at either end of
the logical T1 spans serviced by any other CNS module.
eslday N/A Line Errored Seconds (MAJOR, MINOR, or CRITICAL) threshold
value for a 24 hour interval. This number must be 1-65,535,
default is 648.
This error is detectable at both ends of CNS10, CNS40, or CNS45
T1 spans. It is not detectable at either end of the logical T1 spans
serviced by any other CNS module.
seslday N/A Line Severely Errored Seconds (SES) (MAJOR, MINOR, or
CRITICAL) threshold value for a 24 hour interval. This number
must be 1-65,535, default is 100
This error is detectable only at the near end of CNS10, CNS40, or
CNS45 T1 spans. It is not detectable at the far end of CNS10,
CNS40, or CNS45 T1 spans. It is not detectable at either end of
the logical T1 spans serviced by any other CNS module.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
T1 Circuits CLI Reference
Field
Parameter Length Description
cvpday N/A Path Code Violations (MAJOR, MINOR, or CRITICAL) threshold
value for a 24 hour interval. This number must be 1-1,048,575,
default is 132,960.
espday N/A Path Errored Seconds (MAJOR, MINOR, or CRITICAL) threshold
value for a 24 hour interval. This number must be 1-65,535,
default is 648.
sespday N/A Path Severely Errored Seconds (MAJOR, MINOR, or CRITICAL)
threshold value for a 24 hour interval. This number must be 1-
65,535, default is 100.
saspday N/A SEF/AIS Seconds (MAJOR, MINOR, or CRITICAL) threshold
value for a 24 hour interval. This number must be 1-65,535,
default is 17.
This error is detectable only at the Path level.
sefspday N/A Severely Errored Framing Seconds (MAJOR, MINOR, or
CRITICAL) threshold value for a 24 hour interval. This number
must be 1-65,535, default is 17.
This error is detectable only at the Path level.
csspday N/A Controlled Slip Seconds (MAJOR, MINOR, or CRITICAL)
threshold value for a 24 hour interval. This number must be 1-
65,535, default is 4.
This error is detectable only at the Path level.
uaspday N/A Unavailable Seconds (MAJOR, MINOR, or CRITICAL) threshold
value for a 24 hour interval. This number must be 1-65,535,
default is 10.
This error is detectable only at the Path level.
tcaf_state N/A Specifies the state of the threshold crossing alert filter for the
particular error type:
• disabled (default) - Do not generate a threshold crossing alert
event when the threshold is exceeded for this error type.
• enabled - Generate a threshold crossing alert event when the
threshold is exceeded for this error type.
See "Regulated Threshold Crossing Alert Reporting" on page 6–
166 for more information.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference T1 Circuits
Command Example
------------------------------------------------------------------------
T1 Summary Shelf: 1 Slot: 9
------------------------------------------------------------------------
Port |DS1 |Circuit Name |State |Alarm Status |Allocated Channels
| | | | |1---------------------24
------------------------------------------------------------------------
1 |1 |T1-1-9-1 |ENABLED |NOALARM |000000000000000000000001
2 |1 |T1-1-9-2 |ENABLED |NOALARM |000000000000000000000001
3 |1 |T1-1-9-3 |ENABLED |NOALARM |000000000000000000000001
4 |1 |T1-1-9-4 |ENABLED |NOALARM |000000000000000000000001
5 |1 |T1-1-9-5 |ENABLED |NOALARM |000000000000000000000001
6 |1 |T1-1-9-6 |ENABLED |NOALARM |000000000000000000000001
7 |1 |T1-1-9-7 |ENABLED |NOALARM |000000000000000000000000
8 |1 |T1-1-9-8 |ENABLED |NOALARM |000000000000000000000000
9 |1 |T1-1-9-9 |ENABLED |NOALARM |000000000000000000000000
10 |1 |T1-1-9-10 |ENABLED |NOALARM |000000000000000000000000
11 |1 |T1-1-9-11 |ENABLED |NOALARM |000000000000000000000000
12 |1 |T1-1-9-12 |ENABLED |NOALARM |000000000000000000000000
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
T1 Circuits CLI Reference
------------------------------------------------------
Shelf: 1 Slot: 9 Port: 12 DS1: 1
------------------------------------------------------
T1 Configuration
------------------------------------------------------
Circuit Name: T1-1-9-12
IfIndex: 59
State: ENABLED
Available Channels: 1-24
Line Type: ESF
Line Coding: B8ZS
Send Code(FarEnd): SENDNOCODE
Circuit Name: T1-1-9-12
Loopback Config(NearEnd): NOLOOP
Signaling Mode: NONE
FDL Type: ANSI
Line Build Out: 110_220FT
Idle Code: 0x7f
Zero Suppression: NONE
Mode: INSERVICE
Timeout (minutes): 5
Circuit Id:
------------------------------------------------------
Echo Canceller Configuration
------------------------------------------------------
Profile Name: default
Echo Return Loss: DB6
Residual Echo Control: COMFORTNOISE
Modem Tone: G165
Narrow Band Detection: OFF
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference T1 Circuits
------------------------------------------------------
Shelf: 1 Slot: 9 Port: 12 DS1: 1
------------------------------------------------------
T1 Status
------------------------------------------------------
Circuit Name: T1-1-9-12
Operational Status: UP
Alarm Status: NOALARM
Loopback Status: NONE
Sending Test Pattern: NONE
Channels:1----------------------24
Enabled Channels: 111111111111111111111111
Allocated Channels: 000000000000000000000000
------------------------------------------------------
Shelf: 1 Slot: 9 Port: 12 DS1: 1
------------------------------------------------------
T1 Error Statistics
------------------------------------------------------
Circuit Name: T1-1-9-12
Total RED Alarm count: 1
Total AIS Alarm count: 1
Total RAI Alarm count: 0
Total LOF Defects: 1
Total AIS Defects: 1
Total RAI Defects: 0
Total Receive Controlled Slips: 9
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
T1 Circuits CLI Reference
----------------------------------------------------------------------
Shelf: 1 Slot: 9 Port: 12 DS1: 1
----------------------------------------------------------------------
T1 Threshold Configuration
----------------------------------------------------------------------
15 Minute Intervals: Minor Major Critical TCA Filter
-----------------------------------------------------------------------
Line Code Violations: 10672 13340 16008 DISABLED
Line Errored Seconds: 52 65 78 DISABLED
Line Severely Errored Seconds: 8 10 12 DISABLED
Path Code Violations: 10637 13296 15955 DISABLED
Path Errored Seconds: 52 65 78 DISABLED
Path Severely Errored Seconds: 8 10 12 DISABLED
SAS Seconds: 1 2 3 DISABLED
Controlled Slip Seconds: 1 2 3 DISABLED
Unavailable Seconds: 8 10 12 DISABLED
------------------------------------------------------------------------
24 Hour Intervals: Minor Major Critical TCA Filter
------------------------------------------------------------------------
Line Code Violations: 106720 133400 160080 DISABLED
Line Errored Seconds: 518 648 778 DISABLED
Line Severely Errored Seconds: 80 100 120 DISABLED
Path Code Violations: 106368 132960 159552 DISABLED
Path Errored Seconds: 518 648 778 DISABLED
Path Severely Errored Seconds: 80 100 120 DISABLED
SAS Seconds: 14 17 20 DISABLED
Controlled Slip Seconds: 4 5 6 DISABLED
Unavailable Seconds: 8 10 12 DISABLED
------------------------------------------------------------------------
TCA Reporting: Minor/Critical DS1 OOS
------------------------------------------------------------------------
DISABLED DISABLED
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference T1 Circuits
To display the current statistics accumulated by the performance monitor during the last 24 hours
for the T1 span t1-1-9-12:
% SHOW T1 t1-1-9-12 PERFMON CURRENT DAY
Node: TPUBS Date: 2005/08/03 22:38:37 GMT
Zone: GMTMINUS05-EASTERN-US
---------------------------------------------------------------------
Shelf: 1 Slot: 9 Port: 12 DS1: 1
---------------------------------------------------------------------
T1 Current Performance Monitoring Statistics
---------------------------------------------------------------------
Elapsed Time: 403
---------------------------------------------------------------------
Minor Major Critical
Near End Line Parameters Errors TCA TCA TCA
---------------------------------------------------------------------
Code Violations: 0 FALSE FALSE FALSE
Errored Seconds: 0 FALSE FALSE FALSE
Severely Errored Seconds: 0 FALSE FALSE FALSE
---------------------------------------------------------------------
Minor Major Critical
Near End Path Parameters Errors TCA TCA TCA
---------------------------------------------------------------------
Code Violations: 0 FALSE FALSE FALSE
Errored Seconds: 1 FALSE FALSE FALSE
Severely Errored Seconds: 3 FALSE FALSE FALSE
SEF/AIS Seconds: 0 FALSE FALSE FALSE
Controlled Slip Seconds: 0 FALSE TRUE TRUE
Unavailable Seconds: 0 FALSE FALSE FALSE
Failure Count: 0 - - -
---------------------------------------------------------------------
Minor Major Critical
Far End Line Paramaters Errors TCA TCA TCA
---------------------------------------------------------------------
Errored Seconds: N/A FALSE FALSE FALSE
---------------------------------------------------------------------
Minor Major Critical
Far End Path Parameters Errors TCA TCA TCA
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
T1 Circuits CLI Reference
---------------------------------------------------------------------
Code Violations: 0 FALSE FALSE FALSE
Errored Seconds: 0 FALSE FALSE FALSE
Severely Errored Seconds: 0 FALSE FALSE FALSE
Severely Errored Frame Seconds: 0 FALSE FALSE FALSE
Controlled Slip Seconds: 0 FALSE FALSE FALSE
Unavailable Seconds: 0 FALSE FALSE FALSE
Failure Count: 0 - - -
To reset the current Near End Path statistics on T1 span t1-1-9-12 and then redisplay those
current statistics, showing the immediate effect of that action:
% CONFIGURE T1 t1-1-9-12 PERFMON RESET COUNTERS ..
NEAREND DAY PATH
% SHOW T1 t1-1-9-12 PERFMON CURRENT DAY
Node: TPUBS Date: 2005/08/03 22:38:37 GMT
Zone: GMTMINUS05-EASTERN-US
---------------------------------------------------------------------
Shelf: 1 Slot: 9 Port: 12 DS1: 1
---------------------------------------------------------------------
T1 Current Performance Monitoring Statistics
---------------------------------------------------------------------
Elapsed Time: 403
---------------------------------------------------------------------
Minor Major Critical
Near End Line Parameters Errors TCA TCA TCA
---------------------------------------------------------------------
Code Violations: 0 FALSE FALSE FALSE
Errored Seconds: 0 FALSE FALSE FALSE
Severely Errored Seconds: 0 FALSE FALSE FALSE
---------------------------------------------------------------------
Minor Major Critical
Near End Path Parameters Errors TCA TCA TCA
---------------------------------------------------------------------
Code Violations: 0 FALSE FALSE FALSE
Errored Seconds: 0 FALSE FALSE FALSE
Severely Errored Seconds: 0 FALSE FALSE FALSE
SEF/AIS Seconds: 0 FALSE FALSE FALSE
Controlled Slip Seconds: 0 FALSE TRUE TRUE
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference T1 Circuits
To reset all Near End and Far End Path and Line statistics on T1 span t1-1-9-12:
% CONFIGURE T1 t1-1-9-12 INITIALIZE STATISTICS
To enable threshold crossing alerts for unavailable seconds (which are disabled by default) on a T1
span:
% CONFIGURE T1 t1-1-9-12 PERFMON TCA FILTER UAS-P enabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
T1 Circuits CLI Reference
T1 Channels
This object allows you to further configure the T1 object, described previously, by providing
access to a subset of the 24 channels that comprise the T1. You may access an individual channel
or a group of channels through this object.
The default operational state is inservice, where all channels are available for use. Changing the
operational state to outofservice leaves the channels available for maintenance use. In this
state you can configure the T1 channels to run loopback and tone sequences shown below in the
command syntax.
TABLE 3–134
From
(operational
state) Changing to (operational state)
inservice outofservice
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference T1 Circuits
Command Syntax
Command Parameters
Field
Parameter Length Description
t1name 1-23 The automatically assigned (and possibly changed) name of the
T1 span that contains these channels. See the beginning of the T1
section for the structure of the default name.
chrange N/A The set of T1 channels that are being configured. Maximum range
is 1-24, default is 1-24 (a full T1). Any discrete set of channels
within this range may be specified as discussed below.
All CLI ranges specify a comma-separated list of numbers and/or
ranges. A range consists of two numbers separated by a dash, for
example, 5-8. An increment can be specified after a range with the
notation, +<incr>, for example 4-10+2. No spaces are permitted in
the expression. All values and ranges must be in numerically
ascending order. Thus the expression:
1,3,5,8-12+2,14-16
is a valid range specification for the numbers:
1,3,5,8,10,12,14,15, and 16.
chnum N/A The single channel being configured into this object. Must be in
the range 1-24.
idlecode N/A This value is inserted in these channels when they are idle. Must
be 0-255, default is 127 (0x7F).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
T1 Circuits CLI Reference
Field
Parameter Length Description
oper-state N/A The operational state of these T1 channels:
• inservice
• outofservice (default) - must be in this state for loopback
and tone testing.
action N/A The method by which active calls on this T1 are processed when
oper-state outofservice is requested:
• dryup (default) - all active calls are allowed to complete until
the timeout interval expires. When timeout expires the calls
are dropped.
• force - all calls are dropped immediately.
timeout N/A The time (in minutes) to wait to place the T1 channels in the
outofservice oper-state. Must be 0-1440, default is 5. A
value of 0 causes the change immediately.
tonetype N/A The type of test tone to be applied on these channels when they
are outofservice and loopback is enabled:
• none (default)
• dmw (Digital Milliwatt 1000 Hz)
loopback N/A The state of local loopback on the channels:
• disabled (default)
• enabled
Command Example
To configure channels 10-12 on the T1 span t1-1-3-1 to outofservice, to put them in local
loopback mode:
NOTE
This function must operate on an individual channel rather than a range.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference T1 Circuits
------------------------------------------------------
Channel Admin
Shelf: 1 Slot: 9 Port: 1 DS1: 1
------------------------------------------------------
Channel: 10
State: AVAILABLE
Mode: INSERVICE
Idle Code: 0x7f
Tone: NONE
Loopback: DISABLED
------------------------------------------------------
Channel: 11
State: AVAILABLE
Mode: INSERVICE
Idle Code: 0x7f
Tone: NONE
Loopback: DISABLED
------------------------------------------------------
Channel: 12
State: AVAILABLE
Mode: INSERVICE
Idle Code: 0x7f
Tone: NONE
Loopback: DISABLED
------------------------------------------------------
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
E1 Circuits CLI Reference
E1 Circuits
These objects specify the E1 links connected to the Circuit Network Adapters on the GSX9000,
and Gateway Network Adapters (GNA10) on the GSX4010.
Before configuring E1 circuits on a GSX4010 switch, you configure the DS1 mode to specify
which circuit type will be used (T1 or E1). See the "DS1 Ports" object on page 3–574 for more
information.
E1 Profile
This object creates a template for the E1 objects (below). E1 objects that are configured with a
profile will silently take every parameter value specified in the profile unless explicitly overridden.
PERFMON Thresholds
The Performance Monitor (PERFMON) THRESHOLD parameters shown below are for specific types
of interface error conditions. Error counts of this magnitude will trigger an event log entry or trap
notification for each threshold level (MAJOR, CRITICAL, or MINOR) of each associated type of
error, for an interval of either fifteen minutes or twenty-four hours. When you configure a
threshold for an individual error type, the identical threshold value is established at both the near
and far end of the E1 circuit. You may specify the threshold level, the threshold value, the error
type, the interval length, and the error level (line or path). (Line error levels are detectable only for
certain error types on E1 spans serviced by CNS20s, CNS25s, CNS40s, or CNS45s; all other E1
spans detect these errors on a path level only.) You may zero out (PERFMON RESET) the
accumulated counts for these errors on the near or far end, for either interval, and for either error
level. The counts for all the error types, rather than for individual error types, will be zeroed out.
By default, only MAJOR threshold levels are reported when the E1 PROFILE is enabled. To
include MINOR and CRITICAL threshold levels in the reporting you must enable TCA REPORT
MINORCRITICAL. Enabling MINORCRITICAL will also enable the reporting of the beginning
of a new performance monitoring time interval (15 minutes or 24 hours). These interval crossings
will not otherwise be reported.
By default, when a span is taken out of service for any reason, threshold crossing events for that
span are not reported until the span is placed back into service. You may override this policy and
cause continued reporting of threshold crossing events on spans that are out of service by enabling
TCA REPORT DS1OOS. This applies whether the span was taken out of service manually or
automatically (by exceeding MAJOR threshold levels).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference E1 Circuits
Threshold crossing alerts may be selectively enabled or disabled for each error type via TCA
FILTER. See "Alarm and Threshold Crossing Reporting Hierarchies" on page 6–163 for more
information.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
E1 Circuits CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference E1 Circuits
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
E1 Circuits CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference E1 Circuits
Command Parameters
Field
Parameter Length Description
e1profile 1-23 The name of the profile that can be applied to an E1 object.
buildout N/A The drive capacity of the E1 wire:
• 120_OHMS (default)
linetype N/A The frame format used on the E1:
• e1 (default)
• e1crc - E1 Cyclic Redundancy check
coding N/A The E1 line coding:
• hdb3 (default) - High Density Bipolar of order 3 code.
signaling N/A Signaling used for this E1:
• none (default)
• bitOriented - required for CAS
idlecode N/A This value is inserted in these channels when they are idle. Must
be 0-255, default is 84 (0x54).
avchannels N/A The set of E1 channels that are being configured. Maximum range
is 1-31, default is 1-31 (a full E1). Any discrete set of channels
within this range may be specified as discussed below.
All CLI ranges specify a comma-separated list of numbers and/or
ranges. A range consists of two numbers separated by a dash, for
example, 5-8. An increment can be specified after a range with the
notation, +<incr>, for example 4-10+2. No spaces are permitted in
the expression. All values and ranges must be in numerically
ascending order. Thus the expression:
1,3,5,8-12+2,14-16
is a valid range specification for the numbers:
1,3,5,8,10,12,14,15, and 16.
admin-state N/A The administrative state of this E1 profile:
• disabled (default) - Not activated, able to be configured or
deleted.
• enabled - Activated, available for immediate use.
cvl15 N/A Line Code Violations (MAJOR, MINOR, or CRITICAL) threshold
value for a 15 minute interval. This number must be 1-16,383,
default is 13,340.
A line code violation is an occurrence of either of the following
conditions:
• a pulse of the same polarity as the previous pulse
• more than 15 contiguous zeroes in AMI coding or more than 7
contiguous zeros in B8ZS coding
This error is detectable only at the near end of E1 spans.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
E1 Circuits CLI Reference
Field
Parameter Length Description
esl15 N/A Line Errored Seconds (MAJOR, MINOR, or CRITICAL) threshold
value for a 15 minute interval. This number must be 1-900, default
is 65.
An Errored Second is a one second interval in which any one or
more of the following error conditions are present:
• path code violation
• out of frame defect
• controlled slip event
• Alarm Indication Signal (AIS) defect - the AIS is a signal
transmitted downstream informing that an upstream failure has
been detected. This signal replaces the normal traffic signal
when a maintenance alarm indication has been activated. AIS
seconds are a count of the number of seconds during which an
AIS signal was detected.
This error is detectable at both ends of E1 spans.
sesl15 N/A Line Severely Errored Seconds (SES) (MAJOR, MINOR, or
CRITICAL) threshold value for a 15 minute interval. This number
must be 1-900, default is 10.
A Severely Errored Second is a one second interval in which any
one or more of the following error conditions are present:
• 320 or more path code violations (see below)
• out of frame defect
• AIS defect
This error is detectable only at the near end of E1 spans.
cvp15 N/A Path Code Violations (MAJOR, MINOR, or CRITICAL) threshold
value for a 15 minute interval. This number must be 1-16,383,
default is 13,296.
A path code violation is a frame synchronization bit error.
esp15 N/A Path Errored Seconds (MAJOR, MINOR, or CRITICAL)
threshold value for a 15 minute interval. This number must be 1-
900, default is 65.
sesp15 N/A Path Severely Errored Seconds (MAJOR, MINOR, or CRITICAL)
threshold value for a 15 minute interval. This number must be 1-
900, default is 10.
sasp15 N/A SEF/AIS Seconds (MAJOR, MINOR, or CRITICAL) threshold
value for a 15 minute interval. This number must be 1-900, default
is 2.
This error is detectable only at the Path level.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference E1 Circuits
Field
Parameter Length Description
cssp15 N/A Controlled Slip Seconds (MAJOR, MINOR, or CRITICAL)
threshold value for a 15 minute interval. This number must be 1-
900, default is 1.
A Controlled Slip Second is a one second interval in which the
information bits received in a frame are replicated or deleted,
except during an unavailable second (see below).
This error is detectable only at the Path level.
uasp15 N/A Unavailable Seconds (MAJOR, MINOR, or CRITICAL) threshold
value for a 15 minute interval. This number must be 1-900, default
is 10.
An unavailable second is a one second interval in which the T1
interface is unavailable. This period could begin with the onset of
10 consecutive SESs or the onset of a condition leading to a
failure. The period ends at the onset of 10 consecutive seconds
without an SES.
This error is detectable only at the Path level.
cvlday N/A Line Code Violations (MAJOR, MINOR, or CRITICAL) threshold
value for a 24 hour interval. This number must be 1-1,048,575,
default is 133,400.
This error is detectable only at the near end of E1 spans.
eslday N/A Line Errored Seconds (MAJOR, MINOR, or CRITICAL) threshold
value for a 24 hour interval. This number must be 1-65,535,
default is 648.
This error is detectable at both ends of E1 spans.
seslday N/A Line Severely Errored Seconds (SES) (MAJOR, MINOR, or
CRITICAL) threshold value for a 24 hour interval. This number
must be 1-65,535, default is 100
This error is detectable only at the near end of E1 spans.
cvpday N/A Path Code Violations (MAJOR, MINOR, or CRITICAL) threshold
value for a 24 hour interval. This number must be 1-1,048,575,
default is 132,960.
espday N/A Path Errored Seconds (MAJOR, MINOR, or CRITICAL) threshold
value for a 24 hour interval. This number must be 1-65,535,
default is 648.
sespday N/A Path Severely Errored Seconds (MAJOR, MINOR, or CRITICAL)
threshold value for a 24 hour interval. This number must be 1-
65,535, default is 100.
saspday N/A SEF/AIS Seconds (MAJOR, MINOR, or CRITICAL) threshold
value for a 24 hour interval. This number must be 1-65,535,
default is 17.
This error is detectable only at the Path level.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
E1 Circuits CLI Reference
Field
Parameter Length Description
csspday N/A Controlled Slip Seconds (MAJOR, MINOR, or CRITICAL)
threshold value for a 24 hour interval. This number must be 1-
65,535, default is 4.
This error is detectable only at the Path level.
uaspday N/A Unavailable Seconds (MAJOR, MINOR, or CRITICAL) threshold
value for a 24 hour interval. This number must be 1-65,535,
default is 10.
This error is detectable only at the Path level.
tcaf_state N/A Specifies the state of the threshold crossing alert filter for the
particular error type:
• disabled (default) - Do not generate a threshold crossing alert
event when the threshold is exceeded for this error type.
• enabled - Generate a threshold crossing alert event when the
threshold is exceeded for this error type.
See "Regulated Threshold Crossing Alert Reporting" on page 6–
166 for more information.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference E1 Circuits
Command Example
----------------------------------------------------------------------
E1 Profile
----------------------------------------------------------------------
Index: 1
State: ENABLED
Type: E1
Available Channels: 1-31
Line Type: E1CRC
Line Coding: HDB3
Signaling Mode: NONE
Line Build Out: 120_OHMS
Idle Code: 0x54
-----------------------------------------------------------------------
E1 Threshold Configuration
-----------------------------------------------------------------------
15 Minute Intervals: Minor Major Critical TCA Filter
-----------------------------------------------------------------------
Line Code Violations: 10672 13340 16008 DISABLED
Line Errored Seconds: 52 65 78 DISABLED
Line Severely Errored Seconds: 8 10 12 DISABLED
Path Code Violations: 10637 13296 15955 DISABLED
Path Errored Seconds: 52 65 78 DISABLED
Path Severely Errored Seconds: 8 10 12 DISABLED
SAS Seconds: 1 2 3 DISABLED
Controlled Slip Seconds: 1 2 3 DISABLED
Unavailable Seconds: 8 10 12 DISABLED
------------------------------------------------------------------------
24 Hour Intervals: Minor Major Critical TCA Filter
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
E1 Circuits CLI Reference
------------------------------------------------------------------------
Line Code Violations: 106720 133400 160080 DISABLED
Line Errored Seconds: 518 648 778 DISABLED
Line Severely Errored Seconds: 80 100 120 DISABLED
Path Code Violations: 106368 132960 159552 DISABLED
Path Errored Seconds: 518 648 778 DISABLED
Path Severely Errored Seconds: 80 100 120 DISABLED
SAS Seconds: 14 17 20 DISABLED
Controlled Slip Seconds: 4 5 6 DISABLED
Unavailable Seconds: 8 10 12 DISABLED
------------------------------------------------------------------------
TCA Reporting: Minor/Critical DS1 OOS
------------------------------------------------------------------------
DISABLED DISABLED
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference E1 Circuits
E1
This object specifies an E1 circuit that is supported by a Circuit Network Server (CNS) on the
GSX9000, and a Gateway Network Server (GNS) on a GSX4000 series switch. The E1 circuit is
assigned all 31 channels by default, but any subset of those 31 channels may be specified.
Eight E1 objects or spans are automatically created and named when a CNS20 module set is added
to the GSX9000 via the CREATE SERVER .. ADAPTER command. See "Server" on page 3–17 for
additional information. Twelve spans are created for a CNS25 module set. On a GSX4010, 24 E1
objects or spans are automatically created and named upon installation of the switch.
No additional E1 objects may be created nor may the automatically created (and possibly
renamed) E1s be directly deleted. These E1s are removed from a GSX9000 only when the CNS20,
CNS25, CNS40, or CNS45 module set is removed via the DELETE SERVER .. ADAPTER
command.
Naming Conventions
GSX4000 – the default name of a E1 object serviced by the GNS15 does not include a shelf and
slot designation. Therefore the naming convention is E1-port, where port is the port number (1-
12). For example, E1-2 identifies the second E1 port that connects to the port on the GSX4000.
This name may be changed via the CONFIGURE E1..NAME command shown in the command
syntax below. Renaming must be performed while the E1 is disabled and before any other
configuration commands are issued.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
E1 Circuits CLI Reference
E1 Statistics
The STATISTICS associated with this object are kept for fifteen minute intervals, up to a total of
32 intervals or eight hours. INITIALIZE STATISTICS resets the current statistics for fifteen
minute intervals as well as for the DAY interval. SHOW .. STATISTICS always summarizes
statistics for the previous intervals since the GSX was booted, or the previous 32 intervals,
whichever is less. The DAY statistics are collected independently from the fifteen minute intervals.
These results always reflect the last 24 hours of activity. Thus, when the 32nd fifteen minute
interval expires and the first interval is overwritten, the DAY collection continues without
overwriting statistics that are 8 hours old. Statistics that are more than 24 hours old are
overwritten.
PERFMON Thresholds
The Performance Monitor (PERFMON) THRESHOLD parameters shown below are for specific types
of interface error conditions. Error counts of this magnitude will trigger an event log entry or trap
notification for each threshold level (MAJOR, CRITICAL, or MINOR) of each associated type of
error, for an interval of either fifteen minutes or twenty-four hours. When you configure a
threshold for an individual error type, the identical threshold value is established at both the near
and far end of the E1 circuit. You may specify the threshold level, the threshold value, the error
type, the interval length, and the error level (line or path). (Line error levels are detectable only for
certain error types on E1 spans serviced by CNS20s, CNS25s CNS40s, or CNS45s; all other E1
spans detect these errors on a path level only.) You may zero out (PERFMON RESET) the
accumulated counts for these errors on the near or far end, for either interval, and for either error
level. The counts for all the error types, rather than for individual error types, will be zeroed out.
By default, only MAJOR threshold levels are reported when the E1 is enabled. To include MINOR
and CRITICAL threshold levels in the reporting you must enable TCA REPORT
MINORCRITICAL. Enabling MINORCRITICAL will also enable the reporting of the beginning
of a new performance monitoring time interval (15 minutes or 24 hours). These interval crossings
will not otherwise be reported.
By default, when a span is taken out of service for any reason, threshold crossing events for that
span are not reported until the span is placed back into service. You may override this policy and
cause continued reporting of threshold crossing events on spans that are out of service by enabling
TCA REPORT DS1OOS. This applies whether the span was taken out of service manually or
automatically (by exceeding MAJOR threshold levels).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference E1 Circuits
Threshold crossing alerts may be selectively enabled or disabled for each error type via TCA
FILTER. See "Alarm and Threshold Crossing Reporting Hierarchies" on page 6–163 for more
information.
• enabled
• disabled
• inservice
• outofservice
The default operational state is outofservice, where all channels are available for maintenance
use. In this state you can configure the E1 to run the loopback sequences shown below in the
command syntax. Changing the operational state to inservice makes the channels available for
general use.
TABLE 3–137
From
(operational
state) Changing to (operational state)
inservice outofservice
The CONFIGURE E1 SHELF.. commands provide a means of changing the administrative and
operational states of all the E1s in an optical (or other) port with a single command.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
E1 Circuits CLI Reference
Command Syntax
NOTE
When issuing E1 commands on a GSX4000 series switch, omit the SHELF and
SLOT parameters.
CONFIGURE E1 e1name ..
PROFILE e1profile
BUILDOUT buildout
LINETYPE linetype
CODING coding
SIGNALING signaling
IDLECODE idlecode
AVAILABLE CHANNELS avchannels
ECHO PROFILE ecprofile
CIRCUIT ID circuitid
CONFIGURE E1 e1name INITIALIZE STATISTICS
CONFIGURE E1 e1name LEGACY TRAPGENERATION trap-state
CONFIGURE E1 e1name NAME newe1name
CONFIGURE E1 e1name STATE admin-state
CONFIGURE E1 e1name LOOPBACK NEAREND nearend
CONFIGURE E1 e1name MODE oper-state ..
CONFIGURE E1 e1name MODE oper-state ACTION action
CONFIGURE E1 e1name MODE oper-state ACTION action TIMEOUT timeout
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference E1 Circuits
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
E1 Circuits CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference E1 Circuits
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
E1 Circuits CLI Reference
Command Parameters
Field
Parameter Length Description
e1name 1-23 The automatically assigned (and possibly changed) name of the
E1 span. See the beginning of this section for the structure of the
default name.
shelf N/A The shelf number in the GSX node configuration. In this release,
one shelf is supported. Must be 1.
Note: This parameter does not apply to GSX4000 series switches.
slotno N/A The slot number occupied by the circuit network module that
supports this E1. Must be 3-16.
Note: This parameter does not apply to GSX4000 series switches.
port N/A The CNS or GNS port number for the E1 spans referenced by this
command. Must be 1.
spanrange N/A The set of E1 spans referenced by this command. Must be:
• 1-8 for a CNS20
• 1-12 for a CNS25
• 1-36 for a CNS40 or CNS45
• 1-63 for CNS71, CNS81, or CNS86 T1s
• 1-24 for a GSX4010
Any discrete set of spans within these ranges may be specified as
discussed below.
All CLI ranges specify a comma-separated list of numbers and/or
ranges. A range consists of two numbers separated by a dash, for
example, 5-8. An increment can be specified after a range with the
notation, +<incr>, for example 4-10+2. No spaces are permitted in
the expression. All values and ranges must be in numerically
ascending order. Thus the expression:
1,3,5,8-12+2,14-16
is a valid range specification for the numbers:
1,3,5,8,10,12,14,15, and 16.
e1profile 1-23 The name of the profile to be applied to this E1 object.
buildout N/A The drive capacity of the E1 wire:
• 120_OHMS (default)
linetype N/A The frame format used on the E1:
• e1 (default)
• e1crc - E1 Cyclic Redundancy Check.
coding N/A The E1 line coding:
• hdb3 (default) - High Density Bipolar of order 3 code.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference E1 Circuits
Field
Parameter Length Description
signaling N/A Signaling used for this E1:
• none (default)
• bitOriented - required for CAS
ecprofile 1-23 The name of an echo canceller profile to be applied to this E1
circuit. See "Echo Canceller Profile" on page 3–743.
circuitid 1-23 The name of the circuit ID.
idlecode N/A This value is inserted in an idle channel. Must be 0-255, default is
84 (0x54).
avchannels N/A The set of E1 channels that are being configured. Maximum range
is 1-31, default is 1-31 (a full E1). Any discrete set of channels
within this range may be specified as discussed below.
All CLI ranges specify a comma-separated list of numbers and/or
ranges. A range consists of two numbers separated by a dash, for
example, 5-8. An increment can be specified after a range with the
notation, +<incr>, for example 4-10+2. No spaces are permitted in
the expression. All values and ranges must be in numerically
ascending order. Thus the expression:
1,3,5,8-12+2,14-16
is a valid range specification for the numbers:
1,3,5,8,10,12,14,15, and 16.
newe1name 1-23 A new name for an E1 span. The renaming operation will not be
allowed if the automatically created name is referenced by any
other configuration object. For CNS20/CNA20, CNS40/CNA40 or
CNS45/CNA40 modules, this operation should be performed right
after the module set is configured via CREATE SERVER, if it is
performed at all. On GNS modules, perform this operation before
configuring any other configuration objects.
oper-state N/A The operational state of this E1:
• inservice -
• outofservice (default) - must be in this state to enter the
disabled admin-state.
admin-state N/A The administrative state of this E1:
• disabled (default) - Not activated. In this state the E1 can be
reconfigured or deleted.
• enabled - Available for immediate use. This activates a
configured or reconfigured E1.
trap-state N/A The state of legacy trap generation for this E1:
• disabled (default)
• enabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
E1 Circuits CLI Reference
Field
Parameter Length Description
action N/A The method by which active calls on this E1 are processed when
oper-state outofservice is requested:
• dryup (default) - all active calls are allowed to complete until
the timeout interval expires. When timeout expires the calls
are dropped.
• force - all calls are dropped immediately.
timeout N/A The time (in minutes) to wait to place the E1 in the
outofservice oper-state. Must be 0-1440, default is 5. A
value of 0 causes the change immediately.
nearend N/A The type of local loopback to be applied on this switch for this E1
span:
• noloop (default) - not in the loopback state.
• lineloop - the received signal at this interface does not go
through the device but is looped back out.
• inwardloop - the transmitted signal at this interface in looped
back and received by the same interface
• dualloop - both lineloop and inwardloop are active
simultaneously.
interval N/A This number specifies the 15 minute interval for which you seek
statistics. Statistics are stored in “intervals” for every 15 minutes
since the GSX was booted. When 32 intervals (8 hours) are
accumulated, the next interval overwrites the earliest, so that no
more than 8 hours of statistics may be accessed.Interval 1 always
contains the most recent statistics and interval 32 (if existent) the
oldest. Must be 1-32.
cvl15 N/A Line Code Violations (MAJOR, MINOR, or CRITICAL) threshold
value for a 15 minute interval. This number must be 1-16,383,
default is 13,340.
A line code violation is an occurrence of either of the following
conditions:
• a pulse of the same polarity as the previous pulse
• more than 15 contiguous zeroes in AMI coding or more than 7
contiguous zeros in B8ZS coding
This error is detectable only at the near end of E1 spans.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference E1 Circuits
Field
Parameter Length Description
esl15 N/A Line Errored Seconds (MAJOR, MINOR, or CRITICAL) threshold
value for a 15 minute interval. This number must be 1-900, default
is 65.
An Errored Second is a one second interval in which any one or
more of the following error conditions are present:
• path code violation
• out of frame defect
• controlled slip event
• Alarm Indication Signal (AIS) defect - the AIS is a signal
transmitted downstream informing that an upstream failure has
been detected. This signal replaces the normal traffic signal
when a maintenance alarm indication has been activated. AIS
seconds are a count of the number of seconds during which an
AIS signal was detected.
This error is detectable at both ends of E1 spans.
sesl15 N/A Line Severely Errored Seconds (SES) (MAJOR, MINOR, or
CRITICAL) threshold value for a 15 minute interval. This number
must be 1-900, default is 10.
A Severely Errored Second is a one second interval in which any
one or more of the following error conditions are present:
• 320 or more path code violations (see below)
• out of frame defect
• AIS defect
This error is detectable only at the near end of E1 spans.
cvp15 N/A Path Code Violations (MAJOR, MINOR, or CRITICAL) threshold
value for a 15 minute interval. This number must be 1-16,383,
default is 13,296.
A path code violation is a frame synchronization bit error.
esp15 N/A Path Errored Seconds (MAJOR, MINOR, or CRITICAL) threshold
value for a 15 minute interval. This number must be 1-900, default
is 65.
sesp15 N/A Path Severely Errored Seconds (MAJOR, MINOR, or CRITICAL)
threshold value for a 15 minute interval. This number must be 1-
900, default is 10.
sasp15 N/A SEF/AIS Seconds (MAJOR, MINOR, or CRITICAL) threshold
value for a 15 minute interval. This number must be 1-900, default
is 2.
This error is detectable only at the Path level.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
E1 Circuits CLI Reference
Field
Parameter Length Description
cssp15 N/A Controlled Slip Seconds (MAJOR, MINOR, or CRITICAL)
threshold value for a 15 minute interval. This number must be 1-
900, default is 1.
A Controlled Slip Second is a one second interval in which the
information bits received in a frame are replicated or deleted,
except during an unavailable second (see below).
This error is detectable only at the Path level.
uasp15 N/A Unavailable Seconds (MAJOR, MINOR, or CRITICAL) threshold
value for a 15 minute interval. This number must be 1-900, default
is 10.
An unavailable second is a one second interval in which the T1
interface is unavailable. This period could begin with the onset of
10 consecutive SESs or the onset of a condition leading to a
failure. The period ends at the onset of 10 consecutive seconds
without an SES.
This error is detectable only at the Path level.
cvlday N/A Line Code Violations (MAJOR, MINOR, or CRITICAL) threshold
value for a 24 hour interval. This number must be 1-1,048,575,
default is 133,400.
This error is detectable only at the near end of E1 spans.
eslday N/A Line Errored Seconds (MAJOR, MINOR, or CRITICAL) threshold
value for a 24 hour interval. This number must be 1-65,535,
default is 648.
This error is detectable at both ends of E1 spans.
seslday N/A Line Severely Errored Seconds (SES) (MAJOR, MINOR, or
CRITICAL) threshold value for a 24 hour interval. This number
must be 1-65,535, default is 100
This error is detectable only at the near end of E1 spans.
cvpday N/A Path Code Violations (MAJOR, MINOR, or CRITICAL) threshold
value for a 24 hour interval. This number must be 1-1,048,575,
default is 132,960.
espday N/A Path Errored Seconds (MAJOR, MINOR, or CRITICAL)
threshold value for a 24 hour interval. This number must be 1-
65,535, default is 648.
sespday N/A Path Severely Errored Seconds (MAJOR, MINOR, or CRITICAL)
threshold value for a 24 hour interval. This number must be 1-
65,535, default is 100.
saspday N/A SEF/AIS Seconds (MAJOR, MINOR, or CRITICAL) threshold
value for a 24 hour interval. This number must be 1-65,535,
default is 17.
This error is detectable only at the Path level.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference E1 Circuits
Field
Parameter Length Description
csspday N/A Controlled Slip Seconds (MAJOR, MINOR, or CRITICAL)
threshold value for a 24 hour interval. This number must be 1-
65,535, default is 4.
This error is detectable only at the Path level.
uaspday N/A Unavailable Seconds (MAJOR, MINOR, or CRITICAL) threshold
value for a 24 hour interval. This number must be 1-65,535,
default is 10.
This error is detectable only at the Path level.
tcaf_state N/A Specifies the state of the threshold crossing alert filter for the
particular error type:
• disabled (default) - Do not generate a threshold crossing alert
event when the threshold is exceeded for this error type.
• enabled - Generate a threshold crossing alert event when the
threshold is exceeded for this error type.
See "Regulated Threshold Crossing Alert Reporting" on page 6–
166 for more information.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
E1 Circuits CLI Reference
Command Example
--------------------------------------------------------------------------------
E1 Summary Shelf: 1 Slot: 6
--------------------------------------------------------------------------------
Port |DS1 |Circuit Name |State |Alarm Status |Allocated Channels
| | | | |1--------------------------31
--------------------------------------------------------------------------------
1 |1 |E1-1-6-1 |ENABLED |NOALARM |0000000000000000000000000000000
2 |1 |E1-1-6-2 |ENABLED |NOALARM |0000000000000000000000000000000
3 |1 |E1-1-6-3 |ENABLED |NOALARM |0000000000000000000000000000000
4 |1 |E1-1-6-4 |ENABLED |NOALARM |0000000000000000000000000000000
5 |1 |E1-1-6-5 |ENABLED |NOALARM |0000000000000000000000000000000
6 |1 |E1-1-6-6 |ENABLED |NOALARM |0000000000000000000000000000000
7 |1 |E1-1-6-7 |ENABLED |NOALARM |0000000000000001000000000000000
8 |1 |E1-1-6-8 |ENABLED |NOALARM |0000000000000001000000000000000
9 |1 |E1-1-6-9 |ENABLED |NOALARM |0000000000000001000000000000000
10 |1 |E1-1-6-10 |ENABLED |NOALARM |0000000000000001000000000000000
11 |1 |E1-1-6-11 |ENABLED |NOALARM |0000000000000001000000000000000
12 |1 |E1-1-6-12 |ENABLED |NOALARM |0000000000000001000000000000000
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference E1 Circuits
------------------------------------------------------
Shelf: 1 Slot: 5 Port: 2 DS1: 1
------------------------------------------------------
E1 Status
-----------------------------------------------------------
Circuit Name: E1-1-5-2
Operational Status: UP
Alarm Status: NOALARM
Loopback Status: NONE
Sending Test Pattern: NONE
Channels:1----------------------------31
Enabled Channels: 1111111111111111111111111111111
Allocated Channels: 0000000000000000000000000000000
------------------------------------------------------
Shelf: 1 Slot: 6 Port: 2 DS1: 1
------------------------------------------------------
E1 Configuration
------------------------------------------------------
Circuit Name: E1-1-6-2
IfIndex: 41
State: ENABLED
Line Type: E1CRC
Line Coding: HDB3
Loopback Config (Near End): NOLOOP
Signaling Mode: NONE
Available Channels: 1-31
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
E1 Circuits CLI Reference
------------------------------------------------------
Shelf: 1 Slot: 6 Port: 2 DS1: 1
------------------------------------------------------
E1 Error Statistics
------------------------------------------------------
Circuit Name: E1-1-6-2
Total RED alarm count: 1
Total AIS alarm count: 1
Total RAI alarm count: 0
Total LOF Defects: 1
Total AIS Defects: 1
Total RAI Defects: 0
Total Receive Controlled Slips: 0
Total Transmit Controlled Slips: 0
Total FAS Errors: 0
Total CRC Errors: 0
Total Far End Block Errors: 0
Valid 15 min Performance Intervals: 32
Valid 24 hour Performance Intervals: 1
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference E1 Circuits
----------------------------------------------------------------------
Shelf: 1 Slot: 6 Port: 2 DS1: 1
----------------------------------------------------------------------
E1 Threshold Configuration
-----------------------------------------------------------------------
15 Minute Intervals: Minor Major Critical TCA Filter
-----------------------------------------------------------------------
Line Code Violations: 10672 13340 16008 DISABLED
Line Errored Seconds: 52 65 78 DISABLED
Line Severely Errored Seconds: 8 10 12 DISABLED
Path Code Violations: 10637 13296 15955 DISABLED
Path Errored Seconds: 52 65 78 DISABLED
Path Severely Errored Seconds: 8 10 12 DISABLED
SAS Seconds: 1 2 3 DISABLED
Controlled Slip Seconds: 1 2 3 DISABLED
Unavailable Seconds: 8 10 12 DISABLED
------------------------------------------------------------------------
24 Hour Intervals: Minor Major Critical TCA Filter
------------------------------------------------------------------------
Line Code Violations: 106720 133400 160080 DISABLED
Line Errored Seconds: 518 648 778 DISABLED
Line Severely Errored Seconds: 80 100 120 DISABLED
Path Code Violations: 106368 132960 159552 DISABLED
Path Errored Seconds: 518 648 778 DISABLED
Path Severely Errored Seconds: 80 100 120 DISABLED
SAS Seconds: 14 17 20 DISABLED
Controlled Slip Seconds: 4 5 6 DISABLED
Unavailable Seconds: 8 10 12 DISABLED
------------------------------------------------------------------------
TCA Reporting: Minor/Critical DS1 OOS
------------------------------------------------------------------------
DISABLED DISABLED
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
E1 Circuits CLI Reference
To display the current statistics accumulated by the performance monitor during the last 24 hours
for the E1 span e1-1-6-2:
% SHOW E1 e1-1-6-2 PERFMON CURRENT DAY
Node: TPUBS Date: 2005/08/03 22:38:37 GMT
Zone: GMTMINUS05-EASTERN-US
---------------------------------------------------------------------
Shelf: 1 Slot: 6 Port: 2 DS1: 1
---------------------------------------------------------------------
E1 Current Performance Monitoring Statistics
---------------------------------------------------------------------
Elapsed Time: 403
---------------------------------------------------------------------
Minor Major Critical
Near End Line Parameters Errors TCA TCA TCA
---------------------------------------------------------------------
Code Violations: 0 FALSE FALSE FALSE
Errored Seconds: 0 FALSE FALSE FALSE
Severely Errored Seconds: 0 FALSE FALSE FALSE
---------------------------------------------------------------------
Minor Major Critical
Near End Path Parameters Errors TCA TCA TCA
---------------------------------------------------------------------
Code Violations: 0 FALSE FALSE FALSE
Errored Seconds: 2 FALSE FALSE FALSE
Severely Errored Seconds: 0 FALSE FALSE FALSE
SEF/AIS Seconds: 0 FALSE FALSE FALSE
Controlled Slip Seconds: 0 FALSE TRUE TRUE
Unavailable Seconds: 0 FALSE FALSE FALSE
Failure Count: 0 - - -
---------------------------------------------------------------------
Minor Major Critical
Far End Line Paramaters Errors TCA TCA TCA
---------------------------------------------------------------------
Errored Seconds: N/A FALSE FALSE FALSE
---------------------------------------------------------------------
Minor Major Critical
Far End Path Parameters Errors TCA TCA TCA
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference E1 Circuits
---------------------------------------------------------------------
Code Violations: 0 FALSE FALSE FALSE
Errored Seconds: 1 FALSE FALSE FALSE
Severely Errored Seconds: 0 FALSE FALSE FALSE
Severely Errored Frame Seconds: 0 FALSE FALSE FALSE
Controlled Slip Seconds: 0 FALSE FALSE FALSE
Unavailable Seconds: 0 FALSE FALSE FALSE
Failure Count: 0 - - -
To reset the current Near End Path statistics on E1 span e1-1-6-2 and then re-display those
current statistics, showing the immediate effect of that action:
% CONFIGURE E1 e1-1-6-2 PERFMON RESET COUNTERS NEAREND DAY PATH
% SHOW E1 e1-1-6-2 PERFMON CURRENT DAY
Node: TPUBS Date: 2005/08/03 22:38:37 GMT
Zone: GMTMINUS05-EASTERN-US
---------------------------------------------------------------------
Shelf: 1 Slot: 6 Port: 2 DS1: 1
---------------------------------------------------------------------
E1 Current Performance Monitoring Statistics
---------------------------------------------------------------------
Elapsed Time: 403
---------------------------------------------------------------------
Minor Major Critical
Near End Line Parameters Errors TCA TCA TCA
---------------------------------------------------------------------
Code Violations: 0 FALSE FALSE FALSE
Errored Seconds: 0 FALSE FALSE FALSE
Severely Errored Seconds: 0 FALSE FALSE FALSE
---------------------------------------------------------------------
Minor Major Critical
Near End Path Parameters Errors TCA TCA TCA
---------------------------------------------------------------------
Code Violations: 0 FALSE FALSE FALSE
Errored Seconds: 0 FALSE FALSE FALSE
Severely Errored Seconds: 0 FALSE FALSE FALSE
SEF/AIS Seconds: 0 FALSE FALSE FALSE
Controlled Slip Seconds: 0 FALSE TRUE TRUE
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
E1 Circuits CLI Reference
To reset all Near End and Far End Path and Line statistics on E1 span e1-1-6-2:
% CONFIGURE E1 e1-1-6-2 INITIALIZE STATISTICS
To enable threshold crossing alerts for unavailable seconds (which are disabled by default) on an
E1 span:
% CONFIGURE E1 e1-1-6-2 PERFMON TCA FILTER UAS-P enabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference E1 Circuits
E1 Channels
This object allows you to further configure the E1 object, described previously, by providing
access to a subset of the 31 channels that comprise the E1. You may access an individual channel
or a group of channels through this object.
• inservice
• outofservice
The default operational state is inservice, where all channels are available for use. Changing the
operational state to outofservice leaves the channels available for maintenance use. In this
state you can configure the E1 channels to run loopback and tone sequences shown below in the
command syntax.
TABLE 3–139
From
(operational
state) Changing to (operational state)
inservice outofservice
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
E1 Circuits CLI Reference
Command Syntax
Command Parameters
Field
Parameter Length Description
e1name 1-23 The automatically assigned (and possibly changed) name of the
E1 span. See the beginning of the E1 section for the structure of
the default name.
chrange N/A The set of E1 channels that are being configured. Maximum range
is 1-31, default is 1-31 (a full E1). Any discrete set of channels
within this range may be specified as discussed below.
All CLI ranges specify a comma-separated list of numbers and/or
ranges. A range consists of two numbers separated by a dash, for
example, 5-8. An increment can be specified after a range with the
notation, +<incr>, for example 4-10+2. No spaces are permitted in
the expression. All values and ranges must be in numerically
ascending order. Thus the expression:
1,3,5,8-12+2,14-16
is a valid range specification for the numbers:
1,3,5,8,10,12,14,15, and 16.
chnum N/A The single channel being configured into this object. Must be in
the range 1-31.
idlecode N/A This value is inserted in these channels when they are idle. Must
be 0-255, default is 84 (0x54).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference E1 Circuits
Field
Parameter Length Description
oper-state N/A The operational state of these E1 channels:
• inservice (default)
• outofservice - must be in this state for loopback and tone
testing.
action N/A The method by which active calls on this E1 are processed when
oper-state outofservice is requested:
• dryup (default) - all active calls are allowed to complete until
the timeout interval expires. When timeout expires the calls
are dropped.
• force - all calls are dropped immediately.
timeout N/A The time (in minutes) to wait to place the E1 channels in the
outofservice oper-state. Must be 0-1440, default is 5. A
value of 0 causes the change immediately.
tonetype N/A The type of test tone to be applied on these channels when they
are outofservice and loopback is enabled:
• dmw (Digital Milliwatt 1000 Hz)
loopback N/A The state of local loopback on the channels:
• disabled
• enabled
Command Example
NOTE
This function must operate on an individual channel rather than a range.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
E1 Circuits CLI Reference
------------------------------------------------------
Channel Admin
Shelf: 1 Slot: 6 Port: 1 DS1: 1
------------------------------------------------------
Channel: 10
State: AVAILABLE
Mode: INSERVICE
Idle Code: 0x54
Tone: NONE
Loopback: DISABLED
------------------------------------------------------
Channel: 11
State: AVAILABLE
Mode: INSERVICE
Idle Code: 0x54
Tone: NONE
Loopback: DISABLED
------------------------------------------------------
Channel: 12
State: AVAILABLE
Mode: INSERVICE
Idle Code: 0x54
Tone: NONE
Loopback: DISABLED
------------------------------------------------------
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference T3 Circuits
T3 Circuits
These objects specify the T3 links connected to the GSX Circuit Network Adapters.
NOTE
T3 circuits are not available on GSX4000 series switches in this release.
T3
This object specifies a T3 circuit that is supported by a Circuit Network Server on the GSX9000. A
T3 circuit provides 28 T1 interfaces, each of which must be configured as a T1 object.
A T3 object is automatically created and named when a CNS30, CNS60, CNS80, or CNS85
module set is added to the GSX9000 via the CREATE SERVER .. ADAPTER command. See
"Server" on page 3–17 for additional information.
The default name of the T3 is T3-shelf-slot-port, where port is the T3 index (always 1 for
CNS30s, CNS31s, CNS80s, and CNS85s, 1-3 for CNS60s). For example, T3-1-3-1 identifies the
T3 circuit that connects to the port on the CNA30 that resides behind the CNS30 or CNS31 in slot
3 of shelf 1. This name may be changed via the CONFIGURE T3...NAME command shown in the
command syntax below. Renaming must be performed while the T3 is disabled and before any
other configuration commands are issued.
No additional T3 objects may be created nor may the automatically created (and possibly
renamed) T3 be directly deleted. This T3 is removed only when the CNS30 or CNS60 module set
is removed via the DELETE SERVER .. ADAPTER command.
The underlying T1 objects that comprise the T3 circuit (see "T1" on page 3–588) are also
automatically created and named when the CNS30, CNS60, CNS80, or CNS85 module set is
added to the GSX9000.
The default name of each T1 object is T1-shelf-slot-port-span, where port is the T3 index
described above, and span is the span number (1-28 for CNS30s, CNS31s, CNS60s, CNS80s, and
CNS85s). For example, T1-1-3-1-2 identifies the second T1 span on the T3 circuit that connects
to the port on the CNA30 that resides behind the CNS30 or CNS31 in slot 3 of shelf 1. This name
may be changed via the CONFIG T1...NAME command shown in the T1 command syntax (see
"T1" on page 3–588). Renaming must be performed while the T1 is disabled and before any other
configuration commands are issued.
No additional T1 objects may be created nor may the automatically created (and possibly
renamed) T1s be directly deleted. These T1s are removed only when the CNS30, CNS60, CNS80,
or CNS85 module set is removed via the DELETE SERVER .. ADAPTER command.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
T3 Circuits CLI Reference
T3 Statistics
The STATISTICS associated with this object are kept for fifteen minute intervals, up to a total of
32 intervals or eight hours. INITIALIZE STATISTICS resets the current statistics for fifteen
minute intervals as well as for the DAY interval. SHOW .. STATISTICS always summarizes
statistics for the previous intervals since the GSX was booted, or the previous 32 intervals,
whichever is less. The DAY statistics are collected independently from the fifteen minute intervals.
These results always reflect the last 24 hours of activity. Thus, when the 32nd fifteen minute
interval expires and the first interval is overwritten, the DAY collection continues without
overwriting statistics that are 8 hours old. Statistics that are more than 24 hours old are
overwritten.
PERFMON Thresholds
The Performance Monitor (PERFMON) THRESHOLD parameters shown below are for specific types
of interface error conditions. Error counts of this magnitude will trigger an event log entry or trap
notification for each threshold level (MAJOR, CRITICAL, or MINOR) of each associated type of
error, for an interval of either fifteen minutes or twenty-four hours. When you configure a
threshold for an individual error type, the identical threshold value is established at both the near
and far end of the T3. You may specify the threshold level, the threshold value, the error type, the
interval length, and the error level (line or path). Line error levels are detectable only for certain
error types on T3s; path error levels are detectable for all error types. You may zero out (PERFMON
RESET) the accumulated counts for these errors on the near or far end, for either interval, and for
either error level. The counts for all the error types, rather than for individual error types, will be
zeroed out.
By default, only MAJOR threshold levels are reported when the T3 is enabled. To include MINOR
and CRITICAL threshold levels in the reporting you must enable TCA REPORT
MINORCRITICAL. Enabling MINORCRITICAL will also enable the reporting of the beginning
of a new performance monitoring time interval (15 minutes or 24 hours). These interval crossings
will not otherwise be reported.
By default, when a T3 is taken out of service for any reason, threshold crossing events for that T3
are not reported until the T3 is placed back into service. You may override this policy and cause
continued reporting of threshold crossing events on spans that are out of service by enabling TCA
REPORT DS3OOS. This applies whether the T3 was taken out of service manually or
automatically (by exceeding MAJOR threshold levels).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference T3 Circuits
AIS alarm reporting may be limited to root-cause problems only via ALARM REPORTING
HIERARCHY. Threshold crossing alerts may be selectively enabled or disabled for each error type
via TCA FILTER. See "Alarm and Threshold Crossing Reporting Hierarchies" on page 6–163 for
more information.
• enabled
• disabled
• inservice
• outofservice
The default operational state is outofservice, where the T3’s underlying T1 spans are available
for maintenance use. In this state you can configure the T3 to run the loopback sequences shown
below in the command syntax. Changing the operational state to inservice, with DS1OVERRIDE
disabled, also makes the T1 spans available for general use.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
T3 Circuits CLI Reference
TABLE 3–141
From
(operational
state) Changing to (operational state)
inservice outofservice
Command Syntax
CONFIGURE T3 t3name ..
LINETYPE linetype
CODING coding
AVAILABLE T1 t1range
BUILDOUT buildout
CIRCUIT ID circuitid
CONFIGURE T3 t3name INITIALIZE STATISTICS
CONFIGURE T3 t3name NAME newt3name
CONFIGURE T3 t3name STATE admin-state
CONFIGURE T3 t3name STATE enabled DS1OVERRIDE ds1or-state
CONFIGURE T3 t3name MODE oper-state
CONFIGURE T3 t3name MODE outofservice
ACTION action
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference T3 Circuits
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
T3 Circuits CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference T3 Circuits
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
T3 Circuits CLI Reference
Command Parameters
Field
Parameter Length Description
shelf N/A The shelf number in the GSX node configuration. In this release,
one shelf is supported. Must be 1.
slot N/A The slot number occupied by the CNS server module for which the
T3 summary is being displayed. This number must be 3-16.
t3name 1-23 The automatically assigned (and possibly changed) name of the
T3 circuit. See the beginning of this section for the structure of the
default name.
linetype N/A The frame format used on the T3:
• m23 - M23 multiplex framing
• cbit (default) - C-bit parity framing
coding N/A The T3 line coding:
• B3ZS - bipolar with three-zero substitution.
t1range N/A The set of T1 spans that are being configured. Maximum range is
1-28, default is 1-28 (a full T3). Any discrete set of T1 spans within
this range may be specified as discussed below.
All CLI ranges specify a comma-separated list of numbers and/or
ranges. A range consists of two numbers separated by a dash, for
example, 5-8. An increment can be specified after a range with the
notation, +<incr>, for example 4-10+2. No spaces are permitted in
the expression. All values and ranges must be in numerically
ascending order. Thus the expression:
1,3,5,8-12+2,14-16
is a valid range specification for the numbers:
1,3,5,8,10,12,14,15, and 16.
t1number N/A The single T1 span being used for T1 loopback. Must be 1-28,
default is 1.
buildout N/A The length of T3 wire that must be driven. This is the length
between the GSX and a repeater or patch panel:
• 0_100ft (default)
• 100_450ft
newt3name 1-23 A new name for the T3 circuit. The renaming operation will not be
allowed if the automatically created name is referenced by any
other configuration object. Therefore this operation should be
performed right after the CNS30/CNS31/CNA30, CNS80/CNA80,
or CNS85/CNA80 module set is configured via CREATE SERVER, if
it is performed at all.
circuitid 1-23 The name of the circuit ID.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference T3 Circuits
Field
Parameter Length Description
oper-state N/A The operational state of this T3:
• inservice - Ready for immediate use. Underlying T1s are
also placed into service subject to DS1OVERRIDE.
• outofservice (default) - Must be in this state to enter the
disabled admin-state.. Underlying T1s are automatically
set to out of service.
admin-state N/A The administrative state of this T3:
• disabled (default) - Not activated, able to be configured.
Underlying T1s are automatically disabled.
• enabled - Activated, available for immediate use. Underlying
T1s are also enabled subject to DS1OVERRIDE.
ds1or-state N/A Indicates whether or not to enable or place into service, the
underlying T1s:
• disabled (default) - Enable the admin-state or the oper-
state of the underlying T1s as you do so to the T3 circuit.
• enabled - Do not enable the admin-state or oper-state
of the underlying T1s as you do so to the T3 circuit.
action N/A The method by which active calls on this T3 are processed when
oper-state outofservice is requested:
• dryup (default) - all active calls are allowed to complete until
the timeout interval expires. When timeout expires the calls
are dropped.
• force - all calls are dropped immediately.
timeout N/A The time (in minutes) to wait to place the T3 in the
outofservice oper-state. Must be 0-1440, default is 5. A
value of 0 causes the change immediately.
nearend N/A The type of local loopback to be applied on this switch for this T3:
• noloop (default) - not in the loopback state.
• payloadloop - the received signal is looped back for
retransmission after it has passed through the device’s framing
function.
• lineloop - the received signal at this interface does not go
through the device but is looped back out.
• inwardloop - the transmitted signal at this interface in looped
back and received by the same interface
• dualloop - both lineloop and inwardloop are active
simultaneously. inwardloop is performed at the T3 LIU.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
T3 Circuits CLI Reference
Field
Parameter Length Description
farend N/A The type of remote loopback to be applied on this switch for this
T3:
• sendnocode (default) - send looped or normal data.
• sendlinecode - send a request for a line loopback.
• sendpayloadcode - send a request for a payload loopback
(all T1s in a T3 frame).
• sendresetcode - send a loopback termination request.
• sendds1loopcode - send loopback code for a particular T1
within a T3 frame (the T1 is indicated in t1number).
• sendtestpattern - send a test pattern.
pattern N/A Specifies the type of remote loopback to be applied on this switch
for this T3 span:
• none
• qrs - send a Quasi-Random Signal (QRS) test pattern.
interval N/A This number specifies the 15 minute interval for which you seek
statistics. Statistics are stored in “intervals” for every 15 minutes
since the GSX was booted. When 32 intervals (8 hours) are
accumulated, the next interval overwrites the earliest, so that no
more than 8 hours of statistics may be accessed.Interval 1 always
contains the most recent statistics and interval 32 (if existent) the
oldest. Must be 1-32.
cvl15 N/A Line Code Violations (MAJOR, MINOR, or CRITICAL) threshold
value for a 15 minute interval. This number must be 1-16,383,
default is 387.
A line code violation is an occurrence of either of the following
conditions:
• a pulse of the same polarity as the previous pulse
• more than 15 contiguous zeroes in AMI coding or more than 7
contiguous zeros in B8ZS coding
This error is detectable only at the near end of T3s.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference T3 Circuits
Field
Parameter Length Description
esl15 N/A Line Errored Seconds (MAJOR, MINOR, or CRITICAL) threshold
value for a 15 minute interval. This number must be 1-900, default
is 25.
An Errored Second is a one second interval in which any one or
more of the following error conditions are present:
• path code violation
• out of frame defect
• controlled slip event
• Alarm Indication Signal (AIS) defect - the AIS is a signal
transmitted downstream informing that an upstream failure has
been detected. This signal replaces the normal traffic signal
when a maintenance alarm indication has been activated. AIS
seconds are a count of the number of seconds during which an
AIS signal was detected.
This error is detectable only at the near end of T3s.
sesl15 N/A Line Severely Errored Seconds (SES) (MAJOR, MINOR, or
CRITICAL) threshold value for a 15 minute interval. This number
must be 1-900, default is 4.
A Severely Errored Second is a one second interval in which any
one or more of the following error conditions are present:
• 320 or more path code violations (see below)
• out of frame defect
• AIS defect
This error is detectable only at the near end of T3s.
cvp15 N/A Path Code Violations (MAJOR, MINOR, or CRITICAL) threshold
value for a 15 minute interval, for both P-bit and CP-bit. This
number must be 1-16,383, default is 382.
A path code violation is a frame synchronization bit error.
Only C-Bit violations are detectable at the far end of T3s.
esp15 N/A Path Errored Seconds (MAJOR, MINOR, or CRITICAL)
threshold value for a 15 minute interval, for both P-bit and CP-bit.
This number must be 1-900, default is 25.
Only C-Bit violations are detectable at the far end of T3s.
sesp15 N/A Path Severely Errored Seconds (MAJOR, MINOR, or CRITICAL)
threshold value for a 15 minute interval, for both P-bit and CP-bit.
This number must be 1-900, default is 4.
Only C-Bit violations are detectable at the far end of T3s.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
T3 Circuits CLI Reference
Field
Parameter Length Description
uasp15 N/A Path Unavailable Seconds (MAJOR, MINOR, or CRITICAL)
threshold value for a 15 minute interval, for both P-bit and CP-bit.
This number must be 1-900, default is 10.
An unavailable second is a one second interval in which the T1
interface is unavailable. This period could begin with the onset of
10 consecutive SESs or the onset of a condition leading to a
failure. The period ends at the onset of 10 consecutive seconds
without an SES.
Only C-Bit violations are detectable at the far end of T3s.
cvlday N/A Line Code Violations (MAJOR, MINOR, or CRITICAL) threshold
value for a 24 hour interval. This number must be 1-1,048,575,
default is 3865.
This error is detectable only at the near end of T3s.
eslday N/A Line Errored Seconds (MAJOR, MINOR, or CRITICAL) threshold
value for a 24 hour interval. This number must be 1-65,535,
default is 250.
This error is detectable only at the near end of T3s.
seslday N/A Line Severely Errored Seconds (SES) (MAJOR, MINOR, or
CRITICAL) threshold value for a 24 hour interval. This number
must be 1-65,535, default is 40.
This error is detectable only at the near end of T3s.
cvpday N/A Path Code Violations (MAJOR, MINOR, or CRITICAL) threshold
value for a 24 hour interval, for both P-bit and CP-bit. This number
must be 1-1,048,575, default is 3820.
Only C-Bit violations are detectable at the far end of T3s.
espday N/A Path Errored Seconds (MAJOR, MINOR, or CRITICAL) threshold
value for a 24 hour interval, for both P-bit and CP-bit. This number
must be 1-65,535, default is 250.
Only C-Bit violations are detectable at the far end of T3s.
sespday N/A Path Severely Errored Seconds (MAJOR, MINOR, or CRITICAL)
threshold value for a 24 hour interval, for both P-bit and CP-bit.
This number must be 1-65,535, default is 40.
Only C-Bit violations are detectable at the far end of T3s.
uaspday N/A Path Unavailable Seconds (MAJOR, MINOR, or CRITICAL)
threshold value for a 24 hour interval, for both P-bit and CP-bit.
This number must be 1-65,535, default is 10.
Only C-Bit violations are detectable at the far end of T3s.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference T3 Circuits
Field
Parameter Length Description
tcaf_state N/A Specifies the state of the (MAJOR, MINOR, or CRITICAL)
threshold crossing alert filter for the particular error type:
• disabled (default) - Do not generate a threshold crossing alert
event when the threshold is exceeded for this error type.
• enabled - Generate a threshold crossing alert event when the
threshold is exceeded for this error type.
See "Regulated Threshold Crossing Alert Reporting" on page 6–
166 for more information.
arh_state N/A Specifies whether the Alarm Reporting Hierarchy is in effect for
alarm state change events:
• disabled - Generate an alarm for every impacted component
in every individual layer downstream from the original AIS
defect.
• enabled (default) - Generate an alarm only for the root cause
problem at the lowest layer.
The Alarm Reporting Hierarchy is described in GR-253-CORE,
Issue 3, Section 6.2.1.8.2. See "Regulated Alarm State Change
Reporting" on page 6–165 for more information..
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
T3 Circuits CLI Reference
NOTE
The following descriptions are taken from GR-820-CORE:
P-Bits are PATH parity bits that contain parity information. These parity bits
provide a means of in-service error detection. A P-bit parity error occurs when the
locally calculated parity does not match the received parity bits, or when the two P-
bits do not agree.
A CP-bit parity error occurs when the majority vote of the CP-bits contained in the
following DS3 M-Frame do not agree with the calculated parity of the current DS3
M-Frame.
Command Example
To enable threshold crossing alerts for path unavailable seconds (which are disabled by default) on
a T3 port:
% CONFIGURE T3 t3-1-3-1 PERFMON TCA FILTER UAS-P enabled
------------------------------------------------------
Shelf: 1 Slot: 3 Port: 1 DS3: 1
------------------------------------------------------
DS3 Configuration
------------------------------------------------------
IfIndex: 50
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference T3 Circuits
State: DISABLED
Circuit Name: T3-1-3-1
Available T1s: 1-28
Line Type: CBIT
Line Coding: B3ZS
Line Buildout: 0_100FT
Send Code: SENDNOCODE
Loopback Config: NOLOOP
Mode: INSERVICE
Circuit Id:
Alarm Reporting Hierarchy: ENABLED
------------------------------------------------------
Shelf: 1 Slot: 3 Port: 1 DS3: 1
------------------------------------------------------
DS3 Error Statistics
------------------------------------------------------
Circuit Name: T3-1-3-1
Total AIS Alarm Count: 0
Total LOF Alarm Count: 0
Total LOS Alarm Count: 0
Total AIS Defects: 0
Total LOF Defects: 0
Total LOS Defects: 0
Total Line Code Violations: 4
Total Excessive Zeroes: 2
Total Bipolar Violations: 2
Total Framing Errors: 92
Total P-bit Parity Errors: 5
Total C-Bit Parity Errors: 2
Total FEBE: 21
Valid 15 min Performance Intervals: 8
Valid 24 hour Performance Intervals: 0
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
T3 Circuits CLI Reference
---------------------------------------------------------------------
Shelf: 1 Slot: 3 Port: 1 DS3: 1
-----------------------------------------------------------------------
DS3 Threshold Configuration
-----------------------------------------------------------------------
15 Minute Intervals: Minor Major Critical TCA Filter
-----------------------------------------------------------------------
Line Code Violations: 310 387 464 DISABLED
Line Errored Seconds: 20 25 30 DISABLED
Line Severely Errored Seconds: 3 4 5 DISABLED
Path Code Violations: 306 382 458 DISABLED
Path Errored Seconds: 20 25 30 DISABLED
Path Severely Errored Seconds: 3 4 5 DISABLED
Unavailable Seconds: 8 10 12 DISABLED
------------------------------------------------------------------------
24 Hour Intervals: Minor Major Critical TCA Filter
------------------------------------------------------------------------
Line Code Violations: 3092 3865 4638 DISABLED
Line Errored Seconds: 200 250 300 DISABLED
Line Severely Errored Seconds: 32 40 48 DISABLED
Path Code Violations: 3056 3820 4584 DISABLED
Path Errored Seconds: 200 250 300 DISABLED
Path Severely Errored Seconds: 32 40 48 DISABLED
Unavailable Seconds: 8 10 12 DISABLED
------------------------------------------------------------------------
TCA Reporting: Minor/Critical DS3 OOS
------------------------------------------------------------------------
DISABLED DISABLED
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference T3 Circuits
To display the error counts accumulated for the current day by the Performance Monitor for T3
t3-1-11-1:
---------------------------------------------------------------------
Shelf: 1 Slot: 11 Port: 1 DS3: 1
---------------------------------------------------------------------
DS3 Current Performance Monitoring Statistics
---------------------------------------------------------------------
Elapsed Time: 638
---------------------------------------------------------------------
Minor Major Critical
Near End Line Parameters Errors TCA TCA TCA
---------------------------------------------------------------------
Code Violations: 0 FALSE FALSE FALSE
Errored Seconds: 0 FALSE FALSE FALSE
Severely Errored Seconds: 0 FALSE FALSE FALSE
---------------------------------------------------------------------
Minor Major Critical
Near End Path P-Bit Parameters Errors TCA TCA TCA
---------------------------------------------------------------------
Code Violations: 0 FALSE FALSE FALSE
Errored Seconds: 0 FALSE FALSE FALSE
Severely Errored Seconds: 0 FALSE FALSE FALSE
Unavailable Seconds: 0 FALSE FALSE FALSE
Failure Count: 0 - - -
---------------------------------------------------------------------
Minor Major Critical
Near End Path C-Bit Parameters Errors TCA TCA TCA
---------------------------------------------------------------------
Code Violations: 0 FALSE FALSE FALSE
Errored Seconds: 0 FALSE FALSE FALSE
Severely Errored Seconds: 0 FALSE FALSE FALSE
Unavailable Seconds: 0 FALSE FALSE FALSE
---------------------------------------------------------------------
Minor Major Critical
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
T3 Circuits CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference T3 Circuits
------------------------------------------------------
Shelf: 1 Slot: 11 Port: 1 DS3: 1
------------------------------------------------------
DS3 Status
------------------------------------------------------
Circuit Name: T3-1-11-1
DS3 Alarms: NOALARM
Operational Status: UP
DS3 Loopback: NO LOOPBACK
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
System Timing CLI Reference
System Timing
These objects configure the system synchronized timing for all circuit modules (CNSx) in the
GSX9000 shelf, as well as GNS modules on a GSX4000 series switch.
For circuit timing on the GSX4010, the chassis has redundant ports for Building Integrated
Timings Source (BITS) or Synchronous Equipment Timing Source (SETS) clocking. In addition,
timing may be pulled from any PSTN interface, or the internal Stratum 3 clock.
NOTE
A configuration of mixed MTA types, such as one MTA10a and one MTA20a is
valid, but not recommended by Sonus.
The synchronized timing signal used in the immediate GSX shelf may be propagated to other
shelves and/or other circuit switches via the MTA timing out port or via a T1 or E1 span.
(Propagating via the MTA timing out port constitutes a “daisy chain”.) See "Configuring Timing
for Circuit Network Modules" on page 6–2 for additional detail.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference System Timing
This object defines timing policies that are applied throughout the shelf to all MTAs.
You can define revertive behavior for MTAs and for the timing source that drives them. When
enabled, revertive behavior permits a previously failed resource, such as an MTA whose recovery
has been authenticated, to be made available for reuse when the need arises. When revertive
behavior is disabled and such a recovery occurs, the resource must be manually put back into
service. Examples of these procedures are shown in the sections that follow.
The RESEQUENCE command enacts, or commits, new priorities for system timing sources. See
"System Timing Source" on page 3–678 as well as "Timing Source Sequence Table" on page 6–3.
Command Syntax
NOTE
When issuing ST commands on a GSX4000 series switch, omit the SHELF
parameter.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
System Timing CLI Reference
Command Parameters
Field
Parameter Length Description
shelf N/A The shelf number in the GSX node configuration. In this
release, one shelf is supported. Must be 1.
Note: This parameter does not apply to GSX4000 series
switches.
failoverguardtime N/A The number of seconds to wait before switching over to
another timing source, after determining that the current
source has gone bad. Must be 2-5, default is 2 (seconds).
recoveryguardtime N/A The number of seconds that a previously faulted timing
source that has become valid must remain valid before it
can be considered for reuse. Must be 15-120, default is 15
(seconds).
revertive-refswitch N/A Determines whether a previously faulted timing source
that has since become valid can be considered for reuse:
• enabled (default) - eligible to be considered for reuse.
• disabled - never automatically considered for reuse.
revertive-mtaswitch N/A Determines whether a previously faulted MTA can be
considered for reuse. This includes a module swap:
• enabled (default) - new module is eligible to be
considered for reuse.
• disabled - never automatically considered for reuse.
Note: This parameter does not apply to GSX4000 series
switches
insertdelay N/A The number of seconds that an MTA is allowed to warm
up and stabilize before being put into service. This warm
up interval is observed on system boots and on MTA hot-
inserts. Must be 100-300, default is 100.
Note: This parameter does not apply to GSX4000 series
switches
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference System Timing
Field
Parameter Length Description
reconfigalg N/A This object indicates which reconfiguration algorithm
should be used to select timing sources for use as System
Synchronized sources:
• ordered-list (default) - causes sources to be
selected in strict numerical order as assigned by default
or by the system administrator.
• ssm-quality - causes sources to be selected based
upon the quality level of the timing source, as indicated
by the sources’ Synchronized Status Messages (SSM).
Because not all timing sources support SSMs in current
GSX hardware and software, you should not choose
this value for this parameter.
sourceaffinity N/A Specifies the conditions under which a particular timing
source on the alternate MTA might be activated as a
result of a timing source reconfiguration:
• none - Timing sources are chosen based on stratum
quality only, regardless of which MTA is providing the
source.
• sticky (default) - Timing sources are chosen from the
active MTA based on stratum quality, and only after all
sources on the active MTA are determined to be
unsatisfactory, will sources from the alternate MTA be
chosen. This value should be specified if you want to
avoid using the alternate MTA when a timing source
reconfiguration is indicated.
This parameter applies only if the RECONFIGURATION
ALGORITHM is ssm-quality and therefore, for the
reasons cited above, is not currently applicable.
Note: This parameter does not apply to GSX4000 series
switches.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
System Timing CLI Reference
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference System Timing
This object specifies the timing policies that will be applied to a specific MTA module, either
MTA1 or MTA2
NOTE
The ST MTA SHELF object is not supported on GSX4000 series switches.
Command Syntax
Command Parameters
Field
Parameter Length Description
shelf N/A The shelf number in the GSX node configuration. In this release,
one shelf is supported. Must be 1.
mta N/A Specifies which MTA is providing the system synchronized
timing signal. Must be 1 or 2.
lineencoding N/A The line coding for the BITS/SETS line interface unit:
• ami - for BITS line interface unit.
• b8zs (default) - for BITS line interface unit.
• hdb3 - for SETS line interface unit.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
System Timing CLI Reference
Field
Parameter Length Description
channelbit N/A For an MTA20 supporting E1 circuits, this identifies which of the
additional spare bits embedded within the framing pattern
contains the SSM channel:
• sa4 (default)
• sa5
• sa6
• sa7
• sa8
(SSM is ignored in T1 circuits.)
framermode N/A Determines the BITS/SETS framer:
• d4sf - should be selected for ami LINEENCODING, BITS
framer.
• esf (default) - should be selected for b8zs LINEENCODING,
BITS framer.
• mf - SETS framer.
• mf-crc4 - SETS framer.
admin-state N/A The administrative state of the specified MTA:
• enabled (default) - activate the MTA, allowing it to participate
in system timing.
• disabled - remove the MTA from service, thereby removing
all timing sources associated with this MTA.
If the shelf contains only one MTA, it may not be disabled
under any conditions.
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference System Timing
To take MTA1 out of service (and simultaneously put MTA2 in the above scenario into service):
% CONFIGURE ST MTA SHELF 1 MTA 1 STATE disabled
Assume that MTA1 has failed, been removed from service, and recovered. If revertive MTA
switching is not enabled, then you can manually restore MTA1 to service with the command:
% CONFIGURE ST MTA SHELF 1 MTA 1 INSERVICE
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
System Timing CLI Reference
The ST FRAMER object specifies the timing policies that are applied to GSX4000 series switches.
NOTE
This command does not apply to GSX9000 switches.
The SHOW ST FRAMER ALL STATISTICS command shows a cumulative count of the number
of various errors detected by the two BITS/SETS framer devices, since the GSX was booted. They
also show the current alarm status of the framers. Table 3–145 lists a description of each of the
statistics.
Statistic Description
BPV Count Bipolar Violations count
CRC Count CRC Error count
FER Count Framing Error count
OOF Count Out of Frame Error count
LOS Count Loss of Signal Alarm count
AIS Count AIS Alarm count
YELLOW Count Yellow Alarm count
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference System Timing
Command Parameters
Field
Parameter Length Description
lineencoding N/A The line coding for the BITS/SETS line interface unit:
• ami - for BITS line interface unit.
• b8zs (default) - for BITS line interface unit.
• hdb3 - for SETS line interface unit.
framermode N/A Determines the BITS/SETS framer:
• d4sf - for ami LINEENCODING, BITS framer.
• esf (default) - for b8zs LINEENCODING, BITS framer.
• mf - SETS framer.
• mfcrc4 - SETS framer.
channelbit N/A For a GSX4000 series switch supporting E1 circuits, this
identifies which of the additional spare bits embedded within the
framing pattern contains the SSM channel:
• sa4 (default)
• sa5
• sa6
• sa7
• sa8
(SSM is ignored in T1 circuits.)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
System Timing CLI Reference
Command Examples
---------------------------------
BITS PRIMARY Framer Statistics
---------------------------------
Current Status: NODEFECT
BPV Count: 646
CRC Count: 1001
FER Count: 0
OOF Count: 543
LOS Count: 0
AIS Count: 0
YELLOW Count: 0
---------------------------------
BITS SECONDARY Framer Statistics
---------------------------------
Current Status: NODEFECT
BPV Count: 0
CRC Count: 1
FER Count: 0
OOF Count: 2
LOS Count: 0
AIS Count: 0
YELLOW Count: 0
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference System Timing
This object specifies and prioritizes up to six input timing sources for a GSX4000 series switch, or
a MTA module on a GSX9000. This command establishes the Timing Source Sequence Table. See
"Timing Source Sequence Table" on page 6–3.
Sources can be added or deleted and priorities can be changed. The actual switchover to a new
timing source is initiated however only by a failure in the current timing source or by the recovery
of a higher priority alternative source. If revertive behavior is disabled, the higher priority
alternative source must be manually returned to service.
Command Syntax
NOTE
When issuing ST SOURCE commands on a GSX4000 series switch, omit the SHELF,
MTA, and the second occurrence of the SOURCE parameter. For example, the
GSX4000 syntax for the CREATE command is CREATE ST SOURCE source.
CONFIGURE ST SOURCE SHELF shelf MTA mta SOURCE source SEQNUM seqnum
CONFIGURE ST SOURCE SHELF shelf MTA mta SOURCE source STATE admin-state
CONFIGURE ST SOURCE SHELF shelf MTA mta SOURCE source INSERVICE
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
System Timing CLI Reference
Command Parameters
Field
Parameter Length Description
shelf N/A The shelf number in the GSX node configuration. In this release,
one shelf is supported. Must be 1.
Note: This parameter does not apply to GSX4000 series switches.
mta N/A Specifies which MTA is providing the system synchronized timing
signal. Must be 1 or 2.
Note: This parameter does not apply to GSX4000 series switches.
source N/A Defines a system timing source to be added to or reprioritized in
the Timing Source Sequence Table:
• extClkA - the BITS 1 input on a GNA (GSX4000 series)
MTA10a (GSX9000), the SETS 1 input on a GNA or MTA20a/
MTA21a, or the DCS 1 input on the MTA30.
• extClkB - the BITS 2 input on a GNA (GSX4000 series)
MTA10a (GSX9000), the SETS 1 input on a GNA or MTA20a/
MTA21a, or the DCS 2 input on the MTA30.
• refClkA - derived timing signal #1 from a CNS or PNS module
on a GSX9000, or a GNS module on a GSX4000 series.
• refClkB - derived timing signal #2 from a CNS or PNS module
on a GSX9000, or a GNS module on a GSX4000 series.
• oscillator (default) - the on-board Stratum 3 oscillator (on a
GSX9000, this is on an MTA module).
• holdover - the MTA replay derived from the current active
source (on a GSX9000, Sonus recommends that sources be
grouped by MTA; that is, define all the MTA 1 sources before
MTA 2 sources)
seqnum N/A The priority in the Timing Source Sequence Table of the specified
SOURCE object, where #1 is the highest priority, followed by #2,
etc. These priorities are automatically established when the GSX
software is initialized. Must be 1-12.
admin-state N/A The administrative state of the specified timing source:
• enabled (default) - Activate the timing source and make it
available for service.
• disabled - Remove the timing source from service.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference System Timing
Command Example
To manually return a timing source to available for service when it has recovered from a failure
and revertive source switching is not enabled:
% CONFIGURE ST SOURCE SHELF 1 MTA 2 SOURCE refclka ACTION available
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
System Timing CLI Reference
To show the status of all timing sources, including signal level validity and Stratum traceability:
% SHOW ST SOURCE ALL STATUS
Node: TPUBS Date: 2001/02/16 19:48:41 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference System Timing
This object assigns a T1 or E1 span from a CNS10, CNS20, CNS25, CNS30, CNS31, CNS40,
CNS45, CNS60, CNS80, or CNS85 module on a GSX9000 as a reference clock into the MTA. On
a GSX4010, this object simply assigns a reference clock to a T1 or E1 span. Two reference clocks
(A and B) may be defined. These constitute derived timing sources.
When you specify an OC3TDM CLOCK, the source is derived from the active OC-3 SONET channel
on the CNA33. When you specify PIMLOWER CLOCK or PIMUPPER CLOCK on a GSX9000, you
are selecting the master clock on the OC-3 or STM-1 optical interface of the specified CPIM that is
connected to the CNA70 or CNA81.
NOTE
When using the CNS71 Optical Interface Module, you should not use a VT 1.5/TU-
11 as a system clock source due to the jitter and wander introduced by STM/
SONET mapping. There are two timing options: a Stratum 1 clock external clock
input, and an STM-1/SONET OC-3 optical line derived clock on the CNA70. Any
MTA can be used in conjunction with any CNS. The only difference among MTAs is
the physical interface on the MTA for the external timing source.
Command Syntax
NOTE
When issuing ST REFCLK commands on a GSX4000 series switch, omit the SHELF
and SLOT parameters. Also, GSX4000 series switches do not support the PORT,
OC3TDM, OC12, PIMLOWER, and PIMUPPER parameters.
CREATE ST REFCLK BINDING SHELF shelf SLOT slot SPAN span CLOCK clock
CREATE ST REFCLK BINDING SHELF shelf SLOT slot PORT port SPAN span ..
CLOCK clock
CREATE ST REFCLK BINDING SHELF shelf SLOT slot OC3TDM CLOCK clock
CREATE ST REFCLK BINDING SHELF shelf SLOT slot OC12 CLOCK clock
CREATE ST REFCLK BINDING SHELF shelf SLOT slot PIMLOWER CLOCK clock
CREATE ST REFCLK BINDING SHELF shelf SLOT slot PIMUPPER CLOCK clock
DELETE ST REFCLK BINDING SHELF shelf SLOT slot SPAN span CLOCK clock
DELETE ST REFCLK BINDING SHELF shelf SLOT slot PORT port SPAN span ..
CLOCK clock
DELETE ST REFCLK BINDING SHELF shelf SLOT slot OC3TDM CLOCK clock
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
System Timing CLI Reference
DELETE ST REFCLK BINDING SHELF shelf SLOT slot OC12 CLOCK clock
DELETE ST REFCLK BINDING SHELF shelf SLOT slot PIMLOWER CLOCK clock
DELETE ST REFCLK BINDING SHELF shelf SLOT slot PIMUPPER CLOCK clock
Command Parameters
Field
Parameter Length Description
shelf N/A The shelf number in the GSX node configuration. In this release,
one shelf is supported. Must be 1.
Note: This parameter does not apply to GSX4000 series switches.
slot N/A The slot number occupied by the CNS10, CNS20, CNS25,
CNS30, CNS31, CNS40, CNS45, CNS60, CNS80, or CNS85
module that you are selecting for a derived timing source. For an
OC3TDM CLOCK, you must specify either of the lower two slots of
the CNS30-triplicate that makes up the OC3TDM. Must be 3-16.
Note: This parameter does not apply to GSX4000 series switches.
port N/A The CNS60 T3 port that contains the T1 channel that will provide
the derived timing source. Must be 1-3.
Note: This parameter does not apply to GSX4000 series switches.
span N/A The span number on the T1 or E1 circuit serviced by the above
specified module that will provide the derived timing source. Must
be:
• 1-12 for a CNS10
• 1-8 for a CNS20
• 1-12 for a CNS25
• 1-28 for a CNS30, CNS31, CNS60, CNS80, or CNS85
• 1-36 for CNS40 or CNS45
• 1-84 for CNS71, CNS81, or CNS81 T1s, 1-63 for E1s
• 1-24 for a GSX4010
clock N/A The backplane signal the derived clock source should be bound
to:
• refClkA
• refClkB
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference System Timing
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Circuit Service Group CLI Reference
This object assists node resource management by creating a template for the circuit endpoint; it
may be applied to an ISUP circuit or a ISDN B-channel.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Circuit Service Group
Command Parameters
Field
Parameter Length Description
csprofile 1-23 The name of the profile that can be applied to a circuit service
object.
encoding N/A The audio encoding method to be performed on the voice data
received from, and destined to the PSTN.
• g711ulaw (default) - use this audio encoding method for
ISUP (protocol) REVISIONs ansi1992 and ansi1995
• g711alaw - use this audio encoding method for all other
ISUP REVISIONs
bandwidth N/A The number of channels to group for Nx64 connections. Must be
1-24, default is 1.
echocancel N/A State of Network Echo Cancellation on the channel:
• disabled - No echo cancellation will be performed on the
incoming PSTN signal. Nevertheless, all data patterns do not
pass unaltered because G.711 encoding will still alter one of
the byte patterns. Full data transparency only occurs on calls
that have a Data Bearer capability.
• enabled (default) - Activated according to the ECHO
CANCELLER PROFILE parameters. See "Echo Canceller
Profile" on page 3–743.
This parameter is normally enabled for calls. However, ISUP
has procedures for enabling or disabling this parameter to
process a particular call after determining that the alternate
setting applies. This potentially results in a parameter value that
differs from its manually configured value, when viewed by a
SHOW command.
When you manually configure a new value for this parameter,
this setting will apply to subsequent calls but not to currently
active calls
contesttype N/A Specifies the type of continuity test to perform based on the
configuration of the remote switch or trunk connection:
• remoteLoopback (default) - the remote switch will loop back
the channel being tested.
• remote2Wire - the remote switch supports the 2 wire
continuity test procedure.
• remote4Wire - the remote switch supports the 4 wire
continuity test procedure.
timeout N/A Specifies the time in seconds to await the detection of a tone
from the continuity test before declaring the test to have failed.
Must be 1-8, default is 2.
mindetect N/A Specifies the minimum duration time in milliseconds for a tone to
satisfy the continuity test requirements. Must be 10-60, default is
45.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Circuit Service Group CLI Reference
Field
Parameter Length Description
minrelease N/A Specifies the minimum quiescent time in milliseconds for a
previously present tone to be considered removed in order to
satisfy the continuity test requirements. Must be 10-40, default is
25.
capabilities N/A Specifies the data capabilities for the circuit:
• voiceOnly - voice only.
• circuitModeData - circuit mode data only
• voiceOrCircuitModeData (default) - both voice and
circuit mode data can be supported by the circuit.
NOTE: You must not specify the voiceOrCircuitModeData
option for a CAS channel. A CAS channel must be configured
either as voiceOnly or as circuitModeData.
dparams N/A Specifies the data parameters for circuits with
circuitModeData or voiceOrCircuitModeData
capabilities:
• unrestricted (default) - 64 Kbit/second unrestricted.
• restricted - 56 Kbit/second restricted. T1 CAS
(circuitModeData) channels must be configured with this
value.
dtmfprofile 1-23 Name of the DTMF tone profile. This profile defines parameters
specific to DTMF tone generation. The defaultDtmf profile is
used by default for this function. See "Tone Profile" on page 3–
1189.
xfrcap N/A The transfer capability value used in CAS to ISDN/ISUP call
interworking. This value is assigned to the egress bearer IE
(ISDN Call Setup) or the egress USI parameter (ISUP IAM
message). The values that may be assigned are:
• speech (default)
• audio31Khz
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Circuit Service Group
Field
Parameter Length Description
txlevelcontrl N/A Specifies the type of level control to be applied to non-data
bearer signals transmitted to the PSTN:
• none (default) - 0 dB is applied to TX gain.
• highLevelCompensation - This adds 6 dB of attenuation
to TX signals if the proprietary Echo Canceller logic has
determined that the signal level may saturate the analog
hybrid. Saturation of the hybrid can cause non linear echoes.
This attenuation is added or removed during silence gaps to
make the level change less noticeable. The attenuation
remains present until the echo canceller determines that the
signal level has been reduced long enough to prevent
saturation. This attenuation will be removed in the next
silence period. This action is prevented if ECHO CANCEL is
disabled. This action is also prevented if a modem (2100
Hz. phase reversing signal) or a FAX (2100 Hz. non phase
reversing signal) is detected. This treatment must NOT be
selected for either G.168 testing, or any other testing where
tones of specific levels must pass through without any
attenuation.
• fixedGain - This applies the gain or loss in the TX direction
according to the TX GAIN parameter.
rxlevelcontrl N/A Specifies the type of level control to be applied to the non-data
bearer signals received from the PSTN:
• none (default) - 0 dB is applied to RX gain.
• fixedGain - This applies the gain or loss in the RX direction
according to the RX GAIN parameter.
txgain N/A Specifies the amount of gain or loss to be applied to the circuit in
the transmit direction (when transmitting to the PSTN). The gain
is applied at RIN (before the echo canceller). Must be -12 dB to
+12 dB. Default is 0 (dB).
This constant gain or loss is applied to all non-data bearer
channel calls sent to a T1 or E1 circuit without regard to the
presence of echo canceller.
This parameter is ignored if TX LEVEL CONTROL is not
fixedGain.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Circuit Service Group CLI Reference
Field
Parameter Length Description
rxgain N/A Specifies the amount of gain or loss to be applied to the circuit in
the receive direction (when receiving from the PSTN). The gain
is applied at the SOUT (after the echo canceller). Must be -12
dB to +12 dB. Default is 0 (dB).
This constant gain or loss is applied to all non-data bearer
channel calls received from a T1 or E1 circuit without regard to
the presence of echo canceller.
This parameter is ignored if RX LEVEL CONTROL is not
fixedGain.
admin-state N/A The administrative state of this circuit service profile:
• disabled (default) - Not activated, able to be reconfigured,
able to be deleted.
• enabled - Activated. Ready to be applied.
Command Example
To disable the default circuit service profile, turn off echo cancellation, and then reenable the
profile:
% CONFIGURE CIRCUIT SERVICE PROFILE default STATE disabled
% CONFIGURE CIRCUIT SERVICE PROFILE default ECH CANC disabled
% CONFIGURE CIRCUIT SERVICE PROFILE default STATE enabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Packet Service Group
This object creates a template for a packet endpoint that describes attributes that can potentially be
applied to each individual call. Typically the Packet Service Profile is provided to the GSX by the
PSX in the Policy Request reply. The types of calls that receive this treatment are:
The STATIC CALL uses the GSX PACKET SERVICE PROFILE object described in the
following sections. Static Calls are used to provide SS7 F-links in international environments. See
"Static Call" on page 3–1206.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Packet Service Group CLI Reference
To determine the packet service used on a packet call leg, negotiation between the peers is
necessary to arrive at an optimal compression algorithm to use between them.
The Packet Service Profile supports up to four audio encoding entries or CODECs. The available
compression algorithms that may be assigned to these CODECs are:
• G711 - G.711
• G711SS - G.711 with Silence Suppression
• G7231 - G.723.1
• G7231A - G.723.1A
• G726 - G.726
• G729A - G.729A
• G729AB - G.729AB
• iLBC - Internet Low Bit-Rate Codec
• iLBCSS - Internet Low Bit-Rate Codec with Silence Suppression
• G722 - G.722
• G722SS - G.722 with Silence Suppression
• G7221 - G.722.1
• G7221SS - G.722.1 with Silence Suppression
• AMRWB - AMR-WB (G.722.2)
• G728 - G.728
• G728SS - G.728 with Silence Suppression
• AMR - Adaptive Multi-rate Codec
• EFR - Enhanced Full Rate Codec
G722, G722SS, G7221, G7221SS, AMR-WB, G728, and G728SS CODECS are supported in pass-
through or direct media mode only (special DSP treatments and transcoding are not applicable to
the calls using these codecs).
A PRIORITY of 1-4, assigned to each CODEC, establishes the precedence (or preference) of each of
the four CODECs used by this GSX. A PRIORITY of 1 is highest, 4 is lowest. The four prioritized
CODECs make up the list of audio encoding entries for this GSX.
One example of a negotiation scenario occurs when a call comes into the GSX from an H.323 peer.
The GSX preferred coding may be G.711, while the H.323 gateway at the far end may prefer
G.729A coding because that gateway has limited bandwidth to access the IP network.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Packet Service Group
In order to properly handle a call compression negotiation such as that described above, it is
necessary to examine the CODEC list on both the local and remote gateway to find one or more
CODECs that are common to both. The precedence of the resultant CODECs is controlled by the
local precedence setting, or the precedence of the remote peer. This provisioning directive is
provided by the HONOR REMOTE PRECEDENCE parameter.
NOTE
None of the above listed compression algorithms are valid or meaningful for
CNS31 based calls.
• COMMON - These parameters apply universally to all CODECs in the list, unless noted
otherwise in their descriptions. See "COMMON PACKET SERVICE PROFILE Parameters"
on page 3–702.
• CODEC - These parameters apply only to the particular CODEC that is being provisioned. See
"CODEC PACKET SERVICE PROFILE Parameters" on page 3–710.
The T.38 fax relay protocol may be used with any of the compression algorithms mentioned
above.
NOTE
When G711 is selected as the audio codec and FAX TREATMENT is set to
faxRelayOrG711Fallback, the GSX does not initiate a T.38 Re-INVITE message
when T.38 fax relay protocol (fax tone) is detected, but responds to a T.38 Re-
INVITE that is initiated by the peer. However, when FAX TREATMENT is set to
faxRelay and FAX FAILURE is set to continue, then the GSX will initiate a T.38
Re-INVITE when fax tone is detected even if the audio codec is G711.
Table 3–150 summarizes this behavior for the G711 and T.38 Fax Transmittal Protocols.
Fax
FAX FAX Transmittal
Codec TREATMENT FAILURE GSX Action Protocol Failure Action
G711 faxRelayOrG711Fallback Continue no action G711 continue with
taken G711
G711 faxRelay Continue send T.38 T.38 fallback to
Re-Invite G711
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Packet Service Group CLI Reference
The negotiation services described above contribute to GSX software support for both signaling
and media flows between communicating packet peers. This capability is comprehensive and
complex. The Packet Service Profiles (PSPs) that establish the negotiation parameters are
provisioned exclusively on the PSX Policy Server. Their structure and content however is identical
to the GSX PSP object described in the sections that follow. By properly provisioning the Packet
Service Profile on the PSX Policy Server, the GSX software provides the following capabilities:
• An ingress packet-to-packet call leg may use SIP, SIP-I, H.323, or Gateway-to-Gateway
protocol.
• An egress packet-to-packet call leg may use SIP, SIP-I, H.323, or Gateway-to-Gateway
protocol, with the exception that Gateway-to-Gateway protocol may not apply to the ingress
and egress legs of the same call. There are no other constraints on the pair of protocols used on
the ingress and egress call legs.
• End-to-end media negotiation from ingress peer to egress peer is supported. The GSX can
negotiate end-to-end between the same or different packet signaling protocols. In prior
releases, packet-to-packet media was completely negotiated on the ingress leg with the
assumption that the egress leg would agree to the ingress selection.
• The GSX supports media stream renegotiation during the call. The renegotiation can occur
either prior to or after the call is established (stable).
• As a possible outcome of media negotiation, the GSX supports the mapping of one
compression algorithm to another, when necessary, through transcoding. Transcoding by the
GSX supports mapping between media formats when necessary. Transcoding can be
provisioned either unconditionally or conditionally. Unconditional transcoding forces
transcoding to occur between selected ingress and egress codec types even if a common media
flow could have been negotiated. Conditional transcoding is provisioned to address codec
incompatibility as well as ingress/egress leg differences in packet size, silence suppression,
and DTMF handling where transcoding is determined to be preferable to negotiating a
compromise setting.
• As another outcome of media negotiation, the GSX supports the pass through of RTP packets
between call legs. For every call, the GSX determines if the ingress and egress peers can
negotiate a common media flow on the ingress and egress legs. If such a common flow is
determined the GSX will simply forward RTP packets from ingress to egress. If this is not
possible, the GSX will attempt to support the call using transcoding. In the case of SIP, for
example, the GSX combines the ingress peer’s SDP offer with ingress and egress PSPs
received from the PSX to generate an SDP offer to present to the egress peer. The egress peer's
answer SDP is combined with the same ingress and egress PSPs received from the PSX to
generate an SDP answer to present to the ingress peer.
• Control of GSX media handling is provided by Packet Service Profiles (PSPs) provisioned on
the PSX. PSPs and Preferred PSPs on the PSX are combined and sent to the GSX in the PSX
policy response. Separate PSPs for each packet call leg, ingress and egress, are provided on a
call-by-call basis.
• PSPs support GSX call-by-call restriction on the codec combinations allowed for ingress and
egress.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Packet Service Group
• PSPs provide the GSX with multiple codecs choices and differing media attributes on a call-
by-call basis.
• Transcoding can be applied to support different modes of fax support on the ingress and egress
call legs. One call leg may fallback to using G.711 while the other leg may use the T.38
protocol.
• Clearmode support that conforms to RFC 4040, is provided for SIP digital data call legs. If the
PSX IP Signaling Profile “Clearmode for Data” parameter is enabled for the SIP Egress call
leg, then Clearmode is sent using a dynamic payload type. If the PSX IP Signaling Profile
“Clearmode for Data” parameter is enabled for the SIP Ingress call leg, then only Clearmode
data calls are accepted. If this parameter is disabled for the SIP Egress call leg, then legacy
operation is signaled and the payload type is implicit, assumed to be the same on both sides. If
this parameter is disabled for the SIP Ingress call leg, then legacy operation is accepted as well
as Clearmode. See the PSX Policy Server Provisioning Guide for additional detail.
• CNS and SPS cards are not required for all packet-to-packet environments. The GSX provides
the flexibility to configure a packet-to-packet solution without CNS or SPS cards (if
announcement or tone resources are not needed and transcoding is not allowed). Where
announcements, tones, or transcoding are needed, SPS but not CNS cards are required. DSP
resources for recognizing and processing DTMF digits and fax tones will be allocated by the
GSX based on provisioning of these capabilities on the PSX PSPs.
The packet services described above are carried out by GSX software, based on a pair of Packet
Service Profiles (PSPs) that are presented to the GSX by the PSX Policy Server in response to a
query at call setup time:
1. a “route” PSP that specifies the restrictions on the ingress peer
2. a “route” PSP that specifies the restrictions on the egress peer
Subsequent PSPs that drive the processing are derived from these initial PSPs. The default PSP
residing on the GSX may be employed for GSX based routing, and only for this purpose. If the
PSX does not return the PSP pair shown above in response to the call setup query for a packet-to-
packet call, the call will terminate.
Calls using CODECs G729A, G729AB, G7231, G7231A, or ILBC that require DTMF digits to be
passed, require a DTMF RELAY (that is the DTMF RELAY value cannot be none).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Packet Service Group CLI Reference
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Packet Service Group
COS cosservice
CONFIGURE PACKET SERVICE PROFILE psprofile P2PCONTROL ..
TRANSCODE transcode
CONDITIONS DIFFERENT ..
PACKET SIZE condiffpktsize
SILENCE SUPRESSS condiffsilsup
DTMF RELAY condiffdtmfrel
CONDITIONS HONOR OFFER PREFERENCE honoroffer
CONFIGURE PACKET SERVICE PROFILE psprofile P2PCONTROL ..
CODECS ALLOWED THIS LEG ..
G711A thislegG726
G711U thislegG711U
G7231 thislegG7231
G726 thislegG726
G729 thislegG729
ILBC thislegILBC
AMR thislegAMR
EFR thislegEFR
T38 thislegGt38
ALL thislegall
CONFIGURE PACKET SERVICE PROFILE psprofile P2PCONTROL ..
CODECS ALLOWED OTHER LEG ..
G711A otherlegG711a
G711U otherlegG711u
G7231 otherlegG7231
G726 otherlegG726
G729 otherlegG729
ILBC otherlegiLBC
AMR otherlegAMR
EFR otherlegEFR
T38 otherlegt38
ALL otherlegall
CONFIGURE PACKET SERVICE PROFILE psprofile STATE admin-state
CONFIGURE PACKET SERVICE PROFILE psprofile PRIORITY pri CODEC NONE
CONFIGURE PACKET SERVICE PROFILE psprofile PRIORITY pri CODEC G711
CONFIGURE PACKET SERVICE PROFILE psprofile PRIORITY pri CODEC G711 ..
PACKET SIZE G711pktsize
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Packet Service Group CLI Reference
LAW law
MODEM TREATMENT modemtrtmnt
FAX TREATMENT faxtrtmnt
MODEM FAILURE modemfailure
FAX FAILURE faxfailure
DTMF RELAY dtmfrelay
DTMF REMOVE DIGITS dtmfrlyrd
CONFIGURE PACKET SERVICE PROFILE psprofile PRIORITY pri CODEC G711SS
CONFIGURE PACKET SERVICE PROFILE psprofile PRIORITY pri CODEC G711SS ..
PACKET SIZE G711pktsize
LAW law
SEND SID sendsid
MODEM TREATMENT modemtrtmnt
FAX TREATMENT faxtrtmnt
MODEM FAILURE modemfailure
FAX FAILURE faxfailure
DTMF RELAY dtmfrelay
DTMF REMOVE DIGITS dtmfrlyrd
CONFIGURE PACKET SERVICE PROFILE psprofile PRIORITY pri CODEC G7231
CONFIGURE PACKET SERVICE PROFILE psprofile PRIORITY pri CODEC G7231 ..
PACKET SIZE G723pktsize
CODING RATE codingrat723
MODEM TREATMENT modemtrtmnt
FAX TREATMENT faxtrtmnt
MODEM FAILURE modemfailure
FAX FAILURE faxfailure
DTMF RELAY dtmfrelay
DTMF REMOVE DIGITS dtmfrlyrd
CONFIGURE PACKET SERVICE PROFILE psprofile PRIORITY pri CODEC G7231A
CONFIGURE PACKET SERVICE PROFILE psprofile PRIORITY pri CODEC G7231A ..
PACKET SIZE G723pktsize
CODING RATE codingrat723
MODEM TREATMENT modemtrtmnt
FAX TREATMENT faxtrtmnt
MODEM FAILURE modemfailure
FAX FAILURE faxfailure
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Packet Service Group
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Packet Service Group CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Packet Service Group
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Packet Service Group CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Packet Service Group
Field
Parameter Length Description
psprofile 1-23 The name of the profile that can be applied to a packet service
object.
silencef N/A Specifies the percent of call time that silence is expected. This
parameter is used to reduce expected call bandwidth. Must be
0-50, default is 0.
voicedelay N/A Specifies the initial delay in milliseconds used in the playout
buffer. This is the amount of time to wait after receiving the first
packet before it gets played out towards the PSTN. This value
must be less than the JITTER MINOCCTHRSH value for the
associated RESOURCE PAD. See "Packet Assembler
Disassembler (PAD) Resources" on page 3–726.
If you know the maximum network jitter and you wish to never
lose data due to jitter, then set this value to that maximum jitter
size. Otherwise, Sonus recommends choosing the default value
of 10 milliseconds. The playout buffer will dynamically add delay
if the actual network jitter is larger than this initial delay value.
Must be 1-50, in increments of 1. Default is 10 (milliseconds).
service N/A Specifies the Type of Service (TOS) parameters to be provided
in the IP header for voice packets. Must take an 8 bit hex value
between 0x00 and 0xFF, default is 0x00. The meaning of any
arbitrary value in this byte is network specific.
dcpayload N/A Specifies the RTP payload type to be used for data calls (where
data is as defined in ISDN, or in ISUP, the bearer channel is
type data). Must be 0-127, default is 56.
dcinitialdelay N/A Specifies the size of the initial playout buffer required to absorb
the maximum expected data packet delay across the network, in
milliseconds. Must be 5-50, in increments of 1 ms. Default is 50
(milliseconds).
This is the initial playout delay for calls with a data bearer
channel, for example, ISDN 64K data calls. This value is
configured separately from the initial playout delay for voice
channels (VOICE INITIAL PLAYOUT BUFFER DELAY) so
providers can trade off delay on data calls versus the likelihood
of jitter causing delay changes while the playout buffer adapts.
Some data bearer calls are very sensitive to delay changes
(such as H.320 video conferencing) so a higher initial delay
should reduce the chance of jitter bursts causing problems.
dcpacketsize N/A Specifies the maximum packet size of the data packet in
milliseconds. Must be 10-40 (milliseconds); default is 20.
sidpayload N/A Specifies the G.711 and iLBCSS SID RTP payload type. This
parameter applies only if the selected CODEC is G711SS or
ILBCSS. Must be 0-127, default is 19.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Packet Service Group CLI Reference
Field
Parameter Length Description
sidheartbeat N/A Specifies whether SID packets should be sent within some
minimum interval during a silence period:
• enabled (default) - send at least one SID packet within the
SID Maximum Packet Time (which is defined in a MIB).
• disabled - send SID packets only when the background
noise level changes.
This parameter applies only if the selected CODEC matches one
of the following:
• G711SS and SEND SID is enabled
• G729AB
• G7231A
• iLBCSS
Note: SIP, H.323, and MGCP calls using G.711 with silence
suppression and RTCP should disable the SID heartbeat to
avoid premature Packet Outage Detection (POD) detection and
the associated RTCP events; see "Packet Assembler
Disassembler (PAD) Resources" on page 3–726.
rtcp N/A Specifies whether Real Time Control Protocol (RTCP) is
enabled for the call:
• enabled - use RTCP for the call.
• disabled (default) - do not use RTCP for the call.
RTCP is used to report network traffic congestion data. Various
actions (for example call disconnect) may be taken when
congestion threshold settings are exceeded.
plthreshold N/A Specifies the RTP packet loss threshold, per 100,000 packets.
Must be 0-65,535, default is 0. A value of 0 means no detection
of packet loss.
This parameter applies only if RTCP is enabled.
plaction N/A Specifies the action to take when plthreshold is exceeded:
• none (default) - no action.
• trap - issue a trap.
• trapAndDisconnect - issue trap and disconnect the call.
This parameter applies only if RTCP is enabled.
peeraction N/A Specifies the action to take when the RTP peer is determined to
be absent due to lack of RTP and RTCP packets:
• none (default) - no action.
• trap - issue a trap.
• trapAndDisconnect - issue trap and disconnect the call.
This parameter applies only if RTCP is enabled.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Packet Service Group
Field
Parameter Length Description
t38ect N/A This field specifies the T.38 error correction type:
• redundancy (default) - Repeat the previous secondary
Internet Facsimile Protocol (IFP) messages along with a
primary message. This is the only valid enumeration.
t38hsnum N/A This field specifies the number of redundant IFP messages sent
in a UDP packet for T.38 high speed fax transmission. This field
applies only if the T.38 error correction type is redundancy.
Must be 0-2, default is 1.
t38lsnum N/A This field specifies the number of redundant IFP messages sent
in a UDP packet for T.38 low speed fax transmission. This field
applies only if the T.38 error correction type is redundancy.
Must be 0-2, default is 1.
t38mxbr N/A The T.38 Maximum Bit Rate. The maximum FAX rate is 14400
bits per second. This parameter provides a means of lowering
this rate if necessary (for example, to troubleshoot a problem):
• 2400bps
• 4800bps
• 9600bps
• 14400bps (default)
t38drmt N/A The T.38 Data Rate Management Type:
• type1 - Type 1 data rate management requires that the
Training Check Frame (TCF) training signal be generated
locally by the receiving gateway. Data rate management is
performed by the emitting gateway based on training results
from both PSTN connections. Type 1 is used for TCP
implementations and is optional for use with UDP
implementations.
• type2 (default) - Type 2 data rate management requires that
the TCF be transferred from the sending gateway to the
receiving gateway rather than having the receiving gateway
generate it locally. Speed selection is done by the gateways
in the same way as they would on a regular PSTN
connection. Data rate management type 2 requires the use of
UDP and is not recommended for use with TCP.
For SIP signaling, because Sonus doesn’t currently support T38
over TCP, a supplied value of localTCF is changed to
transferredTCF by the SIP service group.
honorrp N/A Specifies which CODEC priority list will take precedence when a
common CODEC priority list is to be created, that will be derived
from the individual local and remote peer lists:
• enabled - the remote peer’s Packet Service Profile CODEC
priority list takes precedence over the local peer’s list
• disabled (default) - the local peer’s Packet Service Profile
CODEC priority list takes precedence over the remote peer’s
list.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Packet Service Group CLI Reference
Field
Parameter Length Description
transcode N/A Specifies the transcoding method used for the associated
packet flow. The GSX can perform transcoding for media
streams carried between two IP devices by translating the
streams from the ingress audio encoding format to the egress
audio encoding format when the devices do not share a
common codec.
• only - apply transcoding unconditionally.
• conditional - the GSX performs transcoding when any of
the conditions specified in the Conditions In Addition To “No
Common Codec” section are met.
• determinedByOtherLeg - the GSX performs transcoding
based on the transcoding options specified in the packet
service profile assigned to the other leg of the call.
• transcoderFreeTransparency - when selected, the GSX
transparently passes the Packet Service Profile from the
ingress call-leg to the egress call-leg, bypassing transcoding.
aal1payloadsz N/A Specifies the ATM Adaption Layer Type 1 (AAL-1) payload size
in bytes. For G.711, this value must be 40, 44, or 47 bytes;
default is 47 (bytes).
digitdetect N/A Specifies whether digit detection is enabled on digits sent to the
network:
• enabled
• disabled (default)
disallowdata N/A Specifies whether data calls are allowed. If enabled, digit data
calls are rejected:
• enabled
• disabled (default)
dtmfpayload N/A Specifies the preferred RTP payload type to be sent in the RTP
header of RFC 2833 packets. If set to 128, the value set with the
CONFIGURE RESOURCE PAD .. RTPPAYLOADTYPE ..
DTMFRELAY command is used instead. See "Packet Assembler
Disassembler (PAD) Resources" on page 3–726. Must be 0-
128; default is 128.
condiffpktsize N/A Specifies whether media is transcoded when the ingress and
egress call legs use different packet sizes:
• enabled
• disabled (default) - transcoding is not determined by
different packet size.
condiffsilsup N/A Specifies whether media is transcoded when the ingress and
egress legs use different silence suppression methods:
• enabled
• disabled (default) - transcoding is not determined by
different silence suppression methods.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Packet Service Group
Field
Parameter Length Description
condiffdtmfrel N/A Specifies whether media is transcoded when the ingress and
egress legs use different DTMF relay methods:
• enabled
• disabled (default) - transcoding is not determined by
different DTMF relay methods.
honoroffer N/A Specifies whether the GSX will honor the codec preference sent
in a call regardless of the setting of the Transcode flag:
• enabled - transcode the answer codec, even though it could
be passed through, if this allows a more preferred codec to be
used on the offer side.
• disabled (default) - minimize the use of DSP resources by
passing through the answer codec, if it is present in the offer.
Transcode only if there is no common codec.
thislegG711a N/A Specifies whether audio encoding G.711 A-Law on this call leg
is allowed to be transcoded:
• enabled
• disabled (default)
thislegG711u N/A Specifies whether audio encoding G.711 u-Law on this call leg is
allowed to be transcoded:
• enabled
• disabled (default)
thislegG7231 N/A Specifies whether audio encoding G.723.1 on this call leg is
allowed to be transcoded:
• enabled
• disabled (default)
thislegG726 N/A Specifies whether audio encoding G.726 on this call leg is
allowed to be transcoded:
• enabled
• disabled (default)
thislegG729 N/A Specifies whether audio encoding G.729 on this call leg is
allowed to be transcoded:
• enabled
• disabled (default)
thislegiLBC N/A Specifies whether audio encoding iLBC on this call leg is
allowed to be transcoded:
• enabled
• disabled (default)
thislegAMR N/A Specifies whether audio encoding AMR (octet-align mode) on
this call leg is allowed to be transcoded:
• enabled
• disabled (default)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Packet Service Group CLI Reference
Field
Parameter Length Description
thislegEFR N/A Specifies whether audio encoding EFR on this call leg is allowed
to be transcoded:
• enabled
• disabled (default)
thislegt38 N/A Specifies whether fax media encoding T.38 on this call leg is
allowed to be transcoded:
• enabled
• disabled (default)
thislegall N/A Specifies whether all media encoding on this call leg is allowed
to be transcoded:
• enabled
• disabled (default)
otherlegG711a N/A Specifies whether audio encoding G.711 A-Law on the other call
leg is allowed to be transcoded:
• enabled
• disabled (default)
otherlegG711u N/A Specifies whether audio encoding G.711 u-Law on the other call
leg is allowed to be transcoded:
• enabled
• disabled (default)
otherlegG7231 N/A Specifies whether audio encoding G.723.1 on the other call leg
is allowed to be transcoded:
• enabled
• disabled (default)
otherlegG726 N/A Specifies whether audio encoding G.726 on the other call leg is
allowed to be transcoded:
• enabled
• disabled (default)
otherlegG729 N/A Specifies whether audio encoding G.729 on the other call leg is
allowed to be transcoded:
• enabled
• disabled (default)
otherlegiLBC N/A Specifies whether audio encoding iLBC on the other call leg is
allowed to be transcoded:
• enabled
• disabled (default)
otherlegAMR N/A Specifies whether audio encoding AMR (octet-align mode) on
the other call leg is allowed to be transcoded:
• enabled
• disabled (default)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Packet Service Group
Field
Parameter Length Description
otherlegEFR N/A Specifies whether audio encoding EFR on the other call leg is
allowed to be transcoded:
• enabled
• disabled (default)
otherlegt38 N/A Specifies whether fax media encoding T.38 on the other call leg
is allowed to be transcoded:
• enabled
• disabled (default)
otherlegall N/A Specifies whether all media encoding on the other call leg is
allowed to be transcoded:
• enabled
• disabled (default)
admin-state N/A The administrative state of this packet service profile:
• disabled (default) - Not activated, able to be deleted.
• enabled - Activated, available for immediate use.
suite N/A A prioritized list of supported crypto suites that the GSX/NBS
uses in one or more crypto attributes (a=crypto) of SDP offers
and answers when negotiating Secure RTP calls using this
profile.
• nosuite - Remove all specified crypto suites from this
profile.
• aes-cm-128-hmac-sha1-80 (default) - Add the aes-cm-
128-hmac-sha1-80 crypto suite to this profile.
fb_rtp N/A Specifies whether calls being negotiated for a specified packet
service profile can fall back to regular RTP if the crypto attribute
offer/answer fails, or when the maximum number of Secure RTP
sessions has been reached.
• false (default) - Don't fall back to regular RTP.
• true - Allow fallback to regular RTP.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Packet Service Group CLI Reference
Field
Parameter Length Description
srtp_param N/A By default, SRTP and SRTCP packet payloads are both
authenticated and encrypted. You may optionally specify any
combination of these Secure RTP session parameters as not to
be used, by setting the appropriate session parameters as
follows.
• none - Remove all of these Secure RTP session parameters
from this profile.
• unencrypted_srtp - Do not encrypt Secure RTP packet
payloads.
• unencrypted_srtcp - Do not encrypt Secure RTCP packet
payloads.
• unauthenticated_srtp - Do not authenticate Secure RTP
packet payloads (not recommended.)
You can select more than one of the session parameters by
using the "|" between selections.
srtp_state N/A Enables or disables use of Secure RTP for calls using this
packet service profile as follows:
• disabled (default) - Do not negotiate for SRTP, and ignore
peer request for SRTP. Accept the call using RTP.
• enabled - Act based upon the SRTP FALLBACKTORTP
state:
false - Negotiate for SRTP; reject the call if security
mismatch.
true - Use RTP.
videomaxbw N/A Specifies the maximum bandwidth in kilobits per second for the
video stream. The video stream will be policed at this rate. This
value must include all codec-specific header and payload data
as well as any non-codec header data including RTP, UDP, IP,
Ethernet, or MAC. Must be 0-2048 Kbps; default is 0 (which
disallows video for the call).
videobwreduct N/A Specifies the percentage that the configured MAXIMUM VIDEO
BANDWIDTH (videomxbw) should be reduced to determine the
IP bandwidth that should be allocated from the IP trunk group
and NIF to a video call. Must be 1-100 (percent); default is 0.
videofailure N/A Specifies whether a call should continue as audio only call when
video cannot be established for any reason. If this field is
enabled in either egress or ingress Packet Service Profiles, the
audio stream of the call continues using normal negotiation
process and the video request is rejected via a port 0 in the
subsequent answer exchange. If this field is disabled in both
egress and ingress Packet Service Profiles, the call is rejected.
• disabled
• enabled (default)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Packet Service Group
Field
Parameter Length Description
tosservice N/A Specifies the Type of Service (TOS) parameters to be provided
in the IP header for voice packets. Must be 0-255; default is 0.
Note: The default Packet Service Profile (PSP) configured by
the GSX CLI is only used to fill gaps where a PSP is omitted
from a PSX query response. This is inadequate for the
differential marking of media packets, because it supplies only
one pair of TOS/COS values; the same for HPC and non-HPC
calls.
cosservice N/A Specifies the Class of Service (COS) value to be set in the IEEE
802.1D User Priority field of media packets transmitted on a call
leg that uses this Packet Service Profile. This parameter only
has an effect if the network interface supports 802.1Q tagged
Ethernet frames. Must be 0 - 7; default is 0 (best effort).
Note: The default Packet Service Profile (PSP) configured by
the GSX CLI is only used to fill gaps where a PSP is omitted
from a PSX query response. This is inadequate for the
differential marking of media packets, because it supplies only
one pair of TOS/COS values; the same for HPC and non-HPC
calls.
Field
Parameter Length Description
pri N/A The priority of the specified CODEC in this Packet Service Profile
priority list. Because there are four entries in this list, must be 1-
4.
G711pktsize N/A For CODECs G711 and G711SS, the packet size in milliseconds.
Must be 10-40, in increments of 5. Default is 10 (milliseconds).
Packets of this size will be transmitted. Received packet sizes
will range from 10 to 40 milliseconds.
G723pktsize N/A For CODECs G7231 and G7231A, the packet size in
milliseconds. Must be 30-150, in increments of 30. Default is 30
(milliseconds).
Packets of this size will be transmitted. Received packet sizes
will range from 30 to 90 milliseconds.
G729pktsize N/A For CODECs G726, G729A, and G729AB, the packet size in
milliseconds. Must be 10-40, in increments of 10. Default is 20
(milliseconds).
Packets of this size will be transmitted. Received packet sizes
will range from 10 to 40 milliseconds.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Packet Service Group CLI Reference
Field
Parameter Length Description
ilbcpktsize N/A For CODECs iLBC and iLBCSS, the packet size in milliseconds.
Must be 20-60 milliseconds, in multiples, based on the coding
rate. The default is 30ms for 13.333 kbps and 20ms for 15.2
kbps.
Packets of this size will be transmitted. Received packet sizes
will range from 20 to 60 milliseconds.
law N/A For CODECs G711 and G711SS, the G.711 Law value:
• lawFromCircuit (default) - determine the G.711 Law from
the Circuit Service Profile setting for this call.
• uLaw - use this audio encoding method for ISUP (protocol)
REVISIONs ansi1992 and ansi1995
• aLaw - use this audio encoding method for all other ISUP
REVISIONs
This parameter applies to egress calls (to the IP network) from
the GSX. For ingress calls to the GSX (from the IP network), the
remote peer always determines the G.711 Law value.
sendsid N/A For CODEC G711SS, specifies whether Silence Insertion
Descriptor (SID) packets are sent during a call:
• enabled - send SID packets during silence intervals to
provide an estimate of the background noise to the receiving
end.
• disabled (default) - Do not send SID packets, placing the
burden on the remote side to determine the way it will
generate comfort noise.
codingrate723 N/A For CODECs G7231 and G7231A, the coding rate in bits per
second:
• r5300bps
• r6300bps (default)
codingrate726 N/A For CODEC G726, the coding rate in bits per second:
• r32kbps (default) - currently, the only supported rate
codingratilbc N/A For CODECs iLBC and iLBCSS, the coding rate in bits per
second:
• 13333bps (default)
• 15200bps
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Packet Service Group
Field
Parameter Length Description
modemtrtmnt N/A Specifies the treatment taken when the modem tone is
detected:
• none (default) - For all signaling types, do nothing.
• notifyPeer - For SIP signaling, notify peer and let the peer
decide the next action.
• disconnect - For all signaling types, disconnect the call.
• g711fallback - For SIP and H.323 signaling, fallback to
G.711.
For G.711 calls, notifyPeer and disconnect require a
compression resource to be allocated.
modemfailure N/A Specifies the behavior when a modem tone is detected but
modem tone treatment fails for any reason:
• disconnect - release the call
• continue (default) - continue to process the call
One example of modem tone treatment failure occurs when, on
a fallback to G.711, the bandwidth exceeds the thresholds set in
the gateway due to high call volume or high bandwidth per call.
faxtrtmnt N/A Specifies the treatment given when a fax tone is detected:
• none (default) - For all signaling types, do nothing.
• notifyPeer - For SIP signaling, notify peer and let the peer
decide the next action.
• disconnect - For all signaling types, disconnect the call.
• g711fallback - For all signaling types, fallback to G.711.
• faxRelay - For all signaling types, use T.38 fax relay
protocol.
• faxRelayOrG711Fallback - For SIP and H.323 signaling,
use T.38 fax relay protocol if the peer supports this protocol.
If the peer does not support T.38, fallback to G.711.
For G.711 calls, notifyPeer, disconnect, faxRelay, and
faxRelayOrG711Fallback require a compression resource
to be allocated.
faxfailure N/A Specifies the behavior when a fax tone is detected but fax tone
treatment fails for any reason.
• disconnect - Release the call.
• continue (default) - Continue to process the call. This
behavior is equivalent to faxRelayOrG711Fallback.
When fax tone is detected, initiate a T.38 Re-INVITE. If the
peer rejects the Re-INVITE, fallback to G.711.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Packet Service Group CLI Reference
Field
Parameter Length Description
dtmfrelay N/A Specifies the type of DTMF Relay to use when DTMF digits are
detected in the data stream:
• none (default) - For all signaling types, do nothing.
• longDigit - For SIP signaling when long digit (# or ##)
recognition is enabled on the appropriate CNS. When the
long digit is detected, notify the SIP signaling peer on the SIP
signaling channel via SIP INFO messages.
• outOfBand - For all signaling types, deliver DTMF digits on
the signaling channel. For SIP, DTMF is delivered in SIP
INFO messages. For H323, the procedures of H.245 User
Indication are used. For CODECs G711 and G711SS, this
parameter value causes a compression resource to be
allocated.
• rfc2833 - For all signaling types, deliver DTMF digits within
the RTP stream by using different packet payload types (the
RFC2833 mechanism). The payload type when this setting is
in effect is controlled by the RESOURCE PAD ..
RTPPAYLOADTYPE .. DTMFRELAY parameter. See "Packet
Assembler Disassembler (PAD) Resources" on page 3–726.
For CODECs G711 and G711SS, this parameter value
causes a compression resource to be allocated.
Setting outOfBand or rfc2833 will force a compression
resource to be allocated, even if the call uses G.711 audio.
For further SIP handling details, see "SIP DTMF Detection/
Insertion Handling" on page 6–146.
dtmfrlyrd N/A Specifies whether or not to remove DTMF digits from the media
stream. This applies only if DTMF RELAY is set to outOfBand or
rfc2833:
• disabled - Do not remove DTMF digits.
• enabled (default) - Remove DTMF digits.
ilbcpayloadtype N/A Specifies the preferred RTP payload type for iLBC and iLBCSS
codecs, to be set in the RTP header of audio packets. The
preference may not be honored if the signaling peer offers a
different value first. Must be 0-127; there is no default.
amrwbpktsize N/A For all variants of the CODEC AMRWB (G7222), the packet sizes
in milliseconds. Must be 20-100, in increments of 20. Default is
20 (milliseconds).
Packets of this size will be transmitted. Received packet sizes
will range from 20 to 100 milliseconds.
amrwbpaylodtype N/A For the AMRWB codec, specifies the preferred RTP payload type
for all variants of the AMRWB codec, to be set in the RTP
header of audio packets for this encoding. Must be 0-128; there
is no default.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Packet Service Group
Field
Parameter Length Description
amrwbmodeset N/A Specifies a set of bit rates to support for a session (optional). If
configured, the highest provided rate is used for bandwidth
calculations. If it is not present, the highest bit rate (23.85 kbits
per second) is used for bandwidth calculation.
• r6600bps (default)
• r8850bps
• r12650bps
• r14250bps
• r15850bps
• r18250bps
• r19850bps
• r23050bps
• r23850bps
G722pktsize N/A For CODECs G722 and G722SS, specifies the packet size in
milliseconds. Must be 10-40, in increments of 10; default is 10
(milliseconds).
Packets of this size will be transmitted. Received packet sizes
will range from 10 to 40 milliseconds.
G722payloadtype N/A For CODECs G722 and G722SS, specifies the preferred RTP
payload type for G722 and G722SS codecs, to be set in the RTP
header of audio packets for this encoding. Must be 0-128; there
is no default.
G7221pktsize N/A For CODECs G7221 and G7221SS, the packet size in
milliseconds. Must be 20-80, in increments of 20; default is 20
(milliseconds).
Packets of this size will be transmitted. Received packet sizes
will range from 20 to 80 milliseconds.
G7221codingrate N/A For CODECs G7221 and G7221SS, the coding rate in kbits per
second:
• r24kbps (default)
• r32kbps
G7221payloadtype N/A For CODECs G7221 and G7221SS, specifies the preferred RTP
payload type for G7221 and G7221SS codecs, to be set in the
RTP header of audio packets for this encoding. Must be 0-128;
there is no default.
G728pktsize N/A For CODECs G728 and G728SS, the packet size in milliseconds.
Must be 10-150, in increments of 10, default is 10
(milliseconds).
Packets of this size will be transmitted. Received packet sizes
will range from 10 to 150 milliseconds.
G728payloadtype N/A For CODECs G728 and G728SS, specifies the preferred RTP
payload type for G728 and G728SS codecs, to be set in the
RTP header of audio packets for this encoding. Must be 0-128;
there is no default.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Packet Service Group CLI Reference
Field
Parameter Length Description
amrvariant N/A Specifies the AMR encoding variant:
• amrBandwidthEfficient
• amrOctetAligned
• amrCrc
• amrCrcInterleaving
• amrCrcRobustSorting
• amrCrcInterleavingRobustSorting
• amrInterleaving
• amrInterleavingRobustSorting
• amrRobustSorting
amrpktsize N/A For the AMR codec (all variants), specifies the packet size in
milliseconds. Must be 20 - 60, in increments of 20. Default is 20
(milliseconds).
amrpktredun N/A For the AMR codec, specifies the RTP Redundancy level (used
when calculating bandwidth):
• none (default)
• one
• two
amrpayloadtype N/A Specifies the preferred RTP payload type to be set in the RTP
header of audio packets for AMR encoding. The preference
may not be honored if the signaling peer offers a different value
first. Must be 0 - 128; default is 128.
gancmode N/A For the AMR codec, specifies whether Generic Access Network
Controller (GANC) mode is enabled:
• enabled
• disabled (default)
modeset N/A Specifies the AMR active codec mode set:
• r4750bps
• r5150bps
• r5900bps
• r6700bps
• r7400bps
• r7950bps
• r10200bps
• r12200bps
For GANC Mode, you can select up to 4 out of the first 8 modes.
For Generic Mode, you can select all 8 modes.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Packet Service Group
Field
Parameter Length Description
efrpktsize N/A For the EFR codec, specifies the packet size in milliseconds.
Must be 20 - 60, in increments of 20. Default is 20
(milliseconds).
efrpayloadtype N/A Specifies the EFR Payload Type. Specifies the preferred RTP
payload type to be set in the RTP header of audio packets for
EFR encoding. The preference may not be honored if the
signaling peer offers a different value first. Must be 0 - 128;
default is 128.
The manipulations below are performed by the GSX software on the Packet Service Profile used
for calls between two GSXs that use Sonus Gateway signaling protocol. These overrides optimize
Voice over IP performance between two GSXs. Notice that these may be imposed on certain
CODEC parameters of Packet Service Profiles that originate on the PSX.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Packet Service Group CLI Reference
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Packet Service Group
To create and configure the h323default packet service profile such that H.323 calls into the
GSX are set up with G729AB compression using DTMF via H245 DTMF Relay between the GSX
and the H.323 peer (provided the H.323 peer supports H245 DTMF Relay):
% CREATE PACKET SERVICE PROFILE h323default
% CONFIGURE PACKET SERVICE PROFILE h323default PRIORITY 1 ..
CODEC g729ab DTMF RELAY outofband
% CONFIGURE PACKET SERVICE PROFILE h323default STATE enabled
To create and configure the sipdefault packet service profile such that SIP calls into the GSX
are set up with G729AB compression using DTMF transported via RFC 2833 between the GSX
and the SIP peer (provided the SIP peer also supports RFC 2833):
% CREATE PACKET SERVICE PROFILE sipdefault
% CONFIGURE PACKET SERVICE PROFILE sipdefault PRIORITY 1 ..
CODEC g729ab DTMF RELAY rfc2833
% CONFIGURE PACKET SERVICE PROFILE sipdefault STATE enabled
To configure the sipdefault packet service profile such that SIP calls are enabled for T.38 fax
relay (where the call is initially set up for audio):
% CONFIGURE PACKET SERVICE PROFILE sipdefault PRIORITY 1 FAX ..
TREATMENT faxrelay
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Packet Service Group CLI Reference
To configure the sipdefault packet service profile such that SIP calls are enabled for G.711
fallback (where the call is initially set up for audio):
% CONFIGURE PACKET SERVICE PROFILE sipdefault PRIORITY 1 FAX ..
TREATMENT g711Fallback
In the above examples, if the h323default and sipdefault packet service profiles are not
present, the default packet service profile would need to be configured as shown, to achieve
these results.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Packet Service Group
Packet to Packet functionality brings data and signaling flows through the GSX between packet
interfaces in addition to flows between circuit interfaces and flows between circuit and packet
interfaces.
Command Syntax
Command Parameters
Field
Parameter Length Description
admin-state N/A The administrative state of packet to packet routing capabilities in
this GSX.
• disabled (default) - Not able to route packet to packet data
flows.
• enabled - Packet to packet data flows are in effect for call
routing.
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Voice Packet Resources CLI Reference
These objects specify packet assembly and echo canceller processing that takes place on the circuit
network server modules.
Media Profile
This object creates a template for the audio compression capabilities to be utilized on individual
SPS and CNS25, CNS45, CNS85, and CNS86 server modules on a GSX9000, and GNS modules
on a GSX4000 series switch. Each media profile is derived from a Sonus supplied DSP media base
type listed in the BASEMEDIAPROFILE. The BASEMEDIAPROFILE takes one of four base types:
1. Voice Compression
2. Universal Compression and Tone in a 4:1 ratio and Bridge Conferencing
3. Universal Compression and Tone in a 1:1 ratio and Bridge Conferencing
4. Bridge Conferencing
For base types 1-3, one of six compression types may be specified (enabled or disabled) in a
media profile object:
• G729AB - G.729A and G.729A+B (Silence Suppression)
• G7231 - G.723.1 and G.723.1A (Silence Suppression)
• G726 - G.726
• ILBC - Internet Low Bit-Rate Codec and iLBSS (Silence Suppression)
• GSM - Global System for Mobile Communication codecs, including Adaptive Multi-Rate
(AMR) and Enhanced Full Rate (EFR) codecs.
• PXPAD - Packet XPADs for optimized compression of G72X (including ILBC and T.38) <-->
G711 packet-to-packet calls
NOTE
iLBC and GSM codecs and PXPAD capabilities are not supported on CNS25
modules. Furthermore, any media profile that is assigned to a CNS25 must use one
and only one of the G72X compression types.
CNS25, CNS45, CNS85, CNS86, SPS, and GNS modules may be associated with any
combination of these types, including none (see the command examples).
See "Configuring the SPS70 and SPS80 High Density Signal Processing Server" on page 6–9 for
additional detail on using MEDIA PROFILE to provision redundant SPS70 and SPS80 servers.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Voice Packet Resources
Command Syntax
Command Parameters
Field
Parameter Length Description
mprofilename 1-23 The name of the media profile that is being created and
configured.
bmprofno N/A Specifies the base type to be applied to this media profile.
Currently this must be:
• 1 (default) - Voice Compression.
• 2 - Universal Compression + Tone with a 4:1 ratio and
Conferencing.
• 3 - Universal Compression + Tone with a 1:1 ratio and
Conferencing.
• 4 - Conferencing.
g729ab_state N/A Specifies whether G.729A and G.729A+B (Silence Suppression)
compression is applied to the PAD resources controlled by this
media profile:
• enabled - Provide G729AB compression.
• disabled (default) - Do not provide G729AB compression.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Voice Packet Resources CLI Reference
Field
Parameter Length Description
g7231_state N/A Specifies whether G.723.1 and G.7231A (Silence Suppression)
compression is applied to the PAD resources controlled by this
media profile:
• enabled - Provide G7231 compression.
• disabled (default) - Do not provide G7231 compression.
g726_state N/A Specifies whether G.726 compression is applied to the PAD
resources controlled by this media profile:
• enabled - Provide G726 compression.
• disabled (default) - Do not provide G726 compression.
ilbc_state N/A Specifies whether the Internet Low Bit Rate Codec (iLBC) is
applied to the PAD resources controlled by this media profile:
• enabled - Provide iLBC compression.
• disabled (default) - Do not provide iLBC compression.
gsm_state N/A Specifies whether the GSM (Global System for Mobile
communication) codecs AMR/EFR are applied to the PAD
resources controlled by this media profile.
• enabled - Provide GSM codec compression.
• disabled (default) - Do not provide GSM codec
compression.
pxpad_state N/A Specifies whether the Packet XPAD (PXPAD) capability is
enabled in this media profile.
• enabled - Use one PXPAD for G72X <--> G711 transcoded
calls.
• disabled (default) - Use 2 Back-to-Back (B2B) XPADs for
G72X <--> G711 transcoded calls, resulting in compromised
compression resource allocation.
This packet-to-packet capability provides G72X <--> G711 call
compression. It may be applied on SPS, CNS4X, and CNS8X
modules and on the GSX4000 chassis.
admin-state N/A The administrative state of the designated media profile:
• disabled (default) - Not activated, able to be configured.
• enabled - Active.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Voice Packet Resources
Command Example
NOTE
The t38 profile above directs PAD resources to the support of G.711 and T.38
compression only. The universal profile above directs PAD resources to all
compression types. These profiles may be assigned to an SPS, CNS45, CNS85,
CNS85, or GNS, but may not be assigned to a CNS25 module.
To create media profile, profile_A, to use PXPAD for G.729AB <--> G711 and G.726 <-->
G711 packet-to-packet call compression:
% CREATE MEDIA PROFILE profile_A BASMEDIAPROFILE 1
% CONFIGURE MEDIA PROFILE profile_A G729AB enabled G726 enabled ..
G7231 disabled ILBC disabled GSM disabled PXPAD enabled
To create media profile, profile_B, to use PXPAD for G.723 <--> G711 packet-to-packet call
compression:
% CREATE MEDIA PROFILE profile_B BASMEDIAPROFILE 1
% CONFIGURE MEDIA PROFILE profile_B G729AB disabled G726 disabled ..
G7231 enabled ILBC disabled GSM disabled PXPAD enabled
-------------------------------------------------------------------------------
Media Profiles
--------------------------------------------------------------------------------
Index Name State Status Base G729 G726 G723 iLBC GSM PXPAD
----- ---- ----- ------ ---- ---- ---- ---- ---- ---- -----
2 universal ENABLED IS 1 ENA ENA ENA ENA DIS DIS
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Voice Packet Resources CLI Reference
-------------------------------------------------------------------------------------
Media Profiles
-------------------------------------------------------------------------------------
Index Name State Status Base G729 G726 G723 iLBC GSM PXPAD
----- ---- ----- ------ ---- ---- ---- ---- ---- ---- -----
1 default ENABLED OOS 1 DIS ENA DIS DIS DIS DIS
2 pinto ENABLED IS 1 ENA ENA ENA DIS DIS DIS
3 universal ENABLED OOS 1 ENA ENA ENA ENA DIS DIS
4 profile_A ENABLED OOS 1 ENA ENA DIS DIS DIS ENA
5 profile_B ENABLED OOS 1 DIS DIS ENA ENA DIS ENA
------------------------------------------------------
Media Profile Base Types
------------------------------------------------------
Index Description
----- -----------
1 Voice Compression
2 Compr+Tone(4:1)+ Bridge
3 Compr+Tone(1:1)+ Bridge
4 Bridge Conference
PXPAD Limitations
Some limitations may apply when a packet-to-packet call is set up with one PXPAD compression
resource as compared to the same call set up with either two B2B XPADs or two B2B PXPADs.
With the call set up using single PXPAD, certain combinations of DTMF Relay, Mid-Call DTMF
detect and T.38 Fax Relay are impaired. These should be considered when you provision MEDIA
PROFILEs for calls in which these circumstances may occur.
• If the call legs involve DTMF Relay interworking between In-band RFC and out-of-band, the
following scenario could arise. If the call is set up as compressed codec (Side A) with DTMF
RELAY = none and other leg (Side B) is G711 with DTMF RELAY = rfc2833 or outOfBand,
then DTMF digits coming as In-band from A can not be detected by PXPAD. Thus these digits
can not be regenerated towards Side B as either rfc2833 or outOfBand and hence these
digits can not be transported to Side B. Depending on fidelity of the compressed signal with
respect to the original DTMF signal, this scenario may function if two XPADs or two
PXPADs, are used for the compression resources.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Voice Packet Resources
• The above scenario also applies to Mid-Call DTMF detect. If the Packet Service Profile for
Side B is configured to send mid call DTMF digit notification to its peer, then it can not be
done if Side A is In-band. Depending on fidelity of the compressed signal with respect to the
original DTMF signal, this scenario may function if two XPADs or two PXPADs, are used for
the compression resources.
NOTE
These DTMF limitations do not apply if side A is configured to be G711 or G726.
• If the audio call is set up as G11 to G72x (using any compression codec) and a fax is sent from
calling to called (that is, from the G711 side to the compressed side), then the called peer is
expected to detect the answer tone and re-INVITE the NBS with T.38. NBS will not detect the
T.38 fax tone and hence will not issue a T.38 re-INVITE to the called peer. Had the same call
been set up with two B2B XPADs, then in the absence of answer tone detection by the peer,
the NBS may detecte fax tone, depending on the fidelity of the fax signal after compression,
and send a RE-INVITE to the peer.
This object allows you to specify the characteristics of packet assembly and disassembly used
throughout the shelf. The PAD resources exist on all CNS server modules as well as the SPS70
and SPS80 server module on a GSX9000 and GNS modules on a GSX4000 series switch.
The GSX9000 provides six server modules that perform audio compression via their on-board
Digital Signal Processors (DSPs):
• CNS25 - The CNS25 server module supports the E1 circuits that are physically attached to its
adapter module, the CNA25. Each CNS25 is restricted to one and only one audio compression
type value, and must be associated with a media profile that meets this requirement. The PAD
resources on the CNS25 can also be used by other CNS modules.
• CNS45 - The CNS45 server module supports the T1 or E1 circuits that are physically attached
to its adapter module, the CNA40. The PAD resources on the CNS45 can also be used by other
CNS modules.
• CNS85 - The CNS85 server module supports the T3 or T1 circuits that are physically attached
to its adapter module, the CNA80. The PAD resources on the CNS85 can also be used by other
CNS modules.
• CNS86 - The CNS86 server module supports the T3 or T1 circuits that are physically attached
to its adapter module, the CNA81. The PAD resources on the CNS86 can also be used by other
CNS modules.
• SPS70 and SPS80 - The Signal Processing Servers (SPS70, SPS80) are dedicated signal
processing server modules that is used without I/O ports (that is, without an adapter module).
These modules are configured as if it is a “DSP farm” with processing resources for calls on
any of the T1/E1 circuits connected to the GSX. One SPS70 or SPS80 may assigned to
multiple compression types through an appropriately configured media profile.
The GSX4000 also provides audio compression via its on-board Digital Signal Processors (DSPs).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Voice Packet Resources CLI Reference
Audio compression of the following types may be assigned to the above mentioned resources:
• G.729A
• G.729A+B (Silence Suppression)
• G.723.1
• G.723.1A (Silence Suppression)
• G.726
• iLBC (SPS70, SPS80, CNS4x, CNS8x, and GSX4000 only)
• iLBCSS (Silence Suppression) (SPS70, SPS80, CNS4x, CNS8x, and GSX4000 only)
• AMR and EFR (SPS70, SPS80, CNS4x, CNS8x, and GSX4000 only when configured for
GSM)
A packet outage is the loss of incoming voice (RTP) packets. If a PAD on any CNS, GNS, or SPS
server module detects a packet outage that exceeds the PACKET OUTAGE THRESHOLD, a "set" trap
is generated after the call is disconnected. The set trap displays a count for the total outage
occurrences on the shelf and the slot of the affected module. Ten seconds after the last detected
outage, a "clear" trap is generated to indicate that the condition has not occurred for a 10 second
interval on the shelf and slot. A counter for the occurrences within the interval is displayed in the
clear trap. A total occurrence counter increments with every packet outage that exceeds the
threshold on a CNS/GNS/SPS. The counter can be reset via .. PACKET OUTAGE RESET TOTAL
COUNTER.
Packet outages cannot be detected if T.38 is used in a call. Calls that use a silence suppression
algorithm need to specify a heartbeat of an appropriate interval to detect outages. A summary of
these and associated considerations is shown in Table 3–155.
Expanded configuration capabilities for PAD resources on the CNS25, CNS45, SPS70, and SPS80
are available through the MEDIA PROFILE CLI object. See "Configuring the SPS70 and SPS80
High Density Signal Processing Server" on page 6–9 for a detailed description of this interface.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Voice Packet Resources
NOTE
You must disable the SID Heartbeat for SIP, H.323, and MGCP calls using G.711
with silence suppression and RTCP, in order to avoid premature Packet Outage
Detection (POD) detection and the associated RTCP events.
Through the SHOW commands, you may examine the configuration and status of the PAD
resources on any individual CNS or SPS server module.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Voice Packet Resources CLI Reference
Each SPS70, SPS80, and GNSx supports any combination of the G.723, G.726, G.729, and iLBC
codecs from a single codec to all four codec types. However, the AMR and EFR codecs can not be
configured with any other codec. The default codec on the SPS70, SPS80, and GNSx is G.726; the
codec choice determines how many channels are supported. Note that codecs are licensed for use
by Sonus Networks and the SPS70, SPS80, and GNSx should be configured only for the codecs
that have already been licensed. Table 3–156 lists the codec choices possible in the media profile
and the number of channels supported:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Voice Packet Resources
The GSX monitors the affects of packet loss and jitter exceeding the jitter buffers capacity using
the playout time series. The playout time series consists of 31 quality measurements, with each
measurement representing a consecutive time period. Taken as a whole, the measurements
represent how the playout buffer viewed the jitter and packet loss over consecutive time periods.
Within each time period the quality is classified into four possible values:
• Good
• Acceptable
• Poor
• Unacceptable
Anytime the playout buffer has no data to play due to packet loss or excessive jitter, the GSX
tracks the duration of this during a time period. The total duration of the missing data during a time
period is compared against three programmable thresholds to classify the performance during the
period (THRESHOLD0, THRESHOLD1, and THRESHOLD2). The comparison works as listed in
Table 3–157.
The time series provides an approximate indication of the locations (in time) of packet problems
for determining call problems due to, for example, a large single-event outage or a continuous
series of packet issues distributed throughout the call.
Since the time period is fixed, the duration of the calls affect the number of time period intervals
that are used for collecting data. Using a default time period of 20 seconds, a short call of 1-30
seconds only produces data for one or two time periods, whereas a longer call lasting 10 minutes
will have data for the last 30 time periods. Calls lasting longer than 31 time periods will have data
for the last 31 time periods of the call only (old data is discarded). If you wish to obtain data at a
more granular level, you can configure the time period to be shorter, however this precludes you
from monitoring longer calls (since only the last 31 time periods are recorded).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Voice Packet Resources CLI Reference
To configure the playout time series parameters, you set the thresholds to detect a certain
percentage of missing data within a time period. For example, to configure a 20-second time
period where between 1 and 2 percent of missing data is considered Poor quality, and more than 2
percent of missing data is considered Unacceptable:
Command Syntax
NOTE
When issuing RESOURCE PAD commands on a GSX4000 series switch, omit the
SHELF and SLOT parameters.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Voice Packet Resources
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Voice Packet Resources CLI Reference
Command Parameters
Field
Parameter Length Description
shelf N/A The shelf number in the GSX node configuration. In this
release, one shelf is supported. Must be 1.
Note: This parameter does not apply to GSX4000 series
switches.
slotnumber N/A The slot number occupied by the CNS or SPS server module
for which PAD Resource status is being assigned or displayed.
This number must be 3-16.
Note: This parameter does not apply to GSX4000 series
switches.
g7231thrsno N/A This positive integer is a percentage that indicates the usage
threshold for G.723.1 resources in the node. When this usage
level or threshold is reached, an event (and possibly a trap) will
be generated. A trap is generated if G7231 STATE is enabled.
Must be 1-100, default is 90.
Thus, by default, an event and a trap are generated when the
GSX software detects that the G.723.1 resources are 90% (or
more) utilized.
g7231_state N/A Specifies whether a trap will be generated when G.723.1
resources are reduced beyond a threshold value:
• enabled (default) - generate the trap
• disabled - do not generate the trap
g726thrsno N/A This positive integer is a percentage that indicates the usage
threshold for G.726 resources in the node. When this usage
level or threshold is reached, an event (and possibly a trap) will
be generated. A trap is generated if GB726 STATE is enabled.
Must be 1-100, default is 90.
Thus, by default, an event and a trap are generated when the
GSX software detects that the G.726 resources are 90% (or
more) utilized.
g726_state N/A Specifies whether a trap will be generated when G.726
resources are reduced beyond a threshold value:
• enabled (default) - generate the trap
• disabled - do not generate the trap
g729abthrsno N/A This positive integer is a percentage that indicates the usage
threshold for G.729A+B resources in the node. When this
usage level or threshold is reached, an event (and possibly a
trap) will be generated. A trap is generated if GB729AB STATE
is enabled. Must be 1-100, default is 90.
Thus, by default, an event and a trap are generated when the
GSX software detects that the G.729A+B resources are 90%
(or more) utilized.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Voice Packet Resources
Field
Parameter Length Description
g729ab_state N/A Specifies whether a trap will be generated when G.729A+B
resources are reduced beyond a threshold value:
• enabled (default) - generate the trap
• disabled - do not generate the trap
tonethrsno N/A This positive integer is a percentage that indicates the usage
threshold for tone processing resources in the node. When this
usage level or threshold is reached, an event (and possibly a
trap) will be generated. A trap is generated if TONE STATE is
enabled. Must be 1-100, default is 90.
Thus, by default, an event and a trap are generated when the
GSX software detects that the tone processing resources are
90% (or more) utilized.
tone_state N/A Specifies whether a trap will be generated when tone
processing resources are reduced beyond a threshold value:
• enabled (default) - generate the trap
• disabled - do not generate the trap
uncmpthrsno N/A This positive integer is a percentage that indicates the usage
threshold for universal compression resources in the node.
When this usage level or threshold is reached, an event (and
possibly a trap) will be generated. A trap is generated if TONE
STATE is enabled. Must be 1-100, default is 90.
Thus, by default, an event and a trap are generated when the
GSX software detects that the universal compression resources
are 90% (or more) utilized.
uncomp_state N/A Specifies whether a trap will be generated when universal
compression resources are reduced beyond a threshold value:
• enabled (default) - generate the trap
• disabled - do not generate the trap
evper N/A Jitter evaluation period. Time period in which to decide when to
periodically evaluate playout occupancy in milliseconds. This
parameter determines the rate at which the jitter buffer is
adapted. This value should be set in a range that covers
somewhere between 0.5 seconds to 2 seconds although you
can set it to numbers outside this range. If this number is too
small the jitter buffer algorithm may tend to discard samples too
aggressively causing small losses of audio. If the number is too
large the excess delay built up in the jitter buffer will remain for
a long time before it can be removed. The default setting of 1
second is a reasonable compromise. Must be 10-300000,
default is 1000.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Voice Packet Resources CLI Reference
Field
Parameter Length Description
minocthrsh N/A Minimum jitter buffer occupancy threshold (in milliseconds). The
occupancy below which playout time is advanced if this
occupancy has existed for the JITTER EVALPERIOD. This
value is the target minimum occupancy of the buffer assuming
the actual network jitter is small enough to reach this number.
The minimum occupancy of the jitter buffer over time represents
the delay added before audio is played out to the PSTN. This
value is used to prevent excess delay from building up in the
jitter buffer if the delay is not needed. If the network jitter is
small enough the occupancy will gradually be brought down to
this level or possibly lower. If you know the expected jitter in
your network then you should set this threshold equal to or
slightly larger than this jitter in order to have minimum delay. If
the actual jitter is higher then some samples may (infrequently)
be discarded, depending on the statistics of the signal. If the
actual jitter is somewhat smaller then you may have some
accumulated delay (less than or equal to this value) in the jitter
buffer. This represents the trade-off between maintaining
minimum delay and discarding samples. Must be 2-200
(covering a delay of 2 to 200 milliseconds), default is 20
(milliseconds). Setting this number to 200 will disable jitter
buffer adaptation.
dtmfrelay N/A This integer specifies the RTP payload type to use for DTMF
Relay during compressed calls.
Must be 96-127, default is 100. When running RFC 2833 with
H.323 or SIP signaling, H.323 disallows 0-95.
Under GSX gateway to gateway signaling, this parameter value
may differ on the respective GSXs.
mintime N/A This integer specifies the minimum time between SID packets,
in milliseconds, when the CODEC in the Packet Service Profile is
G711SS. This ensures that SID packets will not be sent too
frequently when the background noise is changing, but instead
some minimum amount of compression will still occur. Must be
50-300000, default is 200 (milliseconds).
maxtime N/A This integer specifies the maximum time between SID packets,
in milliseconds, when the CODEC in the Packet Service Profile is
G711SS, G7231A, or G729AB. If SID HEARTBEAT in the Packet
Service Profile is enabled, the SID packets will be sent during
silence intervals lasting longer than the value specified by this
parameter. These packets can be used to keep a minimum
level of bearer traffic flowing for RTCP calculation purposes.
This value must exceed SILENCE SUPPRESSION MINTIME
(above). Must be 50-300000, default is 2000 (or 2 seconds).
hangovertime N/A This integer specifies the minimum time after voice is detected
inactive before sending a SID packet, in milliseconds, when the
CODEC in the Packet Service Profile is G711SS. Must be 80-
2560, default is 300 (milliseconds).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Voice Packet Resources
Field
Parameter Length Description
minnoise N/A This (positive) integer specifies the minimum noise level below
which level any noise is considered to be silence (in dBm0s),
when the CODEC in the Packet Service Profile is G711SS. Must
be -62dBm0 to -24dBm0, default is 60 (or -60 dBm0).
maxnoise N/A This (positive) integer specifies the maximum noise level above
which level any noise is considered to be speech (in dBm0s),
when the CODEC in the Packet Service Profile is G711SS. Must
be -62dBm0 to -24dBm0, default is 48 (or -48 dBm0).
energy N/A This (positive) integer specifies the initial estimate to be used
for generating comfort noise when the CODEC in the Packet
Service Profile is G711 or G711SS. For G711, when no modem
has been detected, it represents the level of comfort noise to
generate to fill in the audio if packet losses occur; it is played
until the first packet is received. For G711SS, it represents the
level of comfort noise to generate if no SID is received,
whenever there are gaps without packets (due to either packet
losses or silence periods). Must be -90dBm0 to -35dBm0,
default is 56 (or -56 dBm0).
signalingtone N/A Echo Cancellation Signaling Tone frequency.
• none (default)
• c5
To activate this parameter value, the CNS must be rebooted.
nlpdisable N/A Non-linear processing control, disable. Must be 0-16, default is
6.
To activate this parameter value, the CNS must be rebooted.
nlpenable N/A Non-linear processing control, enable. Must be 0-80, default is
75.
To activate this parameter value, the CNS must be rebooted.
narrowbdetect N/A Specifies the status of Echo Cancellation narrowband
detection:
• on - The detection bandwidth is 2079 to 2121 Hz.
• off (default) - The detection bandwidth is 2010 Hz to 2240
Hz.
Either bandwidth is compliant with the ITU-T G.164
specification. The broader bandwidth permits disabling on non-
ITU modems such as Bell 103 and Bell 208. These modems are
chiefly found in North America.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Voice Packet Resources CLI Reference
Field
Parameter Length Description
pothreshold N/A This integer specifies the packet outage threshold in
milliseconds. This interval applies to any call in which the
threshold is exceeded while the call remains connected. A “set”
trap is generated by the detection of this event on any CNS
server module. Once the “set” trap is generated, the packet
outage counter will be incremented each time the threshold is
again exceeded, but the trap will not be generated. An interval
of ten seconds without an outage causes a “clear” trap. After a
“clear” trap, the original rules are again in effect. The packet
outage counter on all CNS server modules is cleared by RESET
TOTAL COUNTER.
Must be 100-60000 (milliseconds), default is 6000.
period N/A Specifies the recording interval size (in milliseconds) used by
the GSX when monitoring RTP playout buffer quality; used only
when an RTP stream is terminated. This parameter does not
operate in a Packet Monitor channel type. The default is 20000
(20 seconds).
threshold0 N/A Specifies the playout loss time series threshold (in milliseconds)
used by the GSX when quantifying packet loss as applied to the
PLAYOUT TIMESERIES PERIOD.
Loss durations less than or equal to THRESHOLD0 are
considered Good. Loss durations greater than THRESHOLD0
and less than THRESHOLD1 are considered Acceptable. The
default is 0 (0.0 seconds, or 0 percent of the PLAYOUT
TIMESERIES PERIOD).
This parameter is applicable for all channel instances.
threshold1 N/A Specifies the playout loss time series threshold (in milliseconds)
used by the GSX when quantifying packet loss as applied to the
PLAYOUT TIMESERIES PERIOD.
Loss durations greater than THRESHOLD0 and less than
THRESHOLD1 are considered Acceptable. Loss durations
greater than THRESHOLD1 and less than THRESHOLD2 are
considered Poor. The default is 200 (0.2 seconds, or 1 percent
of the PLAYOUT TIMESERIES PERIOD).
This parameter is applicable for all channel instances.
threshold2 N/A Specifies the playout loss time series threshold (in milliseconds)
used by the GSX when quantifying packet loss as applied to the
PLAYOUT TIMESERIES PERIOD. This parameter is applicable
for all channel instances.
Loss durations greater than THRESHOLD1 and less than
THRESHOLD2 are considered Poor. Loss durations greater than
THRESHOLD2 are considered Unacceptable. The default is 600
(0.6 seconds, or 3 percent of the PLAYOUT TIMESERIES
PERIOD).
This parameter is applicable for all channel instances.
outageintv N/A Specifies the link loss detection interval in seconds. Must be 10
- 60 seconds; default is 60.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Voice Packet Resources
Field
Parameter Length Description
lossevalint N/A Specifies the time period during which the frame loss rate is
evaluated in seconds. Must be 1 - 10 seconds; default is 10.
lossexcthresh N/A Specifies the percentage of the packet loss during PACKET
LOSS EXCEEDED THRESHOLD DURATION. Must be 0 - 100
percent; default is 10.
lossexcthresdur N/A Specifies the time period during which packet loss rate is
evaluated in seconds. Must be 1-10 seconds; default is 10.
codecmode N/A Specifies the codec rate in the Active Codec Set (ACS). AMR
GANC mode supports up to four codec rates in the Active
Codec Set. Must be 1-4.
codecmoderedun N/A Specifies the Packet Redundancy associated with the CODEC
MODE. 0 indicates Redundancy is disabled for AMR GANC
mode. Must be 0, 1, or 2; default is 0.
codecmodethresh N/A Specifies the maximum number of frame loss allowed during
the PACKET LOSS EVALUATION INTERVAL before a CODEC
MODE change occurs. If the Packet Loss Evaluation Interval is
10 seconds and the PACKET LOSS EXCEEDED THRESHOLD
rate allowed is 1%, then this value should be set to 5 (frames).
Not applicable if the REDUNDANCY value is 0 (disabled).Must be
0-63; default is 2.
hysteresis N/A Specifies the packet loss hysteresis value associated with the
CODEC MODE, expressed in number of AMR frames. This value
is a percentage of the total AMR frames in the PACKET LOSS
EVALUATION INTERVAL and is used to calculate the frame
loss ratio for AMR. Not applicable if the REDUNDANCY value is 0
(disabled). Must be 0-15; default is 2.
mprofilename 1-23 The name of the media profile to use to configure the PAD
resources on the specified CNS or SPS server module.
Command Example
To direct all of the PAD resources of the CNS25 server module in slot 14 to perform G.726 audio
compression:
% CONFIGURE SERVER SHELF 1 SLOT 14 MODE outofservice
% CONFIGURE SERVER SHELF 1 SLOT 14 STATE disabled
% CONFIGURE RESOURCE PAD SHELF 1 SLOT 14 MEDIA PROFILE default
% CONFIGURE SERVER SHELF 1 SLOT 14 STATE enabled
% CONFIGURE SERVER SHELF 1 SLOT 14 MODE inservice
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Voice Packet Resources CLI Reference
To display the media profile used in the example above to configure the CNS25:
% SHOW MEDIA PROFILE default ADMIN
Node: TPUBS Date: 2007/02/01 22:45:07 GMT
Zone: GMTMINUS05-EASTERN-US
-----------------------------------------------------------------------------
Media Profiles
-----------------------------------------------------------------------------
Index Name State Status Base G729 G726 G723 iLBC
----- ---- ----- ------ ---- ---- ---- ---- ----
2 default ENABLED IS 1 DIS ENA DIS DIS
To display the status of the PAD resources that were configured in the example above:
% SHOW RESOURCE PAD SHELF 1 SLOT 14 STATUS
------------------------------------------------------
DSP Resource Status: Shelf: 1 Slot: 14
------------------------------------------------------
Total Utilization Allocation
% Failures %
----- --------- -----------
G711+Echo Cancellation: 432 0 0
G711: 0 0 0
HDLC: 12 0 0
Tone: 108 0 0
---- --- ---
Conference: 0 0 0
Participant: 0 0 0
---- --- ---
Total Compression: 392 0 0
G729A+B: 0 0 0
G723.1: 0 0 0
G726: 392 0 0
iLBC: 0 0 0
GSM 0 0 0
Packet Outages total: 0
Packet Outages during interval: 0
To change the G.726 percentage threshold to 80 and then re-enable events for this resource:
% CONFIGURE RESOURCE PAD SHELF 1 THRESHOLD G726 STATE disabled
% CONFIGURE RESOURCE PAD SHELF 1 THRESHOLD G726 80
% CONFIGURE RESOURCE PAD SHELF 1 THRESHOLD G726 STATE enabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Voice Packet Resources
To display the PAD Resource summary of SPS70s and CNS25s and their respective
configurations in a shelf:
% SHOW RESOURCE PAD SHELF 1 ALL ADMIN
Node: TPUBS Date: 2003/10/17 20:07:36 GMT
Zone: GMTMINUS05-EASTERN-US
----------------------------------------------------
Shelf/Server PAD Configurations
----------------------------------------------------
Shelf Slot Media Profile
----- ---- -------------
1 6 g723
1 12 universal
1 13 universal
1 14 g729_g726
------------------------------------------------------
PAD Configuration: Shelf: 1
------------------------------------------------------
-------------------------------------------
Echo Canceller Parameters
-------------------------------------------
Signaling Tone: NONE
NLP Enable: 75
NLP Disable: 6
Narrow Band Detection: OFF
-------------------------------------------
Jitter Parameters
-------------------------------------------
Jitter Eval Period : 1000ms
Jitter Min Occ Threshold : 20ms
-------------------------------------------
RTP Payload Types
-------------------------------------------
DTMF Relay : 100
-------------------------------------------
Silence Suppression Parameters
-------------------------------------------
Minimum SID Generation Interval : 200ms
Maximum SID Generation Interval : 2000ms
Hangover Time : 300ms
Minimum VAD Level : -60dBm
Maximum VAD Level : -48dBm
-------------------------------------------
Other Parameters
-------------------------------------------
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Voice Packet Resources CLI Reference
NOTE
For CNS10s and CNS30s, the DSP G729A+B, G723.1, and G726 resources are never
used. For CNS25s, all DSP resources may be used.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Voice Packet Resources
To display the PAD Resource usage summary of all CNS (including SPS) server modules in a
shelf:
% SHOW RESOURCE PAD SHELF 1 SUMMARY
---------------------------------------------------------------
DSP Resource Summary: Shelf: 1
---------------------------------------------------------------
G711 HDLC Tone Conference Compression
Tot Util Fail Tot Util Fail Tot Util Fail Tot Util Fail Tot Util Fail
Slot % % % % % % % % % %
---- ------------- ------------- ------------- ------------- -----------
7 2016 0 0 112 0 0 672 0 0 0 0 0 0 0 0
8 2016 49 0 112 0 0 672 0 0 0 0 0 0 0 0
9 432 0 0 12 0 0 108 0 0 0 0 0 392 1 0
10 2016 49 0 112 0 0 672 0 0 0 0 0 0 0 0
11 288 2 0 28 28 0 108 0 0 24 0 0 0 0 0
13 672 0 0 28 0 0 180 0 0 6 0 0 0 0 0
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Voice Packet Resources CLI Reference
This object allows you to specify echo cancellation characteristics and store them in a named
profile. This profile is applied to the entire GSX, when it is enabled.
Command Syntax
Command Parameters
Field
Parameter Length Description
ecprofile 1-23 The name of the echo canceller profile that is being created and
configured.
returnloss N/A Specifies the worst case (or minimum) expected echo return loss
(ERL) at the 4 to 2 wire conversion, in dBm0s:
• dB6 (default)
• dB3
• dB0
The canceller will still work if the ERL is higher, but convergence
time might be affected.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Voice Packet Resources
Field
Parameter Length Description
residecho N/A Specifies how the Non Linear Processor (NLP) works to remove
the residual echo left after linear cancellation:
• cancelOnly - NLP is disabled and the residual echo is left
intact.
• suppressResidual - NLP completely removes the residual
echo and leaves silence in its place.
• comfortNoise (default) - NLP removes the residual echo
and replaces it with a mix of spectrally matched background
noise and signal.
modemdisable N/A Specifies echo canceller behavior when modem tone is detected:
• ignore2100Hz - The echo canceller will not disable if it
detects 2100Hz signals. This would interfere with FAX and
MODEM calls.
• g164 - The echo canceller will disable if it detects either
2100Hz tones or 2100Hz phase reversing tones.
• g165 (default) - The echo canceller will disable if it detects
2100Hz phase reversing tones. For 2100Hz tones (FAX) it will
disable the NLP but leave the linear part of the echo canceller
running.
admin-state N/A The administrative state of the designated echo canceller profile:
• disabled (default) - Not activated, able to be configured.
• enabled - Active.
Command Example
To create the echo canceller profile ecprof1, configure it with several nonstandard parameter
values, and apply it to the entire GSX:
% CREATE ECHO CANCELLER PROFILE ecprof1
% CONFIGURE ECHO CANCELLER PROFILE ecprof1 ..
RESIDUALECHO cancelOnly
RETURNLOSS dB3
% CONFIGURE ECHO CANCELLER PROFILE ecprof1 STATE enabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Voice Packet Resources CLI Reference
------------------------------------------------------
Echo Canceller Profile: ecprof1
------------------------------------------------------
Index: 1
State: ENABLED
Echo Return Loss: DB3
Residual Echo Control: CANCELONLY
Modem Tone: G165
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
This object creates a template for the underlying ISUP service group object that uses this profile
(below). ISUP service groups that are configured with an ISUP service profile will silently take
every parameter value specified in the profile unless explicitly overridden.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
ACCL3ARCANCELPERCENT accl3ARcanperc
ACCL3DRCANCELPERCENT accl3DRcanperc
ACCSENDACL accSendACL
OLIPCHECK olipcheck
INR INF PROFILE inrinfprof
CLLI TOWN CODE cllitown
CLLI STATE CODE cllistate
CLLI BUILDING CODE cllibldg
CLLI BUILDING SUB DIVISION CODE cllibldgsd
ALERT TONE alerttone
ALERT TONE NONE
CLUSTER ROUTING clusrouting
SENDINGOLIPCHECK sendingolipchk
MINIMUM DIGITS FOR SENDING DS QUERY mindsqdigits
CONFIRMATION TONE conftone
CONFIRMATION TONE NONE
CONFIRMATION TONE OVERRIDE conftoneover
ANSWER SUPERVISION TIMEOUT anssupvtimeout
ANSWER SUPERVISION TIMEOUT ACTION anssupvtimeoact
CUT THROUGH OVERRIDE ACM RECEIVED WITH BCI INTERWORKING ..
cutthruoverride
CRANKBACK PROFILE cbprofno
CONGESTION RELEASE TIMEOUT cgrtimeout
MESSAGE THROTTLING mssgthrottling
MESSAGE THROTTLING TIMER mssgthrottlingtimer
CALLSPERSEGMENT callspersegment
INTERSEGMENTTIMER intersegtimer
MESSAGE PRIORITY RESET messagereset
LDC ACTION ldcaction
LDC EMERGENCY CALLS ldcemergcalls
LDC RELEASE CAUSE ldcrelcause
LDC TIMEOUT ldctimeout
LOOKAHEADFORBUSY lkaheadforbusy
NETWORK IDENTITY networkid
CHARGE AREA chargearea
NODE IDENTITY nodeidentity
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Command Parameters
Field
Parameter Length Description
profilename 1-23 The name of this profile, which can be applied to an
underlying ISUP service.
tgname 1-23 The name of the trunk group that the ISUP service will
belong to.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
hdirection N/A The hunt algorithm for choosing a specific CIC within a
trunk group.This algorithm must complement the
algorithm in effect at the central office switch:
• top2bottom - Start the search at the highest
physical port number on the highest CNA slot number
on the highest shelf number in the node. On a
GSX4000 series switch, start the search at the
highest physical port number.
• bottom2top - Start the search at the lowest
physical port number on the lowest CNA slot number
on the lowest shelf number in the node. On a
GSX4000 series switch, start the search at the
highest physical port number.
• circuithi2lo - Start with the highest CIC number
and proceed to the lowest CIC number. (CICs must
be numbered contiguously within a port for this
algorithm.)
• circuitlo2hi - Start with the lowest CIC number
and proceed to the highest CIC number. (CICs must
be numbered contiguously within a port for this
algorithm.)
• mostnleastidle - Use the CONTROL parameter
hunt algorithms.
• circulartop2bottom - Start the search at the
highest physical port number on the highest CNA slot
number on the highest shelf number in the node.
Start the succeeding search at the next table position
rather than back at the top. On a GSX4000 series
switch, start the search at the highest physical port
number. Start the succeeding search at the next table
position rather than back at the top.
• circularbottom2top - Start the search at the
lowest physical port number on the lowest CNA slot
number on the lowest shelf number in the node. Start
the succeeding search at the next table position
rather than back at the bottom.On a GSX4000 series
switch, start the search at the lowest physical port
number. Start the succeeding search at the next table
position rather than back at the bottom.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
revision N/A The ISUP protocol revision that will be supported for this
ISUP service:
• ansi1992 - Use this protocol if this ISUP service is
connecting DMS and ESS SWITCHTYPEs.
• ansi1995
• itu1993
• etsi2 - Use for Germany and Netherlands. (For
Germany, use the Default_German ISUP signaling
profile; for Netherlands, use the Default_ETSI_V2
ISUP signaling profile.)
• nttfcc - Use for Japan.
• itu1997
• itu1988
• ituq767 - Same as etsii (has been renamed).
• belgacom
• spirou
• mexicoic
• italy
• denmarkic
• hongkongic
• singapore
• etsi3
• peru
• chile
• portugaloni
• nttcom - Use the NTT Communications protocol for
Japan.
• chinacnc
• spain
• argentinaidt
• argentina
• brazil
• india
• korea
• ukisup
• etsi2plus - Use for Malaysia.
• ansiatt
cost N/A The relative cost of using the CICs configured in this
service. Must be 0-100. A value of 100 represents the
highest possible cost.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
cicControl N/A The set of CICs controlled by this GSX for the sake of
resolving dual-seizure scenarios. Additionally, if the
HUNT parameter is set to mostnleastidle, a CIC
search algorithm is also implied.
• nocics - None of the CICs in the service group are
controlled by this GSX. If HUNT is mostnleastidle,
CIC hunting is Last-In-First-Out (LIFO).
• allcics - All of the CICs in the service group are
controlled by this GSX. If HUNT is mostnleastidle,
CIC hunting is First-In-First-Out (FIFO).
• oddcics - CICs 1,3,5, etc. in this service group are
controlled by this GSX. If HUNT is mostnleastidle,
these CICs are hunted FIFO while even numbered
CICs are controlled by the remote switch and hunted
LIFO.
• evencics - CICs 2,4,6 etc. in this service group are
controlled by this GSX. If HUNT is mostnleastidle,
these CICs are hunted FIFO while odd numbered
CICs are controlled by the remote switch and hunted
LIFO.
continuityTestFreq N/A The frequency with which active call continuity tests are
performed on each ISUP service group circuit. Must be
0-16:
• 0 - no continuity tests are performed
• 1 - continuity tests are performed on a per-call basis
• 2-16 - a continuity test is performed every nth call
(where n = 2-16)
You do not need to disable the underlying ISUP service
group to change this value.
hopcountval N/A The initial Hop Counter value to use (if hopcountstat
is enabled). Must be 10-20.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
hopcountstat N/A The state of Hop Counting procedures for this service
group:
• enabled - The procedures are in effect. This state
requires that the ISUP protocol revision be ANSI1992
or ANSI1995.
• disabled - The procedures are not in effect.
When Hop Counting is enabled:
• If a Hop Counter parameter is received from the
ingress leg of the call, it is decremented and included
in the outgoing IAM message. If no Hop Counter is
present in the ingress leg of the call, it is included in
the outgoing IAM message using hopcountval.
• If a Hop Counter of zero is present in the ingress leg
of the call, the call is released with a cause of
“exchange routing error”.
When Hop Counting is disabled:
• If a Hop Counter parameter is received from the
ingress leg of the call, it is passed transparently in the
outgoing IAM message.
• If a Hop Counter of value zero is present in the
ingress leg of the call, the call is released with a
cause of “exchange routing error”.
dtprofile 1-23 The name of a Disconnect Treatment Profile that will be
used to map a disconnect reason code to a Disconnect
Signaling Sequence Profile (SSP) for the ISUP service.
See "Disconnect Treatment Profile" on page 3–1162.
tonepkg 1-23 The name of a tone package to be used by the ISUP
service. See "Tone Package" on page 3–1201.
grsatstartup N/A Specifies whether to issue reset messages to all circuits
in this service group when a CNS module or GSX4000
series switch is started or restarted:
• unsupported - Do not issue any reset messages on
any circuits when a CNS module is started.
• supported - Reset all circuits by issuing either
individual (RSC) reset messages or a group (GRS)
reset message. The type of reset message that is
used depends on the GRS setting in the ISUP
Signaling Profile (see "ISUP Signaling Profile" on
page 3–763).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
sequentialgrs N/A Specifies whether to issue the Circuit Group Reset
Message (GRS) in parallel or sequentially to the circuits.
• unsupported - Issue the reset messages in parallel
on the circuits.
• supported - Reset all circuits by sequentially
issuing GRS one at a time per remote point code.
This may be necessary for inter-working with carriers
who become congested or overloaded when
processing large numbers of GRS messages at once.
insptime N/A Inspection time, specified in date-time format. The
INSPECTION parameters provide a way to set up
automatic regular testing and synchronization of call
and maintenance states on all circuits in the ISUP
service group. INSPECTION TIME specifies the first
date-time at which inspection will occur.
Specified in universal octet date-time format. For
example, to represent Tuesday May 26, 1992 at 1:30:15
PM EDT, you would specify:
1992-5-26,10:30:15.0,-4:0
inspfreq N/A Inspection frequency:
• onehour
• threehours
• sixhours
• twelvehours
• oneday (default)
• twodays
The default inspection frequency is once per day. The
date-time for each inspection is calculated from the
initial INSPECTION TIME, so that correct frequency and
timing is maintained even if the GSX has been
rebooted.
inspstate N/A Sets the occurrence of circuit inspections off or on.
• disabled (default)
• enabled
sigprof 1 - 23 Name of the ISUP signaling profile on which this ISUP
service profile will be based. The GSX provides a
default signaling profile for each ISUP revision. Use the
SIGNALING PROFILE parameter only if you wish to
specify a profile other than the default signaling profile.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
accresproc N/A Sets the Automatic Congestion Control (ACC)
Response Process to disabled or enabled.
• disabled
• enabled
When ACC response handling is enabled for the service
group, and the remote node has indicated that it is
congested (by use of the ACL parameter), calls destined
to go out the trunk group are set to SKIP (try alternate
route) or CANCEL (release the call) depending on the
other ACC parameters below.
accl1ARcanperc N/A Automatic Congestion Control (ACC) Level 1 (L1)
Alternate Routed (AR) Cancel Percentage. Indicates
percentage of alternate-routed calls to be released.
Must be 0-100.
accl1DRcanperc N/A ACC Level 1 Direct Routed (DR) Cancel Percentage.
Specifies percentage of direct-routed calls to be
released. A call is considered direct-routed when it first
arrives to a service group to be routed, and retry has not
yet been attempted. Must be 0-100.
accl2ARcanperc N/A ACC Level 2 AR Cancel Percentage. Must be 0-100.
acc2DRcanperc N/A ACC Level 2 DR Cancel Percentage. Must be 0-100.
accl3ARcanperc N/A ACC Level 3 AR Cancel Percentage. Must be 0-100.
accl3DRcanperc N/A ACC Level 3 DR Cancel Percentage. Must be 0-100.
accSendACL N/A Specifies the maximum ACL value sent to a remote
node for this ISUP Service Group. 0 means ACC is
disabled. Must be 0-3.
olipcheck N/A When a call with a Charge Number and a Calling Party
Number arrives, by default the GSX checks for
Originating Line Information Parameters (OLIP) and
rejects the call if they are not present. This parameter
turns OLIP checking off for certain switches that do not
supply OLIP information to such calls:
• on - check for OLIP
• off - don’t check for OLIP
This check is applied only when the GSX receives an
IAM.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
sendingolipchk N/A When a call with a Charge Number and a Calling Party
Number is sent, by default the GSX checks for
Originating Line Information Parameters (OLIP) and
rejects the call if they are not present. This parameter
turns OLIP checking off for certain switches that do not
supply OLIP information to such calls:
• on - check for OLIP
• off - don’t check for OLIP
This check is applied only when the GSX, acting as an
originating exchange, is sending an IAM, the call ingress
is non ANSI, and the call egress is ANSI.
clusrouting N/A Specifies whether this DPC supports cluster routing
(also known as member routing):
• unsupported (default)
• supported -
mindsqdigits N/A Specifies the minimum number of CalledAddress digits
to collect before attempting a route query, when overlap
addressing is supported and CalledAddress receive is
not complete. Must be 0-30, default is 0 (digits).
conftone 1-23 Specifies a confirmation tone to play when the ISUP call
is answered (prior to media cut through). The
confirmation tone must be configured as part of the
ISUP service group's TONE PACKAGE.
A confirmation tone is typically used by a calling PBX to
begin billing.
conftoneover N/A Specifies support for subscriber-level confirmation tone:
• suppported - a confirmation tone plays for all
ingress calls.
• unsupported (default) - use the Calling Party
Subscriber screen on the PSX to activate the
confirmation tone.
anssupvtimeout N/A When answer supervision is enabled, specifies the
timeout period, in seconds, from the egress receiving
the first backwards message from the called party
exchange (Call Proceeding, Alerting, Call Progress)
until the call is answered. If the timeout period expires,
the answer supervision action specified is triggered.
Must be 0-1000, default is 300 (seconds). A value of 0
disables this timer.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
anssupvtimeoact N/A Specifies the action to take if the answer supervision
timer expires (i.e. no signaled answer is received):
• release (default) - release the call.
• softanswer – If an answer message is not received
from the succeeding exchange before the answer
supervision timer expires, the GSX generates an
answer message (ANM) to send in the backward
direction and moves the call into the talking state
cutting through the speech path in both directions. If
an answer message is later received from the
succeeding exchange, it is ignored. This option
(softanswer) is only applicable to ANSI ISUP variants.
• trapAndRestart - Send a trap and restart the
timer. This action will repeat continuously until
cancelled by a received network disconnect, user
intervention, or a received answer message.
The trap contains the following details for the call:
• Ingress Trunk Group
• Ingress Circuit End Point
• Egress Trunk Group
• Egress Circuit End Point
• Called Number
• Calling Number
cutthruoverride N/A Specifies whether to override the protocol-specific cut
through direction when the ACM is received with a
backward call indicator (BCI) of Interworking
Encountered:
• unsupported (default) - no override will occur and
the protocol-specific cut through controls remain in
effect.
• fullduplexcutthru - perform a full duplex cut
through.
• nocutthru - perform no cut through
inrinfprof 1 - 23 Name of the INR INF profile used by this ISUP service.
This name is identical to the name of the ISUP signaling
profile used by this ISUP service. This profile specifies
the information that is to be requested if it is not
received in the IAM. The GSX provides a default INR
INF profile for each ISUP revision.
cllitown 4 Specifies the town code to be used in the CLLI
parameter for ANSI GR317 circuit validation test failure.
Must be a four character string, default is “0000”.
cllistate 2 Specifies the state code to be used in the CLLI
parameter for ANSI GR317 circuit validation test failure.
Must be a two character string, default is “00”.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
cllibldg 2 Specifies the building code to be used in the CLLI
parameter for ANSI GR317 circuit validation test failure.
Must be a two character string, default is “00”.
cllibldgsd 3 Specifies the building sub division code to be used in
the CLLI parameter for ANSI GR317 circuit validation
test failure. Must be a three character string, default is
“000”.
alerttone 1-23 The name of a tone type to play on the ingress call when
the egress side of the call received an ALERTING
message. This may be a ring back tone.
cbprofno N/A The index number of the CRANKBACK PROFILE to use
with this ISUP service group. This must specify a valid
Call Crankback profile index, in the range 1-10. The
default is 1, or Call Crankback Profile default. See
"Call Crankback Profile" on page 3–1171.
cgrtimeout N/A The time (in seconds) to wait to release a call when that
call was rejected due to congestion. This parameter
effectively prevents the machine congestion level from
escalating due to rapid repeated call attempts by
equipment that does not support congestion detection.
Must be 0-5 (seconds), default is 0. A value of 0
disables this timer.
If this value is nonzero, the timer is started when a call is
rejected due to congestion. When the timer expires, the
network release is sent and the call resources are de-
allocated. If a network release is received during the
delay, the timer is stopped and the call resources are
de-allocated.
mssgthrottling N/A Specifies whether message throttling is supported. This
is a per-GSX parameter, and is therefore copied to all
service groups when changed on one:
• supported - allows for blocking or unblocking (BLO/
UBL) messages sent from the GSX to be throttled.
• unsupported (default) - message throttling is not
enabled.
Note: The MESSAGE THROTTLING TIMER,
CALLPERSEGMENT, and INTERSEGMENTTIMER
parameters are only available when MESSAGE
THROTTLING is set to supported.
mssgthrottlingtimer N/A Specifies the time in milliseconds to insert between
consecutive blocking (BLO) and unblocking (UBL)
messages sent on this service group from a certain
CNS. This parameter can have a different value on each
service group. Must be 0 to 1000.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
callspersegment N/A Specifies the number of calls to be cleared at a time (per
CNS) when performing call cleanup. This translates into
the number of REL and RSC messages sent
simultaneously. Must be 1 to 25.
This is a per-CNS/GSX parameter and therefore copied
to all service groups when changes on one.
Note: The GSX expects all calls to be cleared within
eight (8) seconds, therefore Sonus recommends you set
this parameter to a lower value so that all calls are
cleared within this default time to avoid an error
message.
intersegtimer N/A Specifies the time between blocks of calls cleaned up.
Must be 10 to 1000.
This is a per-GSX parameter and is therefore copied to
all service groups when changed on one.
Note: The GSX expects all calls to be cleared within
eight (8) seconds, therefore Sonus recommends you set
this parameter to a lower value so that all calls are
cleared within this default time to avoid an error
message.
ldcaction N/A Specifies the action to take if the Long Duration Call
(LDC) timer expires. The call may be released, a SNMP
trap may be generated, or both:
• noAction (default) - take no action on LDC timer
expiry (a debug log entry will be generated).
• trap - generate an SNMP trap.
• release - automatic call disconnect without
generation of a trap.
• trapAndRelease - generate an trap and release
the call.
ldcemergcalls N/A Specifies whether emergency calls should be excluded
from, or included in Long Duration Call (LDC)
disconnect procedures:
• include
• exclude (default)
Note: Emergency call exclusion relies on the PSX call
type or other protocol-specific criteria to identify the call
as an “emergency” call.
ldcrelcause N/A Specifies the GSX disconnect reason used to release
the call if the call is released due to Long Duration Call
(LDC) timer expiry. Must be 1 to 127; default is 41
(Temporary Failure).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
ldctimeout N/A Specifies the timeout value of the Long Duration Call
(LDC) timer in minutes. Must be 0 or 60-2880. A value
of 0 disables the timer; a value of 60-2880 set the timer.
Default is 0.
messagereset N/A Specifies the behavior applied to setting the Message
Priority field in a transmitted IAM:
• on - Message Transfer Priority will be set to 1 for
HPC calls and 0 for non-High Probability of
Completion (HPC) calls.
• off (default) - Message Transfer Priority will be
passed through from ingress to egress if its value is
greater than 0.
See "High Probability of Completion (HPC) Features" on
page 6–237 for more information on this functionality.
lkaheadforbusy N/A Specifies the default value used in the Look Ahead for
Busy field in the ISUP Precedence parameter.
• allowed - Look Ahead for Busy is allowed.
• pathreserved - Look Ahead for Busy path is
reserved.
• notallowed (default) - Look Ahead for Busy is not
allowed.
See "High Probability of Completion (HPC) Features" on
page 6–237 for more information on this functionality
networkid 4 Specifies the default value used for the 4-digit network
identity field in the ISUP Precedence parameter.
Must be 0000-9999; default is 0100.
See "High Probability of Completion (HPC) Features" on
page 6–237 for more information on this functionality
chargearea 5 Specifies the 5-digit Terminating Charge Area value.
The Charge Area is set in the ACM or CPG message if a
script is returned from the PSX or for a Disconnect
Treatment Profile. The Charge Area can only be
populated in the ACM or CPG messages if the existing
ISUP SIGNALING PROFLE parameter CA FOR
ANNOUNCEMENTS is set to SUPPORTED.
To disable the Charge Area parameter and only use the
Terminating Charge Area received from the PSX, set
the parameter to NULL (““).
Must be 00000-99999 or ““ (NULL).
This is a Japan only control. (GSX9000 only)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
nodeidentity N/A Specifies whether to generate an Application Transport
Mechanism (APM) message with Charging Tariff
(CRGT) data in response to an IAM for this service
group. Must be 0-65535.
• 0 - do not generate an APM message with CRGT
data.
• 1-65535 - generate CRGT data in the APM
message in response to an IAM received for the
specified service group.
Note: The APM parameter in the ISUP SIGNALING
PROFILE associated with this ISUP service group must
be set to supported.
locationrel34 N/A Specifies an updated Cause Indicator Location Value to
set in the ISUP REL message sent to the ingress
network for Release Cause 34 “No circuit/channel
available”:
• notUsed (default) - location information not present
• user
• privateLocal - private network serving the local
user (LPN)
• publicLocal - public network serving the local user
(LN)
• transitNet - transit network (TN)
• publicRemote - public network serving the remote
user (RLN)
• privateRemote - private network serving the
remote user (RPN)
• natReserved6 - reserved
• internationalNet - international network (INTL)
• natReserved8 - reserved
• natReserved9 - reserved
• netBeyondInterPoint - network beyond
interworking point (BI)
• natReserved11 - reserved
• natReserved12 - reserved
• natReserved13 - reserved
• natReserved14 - reserved
• natReserved15 - reserved
Other disconnect reasons are unaffected by this
configuration.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
locationrel42 N/A Specifies an updated Cause Indicator Location Value to
set in the ISUP REL message sent to the ingress
network for release cause 42 “Switching equipment
congestion”:
• notUsed - Location information not present
• user
• privateLocal - Private network serving the local
user (LPN)
• publicLocal - Public network serving the local user
(LN)
• transitNet - Transit network (TN)
• publicRemote - Public network serving the remote
user (RLN)
• privateRemote - Private network serving the
remote user (RPN)
• natReserved6 - reserved
• internationalNet - International network (INTL)
• natReserved8 - reserved
• natReserved9 - reserved
• netBeyondInterPoint - Network beyond
interworking point (BI)
• natReserved11 - reserved
• natReserved12 - reserved
• natReserved13 - reserved
• natReserved14 - reserved
• natReserved15 - reserved
Other disconnect reasons are unaffected by this
configuration.
admin-state N/A The administrative state of this ISUP service group
profile:
• disabled (default) - Not activated, able to be
deleted.
• enabled - Activated, available for immediate use.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Command Example
To create, configure, and activate an ISUP service group profile named isupsp1:
% CREATE ISUP SERVICE PROFILE isupsp1
% CONFIGURE ISUP SERVICE PROFILE isupsp1 TRUNK GROUP tg1
% CONFIGURE ISUP SERVICE PROFILE isupsp1 HUNT bottom2top
% CONFIGURE ISUP SERVICE PROFILE isupsp1 COST 10
% CONFIGURE ISUP SERVICE PROFILE CRANKBACK PROFILE 2
% CONFIGURE ISUP SERVICE PROFILE isupsp1 STATE enabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
This object creates a template for the ISUP signaling services that will be used by the ISUP service
group that uses this signaling profile.
Sonus supplies a number of default signaling profiles that correspond to the ISUP protocol
revision that the ISUP service group uses. These default profiles effectively assign the signaling
conventions to be used under that protocol revision.
To see the list of default signaling profiles that are available, perform a SHOW ISUP SIGNALING
... SUMMARY command.
To see the setting of every control in a particular default signaling profile, perform a SHOW ISUP
SIGNALING PROFILE default_name ADMIN command.
To see the setting of every parameter control in a particular default signaling profile, perform a
SHOW ISUP SIGNALING PROFILE default_name PARAMETERS ADMIN command.
To see the setting of every message control in a particular default signaling profile, perform a
SHOW ISUP SIGNALING PROFILE default_name MESSAGES ADMIN command.
To see the setting of every services control in a particular default signaling profile, perform a SHOW
ISUP SIGNALING PROFILE default_name SERVICES ADMIN command.
You should create a custom signaling profile by copying from a default profile and then modifying
your copy, rather than by directly modifying a default profile. This leaves the master copy intact
and avoids potential problems should the default profiles need to be reset. This strategy also
provides more flexibility if controls need to be modified. To copy a default profile, create your
new profile with CREATE ISUP SIGNALING PROFILE.. and set the BASEPROFILE to the
appropriate default profile when you CONFIGURE your new profile. See the first two examples
under Command Example for a detailed example of this Sonus recommendation.
NOTE
You do not need to take circuits outOfService, to change ISUP SIGNALING
PROFILE parameter values.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
CALLMODMSGS callmodmsgs
CALLDIV calldiv
CALLHIST callhist
GENREF genref
MLPP mlpp
NSF nsf
REDNUMRIST rednumrist
REMOTEOP remoteop
SERVACTV servactv
SERVACTVINREL servactvinrel
SIGPOINTCODE sigpointcode
TMRPRIME tmrprime
TRANSMEDUSED transmedused
USIPRIME usiprime
REDNUMINACM rednuminacm
REDNUMINANM rednuminanm
UUIINREL uuiinrel
UUIININF uuiininf
UUINDCON uuindcon
CONREQINFAA conreqinfaa
CONREQINFAR conreqinfar
FAC fac
ECHOCONTROL echocontrol
BACKWARDGVNS backwardgvns
CIRCASSMAP circassmap
CCSS ccss
CALLDIVTREAT calldivtreat
CALLEDINNUM calledinnum
COLLECTCALLREQ collectcallreq
CONFTREAT conftreat
CORRELATIONID correlationid
CALLOFRTREAT callofrtreat
CALLTRANSNUM calltransnum
CALLTRANSREF calltransref
DISPINFO dispinfo
FORWARDGVNS forwardgvns
LOOPPREVENTION loopprevention
NETWORKMGMT networkmgmt
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
SCFID scfid
UIDACTIONIND uidactionind
UIDCAPIND uidcapind
CONNUMINCPG connumincpg
GENNUMINCPG gennumincpg
ECHOCNTRLINIAM echocntrliniam
REMOTEOPINREL remoteopinrel
ACCESSTRANSINFAC accesstransinfac
GENNOTIFINFAC gennotifinfac
UUINDANM uuindanm
UUINDCPG uunindcpg
NRMSUPPORT nrmsupport
CSEINRLC cseinrlc
UPAUPT upaupt
RECINCAI recincai
TRANSITUNREC transitunrec
CCRAW ccraw
CGBCGU cgbcgu
GRS grs
BASEPROFILE baseprofile
PDV pdv
U2USRVCLEVEL u2usrvclevel
SAM sam
FOT fot
SPECIALDIGITS specialdigits
TNS tns
ACCESSTRANS accesstrans
JURISDICTION jurisdiction
OCN ocn
BUSINESSGRP businessgrp
CONREQ conreq
INFOIND infoind
NTP ntp
NOTIFIND notifind
REDINFOACM redinfoacm
EGRESSSERVICE egressservice
SERVCODEIND servcodeind
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
SPECPROCREQ specprocreq
TRANSREQ transreq
CHGNUM chgnum
GENADRESSREL genaddressrel
UUINDACM uuindacm
UUINFO uuinfo
BCM bcm
NSA nsa
OPERATORSERVINFO operatorservinfo
CVTCVR cvtcvr
GENNAME genname
REDCAP redcap
REDCOUNT redcount
SENDTWOGRPMSGS sendtwogrpmsgs
AWAITTWOGRPMSGS awaittwogrpmsgs
CQMONCARDSWAP cqmoncardswap
ANSI95GRSGRA ansi95grsgra
ANSI95CQM ansi95cqm
ANSI95CFM ansi95cfm
CPGBEFOREACM cpgbeforeacm
AWAIT DIGITS awaitdigits
MAPDMSFEPARAMETER mapdmsfeparameter
MXCGNUM mxcgnum
MXCDNUM mxcdnum
FPH fph
ITXTXA itxtxa
SCCPPROC sccpproc
CNRIAM cnriam
CCNR ccnr
TRANSITCFN transitcfn
HOLDINGIND holdingind
MPDV mpdv
DISPINFO IN ACM dispinfoinacm
DISPINFO IN CON dispinfoincon
DISPINFO IN CPG dispinfoincpg
DISPINFO IN IAM dispinfoiniam
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
CPNREL cpnrel
BCIREL bcirel
CI ci
IUI iui
NROP nrop
MSI msi
RR rr
MI mi
SPC6 spc6
MAREL marel
FORWARDCPG forwardcpg
FORWARDSUS forwardsus
CONREQININF conreqininf
SGMPCI sgmpci
GR317 SCREENING INDICATORS gr317si
CALLED DIRECTORY NUM calleddirnum
OPR opr
CCL ccl
OTHER DIGIT STRING SPECIAL DIGIT F spdigf
CALL REFERENCE IN FRJ callreffrj
PCI PASSON DEFAULT pcipassdef
OTGNANSI92 otgnansi92
MSGSENDDELAY msgsenddelay
DROP CAUSE IN ACM WHEN IWK drpcauseacm
CHARGE IND SETTING chargeindsetting
T11EARLYACM t11earlyacm
DMSFE dmsfe
CQMFORRESYNC cqmforresync
NCR ncr
TRUNK NUMBER SOURCE tnumbersource
SLI IN IAM sliiniam
RLT rlt
UUIND IN FAR uuindinfar
ACCESS TRANS IN FAR accesstran
UPV EXCHANGE ROLES upvexchangeroles
CDBSM cdbsm
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
CGBSM cgbsm
CGOFM cgofm
CDTFM cdtfm
NII nii
NIRI niri
NFCI nfci
PRESNUM presnum
LDLI ldli
PCLI pcli
NFCILNK nfcilink
INR IN ALL STATES inr
NFCI LBL RCI PROCEDURE nfcilbl
ALLIANCE SCREEN INDICATOR alliancescreenind
ANNOUNCEMENT INDICATOR announcementind
DIALED NUMBER dialednumber
FORWARD NETWORK SPECIFIC INFO forwardnetspecinfo
GENERIC NOTIFICATION REPEATABLE gennotifrepeatable
GENERIC NUMBER REPEATABLE gennumrrepeatable
GENERIC NUMBER REPEATABLE IAM gennumrepeatableiam
GENERIC OPERATION genoperation
HARD TO REACH INDICATOR hardtoreachind
NETWORK DATA networkdata
NETWORK MANAGEMENT INFO networkmgmtinfo
NETWORK SWITCH NUMBER networkswitchnumber
ROUTING INFO INDICATOR routinginfoind
SDN sdn
ECI eci
T7 TRANSIT t7transit
JTI jti
INVTNSRELEASE invtnsrelease
CHGINSPEECH chginspeech
ECINF ecinf
FCI USER PART IWK fciuserpartiwk
FCI USER PART TRANS fciuserparttrans
CPTT cptt
FCI USER PART CHOSEN CARRIER fciuserpartchosencar
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
MAXCQMRANGE maxcqmrange
TRUNCATECDPN truncatecdpn
NOIPECHOIND noipechoind
VISITORMA visitorma
HWBLK SEND BLO hwblksendblo
HWBLK ALLOW CALLS hwblkallowcalls
HWBLK SEND RSC FOR CALLS hwblksendrscforcalls
IAM GENERATED CARRIERCODE IN CDR iamgeneratedcarrierc
ASSUMEOGDEVICE assumeogdevice
SIGNALONLYSIPALERT signalonlysipalert
ALWUNSCRNDCIN alwunscrndcin
DROP USI FROM NON ISUP dropusi
PREVENTACMTOCPG preventacmtocpg
DONT MAP TO HEADER To OCN dontmaptoheaderocn
NO IN NUMBER UPDATES noinnumberupdates
USE PSX CHG IND FOR CPG IN PRESUB CALL usepsxchgind
ALWAYS ADD OPT PTR alwaysaddoptptr
SUPPRESS CIT FOR PRE SUB ACM suppresscit
ONLYSENDACMFOR181 onlysendacmfor181
DONTSENDEXM dontsendexm
REAFFIRM BLOCK AFTER RESET reaffirm_block
CITTERMEXCHANGELOGIC CITTERMEXCHANGELOGIC
BCIINCPGWITHCIT BCIINCPGWITHCIT
DONTGENERATEDIAGS DONTGENERATEDIAGS
ONLY CPG INBAND BEFORE ACM onlycpginbandbeforeacm
SIMPLE EC BCI IN ALL BK MSG simpleecbciinallbkmsg
CA FOR ANNOUNCEMENTS caforannouncements
UNIQUE TRANSIT CIT uniquetransitcit
ISUBTYPEFROMSIP isubtypefromsip
VALIDATEISUBFROMSIP validateisubfromsip
FORCEECHOCNTRL forceechocntrl
CHGBEFOREACM chgbeforeacm
NOOBCISIPACM noobcisipacm
NO OBCI FOR SIP APN noobcisipapn
CHGBETWEENACMANDANM chgbetacmanm
UUINDIAM uuindiam
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
ITUCAI24 itucai24
CELLULARCPCS cellularcpcs
IEPSCPC iepscpc
Command Parameters
Field
Parameter Length Description
sigprofilename 1-23 The name of the ISUP signaling profile.
compat N/A Specifies whether the compatibility functionality is
active:
• unsupported
• supported
accessdel N/A Specifies whether the access delivery functionality is
active:
• unsupported
• supported
gennum N/A Specifies whether the generic number functionality is
active:
• unsupported
• supported
gennotif N/A Specifies whether the generic notification functionality
is active:
• unsupported
• supported
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
gendigs N/A Specifies whether the generic digit functionality is
active:
• unsupported
• supported
locnum N/A Specifies whether the location number functionality is
active:
• unsupported
• supported
origiscpc N/A Specifies whether the originating ISC point code
functionality is active:
• unsupported
• supported
teleservice N/A Specifies whether the user teleservice functionality is
active:
• unsupported
• supported
segmentation N/A Specifies whether the segmentation functionality is
active:
• unsupported
• supported
fallback N/A Specifies whether the fallback functionality is active:
• unsupported
• supported
propdelay N/A Specifies whether the propagation delay functionality is
active:
• unsupported
• supported
emcid N/A Specifies whether the EMCID functionality is active:
• unsupported
• supported
hopcounter N/A Specifies whether the hop counter functionality is
active:
• unsupported
• supported
subprioritycls N/A Specifies whether the subscriber priority class
functionality is active:
• unsupported
• supported
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
apm N/A Specifies whether the Application Transport
Mechanism (APM) functionality is active:
• unsupported
• supported
connuminacm N/A Specifies whether the connect number parameter is
supported in the ACM message:
• unsupported
• supported
causeincpg N/A Specifies whether the cause indicators parameter is
supported in the CPG message:
• unsupported
• supported
multicarrierenv N/A Specifies whether the multi carrier environment
functionality is active:
• unsupported
• supported
carrierselection N/A Specifies whether the carrier selection functionality is
active:
• unsupported
• supported
inrinf N/A Specifies whether INR/INF messages are supported:
• unsupported
• supported
cqmcqr N/A Specifies whether CQM/CQR messages are supported:
• unsupported
• supported
callref N/A Specifies whether the call reference parameter is
supported:
• unsupported
• supported
cfn N/A Specifies whether the CFN message is supported:
• unsupported
• supported
facility N/A Specifies whether the FAA, FAR, and FRJ messages
are supported:
• unsupported
• supported
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
pam N/A Specifies whether the PAM message is supported:
• unsupported
• supported
obcianm N/A Specifies whether the optional backward call indicators
parameter is supported in the ANM message:
• unsupported
• supported
drs N/A Specifies whether the DRS message is supported:
• unsupported
• supported
rednum N/A Specifies whether the redirection number parameter is
supported:
• unsupported
• supported
lpa N/A Specifies whether the LPA message is supported:
• unsupported
• supported
ucic N/A Specifies whether the UCIC message is supported:
• unsupported
• supported
olm N/A Specifies whether the OLM message is supported:
• unsupported
• supported
bbrel N/A Specifies whether the Blue Book specific parameters
are supported in the REL message:
• unsupported
• supported
usr N/A Specifies whether the Blue Book specific parameters
are supported in the USR message:
• unsupported
• supported
callmodmsgs N/A Specifies whether the call modification messages
CMR, CMA, and CMRJ are supported:
• unsupported
• supported
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
calldiv N/A Specifies whether the call diversion parameter is
supported:
• unsupported
• supported
callhist N/A Specifies whether the call history parameter is
supported:
• unsupported
• supported
genref N/A Specifies whether the generic reference parameter is
supported:
• unsupported
• supported
mlpp N/A Specifies whether the MLPP parameter is supported:
• unsupported
• supported
nsf N/A Specifies whether the network specific functionality
parameter is supported:
• unsupported
• supported
rednumrist N/A Specifies whether the redirection number restriction
parameter is supported:
• unsupported
• supported
remoteop N/A Specifies whether the remote operations parameter is
supported:
• unsupported
• supported
servactv N/A Specifies whether the service activation parameter is
supported:
• unsupported
• supported
servactvinrel N/A Specifies whether the service activation parameter is
supported in the ANSI/Japan release (REL) message:
• unsupported
• supported
sigpointcode N/A Specifies whether the signaling point code parameter is
supported:
• unsupported
• supported
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
tmrprime N/A Specifies whether the transmission medium required
prime parameter is supported:
• unsupported
• supported
transmedused N/A Specifies whether the transmission medium used
parameter is supported:
• unsupported
• supported
usiprime N/A Specifies whether the user service information prime
parameter is supported:
• unsupported
• supported
rednuminacm N/A Specifies whether the redirection number parameter is
supported in the ACM message:
• unsupported
• supported
rednuminanm N/A Specifies whether the redirection number parameter is
supported in the ANM message:
• unsupported
• supported
uuiinrel N/A Specifies whether the user to user indicators parameter
is supported in the REL message:
• unsupported
• supported
uuiininf N/A Specifies whether the user to user information (UUI)
parameter is supported in the ANSI INF (information
response) message:
• unsupported
• supported
uuindcon N/A Specifies whether the user to user indicators parameter
is supported in the connect (CON) message:
• unsupported
• supported
conreqinfaa N/A Specifies whether the connection request parameter is
supported in the FAA message:
• unsupported
• supported
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
conreqinfar N/A Specifies whether the connection request parameter is
supported in the FAR message:
• unsupported
• supported
fac N/A Specifies whether the FAC message is supported:
• unsupported
• supported
echocontrol N/A Specifies whether the echo control parameter is
support:
• unsupported
• supported
backwardGVNS N/A Specifies whether the backward GVNS parameter is
supported:
• unsupported
• supported
circassmap N/A Specifies whether the circuit assignment map
parameter is supported:
• unsupported
• supported
ccss N/A Specifies whether the CCSS parameter is supported:
• unsupported
• supported
calldivtreat N/A Specifies whether the Call Diversion Treatment
parameter is supported:
• unsupported
• supported
calledinnum N/A Specifies whether the called IN number parameter is
supported:
• unsupported
• supported
collectcallreq N/A Specifies whether the collect call request parameter is
supported:
• unsupported
• supported
conftreat N/A Specifies whether the conference treatment indicators
parameter is supported:
• unsupported
• supported
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
correlationid N/A Specifies whether the correlation id parameter is
supported:
• unsupported
• supported
callofrtreat N/A Specifies whether the call offering treatment parameter
is supported:
• unsupported
• supported
calltransnum N/A Specifies whether the call transfer number parameter is
supported:
• unsupported
• supported
calltransref N/A Specifies whether the call transfer reference parameter
is supported:
• unsupported
• supported
dispinfo N/A Specifies whether the Display Information parameter is
supported:
• unsupported
• supported
forwardgvns N/A Specifies whether the forward GVNS parameter is
supported:
• unsupported
• supported
loopprevention N/A Specifies whether the LOP message and the Loop
Prevention indicators parameter is supported:
• unsupported
• supported
networkmgmt N/A Specifies whether the Network Management Control
parameter is supported:
• unsupported
• supported
scfid N/A Specifies whether the SCF ID parameter is supported:
• unsupported
• supported
uidactionind N/A Specifies whether the UID action indicators parameter
is supported:
• unsupported
• supported
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
uidcapind N/A Specifies whether the UID capabilities indicators
parameter is supported:
• unsupported
• supported
connumincpg N/A Specifies whether the connect number parameter is
supported in the CPG message:
• unsupported
• supported
gennumincpg N/A Specifies whether the generic number parameter is
supported in the CPG message:
• unsupported
• supported
echocntrliniam N/A Specifies whether the echo control parameter is
supported in the IAM message:
• unsupported
• supported
remoteopinrel N/A Specifies whether the remote operations parameter is
supported in the REL message:
• unsupported
• supported
accesstransinfac N/A Specifies whether access transport in the FAC
parameter is supported:
• unsupported
• supported
gennotifinfac N/A Specifies whether the generic notification parameter is
supported in the FAC message:
• unsupported
• supported
uuindanm N/A Specifies whether the user to user indicators parameter
is supported in the ANM message:
• unsupported
• supported
uuindcpg N/A Specifies whether the user to user indicators parameter
is supported in the CPG message:
• unsupported
• supported
nrmsupport N/A Specifies whether the NRM message is supported:
• unsupported
• supported
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
cseinrlc N/A Specifies whether the cause indicators parameter is
supported in the RLC message:
• unsupported
• supported
upaupt N/A Specifies whether the UPA and UPT messages are
supported:
• unsupported
• supported
recincai N/A Specifies whether the recommendation field in the
cause parameter is supported:
• unsupported
• supported
transitunrec N/A Specifies whether the transiting of unrecognized
parameters is supported:
• unsupported
• supported
ccraw N/A Specifies whether raw ISUP messages should be sent
to the CC:
• unsupported
• supported
cgbcgu N/A Specifies whether Circuit Group Block and Circuit
Group Unblock messages are supported by the ISUP
revision currently in use. If this parameter is set to
unsupported, individual BLO and UBL messages will
be sent for each circuit instead, when necessary.
• supported (default)
• unsupported
grs N/A Specifies how to perform the Group Reset function for
the ISUP revision currently in use, whenever circuits
need to be reset:
• supported - The Group Reset message (GRS) is
supported. Send a GRS message to the group.
• unsupported - The Group Reset message is not
supported. Send an individual reset message (RSC)
on every circuit.
One instance of Group Reset is when a CNS module is
started or restarted and the ISUP service group
parameter GRSATSTARTUP is set to supported.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
baseprofile N/A May be specified when configuring a named ISUP
signaling profile. The specified base profile is used as a
set of defaults for all profile parameter values. Then any
parameter for which you explicitly specify a value
overrides the default base profile value, in the resulting
named signaling profile.
pdv N/A Specifies the Propagation Delay Value in milliseconds.
Must be 0-400, default is 0 (milliseconds).
u2usrvclevel N/A The level of user to user services supported by the
ISUP revision currently in use:
• none (default)
• level1
• level2
• level3
sam N/A Specifies whether the Subsequent Address Message is
supported by the ISUP revision currently in use:
• supported
• unsupported (default)
fot N/A Specifies whether the Forward Transfer Message is
supported by the ISUP revision currently in use:
• supported
• unsupported (default)
specialdigits N/A Indicates the special digits that can appear in dialed
digit strings:
• digitA - digit A is allowed in the digit string.
• digitB - digit B is allowed in the digit string.
• digitC - digit C is allowed in the digit string.
• digitD - digit D is allowed in the digit string.
• digitE - digit E is allowed in the digit string.
• digitF - digit F is allowed in the digit string.
• none - no special digits allowed in the digit string.
tns N/A Specifies whether the Transit Network Selection
parameter is supported by the ISUP revision currently
in use:
• supported
• unsupported (default)
accesstrans N/A Specifies whether access transport parameter is
supported:
• unsupported
• supported
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
jurisdiction N/A Specifies whether the Jurisdiction parameter is
supported:
• unsupported
• supported
ocn N/A Specifies whether the Original Called Number
parameter is supported:
• unsupported
• supported
businessgrp N/A Specifies whether the Business Group parameter is
supported:
• unsupported
• supported
conreq N/A Specifies whether the Connection Request parameter
is supported:
• unsupported
• supported
infoind N/A Specifies whether the Information Indicator parameter
is supported:
• unsupported
• supported
ntp N/A Specifies whether the Network Transport is supported:
• unsupported
• supported
notifind N/A Specifies whether the Notification Indicator parameter
is supported:
• unsupported
• supported
redinfoacm N/A Specifies whether the Redirection Information
parameter is supported in the ACM message:
• unsupported
• supported
egressservice N/A Specifies whether the Egress Service parameter is
supported:
• unsupported
• supported
Note: You cannot set both the NETWORK DATA and
EGRESSSERVICE parameters to supported.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
servcodeind N/A Specifies whether the Service Code Indicator
parameter is supported:
• unsupported
• supported
specprocreq N/A Specifies whether the Special Processing Request
parameter is supported:
• unsupported
• supported
transreq N/A Specifies whether the Transaction Request parameter
is supported:
• unsupported
• supported
chgnum N/A Specifies whether the Charge Number parameter is
supported:
• unsupported
• supported
genaddressrel N/A Specifies whether the Generic Address parameter is
supported:
• unsupported
• supported
uuindacm N/A Specifies whether the User to User Indicators
parameter is supported:
• unsupported
• supported
uuinfo N/A Specifies whether the User to User Information
parameter is supported:
• unsupported
• supported
bcm N/A Specifies whether the Backward Charging Message
parameter is supported:
• unsupported
• supported
nsa N/A Specifies whether the network specific ANM parameter
(0xF0) is supported in the ANM message:
• unsupported
• supported
operatorservinfo N/A Specifies whether the Operator Service Information
parameter is supported:
• unsupported
• supported
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
cvtcvr N/A Specifies whether the Circuit Validation Test/Response
procedures are supported:
• unsupported
• supported
genname N/A Specifies whether the Generic Name parameter is
supported:
• unsupported
• supported
redcap N/A Specifies whether the Redirection Capability parameter
is supported:
• unsupported
• supported
redcount N/A Specifies whether the ANSI Redirect Counter
parameter (0x77) is supported:
• unsupported
• supported
sendtwogrpmsgs N/A Specifies whether to Set the Flag to Send Two Group
Messages:
• unsupported
• supported
awaittwogrpmsgs N/A Specifies whether to set the Flag to Await Two Group
Messages:
• unsupported
• supported
cqmoncardswap N/A Specifies whether to set the Flag to perform CQM on a
card swap:
• unsupported
• supported
ansi95grsgra N/A Specifies whether the ANSI-95 format for Group Reset
Circuit (GRS) and GRA which includes optional
parameters, should be used:
• unsupported
• supported
ansi95cqm N/A Specifies whether the ANSI-95 format for Circuit Query
Message (CQM) which includes optional parameters,
should be used:
• unsupported
• supported
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
ansi95cfm N/A Specifies whether the ANSI-95 format for Confusion
Message (CFM) which includes optional parameters,
should be used:
• unsupported
• supported
cpgbeforeacm N/A Specifies whether a CPG arriving before an ACM
should be transited:
• unsupported
• supported
awaitdigits N/A Specifies whether Await Digits is supported:
• unsupported (default)
• supported
See Timer T35 in Table 3–72 on page 3–318, "ITU
Timers".
mapdmsfeparameter N/A Specifies whether the service group should perform
mapping of the Completion Code in the DMS FE
parameter (ANSI ISUP only):
• unsupported
• supported (default)
mxcgnum N/A The maximum digit string length for the Calling Party
Number parameter. Must be 1-30, default is 30.
mxcdnum N/A The maximum digit string length for the Called Party
Number parameter. Must be 1-30, default is 30.
truncatecdpn N/A Specifies whether or not to truncate a called party
number that contains more than MXCDNUM digits:
• unsupported - don’t truncate and release the call.
• supported - truncate the field to MXCDNUM digits
and continue processing the call.
fph N/A Specifies whether the Freephone Indicators parameter
is supported:
• unsupported
• supported (default)
itxtxa N/A Specifies whether the ITX and TXA messages are
supported:
• unsupported
• supported (default)
sccpproc N/A Specifies whether the SCCP Procedure is supported:
• unsupported
• supported (default)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
cnriam N/A Specifies whether the Connection Request parameter
is supported in the IAM:
• unsupported
• supported (default)
ccnr N/A Specifies whether the CCNR Possible Indicator
parameter is supported:
• unsupported
• supported (default)
transitcfn N/A Specifies whether the CFN message should be
transited:
• unsupported
• supported (default)
holdingind N/A Specifies whether the Holding Indicator is supported:
• unsupported
• supported (default)
dispinfoinacm N/A Specifies whether the Display Information parameter in
the ACM is supported:
• unsupported
• supported (default)
dispinfoincon N/A Specifies whether the Display Information parameter in
the CON is supported:
• unsupported
• supported (default)
dispinfoincpg N/A Specifies whether the Display Information parameter in
the CPG is supported:
• unsupported
• supported (default)
dispinfoiniam N/A Specifies whether the Display Information parameter in
the IAM is supported:
• unsupported
• supported (default)
gennuminacm 1-23 Specifies whether the Generic Number parameter in
the ACM is supported:
• unsupported
• supported (default)
gennuminfac N/A Specifies whether the Generic Number parameter in
the FAC is supported:
• unsupported
• supported (default)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
gennumininf N/A Specifies whether the Generic Number parameter in
the INF is supported:
• unsupported
• supported (default)
conftreatinanm N/A Specifies whether the Conference Treatment
parameter in the ANM is supported:
• unsupported
• supported (default)
continuity N/A Specifies whether the Continuity procedures are
supported:
• unsupported
• supported (default)
trunkoffering N/A Specifies whether the trunk offering messages can,
fan, ofr, and rcl are supported:
• unsupported (default)
• supported
operatorselection N/A Specifies whether the operator selection parameter is
supported:
• unsupported (default)
• supported
diagnostics N/A Specifies whether the Diagnostics field is supported:
• unsupported
• supported (default)
optionalfci 1-23 Specifies whether the Optional Forward Call Indicators
(FCI) are supported:
• unsupported
• supported (default)
cugic N/A Specifies whether the Closed User Group Interlock
Code is supported:
• unsupported
• supported (default)
com N/A Specifies whether the COM message is supported:
• unsupported
• supported (default)
con N/A Specifies whether the CON message is supported:
• unsupported
• supported (default)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
usiparam N/A Specifies whether the User Service Information
parameter is supported:
• unsupported
• supported (default)
connectednumber N/A Specifies whether the connected number is supported:
• unsupported
• supported (default)
iriorircv N/A Specifies whether an IRI/ORI message is expected:
• unsupported
• supported
iriorisent N/A Specifies whether an IRI/ORI message is to be sent
out:
• unsupported
• supported
t11active N/A Specifies whether ISUP T11 timing is supported:
• unsupported
• supported - Start the T11 timer for all ISUP to non-
ISUP exchanges. See the T11EARLYACM parameter
for additional controls.
iriori N/A Specifies whether IRI/ORI is supported:
• unsupported
• supported
transmedusedinnrm N/A Specifies whether the TMU parameter within the NRM
Message is supported:
• unsupported
• supported
rlcackgrs N/A Specifies whether acknowledging a GRS with an RLC
is supported:
• unsupported
• supported
incomingtrunkidcode N/A Specifies whether the Incoming Trunk Identity Code
parameter is supported:
• unsupported
• supported
spcinirs N/A Specifies whether the SPC parameter with the IRS
message is supported:
• unsupported
• supported
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
redinfoiam N/A Specifies whether the Redirection Information
parameter is supported within the IAM message:
• unsupported
• supported
RedirectingNum N/A Specifies whether the Redirecting Number is
supported:
• unsupported
• supported
SendBloAfterSetup N/A Specifies, for some ANSI protocols, whether a BLO
message should be sent when blocking a circuit, after a
backwards message has been received during the call:
• unsupported
• supported
t6causeval N/A Specifies the T6 timer default release cause value used
by all ITU protocols. Must be 1-127, default is 16.
t7causeval N/A Specifies the T7 timer default release cause value used
by all ITU protocols. Must be 1-127, default is 31.
uuiacm N/A Specifies whether signaling control for the user-to-user
information (UUI) parameter is supported in the early
address complete message (ACM):
• unsupported
• supported
atrel N/A Specifies whether signaling control for the Access
Transfer (AT) parameter is supported in the Release
message (REL):
• unsupported
• supported
uuindrel N/A Specifies whether signaling control for the user-to-user
Indicator (UUIND) parameter is supported in the REL:
• unsupported
• supported
eit N/A Specifies whether signaling control for the End
Information Transfer (EIT) parameter is supported:
• unsupported
• supported
gi N/A Specifies whether signaling control for the Global
Information (GI) parameter is supported:
• unsupported
• supported
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
tit N/A Specifies whether signaling control for the Test
Information Transfer (TIT) parameter is supported:
• unsupported
• supported
ait N/A Specifies whether signaling control for the Additional
Information Transfer (AIT) is supported:
• unsupported
• supported
tci N/A Specifies whether signaling control for the Test Call
Information (TCI) parameter is supported:
• unsupported
• supported
nft N/A Specifies whether signaling control for the Network
Function Type (NFT) parameter is supported:
• unsupported
• supported
cpnrel N/A Specifies whether signaling control for the Called Party
Number (CPN) parameter is supported in the REL:
• unsupported
• supported
bcirel N/A Specifies whether BCI is supported in the REL:
• unsupported
• supported
ci N/A Specifies whether the CI6 is supported:
• unsupported
• supported
iui N/A Specifies whether the IUI6 is supported:
• unsupported
• supported
nrop N/A Specifies whether the NROP6 is supported:
• unsupported
• supported
msi N/A Specifies whether the MSI6 is supported:
• unsupported
• supported
rr N/A Specifies whether the RR6 is supported:
• unsupported
• supported
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
mi N/A Specifies whether the MI6 is supported:
• unsupported
• supported
spc6 N/A Specifies whether the SPC6 is supported:
• unsupported
• supported
marel N/A Specifies whether the MA6 is supported in the REL:
• unsupported
• supported
forwardcpg N/A Specifies whether the Call Progress (CPG) message is
supported in the forward direction:
• unsupported
• supported
forwardsus N/A Specifies whether the Suspend (SUS) message is
supported in the forward direction:
• unsupported
• supported
conreqininf N/A Specifies whether the Connection Request is
supported in the INR INF profile:
• unsupported
• supported
sgmpci N/A Specifies whether the PCI parameter is supported in
the SGM:
• unsupported
• supported
gr317si N/A Specifies whether various screening indicators for
GR317 parameter compliancy are supported:
• unsupported
• supported
calleddirnum N/A Specifies whether the called directory number
parameter is supported:
• unsupported
• supported
opr N/A Specifies whether the OPR message is supported in
China:
• unsupported
• supported
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
ccl N/A Specifies whether the CCL message is supported in
China:
• unsupported
• supported
spdigf N/A Specifies whether the stop digit is supported in other
digit strings apart from the called party number:
• unsupported
• supported
callreffrj N/A Specifies whether the call reference number is
supported in the FRJ message:
• unsupported
• supported
pcipassdef N/A The “parameter compatibility” parameter has a field for
“pass on not possible”. The value of 11 has different
meanings for different customers. This control specifies
how that value should be processed:
• unsupported
• discardparameter
• discardMessage
• discardCall
otgnansi92 N/A Specifies whether the outgoing trunk group number
parameter in ANSI uses the ANSI’92 format:
• unsupported (default) - no uses GR394 format
• supported - yes uses ANSI’92 format
msgsenddelay N/A Specifies the delay in milliseconds between sending
messages on the same circuit. Some older exchanges
in Japan require a 100 millisecond delay between
messages on the same circuit or they could miss a
message. Must be 0-255 (milliseconds), default is 0.
drpcauseacm N/A Specifies whether the ACM should include a cause
parameter or not when the forward call indicator
parameter in the IAM indicates that interworking has
occurred at a previous exchange, the call is torn down
and an announcement generated by the GSX:
• unsupported - don’t include a cause parameter
• supported - do include a cause parameter
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
chargeindsetting N/A Specifies the BCI charge indicator:
• transit (default) - Transit whatever is received
from the sending side (egress) of the network. This
could be nothing at all, as with ISDN, or whatever is
received, as with ISUP.
• charge - Charge.
• nocharge - Do not charge.
• noindication - Do not use this parameter for the
charge decision.
t11earlyacm N/A Specifies whether an ISUP Early ACM guard timer
(T11) is started by the GSX:
• unsupported - ISUP Early ACM guard timer is not
started.
• supported - ISUP Early ACM guard timer is
started. This starts the T11 timer for all types of
exchanges while the T11ACTIVE parameter starts
this timer only for ISUP to non-ISUP exchanges.
dmsfe N/A Specifies whether the DMS FE field is supported for
ACM, ANM, and CPG messages:
• unsupported - DMS FE field is not supported
• supported - DMS FE field is supported
cqmforresync N/A Specifies whether to send a CQM PDU to re-
synchronize when transitioning from MTP Pause to
RESUME state:
• unsupported - do not send a CQM PDU to re-
synchronize
• supported - send a CQM PDU to re-synchronize
ncr N/A Specifies whether the network call reference parameter
is supported in the ISUP IAM when ISUP SERVICE
REVISION is portugaloni:
• unsupported - ignore NCR in the IAM
• supported - recognize NCR in the IAM and
generate an NCR if it is not present in the IAM
tnumbersource N/A Specifies which of two value types to use to populate
the Spare Trunk Number field:
• trunkgroup (default) - trunk group number
• cic - circuit value
sliiniam N/A Specifies whether the Supplementary Line Info
parameter is supported in the IAM:
• supported - SLI is valid in the IAM
• unsupported - SLI is not valid in the IAM
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
rlt N/A Specifies whether Release Link Trunking service is
supported:
• supported - RLT is supported
• unsupported - RLT is not supported
accesstran N/A Specifies whether the Access Transport parameter is
supported in the FAR message:
• supported - Access Transport is valid in the FAR
• unsupported - Access Transport is not valid in the
FAR
uuindinfar N/A Specifies whether the User-to-User Indicators
parameter is supported in the FAR message:
• supported - UU Indicators parameter is valid in the
FAR
• unsupported - UU Indicators is not valid in the
FAR
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
upvexchangeroles N/A Specifies the GSX exchange type that can perform
unrecognized parameter value (UPV) screening for a
call:
• orig - The originating exchange is allowed to
perform UPV. (For non-ISUP to ISUP.)
• term - The terminating exchange is allowed to
perform UPV. (For ISUP to non-ISUP.)
• intwk - The interworking exchange is allowed to
perform UPV. (For ISUP to ISUP using different
ISUP revisions on the ingress and egress.)
• trans - The transit exchange is allowed to perform
UPV. (For ISUP to ISUP using the same ISUP
revision.)
• int - The international exchange is allowed to
perform UPV. (For ISUP to ISUP using different
country codes on the ingress and egress trunk
groups.)
• unknown - The unknown exchange role is allowed to
perform UPV.
• none - No exchange roles are allowed to perform
UPV.
Parameter value screening is used to validate the
information sent and received in the ISUP parameters
and to prevent invalid values from being sent into a
network. Setting the control to none effectively turns off
the checking for all call scenarios. This allows you to
send unsupported values to the GSX and in most cases
the GSX will transit the value.
This control may be helpful if you see UPV messages
in the system log.
cdbsm N/A Specifies whether Called Subscribers Basic Service
Marks are supported (UKISUP only):
• unsupported
• supported
cgbsm N/A Specifies whether Calling Subscribers Basic Service
Marks are supported (UKISUP only):
• unsupported
• supported
cgofm N/A Specifies whether Calling Subscribers Originating
Facility Marks are supported (UKISUP only):
• unsupported
• supported
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
cdtfm N/A Specifies whether Called Subscribers Terminating
Facility Marks are supported (UKISUP only):
• unsupported
• supported
nii N/A Specifies whether National Information Indicators are
supported (UKISUP only):
• unsupported
• supported
niri N/A Specifies whether National Information Request
Indicators are supported (UKISUP only):
• unsupported
• supported
nfci N/A Specifies whether National Forward Call Indicators are
supported (UKISUP only):
• unsupported
• supported
presnum N/A Specifies whether the Presentation Number is
supported (UKISUP only):
• unsupported
• supported
ldli N/A Specifies whether Last Diverting Line Identity is
supported (UKISUP only):
• unsupported
• supported
pcli N/A Specifies whether Partial Calling Line Identity is
supported (UKISUP only):
• unsupported
• supported
nfcilink N/A Specifies whether National Forward Call Indicators
(link-by-link) are supported (UKISUP only):
• unsupported
• supported
inr N/A Specifies whether the Information Request message in
all states from post-IAM to pre-release is supported
(UKISUP only):
• unsupported
• supported
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
nfcilbl N/A Specifies whether the NFCI (link-by-link) parameter is
supported in the IAM (UKISUP only):
• unsupported
• supported
alliancescreenind N/A Specifies whether the Alliance screening indicator is
supported in the IAM message:
• unsupported
• supported
announcementind N/A Specifies whether the announcement indicator is
supported in the REL message:
• unsupported
• supported
dialednumber N/A Specifies whether the dialed number indicator is
supported in the IAM message:
• unsupported
• supported
forwardnetspecinfo N/A Specifies whether the forward network specific
information parameter is supported in the IAM
message:
• unsupported
• supported
gennotifrepeatable N/A Specifies whether the generic notification parameter is
repeatable:
• unsupported
• supported
gennumrrepeatable N/A Specifies whether the generic number parameter is
repeatable:
• unsupported
• supported
gennumrepeatableiam N/A Specifies whether the generic number parameter is
repeatable in the IAM (initial address) message:
• unsupported
• supported
genoperation N/A Specifies whether the generic operation parameter is
supported in ACM, ANM, CPG, FAR, REL, and IAM
messages:
• unsupported
• supported
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
hardtoreachind N/A Specifies whether the hard-to-reach indicator in
supported in ACM and REL messages:
• unsupported
• supported
networkdata N/A Specifies whether the network data indicator is
supported in the IAM message (ANSI and ITU only; for
ANSI, the parameter code is 0xC3, and 0xE0 for ITU).
• unsupported (default)
• supported
Note: You cannot set both the NETWORK DATA and
EGRESSSERVICE parameters to supported.
networkmgmtinfo N/A Specifies whether the network management
information indicator is supported in the IAM message:
• unsupported
• supported
networkswitchnumber N/A Specifies whether the network switch number
parameter is supported in ACM, CPG, and IAM
messages:
• unsupported
• supported
routinginfoind N/A Specifies whether the routing information indicator is
supported in the IAM message:
• unsupported
• supported
sdn N/A Specifies whether the SDN SID/ANI increment counter
is supported:
• unsupported
• supported
eci N/A Specifies whether the Emergency Call Indicator (ECI) is
supported (for Japan variants only):
• unsupported
• supported
t7transit N/A Specifies whether the T7 timer will run for an ISUP
Transit call (T7 is normally run only when interworking
between signaling protocols):
• unsupported - don’t run T7 timer on ISUP transit
calls
• supported - run T7 timer on ISUP transit calls
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
jti N/A Specifies whether or not the JTI Information Element
Parameter is supported in the ISUP signaling protocols:
• unsupported (default) - JTI Information Element
Parameter is not used in ISUP signaling messages
• supported - JTI Information Element Parameter is
used in ISUP signaling messages
invtnsrelease N/A Specifies whether to apply Q931 release handling for
invalid TNS:
• unsupported - Do not apply Q931 release handling
when an invalid TNS is detected.
• supported - Apply Q931 release handling when an
invalid TNS is detected.
chginspeech N/A Specifies whether the Japan charge message can be
transitted in speech state i.e. after an ANM:
• unsupported
• supported
ecinf N/A Specifies whether the emergency call information
parameter (0xE1) is supported in the Japan CPG
message:
• unsupported
• supported
fciuserpartiwk N/A Specifies whether the FCI ISDN User Part Preference
Indicator should be overwritten for non-ISUP to ISUP
(or interworking) calls:
• unsupported - Do not overwrite the FCI ISDN User
Part Preference Indicator.
• supported (default for Japan BASEPROFILEs) -
Overwrite the FCI ISDN User Part Preference
Indicator. The ISDN User Part Preference Indicator
will be reset to “not required at all” when the ISDN
Access Indicator is “Non-ISDN”. When the ISDN
Access Indicator is “ISDN” then the ISDN User Part
Preference Indicator will be reset to “preferred all the
way” if Transmission Medium Requirements (TMR)
are other than “64 Kbs unrestricted.” If TMR is “64
Kbs unrestricted,” then the ISDN User Part
Preference Indicator will be reset to “required all the
way.”
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
fciuserparttrans N/A Specifies whether the FCI ISDN User Part Indicator
should be overwritten for ISUP to ISUP (or transit) calls:
• unsupported (default for Japan BASEPROFILEs)
- Do not overwrite the FCI ISDN User Part
Preference Indicator.
• supported - Overwrite the FCI ISDN User Part
Preference Indicator. The ISDN User Part
Preference Indicator will be reset to “not required at
all” when the ISDN Access Indicator is “Non-ISDN”.
When the ISDN Access Indicator is “ISDN” then the
ISDN User Part Preference Indicator will be reset to
“preferred all the way” if Transmission Medium
Requirements (TMR) are other than “64 Kbs
unrestricted.” If TMR is “64 Kbs unrestricted,” then
the ISDN User Part Preference Indicator will be reset
to “required all the way.”
cptt N/A Specifies whether the Connection Point Trunk Type is
supported:
• unsupported - Connection Point Trunk Type is not
supported.
• supported - Connection Point Trunk Type is
supported.
fciuserpartchosencar N/A Specifies whether the FCI ISDN User Part Preference
Indicator should be overwritten based on the chosen
carrier:
• unsupported - Do not overwrite the FCI ISDN User
Part Indicator.
• supported (default for Japan BASEPROFILEs) -
Overwrite the FCI ISDN User Part Indicator based on
the chosen carrier. This applies when the ingress
carrier type is “chosen” and TMR is “speech” or
“3.1Khz audio.” Then the ISDN User Part Preference
Indicator will be reset to “preferred all the way”.
maxcqmrange N/A The maximum value for the Range field in the CQM
message that is generated by the GSX. Must be 0-31.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
noipechoind N/A Specifies whether the Echo Control Indication should
be set on an IP to PSTN call:
• unsupported - This control has no impact on the
echo control procedures. The existing procedures
remain in effect. This typically means that the echo
control indication is set in the IAM.
• supported - The setting of the echo control
indicator for the IP to PSTN call is modified. The
echo control indication is not set in the IAM. You
should note however, that even if this change to the
setting of the indicator in the IAM occurs, in the event
that the ACM is returned and the message indicates
that an echo control device has not been included,
an echo device at this GSX will be included in the
call.
visitorma N/A Specifies whether the Visitor MA parameter is
supported:
• unsupported - Visitor MA parameter is not
supported
• supported - Visitor MA parameter is supported
hwblksendblo N/A Specifies whether to send BLO when a circuit is
hardware blocked:
• unsupported - Don’t send BLO when a circuit is
hardware blocked.
• supported - Send BLO when a circuit is hardware
blocked.
hwblkallowcalls N/A Specifies whether or not to reject calls when a circuit is
hardware blocked:
• unsupported - Reject calls when a circuit is
hardware blocked.
• supported - Allow calls when a circuit is hardware
blocked.
hwblksendrscforcalls N/A Specifies whether or not to send RSC when a call is
impacted by a hardware blockage on a circuit:
• unsupported - Do not send RSC.
• supported - Send RSC.
iamgeneratedcarrierc N/A Specifies whether or not the IAM-Generated Carrier
Code should always be populated in the CDR for
Japan, regardless of type:
• unsupported - Do not populate the IAM-Generated
Carrier Code in the CDR.
• supported - Populate the IAM-Generated Carrier
Code in the CDR.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
assumeogdevice N/A Specifies whether to set the Nature of Connection
Indicator (NCI) to indicate the device included for any
ISUP-ISUP call, and configure incoming devices as if
this field had already been set.
• unsupported
• supported
signalonlysipalert N/A Specifies whether only SIP 180 Alerting messages will
be interworked to ISUP ACM and/or CPG messages:
• unsupported
• supported
alwunscrndcin N/A Specifies whether or not the values 0 and 2 of
Screening Indicator should be allowed in ISUP:
• unsupported - Do not allow the values 0 and 2 of
Screening Indicator in ISUP.
• supported - Allow the values 0 and 2 of Screening
Indicator in ISUP.
This control essentially allows or disallows unverified/
un-screened calling party numbers.
dropusi N/A Specifies whether the USI parameter (ISUP IAM
Message) is supported when the far end switch is not
ISUP:
• unsupported - Do not support USI parameter.
• supported - Support USI parameter.
This control applies only to calls going from non-ISUP
signaling to ISUP signaling, such as SIP to ISUP.
preventacmtocpg N/A Specifies whether an Address complete message
(ACM) received on the egress side of a call, after an
ACM has already been generated by the ingress side of
the call, should cause the GSX to generate a Call
progress message (CPG) on the ingress side of the
call.
• unsupported (default) - Send a CPG to ingress
side when an ACM is received on egress side.
• supported - Accept and process the ACM on the
egress side, but do not send a CPG to the ingress
side.
A CPG received on the egress side after an ACM has
been generated on the ingress side will be allowed to
transit as per the existing functionality and will not be
impacted by this new control.
ACMs may be generated by scripts, announcements,
timer expiration, and other events.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
dontmaptoheaderocn N/A Specifies whether the “To header” in the SIP INVITE
can be mapped into the ISUP Original Called Number
(OCN) parameter:
• unsupported (default) - The “To header” from the
received SIP INVITE message can be mapped into
the OCN parameter.
• supported - The “To header” from the received SIP
INVITE message will never be mapped into the OCN
parameter.
This control applies only to Japan ISUP variants when
interworking with SIP.
noinnumberupdates N/A Specifies how the GSX should generate the called IN
number and original called IN number parameter when
the PSX performs a number translation based on the
received and updated called party number information:
• unsupported (default) - Create or modify the called
IN number and original called IN number parameter,
based on the new called number information.
• supported - Transit the called IN number and
original called IN number parameters if received but
do not modify them based on new called number
information.
This control applies only to Japan ISUP variants.
usepsxchgind N/A Specifies whether or not to overwrite the charge
indicator value sent in CPG messages as part of pre-
subscription calls:
• unsupported (default) - Make the charge indicator
value the same as the received value.
• supported - Overwrite the charge indicator value
based on the ACM charge indicator supplied by the
PSX.
This control applies only to Japan ISUP variants.
alwaysaddoptptr N/A Specifies whether or not the GSX will add an optional
parameter pointer, set to the value 0, into all ISUP
messages, even if there are no optional parameters
defined for the protocol specification such as BLO and
RSC messages:
• unsupported (default) - Do not add the optional
parameter pointer set to the value 0.
• supported - Add the optional parameter pointer set
to the value 0 into all ISUP messages.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
suppresscit N/A Specifies whether or not to prevent the Carrier
Information Transfer (CIT) parameter from being added
to an Early ACM for Pre-Subscription calls:
• unsupported (default) - Send the CIT parameter in
Early ACM for Pre-Subscription calls.
• supported - Do not send the CIT parameter in
Early ACM for Pre-Subscription calls.
This parameter value is displayed in the Service
Controls section of SHOW screens.
onlysendacmfor181 N/A Specifies whether to send an ACM if ISUP is sent a 181
(call forwarding) indication from SIP and the GSX has
not already sent an ACM:
• unsupported
• supported
dontsendexm N/A Specifies whether to prevent the GSX from sending out
EXM messages on certain trunk groups:
• unsupported (default) - Transit EXM messages
received or generated at the GSX.
• supported - prevents the GSX from sending out
any EXM messages on the associated ingress ISUP
trunk group regardless of whether the EXM message
was received or attempted to generate one.
reaffirm_block N/A Specifies whether local blocking states are maintained
when circuits are reset:
• unsupported (default) - Clear the local blocking
states when circuits are reset.
• supported - Do not clear local blocking states after
sending an RSC or GRS message. Instead, send a
BLO message on all locally blocked circuits
immediately following the reset message.
cittermexchangelogic N/A Specifies whether, when interworking in an ISUP to SIP
call, the first backward (ACM or CPG) message will
contain the CIT/CAI information:
• unsupported (default) - Do not include the CIT/CAI
information in the first backward message.
• supported - When interworking in an ISUP to SIP
call, only the first backward message (ACM/CPG)
will contain the CIT/CAI information. Also, if a 200
OK message is received and the only message sent
out on the ingress side was an early ACM without the
CAI/CIT information, the 200 OK will be interworked
into a CPG (with the information) followed by an
ANM.
This control applies only to Japan ISUP variants.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
bciincpgwithcit N/A Specifies whether BCI will be included in the CPG
message:
• unsupported (default) - Do not include BCI in the
CPG message.
• supported - If CITTERMEXCHANGELOGIC is also
set to supported, then BCI will only be included in
the CPG message if the CAI/CIT information is
included.
This control applies only to Japan ISUP variants.
dontgeneratediags N/A Specifies whether to transit any diagnostics received as
part of the cause parameter, while not generating any
diagnostics:
• unsupported (default) - Do not transit any
diagnostics received as part of the cause parameter.
• supported - Transit any diagnostics received as
part of the cause parameter, but do not generate any
diagnostics. You must also set DIAGNOSTICS to
supported to achieve this result.
onlycpginbandbeforeacm N/A Specifies whether or not to allow the egress trunk to
transit any early CPG messages with the event
indicator set to “inband information or an appropriate
pattern is now available”. Early CPG messages are
CPGs received before the ACM message:
• unsupported (default) - Do not allow the egress
trunk to transit any early CPG messages with the
event indicator set to “inband information or an
appropriate pattern is now available”.
• supported - Allow the egress trunk to transit early
CPG messages with the event indicator set to
“inband information or an appropriate pattern is now
available”.
CPG messages whose event indication is other than
“inband information or an appropriate pattern is now
available” will be dropped with the DBG log message:
"Message 0x2c has been discarded because CPG
before ACM not inband avail."
This control is more restrictive than CPGBEFOREACM
(which transits all early ACMs if set to supported). If
both controls are set to supported, this control takes
precedent.
This control applies to all standard ISUP variants.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
simpleecbciinallbkmsg N/A Specifies whether or not to check every backward
message that can contain the Backward Call Indicator
(BCI) parameter:
• unsupported (default) - Normal simple echo
control procedures are followed. Only the first
backward message containing BCI is examined to
determine activation of the echo canceller.
• supported - For each received backward message,
check for the presence of the BCI parameter. If
present, examine the Echo control device indicator
(bit n) and enable or disable the echo cancellor
accordingly.
This control is applicable only to simple echo control
procedures. It is not used (and can’t be enabled) if
either ECHOCNTRLINIAM or ECHOCONTROL are
supported.
caforannouncements N/A Specifies whether the GSX should add a charge area
parameter into the ACM or CPG messages sent as part
of disconnect treatment profiles or scripts to play an
announcement and release the call:
• unsupported (default) - The charge area
parameter is not added into the ACM/CPG
messages.
• supported - The charge area parameter is added
into the ACM/CPG messages using the information
from the POI Charge area field of the ingress trunk
group on the PSX.
This is a Japan only control. (GSX9000 only)
uniquetransitcit N/A Specifies whether the GSX should add in a transit
carrier sub-parameter to the carrier information transfer
parameter if the previous exchange added a sub-
parameter with the same carrier code:
• unsupported (default) - The GSX will add in transit
carrier data with the same carrier code as the
previous code if configured by the PSX.
• supported - The GSX will compare the transit
carrier code configured on the PSX with the last
carrier code added by the previous exchange and if
they are both the same carrier code the GSX will not
add in duplicate carrier code data. The comparison is
performed regardless of the type of carrier code
added at the previous exchange, such as transit,
originating, and so on.
This is a Japan only control. (GSX9000 only)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
isubtypefromsip N/A Specifies valid ISUB types received from SIP to be sent
to the network:
• nsap (default) - Network Service Access Point.
• userspec - User specified.
• both - Both Network Service Access Point and User
specified.
• none - No valid ISUB types.
validateisubfromsip N/A Specifies whether to validate that the SIP ISUB
parameters of type NSAP contain digits 0-9 only:
• unsupported (default) - The ISUB parameters of
type NSAP that are received from SIP are transited
regardless of whether they contain only the digits 0-
9.
• supported - The ISUB parameters of type NSAP
that are received from SIP must contain only the
digits 0-9 to be transited. If they contain any other
digits, the parameter is discarded and the call is
continued.
forceechocntrl N/A Specifies whether echo cancellation will be applied to
non-data calls regardless of information contained in
signaling messages:
• unsupported (default)
• supported
chgbeforeacm N/A Specifies whether the GSX should allow the charge
(CHG) message to be transited in the backward
direction prior to the receipt of an ACM message:
• unsupported (default) - the GSX will not transit the
CHG message in the backward direction before an
ACM has been received.
• supported - the GSX will allow a CHG message to
be transited in the backward direction prior to the
reciept of ACM message.
Set this control to supported on both the ingress and
egress signaling profiles.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
noobcisipacm N/A Specifies whether the GSX will generate the optional
backward call indicator (OBCI) in ACM messages in all
scenarios where the GSX generates announcements
(e.g. pre-subscription calls, disconnect treatment
profile, and PSX scripts):
• unsupported (default) - the GSX will generate the
OBCI parameter in the ACM for all the existing
scenarios, including interworking to SIP.
• supported - the GSX will not generate the OBCI
parameter in the ACM message when interworking
with SIP.
noobcisipapn N/A Specifies whether the GSX will generate the optional
backward call indicator (OBCI) in ACM messages for
Access Point Name (APN) calls when interworking with
SIP.
• unsupported (default) - the GSX will generate the
OBCI parameter in the ACM for APN calls when
interworking with SIP.
• supported - the GSX will not generate the OBCI
parameter in the ACM message for APN calls when
interworking with SIP.
When sending an ACM and interworking to SIP-T, the
GSX will not build a new OBCI parameter, but will send
an OBCI parameter if received in the SIP-T MIME
regardless of the settings within the OBCI.
If the 180 or 183 does not include SDP information, but
the MIME includes the OBCI parameter without the in-
band information or network interactions bits set, and
the GSX plays a tone or announcement, then the GSX
sets the in-band information bit and includes the OBCI
parameter in the outgoing ACM.
uuindiam N/A Specifies whether the user to user indicators parameter
is supported in the IAM message:
• unsupported
• supported
chgbetacmanm N/A Specifies whether the GSX will transit the CHG
message in the backwared direction between and an
ACM and an ANM:
• unsupported
• supported (default)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
itucai24 N/A Specifies whether SIP<->ISUP calls will map REL
cause value 24 to SIP 433 and vice-versa:
• supported - map REL cause value 24 to SIP 433
and map SIP 433 to REL with cause value 24
• unsupported (default) - use the default
SIP<->ISUP mapping
(The PSX must be properly configured for this
interworking.)
cellularcpcs N/A Specifies whether the GSX will support mobile terminal
Public Land Mobile Network (PLMN) values in calling
party category (CPC):
• supported - allow “mobile terminal located in a
home PLMN” and “mobile terminal located in a
visited PLMN” CPC values.
• unsupported (default) - do not allow “mobile
terminal located in ..” CPC values.
iepscpc N/A Specifies whether the GSX will support the
International Emergency Preparedness Scheme (IEPS)
in calling party category (CPC):
• supported - allow the “IEPS call marking for
preferential call set up” CPC value
• unsupported (default) - do not allow the “IEPS call
marking for preferential call set up” CPC value
admin-state N/A The administrative state of this ISUP signaling profile:
• disabled (default) - Not activated, able to be
deleted.
• enabled - Activated, available for immediate use.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Command Example
To create, configure, and activate an ISUP signaling profile named isupsigprf1 that uses the
ANSI_1995 defaults but additionally supports access delivery, generic notification, and user
teleservice:
% CREATE ISUP SIGNALING PROFILE isupsigprf1
% CONFIG ISUP SIGNALING PROFILE isupsigprf1 ..
BASEPROFILE Default_ANSI_1995
ACCESSDEL supported
GENNOTIF supported
TELESERVICE supported
% CONFIG ISUP SIGNALING PROFILE isupsigprf1 ..
STATE enabled
The command below displays the content of isupsigprf1. This signaling profile is identical to
Default_ANSI_1995 except for the ACCESSDEL, GENNOTIF, and TELESERVICE parameters
that were set above:
% SHOW ISUP SIGNALING PROFILE isupsigprf1 ADMIN
Node: TPUBS Date: 2007/02/27 19:49:23 GMT
Zone: GMTMINUS05-EASTERN-US
----------------------------------------------------------------------
ISUP Signaling Profile : isupsigprf1 Message Controls
----------------------------------------------------------------------
APM / PRI : UNSUPPORTED
BCM : UNSUPPORTED CCL : UNSUPPORTED
CFN : SUPPORTED CGB / CGU : SUPPORTED
CMR / CMC / CMRJ : UNSUPPORTED COM : UNSUPPORTED
CON : UNSUPPORTED COT / CCR : SUPPORTED
CPG (forwards) : UNSUPPORTED CQM / CQR : SUPPORTED
CVT / CVR : SUPPORTED DRS : UNSUPPORTED
FAC : SUPPORTED FAR / FAA / FRJ : UNSUPPORTED
FOT : SUPPORTED GRS : SUPPORTED
INR / INF : SUPPORTED
IDR / IRS : UNSUPPORTED ITX / TXA : UNSUPPORTED
LOP : UNSUPPORTED LPA : SUPPORTED
NRM : UNSUPPORTED OFR, CAN, FAN, RLL : UNSUPPORTED
OLM : UNSUPPORTED OPR : UNSUPPORTED
PAM : SUPPORTED SAM : UNSUPPORTED
SDN SID/ANI Inc : UNSUPPORTED
SGM : UNSUPPORTED SUS (forwards) : UNSUPPORTED
UCIC : SUPPORTED
UPA / UPT : UNSUPPORTED USR : UNSUPPORTED
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
----------------------------------------------------------------------
ISUP Signaling Profile : isupsigprf1 Parameter Controls
----------------------------------------------------------------------
AccessDel : SUPPORTED AccessTrans : SUPPORTED
AccessTransInFac : UNSUPPORTED AccessTransInFar : UNSUPPORTED
AccessTransInRel : UNSUPPORTED AllianceScreenInd : UNSUPPORTED
AnnouncementInd : UNSUPPORTED AIT : UNSUPPORTED
BackwardGVNS : UNSUPPORTED BBRel : UNSUPPORTED
BCIRel : UNSUPPORTED Business Group : SUPPORTED
CallDiv : UNSUPPORTED CallDivTreat : UNSUPPORTED
Called BSM : UNSUPPORTED Called TFM : UNSUPPORTED
CalledDirectoryNum : UNSUPPORTED CalledInNum : UNSUPPORTED
CallHist : UNSUPPORTED Calling BSM : UNSUPPORTED
CallInfo : UNSUPPORTED Calling OFM : UNSUPPORTED
CallOfrTreat : UNSUPPORTED CallRef : SUPPORTED
CallRefInFrj : UNSUPPORTED CallTransNum : UNSUPPORTED
CallTransRef : UNSUPPORTED CarrierSelection : SUPPORTED
CauseInCpg : SUPPORTED CCNR Possible Ind : UNSUPPORTED
CCSS : UNSUPPORTED Charge Number : SUPPORTED
CircAssMap : SUPPORTED CollectCallReq : UNSUPPORTED
ConfTreat : UNSUPPORTED ConfTreatInAnm : UNSUPPORTED
Connect Req in IAM : UNSUPPORTED Connected Num : UNSUPPORTED
ConNumInAcm : UNSUPPORTED ConNumInCpg : UNSUPPORTED
ConPointTrunkType : UNSUPPORTED ConReq : SUPPORTED
ConReqInFaa : UNSUPPORTED ConReqInFar : UNSUPPORTED
ConReqInInf : SUPPORTED CorrelationId : UNSUPPORTED
CpnInRel : UNSUPPORTED CseInRlc : UNSUPPORTED
CUG Interlock Cd : SUPPORTED
Diagnostics : SUPPORTED DialedNumber : UNSUPPORTED
DispInfo : UNSUPPORTED
DispInfoInAcm : UNSUPPORTED DispInfoInCon : UNSUPPORTED
DispInfoInCpg : UNSUPPORTED DispInfoInIam : UNSUPPORTED
DMS FE : UNSUPPORTED
EchoCntrlInIam : UNSUPPORTED EchoCntrlParam : UNSUPPORTED
EgressService : SUPPORTED
EIT : UNSUPPORTED EmergencyCallInd : UNSUPPORTED
EmergencyCallInfo : UNSUPPORTED
ForwardNetSpecInfo : UNSUPPORTED ForwardGVNS : UNSUPPORTED
Freephone Ind : UNSUPPORTED
GenAddressREL : SUPPORTED GenDigs : SUPPORTED
GenericOperation : UNSUPPORTED
GenName : SUPPORTED GenNotif : SUPPORTED
GenNotifInFac : UNSUPPORTED GenNotif Rpt : UNSUPPORTED
GenNum : SUPPORTED GenNumInAcm : UNSUPPORTED
GenNumInCpg : UNSUPPORTED GenNumInFac : UNSUPPORTED
GenNumInInf : UNSUPPORTED GenNum Repeatable : SUPPORTED
GenNum Rpt in IAM : SUPPORTED GenRef : UNSUPPORTED
GI : UNSUPPORTED GR317 Screening Ind : UNSUPPORTED
HardToReachInd : UNSUPPORTED
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
----------------------------------------------------------------------
ISUP Signaling Profile : isupsigprf1 Service Controls
----------------------------------------------------------------------
Allow Unscreened CIN : UNSUPPORTED
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Base Profile :
Admin State : ENABLED
The following example shows all current named ISUP signaling profiles, including the default
profiles.
% SHOW ISUP SIGNALING PROFILE SUMMARY
Node: TPUBS Date: 2004/09/21 18:02:50 GMT
Zone: GMTMINUS05-EASTERN-US
------------------------------------------------------------------
ISUP Signaling Profile Summary
--------------------------------------------------------------------
Name Admin State Base Profile (if applicable)
------------------------ ------------- -----------------------------
Default_ANSI_1992 ENABLED
Default_ANSI_1995 ENABLED
Default_ARGENTINA ENABLED
Default_ARGENTINA_IDT ENABLED
Default_ATT_NGBE ENABLED
Default_Belgacom ENABLED
Default_BRAZIL ENABLED
Default_CHILE ENABLED
Default_CHINACNC ENABLED
Default_DENMARK ENABLED
Default_ETSI_V2 ENABLED
Default_ETSI_V2_PLUS ENABLED
Default_ETSI_V3 ENABLED
Default_German ENABLED
Default_GR317 ENABLED
Default_HONGKONG_IC ENABLED
Default_INDIA ENABLED
Default_ITALY ENABLED
Default_ITU_1988 ENABLED
Default_ITU_1993 ENABLED
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Default_ITU_1997 ENABLED
Default_ITU_Q767 ENABLED
Default_KOREA ENABLED
Default_MEXICO_IC ENABLED
Default_NTT_COM ENABLED
Default_NTT_FCC ENABLED
Default_PERU ENABLED
Default_PORTUGAL_ONI ENABLED
Default_SINGAPORE ENABLED
Default_SPAIN ENABLED
Default_SPIROU ENABLED
Default_UKISUP ENABLED
isupsigprf1 ENABLED
Default_ANSI_1995
To view the default ISUP signaling profile parameter controls for a country--Germany for
example--type the command:
% SHOW ISUP SIGNALING PROFILE Default_German PARAMETERS ADMIN
----------------------------------------------------------------------
ISUP Signaling Profile : Default_German Parameter Controls
----------------------------------------------------------------------
AccessDel : SUPPORTED AccessTrans : SUPPORTED
AccessTransInFac : UNSUPPORTED AccessTransInFar : UNSUPPORTED
AccessTransInRel : SUPPORTED AllianceScreenInd : UNSUPPORTED
AnnouncementInd : UNSUPPORTED AIT : UNSUPPORTED
BackwardGVNS : UNSUPPORTED BBRel : SUPPORTED
BCIRel : UNSUPPORTED Business Group : UNSUPPORTED
CallDiv : SUPPORTED CallDivTreat : UNSUPPORTED
Called BSM : UNSUPPORTED Called TFM : UNSUPPORTED
CalledDirectoryNum : UNSUPPORTED CalledInNum : UNSUPPORTED
CallHist : SUPPORTED Calling BSM : UNSUPPORTED
CallInfo : UNSUPPORTED Calling OFM : UNSUPPORTED
CallOfrTreat : UNSUPPORTED CallRef : SUPPORTED
CallRefInFrj : UNSUPPORTED CallTransNum : UNSUPPORTED
CallTransRef : UNSUPPORTED CarrierSelection : SUPPORTED
CauseInCpg : SUPPORTED CCNR Possible Ind : UNSUPPORTED
CCSS : SUPPORTED Charge Number : UNSUPPORTED
CircAssMap : UNSUPPORTED CollectCallReq : UNSUPPORTED
ConfTreat : UNSUPPORTED ConfTreatInAnm : UNSUPPORTED
Connect Req in IAM : UNSUPPORTED Connected Num : SUPPORTED
ConNumInAcm : UNSUPPORTED ConNumInCpg : UNSUPPORTED
ConPointTrunkType : UNSUPPORTED ConReq : UNSUPPORTED
ConReqInFaa : SUPPORTED ConReqInFar : SUPPORTED
ConReqInInf : SUPPORTED CorrelationId : UNSUPPORTED
CpnInRel : UNSUPPORTED CseInRlc : SUPPORTED
CUG Interlock Cd : SUPPORTED
Diagnostics : SUPPORTED DialedNumber : UNSUPPORTED
DispInfo : UNSUPPORTED
DispInfoInAcm : UNSUPPORTED DispInfoInCon : UNSUPPORTED
DispInfoInCpg : UNSUPPORTED DispInfoInIam : UNSUPPORTED
DMS FE : UNSUPPORTED
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
To view the default ISUP signaling profile service controls for Germany, type the command:
% SHOW ISUP SIGNALING PROFILE Default_German SERVICE ADMIN
----------------------------------------------------------------------
ISUP Signaling Profile : Default_German Service Controls
----------------------------------------------------------------------
Allow Unscreened CIN : UNSUPPORTED
Assume OG Echo Device
already included : UNSUPPORTED
AwaitDigits : UNSUPPORTED
Build RDI for SIP IWK: UNSUPPORTED
BCI in CPG with CIT : UNSUPPORTED
BLO after setup : UNSUPPORTED
CA for Announcements : UNSUPPORTED
CIT Terminating
Exchange Logic : UNSUPPORTED
CNID always added : UNSUPPORTED
Compatibility : SUPPORTED
CC Raw : UNSUPPORTED
Cellular CPCs : UNSUPPORTED
Charge Ind Setting : TRANSIT
Don't generate Diags : UNSUPPORTED
Dont map To header
to OCN param : UNSUPPORTED
Drop CAUSE in ACM
when interworking : UNSUPPORTED
Drop USI if farside
is not ISUP : UNSUPPORTED
Fallback : SUPPORTED
FCI User Part Chosen : UNSUPPORTED
FCI User Part Iwk : UNSUPPORTED
FCI User Part Trans : UNSUPPORTED
Force Echo Control : UNSUPPORTED
Hop Counter : SUPPORTED
HWBLK Allow Calls : UNSUPPORTED
HWBLK Send BLO : UNSUPPORTED
HWBLK Send RSC calls : UNSUPPORTED
IAM Gen Carrier
Code in CDR Always : UNSUPPORTED
IEPS CPC : UNSUPPORTED
INR/INF in all states: UNSUPPORTED
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Base Profile :
Admin State : ENABLED
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
To view the default ISUP signaling profile message controls for Germany, type the command:
% SHOW ISUP SIGNALING PROFILE Default_German MESSAGE ADMIN
Node: TPUBS Date: 2007/02/27 19:50:37 GMT
Zone: GMTMINUS05-EASTERN-US
----------------------------------------------------------------------
ISUP Signaling Profile : Default_German Message Controls
----------------------------------------------------------------------
APM / PRI : SUPPORTED
BCM : UNSUPPORTED CCL : UNSUPPORTED
CFN : SUPPORTED CGB / CGU : SUPPORTED
CMR / CMC / CMRJ : UNSUPPORTED COM : UNSUPPORTED
CON : SUPPORTED COT / CCR : SUPPORTED
CPG (forwards) : SUPPORTED CQM / CQR : UNSUPPORTED
CVT / CVR : UNSUPPORTED DRS : UNSUPPORTED
FAC : UNSUPPORTED FAR / FAA / FRJ : SUPPORTED
FOT : SUPPORTED GRS : SUPPORTED
INR / INF : SUPPORTED
IDR / IRS : SUPPORTED ITX / TXA : UNSUPPORTED
LOP : UNSUPPORTED LPA : UNSUPPORTED
NRM : SUPPORTED OFR, CAN, FAN, RLL : UNSUPPORTED
OLM : UNSUPPORTED OPR : UNSUPPORTED
PAM : SUPPORTED SAM : SUPPORTED
SDN SID/ANI Inc : UNSUPPORTED
SGM : SUPPORTED SUS (forwards) : SUPPORTED
UCIC : SUPPORTED
UPA / UPT : UNSUPPORTED USR : SUPPORTED
CHG before ACM : UNSUPPORTED CHG during speech : UNSUPPORTED
CPG before ACM : UNSUPPORTED CPG inbnd before ACM: UNSUPPORTED
Send 2 Group Msgs : UNSUPPORTED Await 2 Group Msgs : UNSUPPORTED
CQM on card swap : UNSUPPORTED ANSI'95 GRS/GRA : UNSUPPORTED
CQM on Resync : UNSUPPORTED ANSI'95 CFN : UNSUPPORTED
ANSI'95 CQM : UNSUPPORTED Only ACM for 181 : UNSUPPORTED
Dont send EXM : UNSUPPORTED
Transit CFN : UNSUPPORTED
Always add opt ptr : UNSUPPORTED
Base Profile :
Admin State : ENABLED
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
This object creates a template for the ISUP information requests (INR) and subsequent actions that
will be carried out by the ISUP service group that uses an associated ISUP signaling profile.
Sonus supplies a number of default INR INF profiles that correspond to the ISUP protocol revision
that the ISUP service group uses. These default profiles effectively assign the information request
conventions to be used under that protocol revision.
The INR INF profile specifies information to be requested when it is absent from the IAM, and
actions to be taken when this request is not fulfilled. This profile must be created (except for the
defaults) and must take the name of the associated ISUP signaling profile. This ISUP signaling
profile must have its INRINF parameter is set to supported.
To see the list of default INR INF profiles, perform a SHOW ISUP INR INF PROFILE SUMMARY
command.
To see the setting of every information request setting in a particular default INR INF profile,
perform a SHOW ISUP INR INF PROFILE profile-name ADMIN command.
To see the setting of every information request setting in every defined INR INF profile, perform a
SHOW ISUP INR INF PROFILE ALL ADMIN command.
As with the ISUP signaling profile, you should create a custom INR INF profile and then modify
your copy, rather than directly modifying a default profile. To copy a default profile, create your
new profile with CREATE ISUP INR INF PROFILE.. using the name of the associated ISUP
signaling profile that you copied from a default ISUP signaling profile.
The INR INF profile allows you to request calling party category, calling party number, and
charge number when it is not in the IAM. You may also specify whether unsolicited information
can be used to complete the request. The actions you may take are:
Because there are no default values for the ISUP INR INF profile parameters, you must explicitly
set these controls to the values required in your network.
A particular ISUP INR INF profile is activated when you configure the INR INF PROFILE
parameter of the ISUP SERVICE object.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Command Syntax
Command Parameters
Field
Parameter Length Description
sigprofilename 1-23 The name of the ISUP INR INF Profile, which is always
identical to the associated ISUP Signaling Profile name.
cpcreq N/A Specifies whether a calling party category (CPC) should be
requested if the value received was unknown:
• unsupported - don’t request CPC
• supported - request CPC
clireq N/A Specifies whether a calling line ID (CLI) should be
requested if it was not received:
• unsupported - don’t request the CLI
• supported - request the CLI
crginforeq N/A Specifies whether charge information should be requested if
it was not received:
• unsupported - don’t request charge information
• supported - request charge information
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
cpcnrf N/A Specifies what happens to the call if a CPC was requested
and it doesn't arrive:
• unsupported - tear down the call
• supported - continue processing the call
clinrf N/A Specifies what happens to the call if a CLI was requested
and it doesn't arrive:
• unsupported - tear down the call
• supported - continue processing the call
crginfonrf N/A Specifies what happens to the call if charge information was
requested and it doesn't arrive:
• unsupported - tear down the call
• supported - continue the call
solinfonly N/A Specifies whether we should ignore unsolicited INF
messages:
• unsupported - ignore this information
• supported - use this information to complete the
request
admin-state N/A The administrative state of this ISUP INR INF profile:
• disabled (default) - Not activated, able to be
configured.
• enabled - Activated, and in use.
Command Example
To create, configure, and activate an ISUP INR INF profile named isupsigprf1 that requests
CPC if it is missing from the IAM, uses unsolicited information to complete the request, continues
the call if the CPC request is unfulfilled, and does not explicitly request any other information that
is missing from the IAM:
% CREATE ISUP INR INF PROFILE isupsigprf1
% CONFIGURE ISUP INR INF PROFILE isupsigprf1 ..
CPC REQUEST supported
CPC NOT RECVD FAIL supported
CRGINFO REQUEST unsupported
CRGINFO NOT RECVD FAIL unsupported
CLI REQUEST unsupported
CLI NOT RECVD FAIL unsupported
USE SOLICITED INF ONLY supported
% CONFIGURE ISUP INF INR PROFILE isupsigprf1 STATE enabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
The following example shows all existing ISUP INR INF profiles:
% SHOW ISUP INR INF PROFILE SUMMARY
Node: TPUBS Date: 2002/12/02 15:39:14 GMT
Zone: GMTMINUS05-EASTERN-US
---------------------------------------------------------------------
ISUP INR INF Profile Summary
---------------------------------------------------------------------
INR INF Profile Name Admin State
------------------------ -------------
Default_ANSI_1992 DISABLED
Default_ANSI_1995 DISABLED
Default_ARGENTINA DISABLED
Default_ARGENTINA_IDT DISABLED
Default_Belgacom DISABLED
Default_BRAZIL DISABLED
Default_CHILE DISABLED
Default_CHINACNC DISABLED
Default_DENMARK DISABLED
Default_ETSI_V2 DISABLED
Default_ETSI_V3 DISABLED
Default_German DISABLED
Default_GR317 DISABLED
Default_HONGKONG_IC DISABLED
Default_INDIA DISABLED
Default_ITALY DISABLED
Default_ITU_1988 DISABLED
Default_ITU_1993 DISABLED
Default_ITU_1997 DISABLED
Default_ITU_Q767 DISABLED
Default_MEXICO_IC ENABLED
Default_NTT_COM DISABLED
Default_NTT_FCC DISABLED
Default_PERU DISABLED
Default_PORTUGAL_ONI DISABLED
Default_SINGAPORE DISABLED
Default_SPAIN DISABLED
Default_SPIROU DISABLED
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
The following example shows all current Default_German ISUP INR INF profile control
settings:
% SHOW ISUP INR INF PROFILE Default_German ADMIN
Node: TPUBS Date: 2002/01/04 17:20:57 GMT
Zone: GMTMINUS05-EASTERN-US
---------------------------------------------------------------------
ISUP INR INF Profile : Default_German
---------------------------------------------------------------------
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
ISUP Service
This object binds an SS7 service to a trunk group and assigns a name and properties to this
binding.
You may temporarily remove and restore this service by toggling its operational state between
inservice and outofservice. When you remove service in this manner you could disrupt
existing calls, so you will be prompted to affirm your command. You may use the GROUP
operations beforehand (block, unblock, and reset) to put all the underlying circuits into
blocked or unblocked status. This operation provides a “wild-card like override” on individual
circuit manipulations that may have previously taken place on the ISUP Circuit object (see "ISUP
Circuit" on page 3–848).
The mechanisms used to carry out these configuration changes are summarized below.
• enabled
• disabled
• inservice
• outofservice
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
TABLE 3–163
From
(operational
state) Changing to (operational state)
inservice outofservice
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
From (operational
state) Performing GROUP operation:
blocked unblocked reset
inservice Affirm the prompt All circuits will be An SS7 reset will
query. unblocked, including occur on all circuits.
any that may have
If no action or the been selectively
All circuits will be
action force is unblocked, including
blocked by operations
specified, then each at the ISUP circuit
any that were blocked
call on each level. The admin-
by ISUP circuit level
underlying ISUP operations. admin-
state remains
circuit is dropped. All enabled.
state stays
circuits are set to enabled.
blocked. The
admin-state
remains enabled.
If action dryUp is
specified, then for
timeout minutes,
each underlying CIC is
set to blocked when
the active call on the
CIC completes.
If timeout minutes
expire before the call
completes, then the
call is dropped and the
CIC is immediately set
to blocked.
outofservice The GROUP operations The GROUP operations The GROUP operations
cannot be used when cannot be used when cannot be used when
the operational state is the operational state the operational state
outofservice. is outofservice. is outofservice.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
TIMEOUT timeout
CONFIGURE ISUP SERVICE isname STATE admin-state
Command Parameters
Field
Parameter Length Description
isname 1-23 The name of the ISUP service you are configuring.
profilename 1-23 The name of the ISUP service profile that you are
applying to this ISUP service.
sigprofilename 1-23 The name of the ISUP signaling profile that you are
applying to this ISUP service.
You should not directly assign a default ISUP signaling
profile to this parameter, because the default profiles
may change during a live software upgrade to a new
software release. To avoid this consequence, create a
new ISUP service profile such as
CUSTOM_ANSI_1992, with the SIGNALING PROFILE
set to DEFAULT_ANSI_1992. Assign
CUSTOM_ANSI_1992 to the ISUP service
PROFILENAME. Then the ISUP signaling values in your
customized ISUP service profile will not change during
a live software update.
tgname 1-23 The name of the trunk group to which this ISUP service
belongs.
dpc N/A The destination point code of the central office switch
that this service is connected to. The range of legal
values for this triplet depends upon the revision of ISUP
protocol supported by this service:
(0-255)(0-255)(0-255) - ANSI1992 and ANSI1995. The
field length is 8bits-8bits-8bits for this protocol.
(0-7)(0-255)(0-7) - ITU and ETSI2. The field length is
3bits-8bits-3bits for this protocol.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
revision N/A The ISUP protocol revision that will be supported for
this ISUP service:
• ansi1992 - Use this protocol if this ISUP service is
connecting DMS and ESS SWITCHTYPEs.
• ansi1995
• itu1993
• etsi2 - Use for Germany and Netherlands. (For
Germany, use the Default_German ISUP signaling
profile; for Netherlands, use the Default_ETSI_V2
ISUP signaling profile.)
• nttfcc - Use for Japan.
• itu1997
• itu1988
• ituq767 - Same as etsii (has been renamed).
• belgacom
• spirou
• mexicoic
• italy
• denmarkic
• hongkongic
• singapore
• etsi3
• peru
• chile
• portugaloni
• nttcom - Use the NTT Communications protocol for
Japan.
• chinacnc
• spain
• argentinaidt
• argentina
• brazil
• india
• korea
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
hdirection N/A The hunt algorithm for choosing a specific CIC within a
trunk group. This algorithm must complement the
algorithm in effect at the central office switch:
• top2bottom - start the search at the highest
physical port number on the highest CNA slot
number on the highest shelf number in the node. On
a GSX4000 series switch, start the search at the
highest physical port number.
• bottom2top - start the search at the lowest
physical port number on the lowest CNA slot number
on the lowest shelf number in the node. On a
GSX4000 series switch, start the search at the
lowest physical port number.
• circuithi2lo - start with the highest CIC number
and proceed to the lowest CIC number.
• circuitlo2hi - start with the lowest CIC number
and proceed to the highest CIC number.
• mostnleastidle - use the CONTROL parameter
hunt algorithms.
• circulartop2bottom - start the search at the
highest physical port number on the highest CNA slot
number on the highest shelf number in the node. On
a GSX4000 series switch, start the search at the
highest physical port number. Start the succeeding
search at the next table position rather than back at
the top.
• circularbottom2top - start the search at the
lowest physical port number on the lowest CNA slot
number on the lowest shelf number in the node. On a
GSX4000 series switch, start the search at the
lowest physical port number. Start the succeeding
search at the next table position rather than back at
the bottom.
cost N/A The relative cost of using the CICs configured in this
service. Must be 0-100. A value of 100 represents the
highest possible cost.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
cicControl N/A The set of CICs controlled by this GSX for the sake of
resolving dual-seizure scenarios. Additionally, if the
HUNT parameter is set to mostnleastidle, a CIC
search algorithm is also implied.
• nocics - None of the CICs in the service group are
controlled by this GSX. If HUNT is mostnleastidle,
CIC hunting is Last-In-First-Out (LIFO).
• allcics - All of the CICs in the service group are
controlled by this GSX. If HUNT is mostnleastidle,
CIC hunting is First-In-First-Out (FIFO).
• oddcics - CICs 1,3,5, etc. in this service group are
controlled by this GSX. If HUNT is mostnleastidle,
these CICs are hunted FIFO while even numbered
CICs are controlled by the remote switch and hunted
LIFO.
• evencics - CICs 2,4,6 etc. in this service group are
controlled by this GSX. If HUNT is mostnleastidle,
these CICs are hunted FIFO while odd numbered
CICs are controlled by the remote switch and hunted
LIFO.
continuityTestFreq N/A The frequency with which active call continuity tests are
performed on each ISUP service group circuit. Must be
0-16:
• 0 - no continuity tests are performed
• 1 - continuity tests are performed on a per-call basis
• 2-16 - a continuity test is performed every nth call
(where n = 2-16)
You do not need to disable the underlying ISUP service
group to change this value.
hopcountval N/A The initial Hop Counter value to use (if hopcountstat
is enabled). Must be 10-32.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
hopcountstat N/A The state of Hop Counting procedures for this service
group:
• enabled - The procedures are in effect. This state
requires that the ISUP protocol revision be ANSI1992
or ANSI1995.
• disabled - The procedures are not in effect.
When Hop Counting is enabled:
• If a Hop Counter parameter is received from the
ingress leg of the call, it is decremented and included
in the outgoing IAM message. If no Hop Counter is
present in the ingress leg of the call, it is included in
the outgoing IAM message using hopcountval.
• If a Hop Counter of zero is present in the ingress leg
of the call, the call is released with a cause of
“exchange routing error”.
• When Hop Counting is disabled:
• If a Hop Counter parameter is received from the
ingress leg of the call, it is passed transparently in
the outgoing IAM message.
• If a Hop Counter of value zero is present in the
ingress leg of the call, the call is released with a
cause of “exchange routing error”.
dtprofile 1-23 The name of a Disconnect Treatment Profile that will be
used to map a disconnect reason code to a Disconnect
Signaling Sequence Profile (SSP) for the ISUP service.
See "Disconnect Treatment Profile" on page 3–1162.
tonepkg 1-23 The name of a tone package to be used by the ISUP
service. See "Tone Package" on page 3–1201.
grsatstartup N/A Specifies whether to issue reset messages to all circuits
in this service group when a CNS module is started or
restarted:
• unsupported - Do not issue any reset messages on
any circuits when a CNS module is started.
• supported - Reset all circuits by issuing either
individual (RSC) reset messages or a group (GRS)
reset message. The type of reset message that is
used depends on the GRS setting in the ISUP
Signaling Profile (see "ISUP Signaling Profile" on
page 3–763).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
sequentialgrs N/A Specifies whether to issue the Circuit Group Reset
Message (GRS) in parallel or sequentially to the
circuits.
• unsupported - Issue the reset messages in parallel
on the circuits.
• supported - Reset all circuits by sequentially
issuing GRS one at a time per remote point code.
This may be necessary for inter-working with carriers
who become congested or overloaded when
processing large numbers of GRS messages at
once.
insptime Inspection time, specified in date-time format. The
INSPECTION parameters provide a way to set up
automatic regular testing and synchronization of call
and maintenance states on all circuits in the ISUP
service group. INSPECTION TIME specifies the first
date-time at which inspection will occur.
Specified in universal octet date-time format. For
example, to represent Tuesday May 26, 1992 at
1:30:15 PM EDT, you would specify:
1992-5-26,10:30:15.0,-4:0
inspfreq Inspection frequency:
• onehour
• threehours
• sixhours
• twelvehours
• oneday (default)
• twodays
The default inspection frequency is once per day. The
date-time for each inspection is calculated from the
initial INSPECTION TIME, so that correct frequency
and timing is maintained even if the GSX has been
rebooted.
inspstate Sets the occurrence of circuit inspections off or on.
• disabled (default)
• enabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
accresproc Sets the Automatic Congestion Control (ACC)
Response Process to disabled or enabled.
• disabled
• enabled
When ACC response handling is enabled for the
service group, and the remote node has indicated that it
is congested (by use of the ACL parameter), calls
destined to go out the trunk group are set to SKIP (try
alternate route) or CANCEL (release the call)
depending on the other ACC parameters below.
accl1ARcanperc N/A Automatic Congestion Control (ACC) Level 1 (L1)
Alternate Routed (AR) Cancel Percentage. Indicates
percentage of alternate-routed calls to be released.
Must be 0-100.
accl1DRcanperc N/A ACC Level 1 Direct Routed (DR) Cancel Percentage.
Specifies percentage of direct-routed calls to be
released. A call is considered direct-routed when it first
arrives to a service group to be routed, and retry has not
yet been attempted. Must be 0-100.
accl2ARcanperc N/A ACC Level 2 AR Cancel Percentage. Must be 0-100.
acc2DRcanperc N/A ACC Level 2 DR Cancel Percentage. Must be 0-100.
accl3ARcanperc N/A ACC Level 3 AR Cancel Percentage. Must be 0-100.
accl3DRcanperc N/A ACC Level 3 DR Cancel Percentage. Must be 0-100.
accSendACL N/A Specifies the maximum ACL value sent to a remote
node for this ISUP Service Group. 0 means ACC is
disabled. Must be 0-3.
olipcheck N/A When a call with a Charge Number and a Calling Party
Number arrives, by default the GSX checks for
Originating Line Information Parameters (OLIP) and
rejects the call if they are not present. This parameter
turns OLIP checking off for certain switches that do not
supply OLIP information to such calls:
• on - check for OLIP
• off - don’t check for OLIP
This check is applied only when the GSX receives an
IAM.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
sendingolipchk N/A When a call with a Charge Number and a Calling Party
Number is sent, by default the GSX checks for
Originating Line Information Parameters (OLIP) and
rejects the call if they are not present. This parameter
turns OLIP checking off for certain switches that do not
supply OLIP information to such calls:
• on - check for OLIP
• off - don’t check for OLIP
This check is applied only when the GSX, acting as an
originating exchange, is sending an IAM, the call
ingress is non ANSI, and the call egress is ANSI.
clusrouting N/A Specifies whether this DPC supports cluster routing
(also known as member routing):
• unsupported (default)
• supported
mindsqdigits N/A Specifies the minimum number of CalledAddress digits
to collect before attempting a route query, when overlap
addressing is supported and CalledAddress receive is
not complete. Must be 0-30, default is 0 (digits).
conftone 1-23 Specifies a confirmation tone to play when the ISUP call
is answered (prior to media cut through). The
confirmation tone must be configured as part of the
ISUP service group's TONE PACKAGE.
A confirmation tone is typically used by a calling PBX to
begin billing.
conftoneover N/A Specifies support for subscriber-level confirmation tone:
• suppported - a confirmation tone plays for all
ingress calls.
• unsupported (default) - use the Calling Party
Subscriber screen on the PSX to activate the
confirmation tone.
anssupvtimeout N/A When answer supervision is enabled, specifies the
timeout period, in seconds, from the egress receiving
the first backwards message from the called party
exchange (Call Proceeding, Alerting, Call Progress)
until the call is answered. If the timeout period expires,
the answer supervision action specified is triggered.
Must be 0-1000, default is 300 (seconds). A value of 0
disables this timer.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
anssupvtimeoact N/A Specifies the action to take if the answer supervision
timer expires (i.e. no signaled answer is received):
• release (default) - release the call.
• softanswer – If an answer message is not received
from the succeeding exchange before the answer
supervision timer expires, the GSX generates an
answer message (ANM) to send in the backward
direction and moves the call into the talking state
cutting through the speech path in both directions. If
an answer message is later received from the
succeeding exchange, it is ignored. This option
(softanswer) is only applicable to ANSI ISUP
variants.
• trapAndRestart - Send a trap and restart the
timer. This action will repeat continuously until
cancelled by a received network disconnect, user
intervention, or a received answer message.
The trap contains the following details for the call:
• Ingress Trunk Group
• Ingress Circuit End Point
• Egress Trunk Group
• Egress Circuit End Point
• Called Number
• Calling Number
cutthruoverride N/A Specifies whether to override the protocol-specific cut
through direction when the ACM is received with a
backward call indicator (BCI) of Interworking
Encountered:
• unsupported (default) - no override will occur and
the protocol-specific cut through controls remain in
effect.
• backwardscutthru - perform backwards cut
through
• fullduplexcutthru - perform a full duplex cut
through
• nocutthru - perform no cut through
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
inrinfprof 1 - 23 Name of the INR INF profile used by this ISUP service.
This name is identical to the name of the ISUP signaling
profile used by this ISUP service. This profile specifies
the information that is to be requested if it is not
received in the IAM. The GSX provides a default INR
INF profile for each ISUP revision.
You should not directly assign a default INR/INF profile
to this parameter, because the default profiles may
change during a live software upgrade to a new
software release. To avoid this consequence, create a
new ISUP service profile such as
CUSTOM_ANSI_1992, with the INR INF PROFILE set
to DEFAULT_ANSI_1992. Assign
CUSTOM_ANSI_1992 to the ISUP service
PROFILENAME. Then the INR/INF values in your
customized ISUP service profile will not change during
a live software update.
cllitown 4 Specifies the town code to be used in the CLLI
parameter for ANSI GR317 circuit validation test failure.
Must be a four character string, default is “0000”.
cllistate 2 Specifies the state code to be used in the CLLI
parameter for ANSI GR317 circuit validation test failure.
Must be a two character string, default is “00”.
cllibldg 2 Specifies the building code to be used in the CLLI
parameter for ANSI GR317 circuit validation test failure.
Must be a two character string, default is “00”.
cllibldgsd 3 Specifies the building sub division code to be used in
the CLLI parameter for ANSI GR317 circuit validation
test failure. Must be a three character string, default is
“000”.
alerttone 1-23 The name of a tone type to play on the ingress call
when the egress side of the call received an ALERTING
message. This may be a ring back tone.
cbprofno N/A The index number of the CRANKBACK PROFILE to use
with this ISUP service group. This must specify a valid
Call Crankback profile index, in the range 1-10. The
default is 1, or Call Crankback Profile default.
See"Call Crankback Profile" on page 3–1171.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
cgrtimeout N/A The time (in seconds) to wait to release a call when that
call was rejected due to congestion. This parameter
effectively prevents the machine congestion level from
escalating due to rapid repeated call attempts by
equipment that does not support congestion detection.
Must be 0-5 (seconds), default is 0. A value of 0
disables this timer.
If this value is nonzero, the timer is started when a call
is rejected due to congestion. When the timer expires,
the network release is sent and the call resources are
de-allocated. If a network release is received during the
delay, the timer is stopped and the call resources are
de-allocated.
mssgthrottling N/A Specifies whether message throttling is supported. This
is a per-GSX parameter, and is therefore copied to all
service groups when changed on one:
• supported - allows for blocking or unblocking (BLO/
UBL) messages sent from the GSX to be throttled.
• unsupported (default) - message throttling is not
enabled.
Note: The MESSAGE THROTTLING TIMER,
CALLPERSEGMENT, and INTERSEGMENTTIMER
parameters are only available when MESSAGE
THROTTLING is set to supported.
mssgthrottlingtimer N/A Specifies the time in milliseconds to insert between
consecutive blocking (BLO) and unblocking (UBL)
messages sent on this service group from a certain
CNS. This parameter can have a different value on
each service group. Must be 0 to 1000.
callspersegment N/A Specifies the number of calls to be cleared at a time
(per CNS) when performing call cleanup. This
translates into the number of REL and RSC messages
sent simultaneously. Must be 1 to 25.
This is a per-CNS/GSX parameter and therefore copied
to all service groups when changes on one.
Note: The GSX expects all calls to be cleared within
eight (8) seconds, therefore Sonus recommends you
set this parameter to a lower value so that all calls are
cleared within this default time to avoid an error
message.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
intersegtimer N/A Specifies the time between blocks of calls cleaned up.
Must be 10 to 1000.
This is a per-GSX parameter and is therefore copied to
all service groups when changed on one.
Note: The GSX expects all calls to be cleared within
eight (8) seconds, therefore Sonus recommends you
set this parameter to a lower value so that all calls are
cleared within this default time to avoid an error
message.
ldcaction N/A Specifies the action to take if the Long Duration Call
(LDC) timer expires. The call may be released, a SNMP
trap may be generated, or both:
• noAction (default) - take no action on LDC timer
expiry (a debug log entry will be generated).
• trap - generate an SNMP trap.
• release - automatic call disconnect without
generation of a trap.
• trapAndRelease - generate an trap and release
the call.
ldcemergcalls N/A Specifies whether emergency calls should be excluded
from, or included in Long Duration Call (LDC)
disconnect procedures:
• include
• exclude (default)
Note: Emergency call exclusion relies on the PSX call
type or other protocol-specific criteria to identify the call
as an “emergency” call.
ldcrelcause N/A Specifies the GSX disconnect reason used to release
the call if the call is released due to Long Duration Call
(LDC) timer expiry. Must be 1 to 127; default is 41
(Temporary Failure).
ldctimeout N/A Specifies the timeout value of the Long Duration Call
(LDC) timer in minutes. Must be 0 or 60-2880. A value
of 0 disables the timer; a value of 60-2880 set the timer.
Default is 0.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
messagereset N/A Specifies the behavior applied to setting the Message
Priority field in a transmitted IAM:
• on - Message Transfer Priority will be set to 1 for
High Probability of Completion (HPC) calls and 0 for
non-HPC calls.
• off (default) - Message Transfer Priority will be
passed through from ingress to egress if its value is
greater than 0.
See "High Probability of Completion (HPC) Features"
on page 6–237 for more information on this
functionality.
lkaheadforbusy N/A Specifies the default value used in the Look Ahead for
Busy field in the ISUP Precedence parameter.
• allowed - Look Ahead for Busy is allowed.
• pathreserved - Look Ahead for Busy path is
reserved.
• notallowed (default) - Look Ahead for Busy is not
allowed.
See "High Probability of Completion (HPC) Features"
on page 6–237 for more information on this
functionality.
networkid 4 Specifies the default value used for the 4-digit network
identity field in the ISUP Precedence parameter.
Must be 0000-9999; default is 0100.
See "High Probability of Completion (HPC) Features"
on page 6–237 for more information on this
functionality.
chargearea 5 Specifies the 5-digit Terminating Charge Area value.
The Charge Area is set in the ACM or CPG message if
a script is returned from the PSX or for a Disconnect
Treatment Profile. The Charge Area can only be
populated in the ACM or CPG messages if the existing
ISUP SIGNALING PROFLE parameter CA FOR
ANNOUNCEMENTS is set to SUPPORTED.
To disable the Charge Area parameter and only use the
Terminating Charge Area received from the PSX, set
the parameter to NULL (““).
Must be 00000-99999 or ““ (NULL).
This is a Japan only control. (GSX9000 only)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
nodeidentity N/A Specifies whether to generate an Application Transport
Mechanism (APM) message with Charging Tariff
(CRGT) data in response to an IAM for this service
group. Must be 0-65535.
• 0 - do not generate an APM message with CRGT
data.
• 1-65535 - generate CRGT data in the APM
message in response to an IAM received for the
specified service group.
Note: The APM parameter in the ISUP SIGNALING
PROFILE associated with this ISUP service group must
be set to supported.
locationrel34 N/A Specifies an updated Cause Indicator Location Value to
set in the ISUP REL message sent to the ingress
network for Release Cause 34 “No circuit/channel
available”:
• notUsed (default) - location information not present
• user
• privateLocal - private network serving the local
user (LPN)
• publicLocal - public network serving the local user
(LN)
• transitNet - transit network (TN)
• publicRemote - public network serving the remote
user (RLN)
• privateRemote - private network serving the
remote user (RPN)
• natReserved6 - reserved
• internationalNet - international network (INTL)
• natReserved8 - reserved
• natReserved9 - reserved
• netBeyondInterPoint - network beyond
interworking point (BI)
• natReserved11 - reserved
• natReserved12 - reserved
• natReserved13 - reserved
• natReserved14 - reserved
• natReserved15 - reserved
Other disconnect reasons are unaffected by this
configuration.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
locationrel42 N/A Specifies an updated Cause Indicator Location Value to
set in the ISUP REL message sent to the ingress
network for release cause 42 “Switching equipment
congestion”:
• notUsed - Location information not present
• user
• privateLocal - Private network serving the local
user (LPN)
• publicLocal - Public network serving the local
user (LN)
• transitNet - Transit network (TN)
• publicRemote - Public network serving the remote
user (RLN)
• privateRemote - Private network serving the
remote user (RPN)
• natReserved6 - reserved
• internationalNet - International network (INTL)
• natReserved8 - reserved
• natReserved9 - reserved
• netBeyondInterPoint - Network beyond
interworking point (BI)
• natReserved11 - reserved
• natReserved12 - reserved
• natReserved13 - reserved
• natReserved14 - reserved
• natReserved15 - reserved
Other disconnect reasons are unaffected by this
configuration.
group N/A A “wild-card” means of blocking or unblocking all of the
underlying ISUP circuits in the service group:
• blocked - all underlying circuits blocked, regardless
of previous state.
• unblocked - all underlying circuits unblocked,
regardless of previous state.
• reset - a transitional state in which an SS7 reset is
applied to all circuits and they return to unblocked
state.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
action N/A The method by which active calls using this ISUP
service are processed when oper-state goes to
outofservice or group goes to blocked or reset.
• force (default) - all calls dropped immediately.
• dryup - all calls are allowed to complete normally
until timeout expires, when they are dropped.
timeout N/A The time (in minutes) to wait to block the underlying
CICs and place the ISUP service in the outOfService
oper-state. Must be 0-1440.
oper-state N/A The operational state of the ISUP service:
• outofservice - all circuits blocked and thus out of
service.
• inservice - all previously unblocked circuits are
unblocked and thus in service. If the circuit was
blocked before it was taken outofservice, it will
remain blocked after this operation.
admin-state N/A The administrative state of this ISUP service:
• disabled (default) - Inactive, can be deleted
• enabled - Active, available for use.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Command Example
-------------------------------------------------------------------------
ISUP Service : SS726 Point Code : 1-1-1
-------------------------------------------------------------------------
Trunk Group : TRUNKGRP-MBL-SS726
Revision : ANSI1995 Hunt Algorithm : CIRCUITLO2HI
Cost : 10 CIC Control : NOCICS
Disc Treatment : isupDefault Tone Package : default
GRS at Startup : SUPPORTED Sequential GRS : UNSUPPORTED
Hop Counter Value: 10 Hop Counter State : ENABLED
ACC Resp : DISABLED ACC Send ACL : 2
ACC L1 AR Cancel : 100% ACC L1 DR Cancel : 100%
ACC L2 AR Cancel : 100% ACC L2 DR Cancel : 100%
ACC L3 AR Cancel : 100% ACC L3 DR Cancel : 100%
Inspect Start : 0000-00-00,00:00:00 Continuity Freq : 0
Inspect Freq : ONEDAY Service Profile :
Inspect State : DISABLED SignalingProfile : ISUP_ANSI_1995
OLIP Check (IN) : ON OLIP Check (OUT) : ON
Gateway Outage : KEEP-CALLS INR INF Profile : Disabled
CLLI Town Code : 0000 CLLI State Code : 00
CLLI Bld'ing Code: 00 CLLI Sub Div Code : 000
Cluster Routing : UNSUPPORTED Charge Area :
Conf Tone : Conf Tone Override: UNSUPPORTED
Answer Supervision Answer Supervision
Timeout : 300 Timeout Action : RELEASE
Override Cut Through For Minimum Digits For
ACM With BCI IW : UNSUPPORTED Sending DS Query: 0
CrankBack Profile: 1 Congestion Rel
Timeout (sec) : 0
Message Throttling
State : UNSUPPORTED Timer : 0
Call Cleanup
Calls / Segment : 25 Inter Segment Timer : 100
Long Duration Call Long Duration Call
Timeout (mins) : 0 Timeout Action : NOACTION
Release Cause : 41 Emergency Calls : EXCLUDE
Network Identity : 0100 Look Ahead For Busy : NOTALLOWED
Message Priority Reset : OFF
Mode : INSERVICE Admin State : ENABLED
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
ISUP Circuit
This object designates the trunk CICs associated with an SS7 service. As specified in the
command syntax, all operations can be applied to one or more CICs.
Using the SHOW ISUP CIRCUIT SERVICE ... commands, you can search for information on a
circuit in the following states for a range of CICs or for ALL CICs:
Using the SHOW ISUP CIRCUIT SHELF ... commands, you can also search for information on
circuits in the above states by specifying the SHELF, SLOT, PORT, and DS1. The PORT and DS1
arguments can be an integer, a range, or ALL, but there are limitations. You cannot simultaneously
specify a PORT range and a DS1 range. The following combination of search parameters are
allowed:
See the "Command Syntax" for the ISUP Circuit commands on page 3–851 for information on
these SHOW commands, and "Command Examples" on page 3–858 for sample output.
NOTE
The SHOW ... FAREND commands invoke ISUP Conformance Tests as described
in "Verifying ISUP Circuits" on page 6–76. These commands should be used with
caution.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
• enabled
• disabled
In addition, an ISUP circuit may enter one of two transitional operational states:
The rules for changing between basic and transitional operational states are:
TABLE 3–165
From (basic
operational state) Changing to (basic operational state)
unblocked blocked
unblocked - Affirm the prompt query.
Blocking will occur on all previously
unblocked circuits. If action is
force, blocking will occur
immediately. If action is dryup,
blocking will occur after all active
calls complete or timeout expires.
You can change the admin-state
to disabled.
You may now delete the circuit.
blocked Change admin-state to enabled. -
Change oper-state to
unblocked.
All circuits will be unblocked.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
TABLE 3–166
From (basic
operational state) Changing to (transitional operational state)
reset cot
unblocked Affirm the prompt request. You may not perform a continuity
check on an unblocked circuit. The
Change oper-state to reset. command will be rejected.
An SS7 reset will occur on all circuits.
All circuits will be placed in oper-
state unblocked, admin-state
enabled.
Outstanding calls are cleared on
reset.
blocked Change oper-state to reset. Change admin-state to enabled.
An SS7 reset will occur on all circuits. Change oper-state to cot.
All circuits will return in oper-state A continuity check procedure will be
unblocked, admin-state performed on all circuits.
enabled.
This procedure will continue until a
successful result is attained or
timeout expires. The check is
repeated indefinitely if it fails and
timeout is not specified. See
"Verifying ISUP Circuits" on page 6–
76 for detail about this procedure.
After a success return or a timeout,
all circuits will be in oper-state
blocked, admin-state enabled.
NOTE
The ISUP Service GROUP operation performs the same functions as those listed
above, but only on a global basis. That is, on the entire service group without
regard to selective CICs. See "ISUP Service" on page 3–826.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
TRUNK MEMBER
You may use the TRUNK MEMBER parameter to uniquely identify each circuit within the trunk
group. This number is used in accounting records.
You may assign a number or range of numbers between 0 and 65535. The GSX software maintains
a list of available trunk member numbers for every trunk group. If a valid trunk member, or a range
of trunk members, is specified, the GSX software will complete the assignment and remove these
numbers from the free list. If the specified number or range of numbers is not available, the
CONFIGURE command will return an error. If no TRUNK MEMBER is specified, the value 65536 is
assigned to the trunk member. This value is displayed as UNSET in the SHOW .. ADMIN screen.
You may release one or more TRUNK MEMBERs within a trunk group by specifying TRUNK MEMBER
UNSET on that CIC or range of CICs.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
SHOW ISUP CIRCUIT SHELF shelf SLOT slot PORT port DS1 ds1 ..
BUSY STATUS
BLOCKED STATUS
LCLMAINTBLK STATUS
REMMAINTBLK STATUS
LCLHWBLK STATUS
REMHWBLK STATUS
STATUS
SHOW ISUP CIRCUIT SHELF shelf SLOT slot PORT port DS1 ALL ..
BUSY STATUS
BLOCKED STATUS
LCLMAINTBLK STATUS
REMMAINTBLK STATUS
LCLHWBLK STATUS
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
REMHWBLK STATUS
STATUS
SHOW ISUP CIRCUIT SHELF shelf SLOT slot PORT port DS1 ds1range ..
BUSY STATUS
BLOCKED STATUS
LCLMAINTBLK STATUS
REMMAINTBLK STATUS
LCLHWBLK STATUS
REMHWBLK STATUS
STATUS
SHOW ISUP CIRCUIT SHELF shelf SLOT slot PORT portrange DS1 ds1 ..
BUSY STATUS
BLOCKED STATUS
LCLMAINTBLK STATUS
REMMAINTBLK STATUS
LCLHWBLK STATUS
REMHWBLK STATUS
STATUS
SHOW ISUP CIRCUIT SHELF shelf SLOT slot PORT portrange DS1 ALL ..
BUSY STATUS
BLOCKED STATUS
LCLMAINTBLK STATUS
REMMAINTBLK STATUS
LCLHWBLK STATUS
REMHWBLK STATUS
STATUS
SHOW ISUP CIRCUIT SHELF shelf SLOT slot PORT ALL DS1 ALL ..
BUSY STATUS
BLOCKED STATUS
LCLMAINTBLK STATUS
REMMAINTBLK STATUS
LCLHWBLK STATUS
REMHWBLK STATUS
STATUS
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Command Parameters
Field
Parameter Length Description
icsname 1-23 The name of the ISUP service used by the circuit that you are
configuring.
cicrange N/A The set of CICs that comprise this ISUP circuit. The range of
legal values depends upon the revision of ISUP protocol
supported by this service:
0-16383 - ANSI1992 and ANSI1995. The field length is 14 bits
for this protocol.
0-4095 - ITU and ETSI2. The field length is 12 bits for this
protocol.
Any discrete set of CICs within the appropriate range may be
specified as discussed below.
All CLI ranges specify a comma-separated list of numbers and/
or ranges. A range consists of two numbers separated by a
dash, for example, 5-8. An increment can be specified after a
range with the notation, +<incr>, for example 4-10+2. No spaces
are permitted in the expression. All values and ranges must be
in numerically ascending order. Thus the expression:
1,3,5,8-12+2,14-16
is a valid range specification for the numbers:
1,3,5,8,10,12,14,15, and 16.
Note that when you map CICs to channels (see below), then the
number of CICs that are specified in the above manner must
equal the number of channels specified, maximum 32.
t1name 1-23 The (automatically generated and possibly changed) name of
the T1 span that contains the channels that comprise this ISUP
circuit.
chanrange N/A The set of channels that the CICs (above) are bound to. Must be
in the overall range 1-32, but is limited to 1-24 when the PORT is
a T1 span. Any discrete set of channels within this range may be
specified as discussed below.
All CLI ranges specify a comma-separated list of numbers and/
or ranges. A range consists of two numbers separated by a
dash, for example, 5-8. An increment can be specified after a
range with the notation, +<incr>, for example 4-10+2. No spaces
are permitted in the expression. All values and ranges must be
in numerically ascending order. Thus the expression:
1,3,5,8-12+2,14-16
is a valid range specification for the numbers:
1,3,5,8,10,12,14,15, and 16.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
tmember N/A A range of numbers with a one-to-one correspondence to the
CIC range that uniquely identifies the circuit endpoints within the
trunk group. The GSX software maintains a list of available trunk
member numbers for every trunk group. The size of the range
must equal the size of the CIC range and each member of the
range must be available. Must be 0-65535.
All CLI ranges specify a comma-separated list of numbers and/
or ranges. A range consists of two numbers separated by a
dash, for example, 5-8. An increment can be specified after a
range with the notation, +<incr>, for example 4-10+2. No spaces
are permitted in the expression. All values and ranges must be
in numerically ascending order. Thus the expression:
1,3,5,8-12+2,14-16
is a valid range specification for the numbers:
1,3,5,8,10,12,14,15, and 16.
csprofilename 1-23 The name of the Circuit Service Profile that you are applying to
this ISUP circuit.
direction 1-23 The type of call traffic these CICs can handle:
• twoway - accept all PSTN calls
• onewayin - accept only inbound PSTN calls
• onewayout - accept only outbound PSTN calls
farend-test 1-23 The far end action taken on this ISUP circuit:
• cqm - issue a Circuit Query Message (CQM) with the far end
• cvt - issue a Circuit Validation Test (CVT) with the far end
• reset - reset all local far statistics for CQM/CVT (these
statistics are the results from the previous command)
oper-state N/A The operational state of the ISUP circuit:
• blocked - all circuits out of service.
• unblocked - all circuits in service.
• reset - a transitional state in which an SS7 reset is applied
to all circuits and they return to unblocked state.
• cot - manual continuity check being performed.
admin-state N/A The administrative state of this ISUP circuit:
• disabled (default) - Not activated, able to be deleted.
• enabled - Activated, available for immediate use.
action N/A The method by which active calls on these ISUP circuits are
processed when oper-state goes to blocked:
• dryup (default) - all calls are allowed to complete until
timeout expires, when they are dropped.
• force - all calls are dropped immediately.
• undefined - undefined.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
timeout N/A This parameter specifies a time interval (in minutes) that may be
used to place circuits into the blocked or cot oper-states:
• blocked - the time to wait for the circuits to go to this oper-
state when dryup is specified.
• cot - the time to wait for a success result from the manual
continuity check.
When specified, this value must be 0-1440.
If not specified, the default system setting is 0. This causes
dryups and cots to attempt indefinitely until successful.
shelf N/A Specifies the shelf number in the GSX node configuration. In
this release, one shelf is supported. Must be 1.
Note: This parameter does not apply to GSX4000 series
switches.
slot N/A Specifies the slot number occupied by the CNS or GNS module,
when you use the SHOW ISUP CIRCUIT SHELF shelf SLOT
slot ... commands to search for circuit status information.
For GNS (GSX4000 series) modules, this number must be 1 or
2. For CNS modules, this number must be 3-16.
port N/A Specifies the port number when you use SHOW ISUP CIRCUIT
SHELF shelf SLOT slot PORT port ... commands to
search for circuit status information. Valid values depend on the
type of CNS or GNS (GSX4000) module installed in the slot
specified in the SLOT parameter.
portrange N/A Specifies the port range when you use SHOW ISUP CIRCUIT
SHELF shelf SLOT slot PORT portrange ...
commands to search for circuit status information. Valid values
depend on the type of CNS or GNS (GSX4000) module installed
in the slot specified in the SLOT parameter.
Note: If a range of ports is supplied that is greater than the
number of ports on the module, results for only the valid ports
are shown. If a port number specified is out of range, an empty
table is shown.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
ds1 N/A Specifies the DS1 number when you use SHOW ISUP CIRCUIT
SHELF shelf SLOT slot PORT port DS1 ds1 ...
commands to search for circuit status information. Valid values
depend on the type of CNS or GNS (GSX4000) module installed
in the slot specified in the SLOT parameter, and the port number
specified in the PORT parameter.
ds1range N/A Specifies the DS1 range when you use SHOW ISUP CIRCUIT
SHELF shelf SLOT slot PORT port DS1 ds1range ...
commands to search for circuit status information. Valid values
depend on the type of CNS or GNS (GSX4000) module installed
in the slot specified in the SLOT parameter, and the port number
specified in the PORT parameter.
Note: If a range of ports is supplied that is greater than the
number of DS1s on the module, results for only the valid DS1s
are shown. If a DS1 number specified is out of range, an empty
table is shown.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Command Examples
To configure CICs 1001-1024 to ISUP Service ss71 using the default Circuit Service Profile:
% CREATE ISUP CIRCUIT SERVICE ss71 CIC 1001-1024
% CONFIG ISUP CIRC SER ss71 CIC 1001-1024 PORT T1-1-3-1 CHANNEL 1-24
% CONFIG ISUP CIRCUIT SERVICE ss71 CIC 1001-1024 DIRECTION twoway
% CONFIG ISUP CIRCUIT SERVICE ss71 CIC 1001-1024 ..
SERVICEPROFILENAME default
% CONFIG ISUP CIRCUIT SERVICE ss71 CIC 1001-1024 STATE enabled
% CONFIG ISUP CIRCUIT SERVICE ss71 CIC 1001-1024 MAINTENANCE unblock
This display indicates a status of transient unblocked (TRN-U) at the local end of these circuits.
This occurs when an UNBLOCK command has been sent to the remote end, but the local end has
not yet received an acknowledgement of the command. A transient blocked (TRN-B) status
indicates no acknowledgement to a BLOCK command. The Man Cot field value of N/A indicates
that manual check procedures on these circuits have not yet been initiated and accepted. See
"Verifying ISUP Circuits" on page 6–76 for more detail about the manual continuity check
procedure.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
The following command issues a Circuit Query Message (or status) on the circuit at the far end of
CIC 5173 on the trunk group serviced by ISUP service group ss72:
% CONFIGURE ISUP CIRCUIT SERVICE ss71 CIC 5173 FAREND TEST cqm
This command performs precisely the same function as the previous command:
% SHOW ISUP CIRCUIT SERVICE ss71 CIC 5173 FAREND STATUS
% SHOW ISUP CIRCUIT SERVICE ss71 CIC 5173 FAREND CURRENT STATUS
Node: TPUBS Date: 2002/12/04 14:50:17 GMT
Zone: GMTMINUS05-EASTERN-US
Trunk Group : tg1
ISUP Service : ss72 Service Mode : INSERVICE
Point Code : 1-1-1 Service Status : AVAILABLE
See "Verifying ISUP Circuits" on page 6–76 for addition detail regarding CLI FAREND
configuration options.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
To display the status of a range of CICs in local Local Maintenance blocked (LCLMAINTBLK)
status:
% SHOW ISUP CIRCUIT SERVICE ss71 CIC 2-10 LCLMAINTBLK STATUS
Node: TPUBS Date: 2007/02/01 17:40:15 GMT
Zone: GMT
Trunk Group : TGITU1
ISUP Service : SS71 Service Mode : INSERVICE
Point Code : 0-0-2 Service Status : AVAILABLE
------------------------------------------------------------------------
Circuit Admin Maint Maint HW HW Man
CIC Port Ch Status Mode Local Remot Local Remot Cot
---- ------------- -- -------- ------ ----- ----- ----- ----- -------
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
To display the status of all DS1s in Remote Maintenance Blocked status (REMMAINTBLK):
% SHOW ISUP CIRCUIT SHELF 1 SLOT 4 PORT 1 DS1 ALL REMMAINTBLK STATUS
Node: TPUBS Date: 2007/02/01 17:31:27 GMT
Zone: GMT
Shelf: 1 Slot: 4
------------------------------------------------------------------------
Circuit Maint Maint HW HW
Port DS1 ISUP Service CIC Ch Status Local Remot Local Remot
---- --- ---------------- ---- -- -------- ----- ----- ----- -----------
1 1 SS71 2 1 IDLE UNBLK BLK UNBLK UNBLK
1 1 SS71 3 2 IDLE UNBLK BLK UNBLK UNBLK
1 1 SS71 4 3 IDLE UNBLK BLK UNBLK UNBLK
1 1 SS71 5 4 IDLE UNBLK BLK UNBLK UNBLK
1 1 SS71 6 5 IDLE UNBLK BLK UNBLK UNBLK
1 1 SS71 7 6 IDLE UNBLK BLK UNBLK UNBLK
1 1 SS71 8 7 IDLE UNBLK BLK UNBLK UNBLK
1 1 SS71 9 8 IDLE UNBLK BLK UNBLK UNBLK
To display the status of all DS1s in Local Hardware Blocked status (LCLHWBLK ):
% SHOW ISUP CIRCUIT SHELF 1 SLOT 4 PORT 1 DS1 ALL LCLHWBLK STATUS
Node: TPUBS Date: 2007/02/01 17:31:27 GMT
Zone: GMT
Shelf: 1 Slot: 4
------------------------------------------------------------------------
Circuit Maint Maint HW HW
Port DS1 ISUP Service CIC Ch Status Local Remot Local Remot
---- --- ---------------- ---- -- -------- ----- ----- ----- ----------
1 1 SS71 2 1 IDLE UNBLK UNBLK BLK UNBLK
1 1 SS71 3 2 IDLE UNBLK UNBLK BLK UNBLK
1 1 SS71 4 3 IDLE UNBLK UNBLK BLK UNBLK
1 1 SS71 5 4 IDLE UNBLK UNBLK BLK UNBLK
1 1 SS71 6 5 IDLE UNBLK UNBLK BLK UNBLK
1 1 SS71 7 6 IDLE UNBLK UNBLK BLK UNBLK
1 1 SS71 8 7 IDLE UNBLK UNBLK BLK UNBLK
1 1 SS71 9 8 IDLE UNBLK UNBLK BLK UNBLK
1 1 SS71 10 9 IDLE UNBLK UNBLK BLK UNBLK
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
This object provides a common access point for describing the ISUP signaling protocol to be used
within SIP-I signaling. This is the SIP-I equivalent of the ISUP SERVICE used for ISUP signaling.
This object provides the ISUP library all required information for the purposes of encoding or
decoding the SIP message. This includes the signaling profile (or data controls) needed within the
SS7 library for message processing purposes, the base standard of the variant, maximum size of
the calling and called party numbers, whether OLIP should be checked, and the version name (the
version name is to be used as an index to the signaling group).
A simple example for creating a customized ISUP SIGNALING GROUP is shown in the command
examples.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Command Parameters
Field
Parameter Length Description
isgname 1-23 The name of the ISUP signaling group you are configuring.
This name must match the strings to be used in the version
field of the SIP message header.
versid N/A The version ID, which may be presented by the PSX, to
identify an ISUP signaling group. This ID must be unique
across all GSXs in the network. For example, a version ID,
such as 105, would represent the same ISUP signaling group
on all GSXs in the network. A matching ID, 105 in this case,
must be provisioned on the PSX. Must be 0-65536.
sigprofilename 1-23 The name of the ISUP signaling profile that you are applying
to this ISUP signaling group.
You should not directly assign a default ISUP signaling profile
to this parameter, because the default profiles may change
during a live software upgrade to a new software release. To
avoid this consequence, create a new ISUP service profile
such as CUSTOM_ANSI_1992, with the SIGNALING
PROFILE set to DEFAULT_ANSI_1992. Assign
CUSTOM_ANSI_1992 to the ISUP SIGNALING GROUP
SIGNALING PROFILE. Then the ISUP signaling values in
your customized ISUP service profile will not change during a
live software update.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
revision N/A The revision of the ISUP protocol supported on this Signaling
Group.
• ansi1992 - Use this protocol if this ISUP service is
connecting DMS and ESS SWITCHTYPEs.
• ansi1995
• itu1993
• etsi2 - Use for Germany and Netherlands. (For
Germany, use the Default_German ISUP signaling
profile; for Netherlands, use the Default_ETSI_V2 ISUP
signaling profile.)
• nttfcc - Use for Japan.
• itu1997
• itu1988
• ituq767 - Same as etsii (has been renamed).
• belgacom
• spirou
• mexicoic
• italy
• denmarkic
• hongkongic
• singapore
• etsi3
• peru
• chile
• portugaloni
• nttcom - Use the NTT Communications protocol for
Japan.
• chinacnc
• spain
• argentinaidt
• argentina
• brazil
• india
• korea
• etsi2plus - Use for Malaysia.
• ansiatt
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
baseversion N/A The Base Signaling group as specified in rfc3204:
• none
• itu-t88
• itu-t92
• ansi88
• ansi00
• etsi121
• etsi356
• gr317
• ttc87
• ttc93
bsiggroup 1-23 The Base Signaling group name.
If this parameter is present, the current signaling group takes
the same values as the base group.
hopcountval N/A Specifies the value of the Hop Counter if hopcountstat is
enabled by the switch. Must be 10-32.
hopcountstat N/A The Hop Counter state for the ISUP Signaling Group:
• enabled - The procedures are in effect. This state
requires that the ISUP protocol revision be ANSI1992 or
ANSI1995.
• disabled - The procedures are not in effect.
When Hop Counting is enabled:
• If a Hop Counter parameter is received from the ingress
leg of the call, it is decremented and included in the
outgoing IAM message. If no Hop Counter is present in the
ingress leg of the call, it is included in the outgoing IAM
message using hopcountval.
• If a Hop Counter of zero is present in the ingress leg of the
call, the call is released with a cause of “exchange routing
error.”
When Hop Counting is disabled:
• If a Hop Counter parameter is received from the ingress
leg of the call, it is passed transparently in the outgoing
IAM message.
• If a Hop Counter of value zero is present in the ingress leg
of the call, the call is released with a cause of “exchange
routing error”.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
Field
Parameter Length Description
olipcheck N/A When a call with a Charge Number and a Calling Party
Number arrives, by default the GSX checks for Originating
Line Information Parameters (OLIP) and rejects the call if
they are not present. This parameter turns OLIP checking off
for certain switches that do not supply OLIP information to
such calls:
• on - check for OLIP
• off - don’t check for OLIP
This check is applied only when the GSX receives an IAM.
sndolipcheck N/A When a call with a Charge Number and a Calling Party
Number is sent, by default the GSX checks for Originating
Line Information Parameters (OLIP) and rejects the call if
they are not present. This parameter turns OLIP checking off
for certain switches that do not supply OLIP information to
such calls:
• on - check for OLIP
• off - don’t check for OLIP
This check is applied only when the GSX, acting as an
originating exchange, is sending an IAM, the call ingress is
non ANSI, and the call egress is ANSI.
propagationdly N/A The propagation delay value in milliseconds for this SIP-I
signaling group. Must be 0-400, default is 0 (milliseconds).
nwindicator N/A Specifies the Network Indicator value to be used in the ISUP
Message header. Normally it is intl0 for international
interfaces, and natl0 for national interfaces:
• intl0 - Corresponds to 00
• intl1 - Corresponds to 01
• natl0 (default) - Corresponds to 10
• natl1 - Corresponds to 11
This setting is as it would be for ISUP if the SIP-I link were an
ISUP link. This parameter prevents unnecessary
interworking, and is not otherwise used by SIP-I.
lkaheadforbusy N/A Specifies the default value used in the Look Ahead for Busy
field in the ISUP Precedence parameter.
• allowed - Look Ahead for Busy is allowed.
• pathreserved - Look Ahead for Busy path is reserved.
• notallowed (default) - Look Ahead for Busy is not
allowed.
This parameter is used when supporting High Probability of
Compltion network capability. See "High Probability of
Completion (HPC) Features" on page 6–237 for more
information on this functionality.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
Field
Parameter Length Description
networkid 4 Specifies the default value used for the 4-digit network
identity field in the ISUP Precedence parameter.
Must be 0000-9999; default is 0100.
This parameter is used when supporting High Probability of
Compltion network capability. See "High Probability of
Completion (HPC) Features" on page 6–237 for more
information on this functionality.
admin-state N/A The administrative state of this ISUP signaling group:
• disabled (default) - Inactive, can be deleted
• enabled - Active, available for use.
Command Example
---------------------------------------------------------------------
ISUP Signaling Group Profile Summary
---------------------------------------------------------------------
Signaling Group Name Version Id Admin State
--------------------- ---------- -----------
ansi88 1 ENABLED
ansi00 2 ENABLED
etsi121 3 ENABLED
etsi356 4 ENABLED
gr317 5 ENABLED
itu-t88 6 ENABLED
itu-t92+ 7 ENABLED
ttc87 8 ENABLED
ttc93+ 9 ENABLED
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISUP Service Group
To create and configure an ISUP signaling group, an ISUP signaling profile must first be created.
To create a customized ISUP signaling profile, ansi, based on an existing profile,
Default_ANSI_1995:
To create and configure an ISUP signaling group, that references the ISUP signaling profile ansi,
with a particular revision and base version and assign it a VERSION ID of 105:
% CREATE ISUP SIGNALING GROUP ansi VERSION ID 105
% CONFIGURE ISUP SIGNALING GROUP ansi SIGNALING PROFILE ansi ..
REVISION ansi1995 BASE VERSION ansi88
-----------------------------------------------------------------------
ISUP Signaling Group : ansi Version ID : 105
-----------------------------------------------------------------------
Revision : ANSI1995 Base Version : ANSI88
Hop Counter Value : 10 Hop Counter State : ENABLED
Olip Check (OUT) : OFF
NetworkInd : NATL0
Propagation Delay : 13
SignalingProfile : ansi
Base Signaling Grp :
Network Identity : 0100 Look Ahead For Busy : ALLOWED
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP Service Group CLI Reference
---------------------------------------------------------------------
ISUP Signaling Group Profile Summary
---------------------------------------------------------------------
Signaling Group Name Version Id Admin State
--------------------- ---------- -----------
ansi88 1 ENABLED
ansi00 2 ENABLED
etsi121 3 ENABLED
etsi356 4 ENABLED
gr317 5 ENABLED
itu-t88 6 ENABLED
itu-t92+ 7 ENABLED
ttc87 8 ENABLED
ttc93+ 9 ENABLED
ansi 105 DISABLED
To make this ISUP signaling group ansi accessible to the PSX, the PSX SIP-I Signaling Content
Type Version and Signaling Profile entities must be properly configured with the name ansi and
the Content Type Version ID of 105.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference BT Service Group
BT Service Group
These objects configure the British Telecom (BT) Interconnect User Part (IUP) call control
services. These services utilize the BT7-IUP protocol (hereafter BT7).
For information on BT7 Timers, see the sections, "Specifying SS7 Timers" on page 3–312, and
"BT7 IUP Timers" on page 3–348.
BT Service Profile
This object creates a template for the underlying BT7 service group object that uses this profile
(below). BT7 service groups that are configured with a BT7 service profile will silently take every
parameter value specified in the profile unless explicitly overridden.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
BT Service Group CLI Reference
Command Parameters
Field
Parameter Length Description
profilename 1-23 The name of this profile, which can be applied to an
underlying BT7 service.
tgname 1-23 The name of the trunk group that the BT7 service will
belong to.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference BT Service Group
Field
Parameter Length Description
hdirection N/A The hunt algorithm for choosing a specific CIC within a
trunk group. This algorithm must complement the
algorithm in effect at the central office switch:
• top2bottom - start the search at the highest physical
port number on the highest CNA slot number on the
highest shelf number in the node. On a GSX4000 series
switch, start the search at the highest physical port
number.
• bottom2top - start the search at the lowest physical
port number on the lowest CNA slot number on the
lowest shelf number in the node. On a GSX4000 series
switch, start the search at the lowest physical port
number.
• circuithi2lo - start with the highest CIC number
and proceed to the lowest CIC number.
• circuitlo2hi - start with the lowest CIC number and
proceed to the highest CIC number.
• mostnleastidle - use the CONTROL parameter hunt
algorithms.
• circulartop2bottom - start the search at the
highest physical port number on the highest CNA slot
number on the highest shelf number in the node. On a
GSX4000 series switch, start the search at the highest
physical port number. Start the succeeding search at
the next table position rather than back at the top.
• circularbottom2top - start the search at the lowest
physical port number on the lowest CNA slot number on
the lowest shelf number in the node. On a GSX4000
series switch, start the search at the lowest physical
port number. Start the succeeding search at the next
table position rather than back at the bottom.
resetatstartup N/A Specifies whether to issue REL messages to all circuits in
this service group when a CNS module is started or
restarted in order to reset the circuits.
• disabled - Do not issue any reset messages on any
circuits when a CNS module is started.
• enabled - Reset all circuits by issuing individual REL
messages.
cost N/A The relative cost of using the CICs configured in this
service. Must be 0-100. A value of 100 represents the
highest possible cost.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
BT Service Group CLI Reference
Field
Parameter Length Description
cicControl N/A The set of CICs controlled by this GSX for the sake of
resolving dual-seizure scenarios. Additionally, if the HUNT
parameter is set to mostnleastidle, a CIC search
algorithm is also implied.
• nocics - None of the CICs in the service group are
controlled by this GSX. If HUNT is mostnleastidle,
CIC hunting is Last-In-First-Out (LIFO).
• allcics - All of the CICs in the service group are
controlled by this GSX. If HUNT is mostnleastidle,
CIC hunting is First-In-First-Out (FIFO).
• oddcics - CICs 1,3,5, etc. in this service group are
controlled by this GSX. If HUNT is mostnleastidle,
these CICs are hunted FIFO while even numbered CICs
are controlled by the remote switch and hunted LIFO.
• evencics - CICs 2,4,6 etc. in this service group are
controlled by this GSX. If HUNT is mostnleastidle,
these CICs are hunted FIFO while odd numbered CICs
are controlled by the remote switch and hunted LIFO.
intlnoa N/A Specifies whether the International Nature of Address is
supported for this BT7 service:
• unsupported (default)
• supported
doublerel N/A Specifies whether or not to send two call release
messages (REL) to the external switch when resetting
circuits. (This does not affect normal call release
procedures which will send two REL messages).
• unsupported (default) - do not send two RELs.
• supported - send two RELs.
thirdpartyidle N/A Specifies whether, upon the third expiry of timer 12a, the
underlying BT7 circuit should be idled:
• unsupported (default) - do not idle the circuit.
• supported - idle the circuit.
rqbeforerouting N/A Specifies the necessity of requesting the calling line
identity (CLI) before routing the call for this BT7 service:
• essential - Request the CLI and release the call if it
is unavailable.
• nonEssential (default) - Request the CLI but allow
the call to progress is the CLI is unavailable.
• noRequest - Do not request this information.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference BT Service Group
Field
Parameter Length Description
pcliusestval N/A Specifies, when a previous calling line identity request fails
but does return a partial calling line identity (PCLI),
whether to use this stored PCLI (that is this transit calling
line identity):
• unsupported (default) - do not use the PCLI.
• supported - use the PCLI.
mindigits N/A Specifies the minimum number of digits of the called
number that must be received before a route query is
performed. Must be 0-30, default is 0.
cgrtimeout N/A The time (in seconds) to wait to release a call when that
call was rejected due to congestion. This parameter
effectively prevents the machine congestion level from
escalating due to rapid repeated call attempts by
equipment that does not support congestion detection.
Must be 0-5 (seconds), default is 0. A value of 0 disables
this timer.
If this value is nonzero, the timer is started when a call is
rejected due to congestion. When the timer expires, the
network release is sent and the call resources are de-
allocated. If a network release is received during the delay,
the timer is stopped and the call resources are de-
allocated.
pnbeforerouting N/A Specifies the necessity of requesting the presentation
number (PN) for this BT Service Group Profile before
routing the call:
• essential - Request the PN and release the call if it is
unavailable.
• nonEssential - Request the PN but allow the call to
progress if the PN is unavailable.
• noRequest (default) - Do not request this information.
ldcaction N/A Specifies the action to take if the Long Duration Call (LDC)
timer expires. The call may be released, a SNMP trap may
be generated, or both:
• noAction (default) - take no action on LDC timer
expiry (a debug log entry will be generated).
• trap - generate an SNMP trap.
• release - automatic call disconnect without generation
of a trap.
• trapAndRelease - generate an trap and release the
call.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
BT Service Group CLI Reference
Field
Parameter Length Description
ldcemergcalls N/A Specifies whether emergency calls should be exluded
from, or included in Long Duration Call (LDC) disconnect
procedures:
• include
• exclude (default)
Note: Emergency call exclusion relies on the PSX call
type or other protocol-specific criteria to identify the call as
an “emergency” call.
ldcrelcause N/A Specifies the BT IUP cause value used to release the call
if the call is released due to Long Duration Call (LDC)
timer expiry. Must be 1 to 127; default is 2 (Network
Termination).
Note: The value set for this parameter may not be the
same value sent in the Release Message. Table 3–170 on
page 3–876, "Long-Duration Call (LDC) Timer Release
Cause Values for BT IUP" lists the forward and backward
Release Cause values sent in the Release Message.
ldctimeout N/A Specifies the timeout value of the Long Duration Call
(LDC) timer in minutes. Must be 0 or 60-2880. A value of 0
disables the timer; a value of 60-2880 set the timer.
Default is 0.
iwklineid N/A Specifies whether any Line Identity parameter received
after the call has routed should have the hexB information
added/removed in an interworking scenario:
• unsupported (default)
• supported
mssgthrottling N/A Specifies whether message throttling is supported.
Message throttling is a mechanism to pace maintenance
messages generated by the GSX (UNBLOCKED and
BLOCKED) and also the Reset on IDLE circuit procedure:
• supported (default) - allows for blocking or unblocking
(BLO/UBL) messages sent from the GSX to be
throttled.
• unsupported - message throttling is not enabled.
When blocking, unblocking, or resetting IDLE circuits, the
messages are paced on a per-CNS basis by the MESSAGE
THROTTLING TIMER
Note: The MESSAGE THROTTLING TIMER parameter is
available when MESSAGE THROTTLING is set to
supported.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference BT Service Group
Field
Parameter Length Description
mssgthrottlingtimer N/A Specifies the time in milliseconds to insert between
consecutive blocking (BLO) and unblocking (UBL)
messages sent on this service group. This parameter can
have a different value on each service group. Must be 0 to
1000; default is 10 (milliseconds).
admin-state N/A The administrative state of this BT7 service group profile:
• disabled (default) - Not activated, able to be deleted.
• enabled - Activated, available for immediate use.
TABLE 3–170 Long-Duration Call (LDC) Timer Release Cause Values for BT IUP
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
BT Service Group CLI Reference
Command Example
To create, configure, and activate a BT7 service group profile named btsp1:
% CREATE BT SERVICE PROFILE btsp1
% CONFIG BT SERV PROF btsp1 TRUNK GROUP tg1
% CONFIG BT SERV PROF btsp1 HUNT bottom2top
% CONFIG BT SERV PROF btsp1 COST 10
% CONFIG BT SERV PROF btsp1 STATE enabled
To display the BT7 service group profile, btsp1, generated by the commands above:
% SHOW BT SERVICE PROFILE btsp1 ADMIN
Node: TPUBS Date: 2007/02/23 20:34:47 GMT
Zone: GMTMINUS05-EASTERN-US
------------------------------------------------------------------------
BT Service Profile : btsp1
------------------------------------------------------------------------
Use Stored PCLI : UNSUPPORTED Trunk Group : tg1
Hunt Algorithm : BOTTOM2TOP Cost : 10
CIC Control : NOCICS Reset On Startup : DISABLED
CLI Request : NON-ESSENTIAL PN Request : NON-ESSENTIAL
Reset Double REL : UNSUPPORTED Idle on 3rd 12A : UNSUPPORTED
Intl NOA Support : UNSUPPORTED Cong Rel Timeout : 0 sec
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference BT Service Group
BT Service
This object binds a BT7 service to a trunk group and assigns a name and properties to this binding.
You may temporarily remove and restore this service by toggling its operational state between
inservice and outofservice. When you remove service in this manner you could disrupt
existing calls, so you will be prompted to affirm your command. You may use the GROUP
operations beforehand (BLOCK, UNBLOCK, and RESET) to put all the underlying circuits into
blocked or unblocked status. This operation provides a “wild-card like override” on individual
circuit manipulations that may have previously taken place on the BT7 Circuit object (see "BT
Circuit" on page 3–890).
The mechanisms used to carry out these configuration changes are summarized below.
A BT7 service is always in one of two administrative states:
• enabled
• disabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
BT Service Group CLI Reference
TABLE 3–171
From
(operational
state) Changing to (operational state)
inservice outofservice
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference BT Service Group
TABLE 3–172
From
(operational
state) Performing GROUP operation:
BLOCK UNBLOCK RESET
inservice Affirm the prompt query. All circuits will be An SS7 reset will occur
unblocked, including on all circuits.
If no action or the
any that may have been
action force is selectively blocked by
All circuits will be
specified, then each call operations at the BT7 unblocked, including
on each underlying BT7 any that were blocked
circuit level. The
circuit is dropped. All admin-state remains
by BT7 circuit level
circuits are set to enabled.
operations. admin-
blocked. The admin- state stays enabled.
state remains
enabled.
If action dryUp is
specified, then for
timeout minutes, each
underlying CIC is set to
blocked when the
active call on the CIC
completes.
If timeout minutes
expire before the call
completes, then the call
is dropped and the CIC
is immediately set to
blocked.
outofservice The GROUP operations The GROUP operations The GROUP operations
cannot be used when cannot be used when cannot be used when
the operational state is the operational state is the operational state is
outofservice. outofservice. outofservice.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
BT Service Group CLI Reference
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference BT Service Group
Command Parameters
Field
Parameter Length Description
btsname 1-23 The name of the BT7 service you are configuring.
profilename 1-23 The name of the BT7 service profile that you are applying
to this BT7 service.
tgname 1-23 The name of the trunk group to which this BT7 service
belongs.
dpc N/A Identifies the SS7 Point Code of the BT7 Service Group in
decimal format, the least significant three bytes
representing Network-Cluster-Member values.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
BT Service Group CLI Reference
Field
Parameter Length Description
hdirection N/A The hunt algorithm for choosing a specific CIC within a
trunk group. This algorithm must complement the
algorithm in effect at the central office switch:
• top2bottom - start the search at the highest physical
port number on the highest CNA slot number on the
highest shelf number in the node. On a GSX4000 series
switch, start the search at the highest physical port
number.
• bottom2top - start the search at the lowest physical
port number on the lowest CNA slot number on the
lowest shelf number in the node. On a GSX4000 series
switch, start the search at the lowest physical port
number.
• circuithi2lo - start with the highest CIC number
and proceed to the lowest CIC number.
• circuitlo2hi - start with the lowest CIC number and
proceed to the highest CIC number.
• mostnleastidle - use the CONTROL parameter hunt
algorithms.
• circulartop2bottom - start the search at the
highest physical port number on the highest CNA slot
number on the highest shelf number in the node. On a
GSX4000 series switch, start the search at the highest
physical port number. Start the succeeding search at
the next table position rather than back at the top.
• circularbottom2top - start the search at the lowest
physical port number on the lowest CNA slot number on
the lowest shelf number in the node. On a GSX4000
series switch, start the search at the lowest physical
port number. Start the succeeding search at the next
table position rather than back at the bottom.
cost N/A The relative cost of using the CICs configured in this
service. Must be 0-100. A value of 100 represents the
highest possible cost.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference BT Service Group
Field
Parameter Length Description
cicControl N/A The set of CICs controlled by this GSX for the sake of
resolving dual-seizure scenarios. Additionally, if the HUNT
parameter is set to mostnleastidle, a CIC search
algorithm is also implied.
• nocics - None of the CICs in the service group are
controlled by this GSX. If HUNT is mostnleastidle,
CIC hunting is Last-In-First-Out (LIFO).
• allcics - All of the CICs in the service group are
controlled by this GSX. If HUNT is mostnleastidle,
CIC hunting is First-In-First-Out (FIFO).
• oddcics - CICs 1,3,5, etc. in this service group are
controlled by this GSX. If HUNT is mostnleastidle,
these CICs are hunted FIFO while even numbered
CICs are controlled by the remote switch and hunted
LIFO.
• evencics - CICs 2,4,6 etc. in this service group are
controlled by this GSX. If HUNT is mostnleastidle,
these CICs are hunted FIFO while odd numbered CICs
are controlled by the remote switch and hunted LIFO.
resetatstartup N/A Specifies whether to issue REL messages to all circuits in
this service group when a CNS module is started or
restarted in order to reset the circuits.
• disabled - Do not issue any reset messages on any
circuits when a CNS module is started.
• enabled - Reset all circuits by issuing individual REL
messages.
intlnoa N/A Specifies whether the International Nature of Address is
supported for this BT7 service:
• unsupported (default)
• supported
doublerel N/A Specifies whether or not to send two call release
messages (REL) to the external switch when resetting
circuits. (This does not affect normal call release
procedures which will send two REL messages).
• unsupported (default) - do not send two RELs.
• supported - send two RELs.
thirdpartyidle N/A Specifies whether, upon the third expiry of timer 12a, the
underlying BT7 circuit should be idled:
• unsupported (default) - do not idle the circuit.
• supported - idle the circuit.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
BT Service Group CLI Reference
Field
Parameter Length Description
rqbeforerouting N/A Specifies the necessity of requesting the calling line
identity (CLI) before routing the call for this BT7 service:
• essential - Request the CLI and release the call if it
is unavailable.
• nonEssential (default) - Request the CLI but allow
the call to progress is the CLI is unavailable.
• noRequest - Do not request this information.
pcliusestval N/A Specifies, when a previous calling line identity request
fails but does return a partial calling line identity (PCLI),
whether to use this stored PCLI (that is this transit calling
line identity):
• unsupported (default) - do not use the PCLI.
• supported - use the PCLI.
mindigits N/A Specifies the minimum number of digits of the called
number that must be received before a route query is
performed. Must be 0-30, default is 0.
cgrtimeout N/A The time (in seconds) to wait to release a call when that
call was rejected due to congestion. This parameter
effectively prevents the machine congestion level from
escalating due to rapid repeated call attempts by
equipment that does not support congestion detection.
Must be 0-5 (seconds), default is 0. A value of 0 disables
this timer.
If this value is nonzero, the timer is started when a call is
rejected due to congestion. When the timer expires, the
network release is sent and the call resources are de-
allocated. If a network release is received during the
delay, the timer is stopped and the call resources are de-
allocated.
pnbeforerouting N/A Specifies the necessity of requesting the presentation
number (PN) for this BT Service Group before routing the
call:
• essential - Request the PN and release the call if it is
unavailable.
• nonEssential - Request the PN but allow the call to
progress if the PN is unavailable.
• noRequest (default) - Do not request this information.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference BT Service Group
Field
Parameter Length Description
ldcaction N/A Specifies the action to take if the Long Duration Call (LDC)
timer expires. The call may be released, a SNMP trap may
be generated, or both:
• noAction (default) - take no action on LDC timer
expiry (a debug log entry will be generated).
• trap - generate an SNMP trap.
• release - automatic call disconnect without generation
of a trap.
• trapAndRelease - generate an trap and release the
call.
ldcemergcalls N/A Specifies whether emergency calls should be excluded
from, or included in Long Duration Call (LDC) disconnect
procedures:
• include
• exclude (default)
Note: Emergency call exclusion relies on the PSX call
type or other protocol-specific criteria to identify the call as
an “emergency” call.
ldcrelcause N/A Specifies the BT IUP cause value used to release the call
if the call is released due to Long Duration Call (LDC)
timer expiry. Must be 1 to 127; default is 41 (Temporary
Failure).
Note: The value set for this parameter may not be the
same value sent in the Release Message. Table 3–170
on page 3–876, "Long-Duration Call (LDC) Timer Release
Cause Values for BT IUP" lists the forward and backward
Release Cause values sent in the Release Message.
ldctimeout N/A Specifies the timeout value of the Long Duration Call
(LDC) timer in minutes. Must be 0 or 60-2880. A value of 0
disables the timer; a value of 60-2880 set the timer.
Default is 0.
iwklineid N/A Specifies whether any Line Identity parameter received
after the call has routed should have the hexB information
added/removed in an interworking scenario:
• unsupported (default)
• supported
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
BT Service Group CLI Reference
Field
Parameter Length Description
mssgthrottling N/A Specifies whether message throttling is supported.
Message throttling is a mechanism to pace maintenance
messages generated by the GSX (UNBLOCKED and
BLOCKED) and also the Reset on IDLE circuit procedure:
• supported (default) - allows for blocking or unblocking
(BLO/UBL) messages sent from the GSX to be
throttled.
• unsupported - message throttling is not enabled.
When blocking, unblocking, or resetting IDLE circuits, the
messages are paced on a per-CNS basis by the MESSAGE
THROTTLING TIMER
Note: The MESSAGE THROTTLING TIMER parameter is
available when MESSAGE THROTTLING is set to
supported.
mssgthrottlingtimer N/A Specifies the time in milliseconds to insert between
consecutive blocking (BLO) and unblocking (UBL)
messages sent on this service group. This parameter can
have a different value on each service group. Must be 0 to
1000; default is 10 (milliseconds).
group N/A A “wild-card” means of blocking or unblocking all of the
underlying ISUP circuits in the service group:
• blocked - all underlying circuits blocked, regardless of
previous state.
• unblocked - all underlying circuits unblocked,
regardless of previous state.
• reset - a transitional state in which an SS7 reset is
applied to all circuits and they return to unblocked
state.
action N/A The method by which active calls using this BT7 service
are processed when oper-state goes to
outofservice or group goes to blocked or reset.
• force (default) - all calls dropped immediately.
• dryup - all calls are allowed to complete normally until
timeout expires, when they are dropped.
timeout N/A The time (in minutes) to wait to block the underlying CICs
and place the BT7 service in the outOfServiceoper-
state. Must be 0-1440.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference BT Service Group
Field
Parameter Length Description
oper-state N/A The operational state of the BT7 service:
• outofservice - all circuits blocked and thus out of
service.
• inservice - all previously unblocked circuits are
unblocked and thus in service. If the circuit was blocked
before it was taken outofservice, it will remain
blocked after this operation.
admin-state N/A The administrative state of this BT7 service:
• disabled (default) - Inactive, can be deleted
• enabled - Active, available for use.
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
BT Service Group CLI Reference
------------------------------------------------------------------------
BT7 Service : bt71 Point Code : 11-4-4
------------------------------------------------------------------------
Trunk Group : sumin
Hunt Algorithm : BOTTOM2TOP Cost : 10
CIC Control : NOCICS Reset On Startup : DISABLED
Intl NOA Support : UNSUPPORTED
Reset Double REL : UNSUPPORTED Idle on 3rd 12A : UNSUPPORTED
CLI Request : NON-ESSENTIAL Use Stored PCLI : UNSUPPORTED
PN Request : NON-ESSENTIAL Cong Rel Timeout : 0 sec
Service Profile :
Mode : INSERVICE Admin State : ENABLED
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference BT Service Group
BT Circuit
This object designates the trunk CICs associated with a BT7 service. As specified in the command
syntax, all operations can be applied to one or more CICs.
• enabled
• disabled
In addition, a BT7 circuit may enter a transitional operational state of reset, when an SS7 reset is
performed on the circuit.
The MODE command is used to change operational states.
The rules for changing between basic and transitional operational states are:
TABLE 3–174
From (basic
operational state) Changing to (basic operational state)
unblocked blocked
unblocked - Affirm the prompt query.
Blocking will occur on all previously
unblocked circuits. If action is
force, blocking will occur
immediately. If action is dryup,
blocking will occur after all active
calls complete or timeout expires.
You can change the admin-state
to disabled.
You may now delete the circuit.
blocked Change admin-state to enabled. -
Change oper-state to
unblocked.
All circuits will be unblocked.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
BT Service Group CLI Reference
TABLE 3–175
From (basic
operational state) Changing to (transitional operational state)
reset
unblocked Affirm the prompt request.
Change oper-state to reset.
An SS7 reset will occur on all circuits.
All circuits will be placed in oper-state unblocked, admin-state
enabled.
Outstanding calls are cleared on reset.
blocked Change oper-state to reset.
An SS7 reset will occur on all circuits.
All circuits will return in oper-state unblocked, admin-state
enabled.
NOTE
The BT Service GROUP operation performs the same functions as those listed
above, but only on a global basis. That is, on the entire service group without
regard to selective CICs. See "BT Service" on page 3–878.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference BT Service Group
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
BT Service Group CLI Reference
Command Parameters
Field
Parameter Length Description
btcsname 1-23 The name of the BT7 service used by the circuit that you are
configuring.
cicrange N/A The set of CICs that comprise this BT7 circuit. The range of legal
values is 0-4095.
Any discrete set of CICs within the appropriate range may be
specified as discussed below.
All CLI ranges specify a comma-separated list of numbers and/
or ranges. A range consists of two numbers separated by a
dash, for example, 5-8. An increment can be specified after a
range with the notation, +<incr>, for example 4-10+2. No spaces
are permitted in the expression. All values and ranges must be
in numerically ascending order. Thus the expression:
1,3,5,8-12+2,14-16
is a valid range specification for the numbers:
1,3,5,8,10,12,14,15, and 16.
Note that when you map CICs to channels (see below), then the
number of CICs that are specified in the above manner must
equal the number of channels specified, maximum 32.
e1name 1-23 The (automatically generated and possibly changed) name of
the E1 span that contains the channels that comprise this BT7
circuit.
chanrange N/A The set of channels that the CICs (above) are bound to. Must be
in the overall range 1-32. Any discrete set of channels within this
range may be specified as discussed below.
All CLI ranges specify a comma-separated list of numbers and/
or ranges. A range consists of two numbers separated by a
dash, for example, 5-8. An increment can be specified after a
range with the notation, +<incr>, for example 4-10+2. No spaces
are permitted in the expression. All values and ranges must be
in numerically ascending order. Thus the expression:
1,3,5,8-12+2,14-16
is a valid range specification for the numbers:
1,3,5,8,10,12,14,15, and 16.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference BT Service Group
Field
Parameter Length Description
tmember N/A A range of numbers with a one-to-one correspondence to the
CIC range that uniquely identifies the circuit endpoints within the
trunk group. The GSX software maintains a list of available trunk
member numbers for every trunk group. The size of the range
must equal the size of the CIC range and each member of the
range must be available. Must be 0-65535.
All CLI ranges specify a comma-separated list of numbers and/
or ranges. A range consists of two numbers separated by a
dash, for example, 5-8. An increment can be specified after a
range with the notation, +<incr>, for example 4-10+2. No spaces
are permitted in the expression. All values and ranges must be
in numerically ascending order. Thus the expression:
1,3,5,8-12+2,14-16
is a valid range specification for the numbers:
1,3,5,8,10,12,14,15, and 16.
csprofilename 1-23 The name of the Circuit Service Profile that you are applying to
this BT7 circuit.
direction 1-23 The type of call traffic these CICs can handle:
• twoway - accept all PSTN calls
• onewayin - accept only inbound PSTN calls
• onewayout - accept only outbound PSTN calls
oper-state N/A The operational state of the BT7 circuit:
• blocked - all circuits out of service.
• unblocked - all circuits in service.
• reset - a transitional state in which an SS7 reset is applied to
all circuits and they return to unblocked state.
admin-state N/A The administrative state of this BT7 circuit:
• disabled (default) - Not activated, able to be deleted.
• enabled - Activated, available for immediate use.
action N/A The method by which active calls on these BT7 circuits are
processed when oper-state goes to blocked:
• dryup (default) - all calls are allowed to complete until
timeout expires, when they are dropped.
• force - all calls are dropped immediately.
• undefined - undefined.
timeout N/A This parameter specifies a time interval (in minutes) that may be
used to place circuits into the blocked oper-state when
dryup is specified.
When specified, this value must be 0-1440.
If not specified, the default system setting is 0. This causes
dryup to attempt indefinitely until successful.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
BT Service Group CLI Reference
Command Example
The command sequence below provisions the SS7 Gateway, GSX SS7 Node, Carrier, Trunk
Group, Circuit Service Profile, BT Service Group, and related objects that are necessary to create
and configure four BT7 circuits supported by a CNS25 module in slot 3 of this GSX.
Create and Configure TRUNK GROUP PROFILE btprof1 (for PSTN trunk groups)
% CREATE TRUNK GROUP PROFILE btprof1
% CONFIGURE TRUNK GROUP PROFILE btprof1 SELECT leastcost
% CONFIGURE TRUNK GROUP PROFILE btprof1 INBOUND 0 CARRIER att
% CONFIGURE TRUNK GROUP PROFILE btprof1 SS7 NODE bt7n1
% CONFIGURE TRUNK GROUP PROFILE btprof1 STATE enabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference BT Service Group
Create and Configure four BT7 circuits, using the objects created above
% CREATE BT CIRCUIT SERVICE bt1sg CIC 50-53
% CONFIGURE BT CIRCUIT SERVICE bt1sg CIC 50-53 PORT E1-1-3-1 CHANNEL 1-4
% CONFIGURE BT CIRCUIT SERVICE bt1sg CIC 50-53 DIRECTION twoWay
% CONFIGURE BT CIRCUIT SERVICE bt1sg CIC 50-53 SERVICEPROFILENAME
csprof1
% CONFIGURE BT CIRCUIT SERVICE bt1sg CIC 50-53 STATE enabled
% CONFIGURE BT CIRCUIT SERVICE bt1sg CIC 50-53 MODE UNBLOCK
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
BT Service Group CLI Reference
To display the configuration of the BT service group, bt1sg, created in the sequence above:
% SHOW BT SERVICE bt1sg ADMIN
Node: TPUBS Date: 2007/02/23 18:35:17 GMT
Zone: GMTMINUS05-EASTERN-US
------------------------------------------------------------------------
BT7 Service : bt1sg Point Code : 7-7-7
------------------------------------------------------------------------
Trunk Group : busterbt1
Hunt Algorithm : BOTTOM2TOP Cost : 50
CIC Control : ODDCICS Reset On Startup : DISABLED
Intl NOA Support : UNSUPPORTED
Reset Double REL : UNSUPPORTED Idle on 3rd 12A : UNSUPPORTED
CLI Request : NON-ESSENTIAL Use Stored PCLI : UNSUPPORTED
PN Request : NON-ESSENTIAL Cong Rel Timeout : 0 sec
Service Profile :
Mode : INSERVICE Admin State : ENABLED
To display the status of the BT service group, bt1sg, configured in the above sequence:
% SHOW BT SERVICE bt1sg STATUS
Node: TPUBS Date: 2003/10/13 15:15:42 GMT
Zone: GMTMINUS05-EASTERN-US
------------------------------------------------------
BT7 Service Point Code Status
------------------------ ------------ ----------------
bt1sg 7-7-7 AVAILABLE
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference BT Service Group
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
BT Service Group CLI Reference
To display the configuration of circuit service profile, csprof1, that was used to configure the
BT7 circuits:
% SHOW CIRCUIT SERVICE PROFILE csprof1 ADMIN
Node: TPUBS Date: 2003/10/09 16:34:02 GMT
Zone: GMT
Circuit Service Profile csprof1 Configuration
Index: 1
Admin. State: ENABLED
Capabilities: VOICEORCIRCUITMODEDATA
Audio Encoding: G711ALAW
Bandwidth (for Nx64): 1 DS0 Channel(s)
Echo Cancellation: ENABLED
Restricted/Unrestricted Data: UNRESTRICTED
Interworking Transfer Cap: SPEECH
TX Level Control: NONE
RX Level Control: NONE
Tx Gain (dB): 0
Rx Gain (dB): 0
DTMF Profile: defaultDtmf
Continuity Test Parameters:
Test Type: REMOTELOOPBACK
Overall Test Timeout (secs): 2
Minimum Tone Detect Time (ms): 45
Minimum Tone Release Time (ms): 25
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference BT Service Group
You may not provision a single GSX/SGX using a single Originating Point Code (OPC or the SS7
NODE PC value) with ISUP and IUP services that share a single Remote Point Code (RPC or the
ISUP SERVICE DPC and BT SERVICE DPC values).
You may not provision a single GSX/SGX using a single OPC with ISUP and IUP services that
have unique RPCs.
You may provision one GSX with ISUP services and a second GSX with IUP services, and allow
the GSXs to use the same OPC as long as the ISUP and IUP RPCs are unique.
Sonus recommends that you dedicate a unique OPC (or SS7 NODE PC) to your BT SERVICE. Then
you may provision ISUP and IUP services on the same GSX.
In general, BT IUP and ISUP should not be configured on the same SS7 Node.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Service Group CLI Reference
These objects configure the Integrated Services Digital Network (ISDN) call services.
This object creates a template for the ISDN service group object. ISDN service groups that are
configured with a profile will silently take every parameter value specified in the profile unless
explicitly overridden.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISDN Service Group
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Service Group CLI Reference
Command Parameters
Field
Parameter Length Description
profilename 1-23 The name of the ISDN service profile that is being created
and configured.
tgname 1-23 The name of the trunk group that this ISDN service belongs
to.
hunt N/A The hunt algorithm used to select channels for calls
destined to this service group:
• lowlow (default) - start the search at the lowest channel
on the lowest interface, for example interface 0, channel
1.
• highhigh - start the search at the highest channel on
the highest interface, for example interface 0, channel 23.
• circularforward - each new search begins one
channel beyond the last channel selected and proceeds
in a low-to-high order (clockwise).
• circularbackward - each new search begins one
channel beyond the last channel selected and proceeds
in a high-to-low order (counterclockwise).
• mostIdle - Place the most recently used channel at the
end of a queue and select channels from the beginning of
the queue, first in, first out.
• leastIdle - Push the most recently used channel to the
top of a stack and select channels from the stack, last in,
first out.
cost N/A The (relative) routing cost to the ISDN service group. Must
be 0-100, default is 50. A value of 100 represents the
highest possible cost.
dirnum 0-30 The default directory number (DN). When a calling party
number (CPN) is provided in the incoming setup, the DN is
used as the billing number. When the CPN is absent from
the incoming setup, the DN is used as the CPN.
cpn_prov N/A Specifies whether a CPN is required in the incoming setup:
• necessary (default) - the incoming call is rejected if no
CPN is provided.
• notNecessary - the DN must be specified and is used
as the CPN.
cpn_disc N/A Specifies whether the CPN or Redirecting Numbers (RDNs)
are discarded:
• no (default) - discard none
• yes - discard all
• rdns - discard redirecting numbers
• rdns2 - discard second redirecting number
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISDN Service Group
Field
Parameter Length Description
cpn_present N/A Specifies the default presentation indicator:
• no - presentation prohibited
• yes (default) - presentation allowed
This default indicator is used for the default directory
number and for calling party numbers received that are
lacking the presentation indicator bits.
This feature may be overridden by Sonus PSX provisioning.
cpn_deliver N/A Specifies whether a CPN or RDN is included within an
outgoing setup:
• no - deliver none
• yes (default) - deliver all
• cpnonly - deliver CPN and no RDNs
• cpn1rdn - deliver CPN and one RDN
cpnam_timer N/A Specifies the time (in milliseconds) to wait to receive the
Calling Party Name. If the Calling Party Name Receive
Timer expires before the CNAME is received, the call
proceeds without the CNAME. Must be 0-3600; default is
500.
A value of “0” disables the timer. If disabled, the GSX
ignores any indication in call setup that information is to
follow, processes the call normally, and ignores any
CNAME that arrives later.
If the timer is enabled (by setting the timer to a value of 1-
3600), the GSX begins call processing but holds the Setup
until the CNAME is received or until the timer expires,
whichever is first.
Note: This parameter is supported on user-side switch
types NI2, 4ESS, and 5ESS only.
cps_tran N/A Specifies whether a calling party subaddress information
element (CPS) is accepted in the incoming setup:
• no - discard the CPS.
• yes (default) - accept the CPS.
• conditional - accept the CPS if the CPN is also
accepted.
cps_deliver N/A Specifies whether a CPS is included within an outgoing
setup for delivery to the Customer Provided Equipment
(CPE):
• no - discard the CPS.
• yes (default) - include the CPS in the setup.
• conditional - include the CPS if the CPN was also
accepted.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Service Group CLI Reference
Field
Parameter Length Description
cdps_tran N/A Specifies whether a called party subaddress information
element is accepted in the incoming setup:
• no - discard the called party subaddress.
• yes (default) - accept the called party subaddress
information element.
• conditional - accept the called party subaddress
information element if the called party number is also
accepted.
cdps_deliver N/A Specifies whether a called party subaddress information
element is included within an outgoing setup for delivery to
the Customer Provided Equipment (CPE):
• no - discard the called party subaddress information
element.
• yes (default) - include the called party subaddress
information element in the setup.
• conditional - include the called party subaddress
information element if the called party name was also
accepted.
cpnam_deliver N/A Controls the delivery of the Calling Party Name:
• no - do not deliver the Calling Party Name.
• yes (default) - deliver the Calling Party Name in the
SETUP message.
• alerting - deliver the Calling Party Name in a
FACILITY message, after the ALERT message.
• answered - deliver the Calling Party Name in a
FACILITY message, after the CONNECT message.
• callproc - deliver the Calling Party Name in a
FACILITY message, after the CALLPROC message.
earlyacm N/A When interworking between ISDN and ISUP, specifies
whether or not to deliver an early address complete
message (ACM):
• no (default) - The ACM is issued only as a result of an
ALERTING message from the ISDN side.
• yes - Deliver the early ACM as long as the egress side of
the ISDN is appropriately configured.
dtprofile 1-23 The name of a Disconnect Treatment Profile that will be
used to map a disconnect reason code to a Disconnect
Signaling Sequence Profile (SSP) for this service group.
See "Disconnect Treatment Profile" on page 3–1162.
dssp 1-23 The name of a Disconnect SSP Profile that will be used for
this service group. See "Disconnect Signaling Sequence
Profile" on page 3–1165.
tonepkg 1-23 The name of a tone package to be used by this ISDN
service group. See "Tone Package" on page 3–1201.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISDN Service Group
Field
Parameter Length Description
ectar N/A Specifies whether early cut through is allowed on an audible
ring:
• yes (default) - Enable early backwards cut through
• no - Disable early cut through
• twoway - Enable early full duplex cut through
ectni N/A Specifies whether early cut through is allowed on network
interworking when receiving progress indicator of 1:
• yes (default) - Enable backwards early cut through
• no - Disable early cut through
• twoway - Enable full duplex early cut through
bearercapfall N/A Specifies whether bearer capability fall back is allowed on
the network:
• no (default) - not allowed
• yes - allowed
dialtone 1-23 Specifies the dial tone to play when the ISDN service group
is emulating a euroIsdn switch and overlap addressing is
in effect.
confirmationtone 1-23 Specifies a confirmation tone to play when the ISDN call is
answered (prior to media cut through). The confirmation
tone must be configured as part of the ISDN service group's
TONE PACKAGE.
A confirmation tone is typically used by a calling PBX to
begin billing.
bchanxfer N/A Specifies whether ISDN PRI Two B-channel Transfer
(TBCT) is enabled for this ISDN service group:
• yes - permit TBCT call transfers
• no (default) - do not permit TBCT call transfers
bchanxferntu N/A Specifies whether a notification is provided to the
transferred users when a TBCT occurs:
• yes - provide user with notification when the call is
transferred
• no (default) - do not provide notification
This applies to the PRI that carries the first call to the
controlling user (that is the user that is initiating the transfer
and dropping out of the call). If the second call is carried by
the same PRI, then this action also applies to that call. If the
second call is carried by another PRI, then the notification
for that call depends on the configuration of this parameter
on that PRI.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Service Group CLI Reference
Field
Parameter Length Description
bchanxfernc N/A Specifies whether a notification is provided to the ISDN
controller when a TBCT is cleared:
• yes (default) - provide controller notification when the
call is cleared
• no - do not provide notification to the controller
bchanxferack N/A Specifies the type of message to carry the TBCT
acknowledgement:
• facility (default) - Send a FACILITY message to carry
the ACK.
• disconnect - Carry the ACK in the DISC message
used to clear the call leg to the controller.
bchanxferal N/A Specifies the number of simultaneously active TBCTs
allowed on the configured PRI. Must be 0 to 60000. Default
is 100. A value of 0 indicates no limit.
bchanxferil N/A Specifies the number of transfer requests allowed on the
configured PRI within a 10 second interval. Must be 0 to
500. Default is 10. A value of 0 indicates no limit.
mindsqdigits N/A Specifies the minimum number of CalledAddress digits to
collect before attempting a route query, when overlap
addressing is supported and CalledAddress receive is not
complete. Must be 0-30, default is 0 (digits).
immed-disc N/A Specifies action to take when the GSX receives a
DISCONNECT with inband tones:
• unsupported (default) - maintain voice path
• supported - perform an immediate disconnect in stable
states
• establishing - perform an immediate disconnect in
establishing states
• allstates - perform an immediate disconnect in all
states
You do not have to disable the ISDN service group to
enable this parameter.
conftoneover N/A Specifies support for subscriber-level confirmation tone:
• suppported - a confirmation tone plays for all ingress
calls.
• unsupported (default) - use the Calling Party
Subscriber screen on the PSX to activate the
confirmation tone.
cbprofno N/A The index number of the CRANKBACK PROFILE to use with
this ISDN service group. This must specify a valid Call
Crankback profile index, in the range 1-10. The default is 1,
or Call Crankback Profile default. See"Call Crankback
Profile" on page 3–1171.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISDN Service Group
Field
Parameter Length Description
guardtimer N/A Specifies the time, in milliseconds, to delay subsequent
hunting of a channel after a call is released. Must be 0-9999
(milliseconds), default is 0. A value of 0 directs immediate
hunting of the channel. An incoming call will be allowed to
proceed, even if the timer is running.
cgrtimeout N/A The time (in seconds) to wait to release a call when that call
was rejected due to congestion. This parameter effectively
prevents the machine congestion level from escalating due
to rapid repeated call attempts by equipment that does not
support congestion detection. Must be 0-5 (seconds),
default is 0. A value of 0 disables this timer.
If this value is nonzero, the timer is started when a call is
rejected due to congestion. When the timer expires, the
network release is sent and the call resources are de-
allocated. If a network release is received during the delay,
the timer is stopped and the call resources are de-allocated.
anssupvtimeout N/A When answer supervision is enabled, specifies the timeout
period, in seconds, from the egress receiving the first
backwards message from the called party exchange
(Alerting or Call Progress) until the call is answered. If the
timeout period expires, the specified answer supervision
action is triggered.
Must be 0 to 1000. Default is 300 (seconds). Setting this
value to 0 seconds disables the answer supervision feature.
anssupvtimeoact N/A Specifies the action to take if the answer supervision timer
expires (i.e. no signaled answer is received):\
• release (default) - release the call.
• softanswer – If an answer message is not received
from the succeeding exchange before the answer
supervision timer expires, the GSX generates a
CONNECT to send in the backward direction and moves
the call into the talking state cutting through the speech
path in both directions. If a CONNECT is later received
from the succeeding exchange, it is ignored.
• trapAndRestart - Send a trap and restart the timer.
This action will repeat continuously until cancelled by a
received network disconnect, user intervention, or a
received answer message.
The trap contains the following details for the call:
• Ingress Trunk Group
• Ingress Circuit End Point
• Egress Trunk Group
• Egress Circuit End Point
• Called Number
• Calling Number
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Service Group CLI Reference
Field
Parameter Length Description
ldcaction N/A Specifies the action to take if the Long Duration Call (LDC)
timer expires. The call may be released, a SNMP trap may
be generated, or both:
• noAction (default) - take no action on LDC timer expiry
(a debug log entry will be generated).
• trap - generate an SNMP trap.
• release - automatic call disconnect without generation
of a trap.
• trapAndRelease - generate an trap and release the
call.
ldcemergcalls N/A Specifies whether emergency calls should be excluded
from, or included in Long Duration Call (LDC) disconnect
procedures:
• include
• exclude (default)
Note: Emergency call exclusion relies on the PSX call type
or other protocol-specific criteria to identify the call as an
“emergency” call.
ldcrelcause N/A Specifies the GSX disconnect reason used to release the
call if the call is released due to Long Duration Call (LDC)
timer expiry. Must be 1 to 127; default is 41 (Temporary
Failure).
ldctimeout N/A Specifies the timeout value of the Long Duration Call (LDC)
timer in minutes. Must be 0 or 60-2880. A value of 0
disables the timer; a value of 60-2880 set the timer. Default
is 0.
admin-state N/A The administrative state of this ISDN service group profile:
• disabled (default) - Not activated, able to be deleted.
• enabled - Activated, available for immediate use.
Command Example
To create, configure with non-default parameter values, and activate an ISDN service group
profile named isdnprof1:
% CREATE ISDN SERVICE PROFILE isdnprof1
% CONFIG ISDN SERV PROF isdnprof1 TRUNK GROUP tg1
% CONFIG ISDN SERV PROF isdnprof1 HUNT highhigh
% CONFIG ISDN SERV PROF isdnprof1 COST 10
% CONFIG ISDN SERV PROF isdnprof1 STATE enabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISDN Service Group
------------------------------------------------------------------
ISDN Service Profile : isdnprof1
State : ENABLED
Trunk Group : tg1
Hunt Algorithm : HIGHHIGH
Cost : 10
Default Directory Number :
Calling Party Number Provision : NECESSARY
Calling Party Number Discard : NO
Calling Party Number Presentation : YES
Calling Party Number Delivery : YES
Calling Party Subaddress Transfer : YES
Calling Party Subaddress Delivery : YES
Calling Party Name Delivery : NO
Called Party Subaddress Transfer : YES
Called Party Subaddress Delivery : YES
Tone Pkg : default
Conf Tone :
Conf Tone Override : UNSUPPORTED
Dial Tone :
Disconnect Treatment Profile : isdnDefault
Disconnect SSP Profile :
Early ACM for Interworking with ISUP : NO
Early Cut Through Audible Ring : YES
Early Cut Through Network Interworking : YES
Bearer Capability Fallback Support : NO
Two Bchannel Transfer
Feature enabled : NO
Transfer acknowledgement message : FACILITY
Notification to transferred users : NO
Notification to controller : YES
Transfers active limit : 100
Transfers within interval limit : 10
Minimum Digits For Sending DS Query : 0
Immediate Disconnect with Inband Tones : UNSUPPORTED
Answer Supervision
Timeout : 300
Timeout Action : RELEASE
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Service Group CLI Reference
This object creates a template that describes the ISDN switch that a particular ISDN service group
will emulate. The characteristics of this switch, including B-channel signaling conventions and
Q.931/Q.921 timer values, are embedded in this profile.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISDN Service Group
Command Parameters
Field
Parameter Length Description
swprofilename 1-23 The name of the ISDN switch profile that is being created and
configured.
switchtype N/A The network switch type the ISDN service group will emulate:
• ni2 (default)
• dms250
• dms100
• 5ess
• 4ess
• euroIsdn
• ins1500 - directs the GSX software to conform to the Japan
INS 1500 ISDN variant
switchside N/A The switch side that this ISDN service group should act as:
• network (default) - A switch on the network side.
• user - A switch on the user side.
bcas N/A Specifies whether SERVICE messages will be used to
communicate the B-channel state:
• yes (default) - service messages are used
• no - service messages disabled
When SERVICE messages are used, a far end may take a B-
channel out of service with a SERVICE message. When you
bring a channel into service from the local end by sending a
SERVICE message, the far end needs to respond with a
SERVICE_ACK message indicating an in service channel state.
This service is not supported by the Euro-ISDN switch.
initialres N/A Specifies whether B-channels are brought into service with
RESTART messages:
• yes (default) - RESTARTs are sent for each channel when
datalink establishes.
• no - the channels are brought into service with SERVICE
messages, unless bcas is no, in which case no messages
are sent.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Service Group CLI Reference
Field
Parameter Length Description
t302 N/A The Q.931, T302 timer value (in seconds). This timer is used on
both the user and the network side. Must be 0-127, default is 15
(seconds). A value of 0 disables this timer.
t303 N/A The Q.931, T303 timer value (in seconds). This timer is used on
both the user and the network side. Must be 0-127, default is 4
(seconds). A value of 0 disables this timer.
t304 N/A The Q.931, T304 timer value (in seconds). This timer is used on
both the user and the network side. Must be 0-127, default is 30
(seconds). A value of 0 disables this timer.
t305 N/A The Q.931, T305 timer value (in seconds). This timer is used on
both the user and the network side. Must be 0-127, default is 30
(seconds). A value of 0 disables this timer.
t306 N/A The Q.931, T306 timer value (in seconds). This timer is used on
the network side only. Must be 0-127, default is 30 (seconds). A
value of 0 disables this timer.
t308 N/A The Q.931, T308 timer value (in seconds). This timer is used on
both the user and the network side. Must be 0-127, default is 4
(seconds). A value of 0 disables this timer.
t309 N/A The Q.931, T309 timer value (in seconds). This timer is used on
both the user and the network side. Must be 0-127, default is 90
(seconds). A value of 0 disables this timer.
t310 N/A The Q.931, T310 timer value (in seconds). This timer is used on
both the user and the network side. Must be 0-127, default is 15
(seconds). A value of 0 disables this timer.
t312 N/A The Q.931, T302 timer value (in seconds). This timer is used on
the network side only. Must be 0-127, default is 6 (seconds). A
value of 0 disables this timer.
t313 N/A The Q.931, T313 timer value (in seconds). This timer is used on
the user side only. Must be 0-127, default is 4 (seconds). A
value of 0 disables this timer.
t314 N/A The Q.931, T314 timer value (in seconds). This timer is used on
both the user and the network side. Must be 0-127, default is 4
(seconds). A value of 0 disables this timer.
t318 N/A The Q.931, T318 timer value (in seconds). This timer is used on
the user side only. Must be 0-127, default is 4 (seconds). A
value of 0 disables this timer.
t319 N/A The Q.931, T319 timer value (in seconds). This timer is used on
the user side only. Must be 0-127, default is 4 (seconds). A
value of 0 disables this timer.
t322 N/A The Q.931, T322 timer value (in seconds). This timer is used on
the network side only. Must be 0-127, default is 4 (seconds). A
value of 0 disables this timer.
k N/A The Q.921, K parameter. Specifies the maximum number of
outstanding I frames. Must be 1-127, default is 7.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISDN Service Group
Field
Parameter Length Description
t200 N/A The Q.921, T200 timer value (in seconds). This timer is used on
both the user and the network side. Must be 1-255, default is 1
(second).
t203 N/A The Q.921, T203 timer value (in seconds). This timer is used on
both the user and the network side. Must be 0-255, default is 0
(seconds). A value of 0 disables this timer.
n200 N/A The Q.921, N200 parameter. Specifies the maximum number of
retransmissions of a frame. Must be 1-100, default is 3.
n201 N/A The Q.921, N201 parameter. Specifies the maximum number of
octets in an information field. Must be 1-260, default is 260.
rswitchtype N/A The remote switch type. This should only be set to something
other than default if the remote switch type has unique
behavior.
• default (default).
• meridian - The Meridian PBX incorrectly rejects the
Channel ID information element when the extension bit is set
correctly. When this object is set to meridian, the extension
bit will not be set in the Channel ID information element.
• ocnrn - For 4ess and 5ess switch types, support both the
Original Called Number Information Element (IE) and the
Redirecting Number IE.
• ocnrnpresentation - Forces number presentation for the
Original Called Number IE and the Redirecting Number IE.
• customap - Forces number presentation for the Original
Called Number IE and the Redirecting Number IE. Also
sends a DISCONNECT instead of a PROGRESS with a
cause IE.
• atttcs - Supports interworking of the Facility message and
the MA-UUI capabilities required for the AT&T Toll Free
Transfer Connect Service.
• cpnrestrictedoverride - If the SWITCH TYPE is
ins1500, present the calling number when presentation is
restricted. This option leaves the presentation indication
restricted. This option cannot be used if the PSX option
FORCED CLIP is enabled.
• pi8inalert - Allow progress indicator #8 in ALERT
messages. This affects all switch types.
• noinbandinfo - Prohibit progress indicator #8 in ALERT
messages. Prohibit progress indicator #1 and #8 in
PROGRESS messages. This affects all switch types.
admin-state N/A The administrative state of this ISDN switch profile:
• disabled (default) - Not activated, able to be deleted.
• enabled - Activated, available for immediate use.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Service Group CLI Reference
Command Example
To create, configure with non-default parameter values, and activate an ISDN switch profile
named isdnsw1:
% CREATE ISDN SWITCH PROFILE isdnsw1
% CONFIGURE ISDN SWITCH PROFILE isdnsw1 SWITCHTYPE 4ESS
% CONFIG ISDN SWITCH PROFILE isdnsw1 SWITCHSIDE user
% CONFIG ISDN SWITCH PROFILE isdnsw1 T302 25
% CONFIG ISDN SWITCH PROFILE isdnsw1 T303 8
---------------------------------------------------------------------
ISDN Switch Profile: isdnsw1
---------------------------------------------------------------------
Switch Type : 4ESS Switch Side : USER
B-channel Availability Signaling : YES
B-channel Initial Restart : YES
State : DISABLED
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISDN Service Group
ISDN Service
This object binds an ISDN service to a trunk group and assigns a name and properties to this
binding. The resulting ISDN service group may be an ISDN Primary Rate Interface (PRI) or an
ISDN Non-Facility-Associated Signaling (NFAS) group with (or without) D-channel backup.
The B-channels of an ISDN service can be split into different trunk groups. This is accomplished
by creating an ISDN service object to control the D-channel and creating other ISDN service
objects to control the sub groups of B-channels. The subgroups of B-channels could be considered
a "tenant service" or a "B-channel service." The B-channel service includes attributes such as
"trunk group" and "default directory number."
All of these ISDN service group arrangements are created by properly configuring the SERVICE
TYPE parameter to one of the following three values:
• default - This is the typical ISDN PRI or NFAS service that binds a service to a trunk group
and assigns all B-channels in a T1 or E1 span to that trunk group. The one ISDN object
controls both the D-channel and B-channels. There is no separation of the B-channels from the
D-channels.
The next two service types work together as an alternative to the ISDN service described above.
Using the service types below, you may assign B-channels from one T1/E1 span to different trunk
groups to provide a “tenant service”. You would create one D-channel service and multiple B-
channel services. Sonus recommends using default ISDN service unless you require the sub
grouping of B-channels.
• dchannel - An ISDN service associated with the D-channel. Interfaces may be added to this
service, and B-channel maintenance may be performed with this service. A trunk group cannot
be assigned to this service. B-channels cannot be assigned to this service.
• bchannel - An ISDN service that can be assigned to a trunk group. The call processing
parameters that apply to default service, apply as well to this service type. B-channels may
be assigned to this service.
You may temporarily remove and restore these services by toggling their operational state between
inservice and outofservice. When you remove service in this manner you could disrupt
existing calls, so you will be prompted to affirm your command. You may use certain GROUP
operations (outOfService, maintenance, and inService) to put the underlying B-
channels into particular operational states. These operations provide a “wild-card like override” on
the ISDN B-channels (see "ISDN B-channel" on page 3–948).
You may enable ISDN PRI Two B-channel Transfers (TBCT) through the TWO BCHANNEL
TRANSFER command. This allows a user to bridge two calls and then be released from the
network, leaving the other two callers connected. The calls may be originated or terminated by the
transferring user, and the bridged call legs may use different PRIs. See "ISDN PRI Two B-
Channel Transfer" on page 6–171.”
The GROUP operation restart restarts all B-channels in the ISDN service group. The GROUP
operation clearstats clears all statistics associated with the ISDN service. The GROUP operation
dchannelSwitchover forces a switchover to the standby D-channel from the inService D-
channel.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Service Group CLI Reference
• enabled
• disabled
• inService
• outOfService
An ISDN service group is available to make calls when its status is AVAILABLE. This status is
revealed by the SHOW ISDN SERVICE .. STATUS command (see the command examples that
follow). To achieve this status:
The conventions that must be used to transition between operational states, as well as to perform
other GROUP operations, are summarized below.
The rules for changing operational states of the ISDN service are:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISDN Service Group
TABLE 3–179
From
(operational
state) Changing to (operational state)
inService outOfService
The GROUP operations below are performed on the underlying B-channels in order to prepare to
change the operational state of the ISDN service.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Service Group CLI Reference
The conventions for performing these GROUP operations from the two respective operational states
of the ISDN service are:
TABLE 3–180
From ISDN
Service
(operational
state) Performing GROUP operation:
inService maintenance outOfService
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISDN Service Group
The GROUP operations below carry out specific actions on the B-channels and D-channels that
belong to the ISDN service group.
The conventions for performing these GROUP operations from the two respective operational states
of the ISDN service are:
TABLE 3–181
From ISDN
Service
(operational
state) Performing GROUP operation:
restart clearStats dchannelSwitchover
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Service Group CLI Reference
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISDN Service Group
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Service Group CLI Reference
Command Parameters
Field
Parameter Length Description
servicename 1-23 The name of the ISDN service that is being created and
configured. This could designate a default, dchannel, or
bchannel service.
tgname 1-23 The name of the trunk group that this ISDN service belongs
to.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISDN Service Group
Field
Parameter Length Description
hunt N/A The hunt algorithm used to select channels for calls
destined to this service group:
• lowlow (default) - start the search at the lowest channel
on the lowest interface, for example interface 0, channel
1.
• highhigh - start the search at the highest channel on
the highest interface, for example interface 0, channel
23.
• circularforward - each new search begins one
channel beyond the last channel selected and proceeds
in a low-to-high order (clockwise).
• circularbackward - each new search begins one
channel beyond the last channel selected and proceeds
in a high-to-low order (counterclockwise).
• mostIdle - Place the most recently used channel at the
end of a queue and select channels from the beginning
of the queue, first in, first out.
• leastIdle - Push the most recently used channel to
the top of a stack and select channels from the stack, last
in, first out.
cost N/A The (relative) routing cost to the ISDN service group. Must
be 0-100, default is 50. A value of 100 represents the
highest possible cost.
switchside N/A The switch side that this ISDN service group should act as:
• network (default) - A switch on the network side.
• user - A switch on the user side.
switchtype N/A The network switch type the ISDN service group will
emulate:
• ni2 (default)
• dms250
• dms100
• 5ess
• 4ess
• euroIsdn
• ins1500 - directs the GSX software to conform to the
Japan INS 1500 ISDN variant
traceformat N/A Specifies the level of decoding for layer 2 and/or layer 3
messages on an ISDN D-Channel in the trace event log.
traceformat values are:
• off - limited decoding.
• on (default) - full decoding.
To completely disable decoding, use the TRACE NONE
command.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Service Group CLI Reference
Field
Parameter Length Description
dirnum 0-30 The default directory number (DN). When a calling party
number (CPN) is provided in the incoming setup, the DN is
used as the billing number. When the CPN is absent from
the incoming setup, the DN is used as the CPN.
cpn_prov N/A Specifies whether a CPN is required in the incoming setup:
• necessary (default) - the incoming call is rejected if no
CPN is provided.
• notNecessary - the DN must be specified and is used
as the CPN.
cpn_disc N/A Specifies whether the CPN or Redirecting Numbers are
discarded:
• no (default) - discard none
• yes - discard all
• rdns - discard redirecting numbers
• rdns2 - discard second redirecting number
cpn_present N/A Specifies the default presentation indicator:
• no - presentation prohibited
• yes (default) - presentation allowed
This default indicator is used for the default directory
number and for calling party numbers received that are
lacking the presentation indicator bits.
This feature may be overridden by Sonus PSX provisioning.
cpn_deliver N/A Specifies whether a CPN or RN is included within an
outgoing setup:
• no - deliver none
• yes (default) - deliver all
• cpnonly - deliver CPN and no RDNs
• cpn1rdn - deliver CPN and one RDN
cps_tran N/A Specifies whether a calling party subaddress information
element (CPS) is accepted in the incoming setup:
• no - discard the CPS.
• yes (default) - accept the CPS.
• conditional - accept the CPS if the CPN is also
accepted.
cps_deliver N/A Specifies whether a CPS is included within an outgoing
setup for delivery to the Customer Provided Equipment
(CPE):
• no - discard the CPS.
• yes (default) - include the CPS in the setup.
• conditional - include the CPS if the CPN was also
accepted.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISDN Service Group
Field
Parameter Length Description
cdps_tran N/A Specifies whether a called party subaddress information
element is accepted in the incoming setup:
• no - discard the called party subaddress.
• yes (default) - accept the called party subaddress
information element.
• conditional - accept the called party subaddress
information element if the called party number is also
accepted.
cdps_deliver N/A Specifies whether a called party subaddress information
element is included within an outgoing setup for delivery to
the Customer Provided Equipment (CPE):
• no - discard the called party subaddress information
element.
• yes (default) - include the called party subaddress
information element in the setup.
• conditional - include the called party subaddress
information element if the called party name was also
accepted.
cpnam_deliver N/A Controls the delivery of the Calling Party Name:
• no - do not deliver the Calling Party Name.
• yes (default) - deliver the Calling Party Name in the
SETUP message.
• alerting - deliver the Calling Party Name in a
FACILITY message, after the ALERT message.
• answered - deliver the Calling Party Name in a
FACILITY message, after the CONNECT message.
• callproc - deliver the Calling Party Name in a
FACILITY message, after the CALLPROC message.
cpnam_timer N/A Specifies the time (in milliseconds) to wait to receive the
Calling Party Name. If the Calling Party Name Receive
Timer expires before the CNAME is received, the call
proceeds without the CNAME. Must be 0-3600; default is
500.
A value of “0” disables the timer. If disabled, the GSX
ignores any indication in call setup that information is to
follow, processes the call normally, and ignores any
CNAME that arrives later.
If the timer is enabled (by setting the timer to a value of 1-
3600), the GSX begins call processing but holds the Setup
until the CNAME is received or until the timer expires,
whichever is first.
Note: This parameter is supported on user-side switch
types NI2, 4ESS, and 5ESS only.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Service Group CLI Reference
Field
Parameter Length Description
bcas N/A Specifies whether SERVICE messages will be used to
communicate the B-channel state:
• yes (default) - service messages are used
• no - service messages disabled
When SERVICE messages are used, a far end may take a
B-channel out of service with a SERVICE message. When
you bring a channel into service from the local end by
sending a SERVICE message, the far end needs to
respond with a SERVICE_ACK message indicating an in
service channel state.
This service is not supported by the Euro-ISDN switch.
initialres N/A Specifies whether B-channels are brought into service with
RESTART messages:
• yes (default) - RESTARTs are sent for each channel
when datalink establishes.
• no - the channels are brought into service with SERVICE
messages, unless bcas is no, in which case no
messages are sent.
pdi N/A The ISDN service group primary D-channel interface. Must
be 0-28, default is 0.
pdts N/A The ISDN service group primary D-channel time slot. Must
be 1-31, default is 24, or 16 when SWITCHTYPE is
euroIsdn.
pdm N/A The ISDN service group primary D-channel mode:
• inService (default) - active
• outOfService - inactive
bdi N/A The ISDN service group backup D-channel interface. Must
be 0-28, default is 1.
bdts N/A The ISDN service group backup D-channel time slot. Must
be 1-31, default is 24, or 16 when SWITCHTYPE is
euroIsdn.
bdm N/A The ISDN service group backup D-channel mode:
• inService - active
• outOfService - inactive
• unEquipped (default) - unable to be used for signaling
dtprofile 1-23 The name of a Disconnect Treatment Profile that will be
used to map a disconnect reason code to a Disconnect
Signaling Sequence Profile (SSP) for this service group.
See "Disconnect Treatment Profile" on page 3–1162.
tonepkg 1-23 The name of a tone package to be used by this ISDN
service group. See "Tone Package" on page 3–1201.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISDN Service Group
Field
Parameter Length Description
dialtone 1-23 Specifies the dial tone to play when the ISDN service group
is emulating a euroIsdn switch and overlap addressing is
in effect.
confirmationtone 1-23 Specifies a confirmation tone to play when the ISDN call is
answered (prior to media cut through). The confirmation
tone must be configured as part of the ISDN service group's
TONE PACKAGE.
A confirmation tone is typically used by a calling PBX to
begin billing.
conftoneover N/A Specifies support for subscriber-level confirmation tone:
• suppported - a confirmation tone plays for all ingress
calls.
• unsupported (default) - use the Calling Party
Subscriber screen on the PSX to activate the
confirmation tone.
bchanxfer N/A Specifies whether ISDN PRI Two B-channel Transfer
(TBCT) is enabled for this ISDN service group:
• yes - permit TBCT call transfers
• no (default) - do not permit TBCT call transfers
bchanxferntu N/A Specifies whether a notification is provided to the
transferred users when a TBCT occurs:
• yes - provide user with notification when the call is
transferred
• no (default) - do not provide notification
This applies to the PRI that carries the first call to the
controlling user (that is the user that is initiating the transfer
and dropping out of the call). If the second call is carried by
the same PRI, then this action also applies to that call. If the
second call is carried by another PRI, then the notification
for that call depends on the configuration of this parameter
on that PRI.
bchanxfernc N/A Specifies whether a notification is provided to the ISDN
controller when a TBCT is cleared:
• yes (default) - provide controller notification when the
call is cleared
• no - do not provide notification to the controller
bchanxferack N/A Specifies the type of message to carry the TBCT
acknowledgement:
• facility (default) - Send a FACILITY message to
carry the ACK.
• disconnect - Carry the ACK in the DISC message
used to clear the call leg to the controller.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Service Group CLI Reference
Field
Parameter Length Description
bchanxferal N/A Specifies the number of simultaneously active TBCTs
allowed on the configured PRI. Must be 0 to 60000. Default
is 100. A value of 0 indicates no limit.
bchanxferil N/A Specifies the number of transfer requests allowed on the
configured PRI within a 10 second interval. Must be 0 to
500. Default is 10. A value of 0 indicates no limit.
oper-state N/A The operational state of the ISDN service:
• outofservice - The ISDN service is prevented from
carrying new calls.
• inservice (default) - The ISDN service can carry new
calls.
action N/A The method by which calls on the channels using this ISDN
service are processed when operational state goes to
outOfService or GROUP goes to outOfService.
• force - all calls dropped immediately.
• dryup - all calls are allowed to complete normally until
TIMEOUT expires, when they are dropped.
timeout N/A The time (in minutes) to wait to place the ISDN channels in
the operational state outOfService. Must be 1-1440. This
parameter value must be explicitly specified when ACTION
is dryUp.
group N/A An operation to be applied either to the underlying B-
channels of the ISDN service group:
• outOfService - Place B-channels out of service.
• maintenance - Place B-channels in maintenance state.
• inService - Place B-channels in service.
• restart - Restart B-channel.
• or to a specific ISDN service group function:
• clearStats - Clear the ISDN service group call
statistics.
• dchannelSwitchover - Initiate a switchover from the
active D-channel to the standby D-channel for call
signaling.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISDN Service Group
Field
Parameter Length Description
rswitchtype N/A The remote switch type. This should only be set to
something other than default if the remote switch type
has unique behavior. Currently, the unique behavior is
meridian:
• default (default)
• meridian - The Meridian PBX incorrectly rejects the
Channel ID information element when the extension bit is
set correctly. When this object is set to meridian, the
extension bit will not be set in the Channel ID information
element.
• ocnrn - For 4ess and 5ess switch types, support both
the Original Called Number Information Element (IE) and
the Redirecting Number IE.
• ocnrnpresentation - Forces number presentation for
the Original Called Number IE and the Redirecting
Number IE.
• customap - Forces number presentation for the Original
Called Number IE and the Redirecting Number IE. Also
sends a DISCONNECT instead of a PROGRESS with a
cause IE.
• atttcs - Supports interworking of the Facility message
and the MA-UUI capabilities required for the AT&T Toll
Free Transfer Connect Service.
• cpnrestrictedoverride - If the SWITCH TYPE is
ins1500, present the calling number when presentation
is restricted. This option leaves the presentation
indication restricted. This option cannot be used if the
PSX option FORCED CLIP is enabled.
• pi8inalert - Allow progress indicator #8 in ALERT
messages. This affects all switch types.
• noinbandinfo - Prohibit progress indicator #8 in
ALERT messages. Prohibit progress indicator #1 and #8
in PROGRESS messages. This affects all switch types.
admin-state N/A The administrative state of this ISDN service group:
• disabled (default) - Not activated, able to be
reconfigured or deleted. (This state clears the ISDN
service group call statistics.)
• enabled - Activated, available for immediate use.
switchprofile 1-23 The name of the ISDN switch profile to be used by the ISDN
service group. This file has embedded information that
describes the SWITCHTYPE.
profilename 1-23 The name of an ISDN service profile to use to provide all
undeclared parameter values in this ISDN service.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Service Group CLI Reference
Field
Parameter Length Description
earlyacm N/A When interworking between ISDN and ISUP, specifies
whether or not to deliver an early address complete
message (ACM):
• no (default) - The ACM is issued only as a result of an
ALERTING message from the ISDN side.
• yes - Deliver the early ACM as long as the egress side of
the ISDN is appropriately configured.
dssp 1-23 The name of a Disconnect SSP Profile that will be used for
this service group. See "Disconnect Signaling Sequence
Profile" on page 3–1165.
ectar N/A Specifies whether early cut through is allowed on an audible
ring:
• yes (default) - Enable early backwards cut through
• no - Disable early cut through
• twoway - Enable early full duplex cut through
ectni N/A Specifies whether early cut through is allowed on network
interworking when receiving progress indicator of 1:
• yes (default) - Enable backwards early cut through
• no - Disable early cut through
• twoway - Enable full duplex early cut through
bearercapfall N/A Specifies whether bearer capability fall back is allowed on
the network:
• no (default) - not allowed
• yes - allowed
mindsqdigits N/A Specifies the minimum number of CalledAddress digits to
collect before attempting a route query, when overlap
addressing is supported and CalledAddress receive is not
complete. Must be 0-30, default is 0 (digits).
cbprofno N/A The index number of the CRANKBACK PROFILE to use with
this ISDN service group. This must specify a valid Call
Crankback profile index, in the range 1-10. The default is 1,
or Call Crankback Profile default. See"Call Crankback
Profile" on page 3–1171.
guardtimer N/A Specifies the time, in milliseconds, to delay subsequent
hunting of a channel after a call is released. Must be 0-9999
(milliseconds), default is 0. A value of 0 directs immediate
hunting of the channel. An incoming call will be allowed to
proceed, even if the timer is running.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISDN Service Group
Field
Parameter Length Description
cgrtimeout N/A The time (in seconds) to wait to release a call when that call
was rejected due to congestion. This parameter effectively
prevents the machine congestion level from escalating due
to rapid repeated call attempts by equipment that does not
support congestion detection. Must be 0-5 (seconds),
default is 0. A value of 0 disables this timer.
If this value is nonzero, the timer is started when a call is
rejected due to congestion. When the timer expires, the
network release is sent and the call resources are
deallocated. If a network release is received during the
delay, the timer is stopped and the call resources are
deallocated.
immed-disc N/A Specifies action to take when the GSX receives a
DISCONNECT with inband tones:
• unsupported (default) - maintain voice path
• supported - perform an immediate disconnect in stable
states
• establishing - perform an immediate disconnect in
establishing states
• allstates- perform an immediate disconnect in all
states
You do not have to disable the ISDN service group to
enable this parameter.
servicetype N/A Specifies the type of ISDN service group to be configured:
• default (default) - Standard service for trunk groups
that use contiguous spans of B-channels.
• dchannel - A service associated exclusively with the D-
channel. INTERFACEs may be added to this service.
• bchannel - A call processing service associated with B-
channels and assigned to a trunk group.
ISDN dchannel and bchannel service types work
together to provide an alternate mechanism to default
ISDN service.
anssupvtimeout N/A When answer supervision is enabled, specifies the timeout
period, in seconds, from the egress receiving the first
backwards message from the called party exchange
(Alerting or Call Progress) until the call is answered. If the
timeout period expires, the specified answer supervision
action is triggered.
Must be 0 to 1000. Default is 300 (seconds). Setting this
value to 0 seconds disables the answer supervision feature.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Service Group CLI Reference
Field
Parameter Length Description
anssupvtimeoact N/A Specifies the action to take if the answer supervision timer
expires (i.e. no signaled answer is received):
• release (default) - release the call..
• softanswer – If an answer message is not received
from the succeeding exchange before the answer
supervision timer expires, the GSX generates a
CONNECT to send in the backward direction and moves
the call into the talking state cutting through the speech
path in both directions. If a CONNECT is later received
from the succeeding exchange, it is ignored.
• trapAndRestart - Send a trap and restart the timer.
This action will repeat continuously until cancelled by a
received network disconnect, user intervention, or a
received answer message.
The trap contains the following details for the call:
• Ingress Trunk Group
• Ingress Circuit End Point
• Egress Trunk Group
• Egress Circuit End Point
• Called Number
• Calling Number
ldcaction N/A Specifies the action to take if the Long Duration Call (LDC)
timer expires. The call may be released, a SNMP trap may
be generated, or both:
• noAction (default) - take no action on LDC timer expiry
(a debug log entry will be generated).
• trap - generate an SNMP trap.
• release - automatic call disconnect without generation
of a trap.
• trapAndRelease - generate an trap and release the
call.
ldcemergcalls N/A Specifies whether emergency calls should be excluded
from, or included in Long Duration Call (LDC) disconnect
procedures:
• include
• exclude (default)
Note: Emergency call exclusion relies on the PSX call type
or other protocol-specific criteria to identify the call as an
“emergency” call.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISDN Service Group
Field
Parameter Length Description
ldcrelcause N/A Specifies the GSX disconnect reason used to release the
call if the call is released due to Long Duration Call (LDC)
timer expiry. Must be 1 to 127; default is 41 (Temporary
Failure).
ldctimeout N/A Specifies the timeout value of the Long Duration Call (LDC)
timer in minutes. Must be 0 or 60-2880. A value of 0
disables the timer; a value of 60-2880 set the timer. Default
is 0.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Service Group CLI Reference
Command Example
Use the following example to create and configure ISDN service isdnserv1. This example also
requires commands for creating and configuring an ISDN interface. Refer to "ISDN Interface" on
page 3–946 for details.
% CREATE ISDN SERVICE isdnserv1
% CONFIGURE ISDN SERVICE isdnserv1 TRUNK GROUP tg1
% CONFIGURE ISDN SERVICE isdnserv1 HUNT lowlow
% CONFIGURE ISDN SERVICE isdnserv1 COST 40
% CONFIGURE ISDN SERVICE isdnserv1 SWITCHSIDE user
% CONFIGURE ISDN SERVICE isdnserv1 SWITCHTYPE ni2
% CONFIGURE ISDN SERVICE isdnserv1 BCHANNEL AVAILABILIITY ..
SIGNALING yes
% CREATE ISDN INTERFACE SERVICE isdnserv1 INTERFACE 0
% CONFIGURE ISDN INTERFACE SERVICE isdnserv1 INTERFACE 0 ..
PORT T1-1-3-1
% CONFIGURE ISDN SERVICE isdnserv1 PRIMARY DCHANNEL INTERFACE 0
% CONFIGURE ISDN SERVICE isdnserv1 PRIMARY DCHANNEL MODE inService
% CONFIGURE ISDN SERVICE isdnserv1 STATE enabled
---------------------------------------------------------------------
ISDN Service : ISDNSERV1
State : ENABLED
Service Type : DEFAULT
Mode : INSERVICE
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISDN Service Group
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Service Group CLI Reference
---------------------------------------------------------------------
ISDN Service : ISDNSERV1
Status : UNAVAILABLE
Trunk Group Mode : INSERVICE
NOTE
The SHOW screen in the example above, is only possible after the CNS server
module that drives the interface is running and the primary D-channel Interface is
enabled. Otherwise, the status will be UNAVAILABLE and you will only see the first
two lines of this display.
The status field in the SHOW screen above is AVAILABLE. This result requires (1)
that the ISDN service group is provisioned INSERVICE, (2) that the Trunk Group
mode is INSERVICE, and (3) that the primary (or backup) D-channel status is
INSERVICE.
This example creates and configures an ISDN service isdnserv2 as an NFAS group, using
interface 0 (channel 24) as the primary D-channel, and interface 1 (channel 24) as the backup
D-channel. ISDN Interface Service commands are required. Refer to "ISDN Interface" on page 3–
946 for details.
% CREATE ISDN SERVICE isdnserv2
% CONFIGURE ISDN SERVICE isdnserv2 TRUNK GROUP tg1
% CONFIGURE ISDN SERVICE isdnserv2 HUNT lowlow
% CONFIGURE ISDN SERVICE isdnserv2 COST 40
% CONFIGURE ISDN SERVICE isdnserv2 SWITCHSIDE user
% CONFIGURE ISDN SERVICE isdnserv2 SWITCHTYPE 4ESS
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISDN Service Group
---------------------------------------------------------------------
Trunk Group : tg1
ISDN Service: ISDNSERV2 State: ENABLED Mode: INSERVICE
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Service Group CLI Reference
Dial Tone :
Confirmation Tone :
Remote Switch Type : DEFAULT
Early ACM for Interworking with ISUP : NO
Early Cut Through Audible Ring : YES
Early Cut Through Network Interworking : YES
Bearer Capability Fallback Support : NO
And the operational status of ISDN service ISDNSERV2 would be shown by:
% SHOW ISDN SERVICE isdnserv2 STATUS
Node: TPUBS Date: 2001/02/12 20:03:06 GMT
Zone: GMTMINUS05-EASTERN-US
---------------------------------------------------------------------
Trunk Group : tg1 Mode: INSERVICE
ISDN Service: ISDNSERV2 Mode: INSERVICE Status: AVAILABLE
Bchannels Configured: 382 Available: 382
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISDN Service Group
The following command enables full decoding for both layer 2 and layer 3 messages in the trace
event log. A sample from the trace event log follows.
% CONFIGURE ISDN SERVICE ABNI2IN TRACE BOTH VERBOSE on
089 05312000 144559.00001:1.12.Info .ISDN : Service ABNI2IN D1 : L2 RX
SABME (SAPI=0 TEI=0 C/R=0[u->n] P=1)
087 05312000 144559.00002:1.12.Info .ISDN : Service ABNI2IN D1 : L2 TX
UA (SAPI=0 TEI=0 C/R=0[n->u] F=1)
189 05312000 144617.00075:1.12.Info .ISDN : Service ABNI2IN D1 : L2 RX
INFO (SAPI=0 C/R=0[u->n] TEI=0 Ns=12 Nr=4 P=0)
157 05312000 144617.00076:1.12.Info .ISDN : Service ABNI2IN D1 : L3 RX
CREF=010d
SETUP (Prot=08 IE=050480a2 IE=1804e180838d
IE=6c0c218038303837373731303031 IE=3031700ba138303837373731303032)
137 05312000 144618.00077:1.12.Info .ISDN : Service ABNI2IN D1 : L3 RX
CREF=010d IE=BEARCAP (Coding=CCITT Cap=Speech Mode=Circuit Rate=64kbps
L2=Q921)
077 05312000 144619.00078:1.12.Info .ISDN : Service ABNI2IN D1 : L3 RX
CREF=010d
IE=CHANID (IntfID=Explicit[ID=80] Intf=Primary Pref/Excl=Preferred
ChanSel=#13 Coding=CCITT)
159 05312000 144620.00078:1.12.Info .ISDN : Service ABNI2IN D1 : L3 RX
CREF=010d
IE=CALLINGNUMBER (NumberType=National NumberingPlan=ISDN/
Telephony[E.164] Presentation=Allowed Screening=None Digits=8087771001)
148 05312000 144621.00078:1.12.Info .ISDN : Service ABNI2IN D1 : L3 RX
CREF=010d
IE=CALLEDNUMBER (NumberType=National NumberingPlan=ISDN/Telephony[E.164]
Digits=8087771002)
090 05312000 144622.00077:1.12.Info .ISDN : Service ABNI2IN D1 : L2 RX
RR (SAPI=0 TEI=0 C/R=1 Nr=5 P/F=0)
090 05312000 144623.00078:1.12.Info .ISDN : Service ABNI2IN D1 : L2 TX
RR (SAPI=0 TEI=0 C/R=0 Nr=13 P/F=0)
117 05312000 144624.00079:1.12.Info .ISDN : Service ABNI2IN D1 : L2 TX
INFO (SAPI=0 C/R=1[n->u] TEI=0 Ns=11 Nr=13 P=0)
109 05312000 144625.00080:1.12.Info .ISDN : Service ABNI2IN D1 : L3 TX
CREF=810c CALLPROCH (Prot=08 IE=021804e980838c)
109 05312000 144626.00080:1.12.Info .ISDN : Service ABNI2IN D1 : L3 TX
CREF=810c IE=CHANID (IntfID=Explicit[ID=80] Intf=Primary Pref/
Excl=Exclusive ChanSel=#12 Coding=CCITT)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Service Group CLI Reference
The same trace event log is shown below. However, limited decoding of the messages is
performed with the following command.
% CONFIGURE ISDN SERVICE ABNI2IN TRACE BOTH VERBOSE off
189 05312000 144617.00075:1.12.Info .ISDN : Service ABNI2IN D1 : L2 RX
INFO 00011808 0802010d 05040380 90a21804 e180838d 6c0c2180 38303837
37373130 3031700b a1383038 37373731 303032
157 05312000 144617.00076:1.12.Info .ISDN : Service ABNI2IN D1 : L3 RX
CREF 010d SETUP BC 8090a2 CH e180838d CP 2180(8087771001) CD
a1(8087771002)
090 05312000 144617.00077:1.12.Info .ISDN : Service ABNI2IN D1 : L2 RX
RR 0201010a
090 05312000 144617.00078:1.12.Info .ISDN : Service ABNI2IN D1 : L2 TX
RR 0001011a
117 05312000 144617.00079:1.12.Info .ISDN : Service ABNI2IN D1 : L2 TX
INFO 0201161a 0802810c 021804e9 80838c
109 05312000 144617.00080:1.12.Info .ISDN : Service ABNI2IN D1 : L3 TX
CREF 810c CALLPROCH CH e980838c
189 05312000 144617.00082:1.12.Info .ISDN : Service ABNI2IN D1 : L2 RX
INFO 00011a0a 0802010e 05040380 90a21804 e180838e 6c0c2180 38303837
37373130 3031700b a1383038 37373731 303032
157 05312000 144617.00083:1.12.Info .ISDN : Service ABNI2IN D1 : L3 RX
CREF 010e SETUP BC 8090a2 CH e180838e CP 2180(8087771001) CD
a1(8087771002)
090 05312000 144617.00084:1.12.Info .ISDN : Service ABNI2IN D1 : L2 RX
RR 0201010c
090 05312000 144617.00085:1.12.Info .ISDN : Service ABNI2IN D1 : L2 TX
RR 0001011c
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISDN Service Group
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Service Group CLI Reference
The following example enables TBCT on ISDN service isdnserv1. The default settings are
retained for all parameters except NOTIFICATION TO TRANSFERRED USERS, which is set to yes:
% CONFIGURE ISDN SERVICE isdnserv1 TWO BCHANNEL TRANSFER ENABLED yes
% CONFIGURE ISDN SERVICE isdnserv1 TWO BCHANNEL TRANSFER ..
NOTIFICATION TO TRANSFERRED USERS yes
-------------------------------------------------------------------
ISDN Service : isdnserv1
---------------------------------------------------------------------
ISDN Service : is152
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISDN Service Group
To configure a dial tone to use with the ISDN service group isdnserv1, that is taken from the
default ISDN tone package, when the GSX is emulating a euroIsdn switch and overlap
sending is in effect:
% CONFIGURE TONE PACKAGE default ADD TONE TYPE dial ..
TONE PROFILE default
% CONFIGURE ISDN SERVICE isdnserv1 SWITCHSIDE network
% CONFIGURE ISDN SERVICE isdnserv1 SWITCHTYPE euroIsdn
% CONFIGURE ISDN SERVICE isdnserv1 TONE PACKAGE default
% CONFIGURE ISDN SERVICE isdnserv1 DIAL TONE dial
To remove the overlap sending dial tone that was configured in the above example:
% CONFIGURE ISDN SERVICE isdnserv1 DIAL TONE NONE
To configure a confirmation tone to use with the ISDN service group isdnserv1, that is taken
from the default ISDN tone package:
% CONFIGURE TONE PACKAGE default ADD TONE TYPE ring ..
TONE PROFILE default
% CONFIGURE ISDN SERVICE isdnserv1 TONE PACKAGE default
% CONFIGURE ISDN SERVICE isdnserv1 CONFIRMATION TONE ring
To remove the confirmation tone that was configured in the above example:
% CONFIGURE ISDN SERVICE isdnserv1 CONFIRMATION TONE NONE
To create BSERVICE BchService and DSERVICE DchService and assign B-channels 5 and 22
to trunk group tg1 using those services:
Assign an interface to the dchannel service, and enable the service and the interface:
% CREATE ISDN INTERFACE SERVICE DchService INTERFACE 0
% CONFIGURE ISDN INTERFACE SERVICE DchService INTERFACE 0 PORT port15-3
% CONFIGURE ISDN SERVICE DchService STATE enabled
% CONFIGURE ISDN INTERFACE SERVICE DchService INTERFACE 0 STATE enabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Service Group CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISDN Service Group
ISDN Interface
This object binds a T1 or E1 span to an ISDN service and assigns it a number. For an NFAS
service group, up to 28 spans may be assigned, depending on the configuration of the D-channel
(see "Adding an ISDN NFAS Group" on page 6–105). These spans may occupy an interface
range of 0-28.
Command Syntax
Command Parameters
Field
Parameter Length Description
servicename 1-23 The name of the ISDN service to which this ISDN Interface is
linked.
interface N/A The Q.931 interface identifier. Must be 0-27 or 1-28.
port 1-23 The automatically created (and possibly changed) name of the T1
or E1 span that is assigned to the ISDN Interface.
mode N/A Operation(s) that may be applied to the interface:
• restart - restart the interface (not currently supported).
admin-state N/A The administrative state of this ISDN interface:
• disabled (default) - Not activated, able to be reconfigured or
deleted.
• enabled - Activated, available for immediate use.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Service Group CLI Reference
Command Example
To create, configure, and enable ISDN Interface 0, binding T1 span T1-1-3-1 to ISDN service
isdnserv1:
To create, configure, and enable ISDN Interfaces 1-4, binding T1 spans T1-1-3-2, T1-1-3-3,
T1-1-3-4, and T1-1-3-5 to ISDN service isdnserv2 (in effect, forming the basis of a four
member ISDN NFAS service group):
% CREATE ISDN INTERFACE SERVICE isdnserv2 INTERFACE 1
% CONFIGURE ISDN INTERFACE SERVICE isdnserv2 INTERFACE 1 PORT T1-1-3-2
% CREATE ISDN INTERFACE SERVICE isdnserv2 INTERFACE 2
% CONFIGURE ISDN INTERFACE SERVICE isdnserv2 INTERFACE 2 PORT T1-1-3-3
% CREATE ISDN INTERFACE SERVICE isdnserv2 INTERFACE 3
% CONFIGURE ISDN INTERFACE SERVICE isdnserv2 INTERFACE 3 PORT T1-1-3-4
% CREATE ISDN INTERFACE SERVICE isdnserv2 INTERFACE 4
% CONFIGURE ISDN INTERFACE SERVICE isdnserv2 INTERFACE 4 PORT T1-1-3-5
% CONFIGURE ISDN INTERFACE SERVICE isdnserv2 INTERFACE 1 STATE enabled
% CONFIGURE ISDN INTERFACE SERVICE isdnserv2 INTERFACE 2 STATE enabled
% CONFIGURE ISDN INTERFACE SERVICE isdnserv2 INTERFACE 3 STATE enabled
% CONFIGURE ISDN INTERFACE SERVICE isdnserv2 INTERFACE 4 STATE enabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISDN Service Group
ISDN B-channel
This object specifies and manipulates the B-channels that make up the ISDN Interface. Operations
can be applied to individual channels or to groups of channels.
B-channels are initially brought into service with RESTART messages. The far end must respond
with RESTART_ACK for the B-channel to be considered in service.
• outOfService
• maintenance
• inService
A B-channel is available for making calls when both the near end and the far end of the channel are
ready. This condition is revealed by the SHOW ISDN BCHANNEL SERVICE .. STATUS command
(see the command examples that follow). In this SHOW screen, the value of Local Admn, Local
Hdwr, and Remote must all be IS. In order to achieve this near and far end status on a B-channel:
• The operational state of the ISDN service group to which it belongs must be inService.
• The operational state of the Trunk Group to which the above service group belongs must be
inService.
• The primary or backup D-channel of the above service group must be inService.
• The T1 span that contains the B-channel must be in operational state inService.
• The far end must respond to the RESTART message with a RESTART_ACK message.
• If BCAS is enabled (see "ISDN Service" on page 3–916), the SERVICE message handshake
must be successfully completed.
The conventions for changing the operational state of one or more B-channels on an ISDN
Interface are:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Service Group CLI Reference
TABLE 3–184
From
(operational
state) Changing to (operational state)
outOfService maintenance inService
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISDN Service Group
TABLE 3–184
From
(operational
state) Changing to (operational state)
outOfService maintenance inService
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Service Group CLI Reference
TRUNK MEMBER
You may use the TRUNK MEMBER parameter to uniquely identify each circuit within the trunk
group. This number is used in accounting records.
You may assign a number or range of numbers between 0 and 65535. The GSX software maintains
a list of available trunk member numbers for every trunk group. If a valid trunk member, or a range
of trunk members, is specified, the GSX software will complete the assignment and remove these
numbers from the free list. If the specified number or range of numbers is not available, the
CONFIGURE command will return an error. If no TRUNK MEMBER is specified, the value 65536 is
assigned to the trunk member. This value is displayed as UNSET in the SHOW .. ADMIN screen.
You may release one or more TRUNK MEMBERs within a trunk group by specifying TRUNK MEMBER
UNSET on that BCHANNEL or range of BCHANNELs.
Command Syntax
NOTE
The commands below affect a specific B-channel.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISDN Service Group
TIMEOUT timeout
CONFIGURE ISDN BCHANNEL SERVICE servicename ..
INTERFACE interface
BCHANNEL bchannel
BCHANNEL operation
CONFIGURE ISDN BCHANNEL SERVICE servicename ..
INTERFACE interface
BCHANNEL bchannel
STATE admin-state
NOTE
The commands below affect a group of B-channels.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Service Group CLI Reference
NOTE
The SHOW commands display either one specific channel or all channels.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISDN Service Group
Command Parameters
Field
Parameter Length Description
servicename 1-23 The name of the ISDN service to which the designated
B-channels are bound.
dservicename 1-23 The name of the ISDN D channel service to which the
INTERFACE is being assigned.
bservicename 1-23 The name of the ISDN B channel service to which the
designated B-channels are assigned.
interface N/A The number of the ISDN Interface that contains the
designated B-channels. Must be 0-20.
bchannel N/A A single B-channel number. Must be in the range 1-23.
bchannelrange N/A A set of B-channels. Must be one or more ranges of B-
channels within the overall range 1-23, as discussed
below.
All CLI ranges specify a comma-separated list of
numbers and/or ranges. A range consists of two
numbers separated by a dash, for example, 5-8. An
increment can be specified after a range with the
notation, +<incr>, for example 4-10+2. No spaces are
permitted in the expression. All values and ranges must
be in numerically ascending order. Thus the expression:
1,3,5,8-12+2,14-16
is a valid range specification for the numbers:
1,3,5,8,10,12,14,15, and 16.
circuitprofilename 1-23 The name of the Circuit Service Profile that you are
applying to the designated B-channels.
direction N/A The direction of traffic allowed on the designated B-
channel(s):
• twoWay - accept all calls
• oneWayIn - accept only inbound calls
• oneWayOut - accept only outbound calls
tmember-no N/A A number that uniquely identifies this circuit endpoint
within the trunk group. The GSX software maintains a
list of available trunk member numbers for every trunk
group. The trunk member number that is assigned to the
BCHANNEL number must be available. Must be 0-65535.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Service Group CLI Reference
Field
Parameter Length Description
tmember-rng N/A A range of numbers with a one-to-one correspondence
to the BCHANNEL range that uniquely identifies the
circuit endpoints within the trunk group. The GSX
software maintains a list of available trunk member
numbers for every trunk group. The size of the range
must equal the size of the BCHANNEL range and each
member of the range must be available. Must be 0-
65535.
All CLI ranges specify a comma-separated list of
numbers and/or ranges. A range consists of two
numbers separated by a dash, for example, 5-8. An
increment can be specified after a range with the
notation, +<incr>, for example 4-10+2. No spaces are
permitted in the expression. All values and ranges must
be in numerically ascending order. Thus the expression:
1,3,5,8-12+2,14-16
is a valid range specification for the numbers:
1,3,5,8,10,12,14,15, and 16.
oper-state N/A The operational state of the designated B-channel(s):
• outOfService - All channels out of service.
• maintenance - All channels out of service, in
maintenance mode.
• inService - All channels active and in service.
action N/A The method by which active calls on the designated
channels are processed when oper-state goes to
outOfService from inservice:
• dryup - All calls are allowed to complete until
TIMEOUT expires, when they are dropped.
• force - All calls are dropped immediately.
timeout N/A The time (in minutes) to wait to place the B-channel in
the outOfService or maintenance operational state.
Must be 1-1440. (An indefinite dryUp time can only be
directed by omitting ACTION in the command.)
operation N/A An operation to be applied to the designated B-
channel(s):
• restart - Restart the B-channel.
admin-state N/A The administrative state of the designated B-channel(s):
• disabled (default) - Not activated, able to be re-
configured.
• enabled - Active.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISDN Service Group
Command Example
To configure, activate, and put into service the 23 B-channels using ISDN service isdnserv1 on
ISDN Interface 0:
% CONFIGURE ISDN BCHANNEL SERVICE isdnserv1 INTERFACE 0 ..
BCHANNEL 1-23 CIRCUITPROFILENAME default DIRECTION twoWay
% CONFIGURE ISDN BCHANNEL SERVICE isdnserv1 INTERFACE 0 ..
BCHANNEL 1-23 STATE enabled
% CONFIGURE ISDN BCHANNEL SERVICE isdnserv1 INTERFACE 0 ..
BCHANNEL 1-23 MODE inService
To reconfigure channels 20-23 to oneWayIn, allowing 5 minutes for any active calls to complete:
To display the status of the B-channels using Interface 0 on ISDN service isdnserv1:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Service Group CLI Reference
ISDNSERV1 0 13 IDLE IS IS IS
ISDNSERV1 0 14 IDLE IS IS IS
ISDNSERV1 0 15 IDLE IS IS IS
ISDNSERV1 0 16 IDLE IS IS IS
ISDNSERV1 0 17 IDLE IS IS IS
ISDNSERV1 0 18 IDLE IS IS IS
ISDNSERV1 0 19 IDLE IS IS IS
ISDNSERV1 0 20 IDLE IS IS IS
ISDNSERV1 0 21 IDLE IS IS IS
ISDNSERV1 0 22 IDLE IS IS IS
ISDNSERV1 0 23 IDLE IS IS IS
In the example above, the Usage field shows the call state. A Remote field of RESTARTING
indicates waiting for the RESTART_ACK message. A Remote field of RESTARTERR indicates the
far end failed to respond.
To display the configuration of B-channel 23 using Interface 0 on ISDN service isdnserv1:
% SHOW ISDN BCHANNEL SERVICE isdnserv1 INTERFACE 0 BCHANNEL 23 ADMIN
Node: TPUBS Date: 2003/08/27 16:06:24 GMT
Zone: GMTMINUS05-EASTERN-US
Trunk
ISDN Service Int Ch Membr Circuit Profile Direct State Mode
-------------- --- -- ----- --------------- ------- ------- ------
ISDNSERV1 0 23 UNSET default TWOWAY ENABLED INSERVICE
To configure, activate, and put into service B-channel 1 as trunk member 100 using ISDN service
isdnserv1 on ISDN Interface 0:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference ISDN Service Group
Trunk
ISDN Service Int Ch Membr Circuit Profile Direct State Mode
-------------- --- -- ----- --------------- ------- ------- ------
ISDNSERV1 0 1 100 default TWOWAY ENABLED INSERVICE
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Show Alarms CLI Reference
Show Alarms
The SHOW ALARMS commands allow you to examine system resources to look for conditions that
warrant immediate attention and action. The commands available are:
NOTE
When issuing SHOW ALARMS commands on a GSX4000 series switch, omit the
SHELF parameter.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Show Alarms
The SHOW ALARMS SUMMARY command (which requires a user confirmation) indicates all
resources that may have an alarm condition. For example, the following results,
% SHOW ALARMS SUMMARY
This command may take several seconds to complete, continue? - Confirm
(y/n): y
Node: TPUBS Date: 2001/02/13 18:02:49 GMT
Zone: GMTMINUS05-EASTERN-US
Subsystem Alarm
Node X
NFS -
Event Log -
ST -
Trunk Group -
Gateway Signaling -
NIF -
T1 X
E1 -
DS3 -
NTP Server -
Softswitch -
ISUP Service -
ISUP Circuit -
Media Gateway -
ISDN Service -
ISDN BChannel -
Shelf: 1
B power: ABSENT
% SHOW ALARMS T1
This command may take several seconds to complete, continue? - Confirm
(y/n): y
Node: TPUBS Date: 2001/02/13 18:09:33 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Announcements CLI Reference
Announcements
Announcements
The SHOW ANNOUNCEMENTS commands display announcement segment memory usage for the
GSX. Each CNS server that generates announcements stores announcement segments in local
CNS memory. These commands monitor that memory’s utilization. The SHOW ANNOUNCEMENT
MEMORY SUMMARY command applies to the GSX9000 only.
Command Syntax
NOTE
When issuing ANNOUNCEMENT commands on a GSX4000 series switch, omit the
SHELF and SLOT parameters.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Announcements
Command Parameters
Field
Parameter Length Description
location N/A Specifies the storage location of the announcement files:
• nfsServer - announcement files are stored on the NFS (DSI
Level 0) server.
• localDisk - announcement files are stored on the local disk.
The default is the current value of the Book Disk location in the
NVS.
Note: This parameter only applies to GSX switches with local
disks on Management Server Modules.
directory 1-63 Specifies the directory off the NFS mount point at which to access
announcement files. The default value is <LoadPath>/
announcements where the LoadPath (or Boot Path) is in
current location of the Load Path in the NVS.
shelfnumber N/A The shelf number in the GSX node configuration. In this release,
one shelf is supported. Must be 1.
Note: This parameter does not apply to GSX4000 series switches.
slotnumber N/A The slot number occupied by the CNS module for which
announcement memory is being accessed. This number must be
3-16.
Note: This parameter does not apply to GSX4000 series switches.
segmentid N/A The announcement ID used to access the file by the PSX and to
name the .wav file in the GSX System Tree. Must be 0-65535.
Command Example
To display the summary of memory usage on all CNS modules in the shelf:
% SHOW ANNOUNCEMENT MEMORY SUMMARY
Node: TPUBS Date: 2000/05/11 22:21:00 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Announcements CLI Reference
Segments Loaded: 4
Memory Utilization: 3%
To display the file status of all announcement segments that have been loaded:
% SHOW ANNOUNCEMENT SEGMENT SUMMARY
Node: TPUBS Date: 2000/05/11 22:36:38 GMT
Zone: GMTMINUS05-EASTERN-US
SegId: 32
Version: 1
NFS Path: SPIRIT/announcements/preload/s32.wav
Bytes: 8004
Seconds: 1.0
Preload: TRUE
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Announcements
-----------------------------------------------
ANNOUNCEMENT CONFIGURATION
-----------------------------------------------
Disk: NFSSERVER
Directory: TPUBS/announcements
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Announcements CLI Reference
Announcement Package
The ANNOUNCEMENT PACKAGE object combines related announcements and maps the Segment
ID of each unique announcement (.wav file) to an announcement name. An announcement name
may be used by a signaling group (SIP, H.323, ISDN, and so on) to direct an announcement to a
particular leg of a call. Announcements may be combined by underlying language or other criteria
into an ANNOUNCEMENT PACKAGE. Once you create and configure this set of announcements on
the GSX, you may perform a PSX configuration sequence to assign it to a particular trunk group.
Subsequent call routes passed to the GSX from the PSX will include an ANNOUNCEMENT
PACKAGE index as well as a trunk group to use for a call leg. You must assure that the
ANNOUNCEMENT PACKAGE index that you configure on the PSX matches the actual
ANNOUNCEMENT PACKAGE IDENTIFIER that you configure on the GSX for this facility to
properly direct the GSX software to the intended announcements.
The ADD ANNOUNCEMENT parameter builds the underlying ANNOUNCEMENT PACKAGE, linking
each announcement name to a Segment ID. The DELETE ANNOUNCEMENT parameter removes an
announcement from an announcement package. The DELETE command removes an entire
announcement package. SHOW commands allow the display of all configured announcement
packages or of a specific announcement package.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Announcements
Command Parameters
Field
Parameter Length Description
package 1-23 The name of the announcement package that is being created,
configured, or deleted. For network documentation consistency,
Sonus recommends that the GSX PACKAGE name also match the
PSX package name.
The default announcement package is auto created and cannot
be deleted.
identifier N/A The numeric ID (or Package Identifier) of the announcement
package. This number must match the announcement package
index that is assigned at the PSX. Must be 0-65535.
This value can be assigned when the announcement package is
created, or subsequently when it is configured. You cannot assign
one Package Identifier to multiple announcement packages.
The default announcement package always takes the value 1,
which cannot be changed.
segmentid N/A The announcement ID used to access the .wav file by the GSX in
the GSX System Tree. Must be 0-65535.
announcement 1-23 The name of an announcement. Names may be used by some
signaling groups to designate announcements. Internally, the GSX
software maps the announcement name to SEGMENT ID.
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Announcements CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Call and Performance Statistics
These commands display statistics pertaining to call and trunk group activity.
Call Counts
The SHOW CALL COUNTS commands allow you to examine and reset the GSX accumulated call
statistics. Summary and/or detailed statistics are available. Statistics may be requested by call, by
CNS module, by shelf, or by node.
NOTE
Currently, each inservice ISDN D-channel is counted as an active, stable call in
these statistics.
The SHOW CALL DETAIL .. commands display respectively the ingress and egress characteristics
of the call. Circuit-to-Circuit calls display DSP information such as echo canceller settings, signal
energy levels, and audio type values on both sides of the call. Circuit-to-Packet calls display the
DSP information for the circuit side of the call and the packet side parameters such as the
configured audio CODEC from the Packet Service Profile, the actual audio CODEC currently in
use for the call, and other IP parameters, including information on IP Loopback for IXP IP looped
legs. The actual CODEC may differ from the configured CODEC if the GSX software detects
FAX or modems and thus switches from a compression CODEC to G.711 or T.38. These
commands provide a breakdown of individual call treatments.
Packet-to-packet calls will have a set of RTP statistics for both their ingress and egress legs.
If a switchover occurs and a redundant CNS module becomes the active module, the call statistics
will still be displayed for the slot number of the client module (the module that was originally
active).
Command Syntax
NOTE
When issuing CALL commands on a GSX4000 series switch, omit the SHELF and
SLOT parameters.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call and Performance Statistics CLI Reference
NOTE
The RESET commands below differ depending on your switch type.
Among the call detail information that is displayed by one or more of the above commands is:
Statistic Description
Bearer Type The signaling bearer type on the call’s ingress or egress circuit :
• voice
• 3.1K Hz
• 64K Data
• 56K Data
• D Channel
Fax Or Modem Indicates that a fax or modem tone was detected by the VPAD on the
Detected call’s ingress or egress circuit:
Echo Canceller Status The echo canceller status on the call’s ingress or egress circuit:
• ENABLED
• DISABLED
• NONE - this call leg is serviced by a CNS31, or the call does not go
out a circuit interface (such as a call that played an announcement to
the IP leg and terminated)
Actual Echo Canceller The four status bits returned by the echo canceller.
Status
Tx Level The Circuit Service Profile setting for the Tx Level on the call’s ingress or
egress circuit:
• NONE
• HLC (High Level Compensation)
• fixed gain
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Call and Performance Statistics
Statistic Description
Rx Level The Circuit Service Profile setting for the Rx Level on the call’s ingress
or egress circuit:
• NONE
• fixed gain
Tx Gain The Circuit Service Profile settings (in dB) for Tx and Rx Gain on the
call’s ingress or egress circuit.
Rx Gain
Energy Level SendIn The measurement of signal energy (in dBM0s) coming in from the PSTN
to the echo canceller’s Send In input before echo cancellation and fixed
gain are applied, on the call’s ingress or egress circuit. This is the energy
on the PSTN line.
Main EC Reflector The location (in milliseconds) of the largest reflector that causes an
echo, on the call’s ingress or egress circuit. Not valid unless the echo
canceller is converged.
Energy Level The measurement of signal energy (in dBM0s) coming in from the
ReceiveIn Packet side to the echo canceller’s Receive Out input before fixed gain
or HLC is applied (if it is enabled). This is the energy of the signal that
will be sent back to the PSTN.
Echo Return Loss The measurement of the echo loss (in dB) due to the analog hybrid. Not
valid unless the echo canceller is converged.
Echo Return Loss The measurement of the extra attenuation (in dB) the GSX echo
Enhancement canceller adds to the Echo Return loss. Small values indicate that the
echo canceller is not converged.
Echo Max Tail The tail length (in milliseconds) that the echo canceller can handle. This
is 96 milliseconds for CNS10, CNS20, CNS25, CNS30, CNS40, CNS45,
CNS81, CNS85 and 128 milliseconds for CNS60, CNS71, CNS81, and
CNS86 .
Audio Type The configured value from the Circuit Service Profile.
Actual Audio Type The actual value used for the call after negotiating with the far end
switch; derived from the VPAD.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call and Performance Statistics CLI Reference
Command Parameters
Field
Parameter Length Description
shelfnumber N/A The shelf number in the GSX node configuration. In this release,
one shelf is supported. Must be 1.
Note: This parameter does not apply to GSX4000 series switches.
slotnumber N/A The slot number occupied by the CNS module for which call
statistics are being accessed. This number must be 3-16.
For a module that is part of a redundancy group, give the slot
number of the client module, even if the redundant module is
active. The call statistics will only be displayed for the slot number
of the client module.
Note: This parameter does not apply to GSX4000 series switches.
callID N/A The internal index of the call on the CNS or GNS module.This
integer, along with the CNS/GNS module designation
(slotnumber) uniquely identifies the call within the GSX.
gcidtext N/A The Global Call ID string by which every call is tracked throughout
its existence. This hex integer is unique within the GSX node.
over N/A The number of minutes that a call was active, after it was
answered. Calls that are equal to or exceed this duration are
selected for call detail viewing.
tgroup 1-23 The name of the trunk group to search for calls that were active for
a minimal duration.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Call and Performance Statistics
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call and Performance Statistics CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Call and Performance Statistics
To display the call detail summary for an individual call with a GCID of 2 that has its egress leg IP
looped with the ingress leg of a call with a GCID of 3:
% SHOW CALL DETAIL GCID 2
Node: TPUBS Date: 2006/07/27 14:20:53 GMT
Zone: GMTMINUS05-EASTERN-US
Detailed Call Data
Gcid: 2 Calling Party: 9786141003
Shelf: 1 Called Party: 4681127082
Slot: 1 Call Translation: NONE
Call Id: 3 Orig Called Party:
Call Type: SIMPLE
Assoc. GCID/Legs: /0,0/0,0/0,0/0,0/0,0/0
Scenario: SS7_TO_SIP
State: Stable
Call Duration: 14 seconds
Ingress Channel Data
Slot: 1 Port: 1 Channel: 1
Trunk Group: MAGPIE-MABEL-SS765 Serv. Profile: default
Egress Channel Data
Local IP Address: 10.7.8.230 Remote IP Address: 10.7.8.230
Dest. GW Name: 10.7.6.40
IP Loop Assoc. GCID/Leg Id: 3/0
RTCP Channel Data
Packets Sent: 1086 Octets Sent: 86880
Packets Received: 540 Octets Received: 86400
Packets Lost: 0 Packets Discarded: 0
Jitter (ms): 0 Latency (ms): 0
ATM Cell Data
Cells Sent: 0 Cells Lost: 0
Cells Received: 0 Cells Discarded: 0
Buffer Underflows: 0 Parity Check Failures: 0
Buffer Overflows: 0 Cells Out Of Sequence: 0
CRC Violations: 0 Cell Delay Variation: 0
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call and Performance Statistics CLI Reference
To display the call detail summary for an individual call with a GCID of 55B555 that has its egress
leg IP looped with the ingress leg of a call with a GCID of 20F0006:
% SHOW CALL DETAIL GCID 55B555 FULL MEDIA
Node: TPUBS Date: 2006/09/28 14:12:33 GMT
Zone: GMTMINUS05-EASTERN-US
Detailed Call Data
Gcid: 55B555 Calling Party: 2142176000
Shelf: 1 Called Party: 8191212012
Slot: 12 Scenario: SIP_TO_SS7
Call Id: 16408 State: Stable
Call Type: SIMPLE
Assoc. GCID/Legs: 0/0,0/0,0/0,0/0,0/0,0/0
Call Duration: 12 seconds
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Call and Performance Statistics
To display the call detail summary and the GSX software resource usage summary for an
individual circuit to circuit call:
% SHOW CALL DETAIL GCID 50011 FULL
Node: TPUBS Date: 2001/02/26 18:35:52 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call and Performance Statistics CLI Reference
To display the call detail summary and the ingress and egress media usage/setting detail for an
individual circuit to circuit call:
% SHOW CALL DETAIL GCID 3080001 FULL MEDIA
Node: TPUBS Date: 2002/12/18 15:28:07 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Call and Performance Statistics
To display the call detail summary and the ingress and egress media usage/setting detail for a
packet to circuit call using G729AB:
% SHOW CALL DETAIL GCID 7000b FULL MEDIA
Node: TPUBS Date: 2003/01/17 16:54:56 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call and Performance Statistics CLI Reference
To display the call detail summary and the ingress and egress media usage/setting detail for a
circuit to packet call using G729AB:
% SHOW CALL DETAIL GCID d001b FULL MEDIA
Node: TPUBS Date: 2003/01/17 16:56:41 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Call and Performance Statistics
To display the call detail summary and the ingress and egress media usage/setting detail for a
packet-to-packet call:
% SHOW CALL DETAIL GCID 1c02c00e full media
Node: TPUBS Date: 2006/09/06 15:32:36 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call and Performance Statistics CLI Reference
To display the call detail summary and the GSX software resource usage summary for an
individual packet-to-packet call:
% SHOW CALL DETAIL GCID 1c02e022 FULL
Node: TPUBS Date: 2006/09/06 15:37:14 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Call and Performance Statistics
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call and Performance Statistics CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Call and Performance Statistics
Performance Statistics
NOTE
The current performance statistics are invalid until the start of the first 15 minute
interval, or whenever the node is initially powered on, or when a new CNS module
is inserted. The current statistics are also rendered invalid by a CNS or MNS
switchover on a GSX9000, a GNS switchover on GSX4000 series switch, or an NTP
update to adjust the GSX clock by more than 10 seconds. Whenever you explicitly
configure INTERVAL SIZE or NUMBER OF INTERVALS, the current interval is
invalidated.
Statistic Description
Inbound Usage The sum of call-seconds on every inbound channel in the trunk group.
Outbound Usage The sum of call-seconds on every outbound channel in the trunk group.
Inbound Completed The sum of normal call completions (answered calls) on every inbound
Calls channel in the trunk group.
Outbound Completed The sum of normal call completions (answered calls) on every outbound
Calls channel in the trunk group.
Inbound Call Attempts The sum of call initiations on every inbound channel in the trunk group.
Outbound Call The sum of call initiations on every outbound channel in the trunk group.
Attempts
Maximum Active Calls The high water mark of seized channels in either direction on the trunk
group. This statistic accounts for calls that are setting up, stable, or
tearing down. This number cannot exceed the total number of channels
in the trunk group.
Call Setup Time The sum of call-setup time in hundredths of seconds on every channel in
the trunk group.
Calls Setup The number of calls setup in both directions.
Routing Attempts The number of routing requests on the trunk group.
Inbound Bandwidth The sum of bandwidth usage (expected data rate in Kbits per second
Usage multiplied by call duration in seconds) for every inbound call associated
with the trunk group.
Outbound Bandwidth The sum of bandwidth usage (expected data rate in Kbits per second
Usage multiplied by call duration in seconds) for every outbound call associated
with the trunk group.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call and Performance Statistics CLI Reference
Statistic Description
Maximum Active The high water mark of bandwidth (bits/second) used in either direction
Bandwidth associated with the trunk group.
Calls with Packet The number of calls with a maximum packet outage whose duration
Outage exceeds the configured minimum for the trunk group
Calls with Packet The number of calls whose maximum packet outage occurs at the end of
Outage at End the call for the trunk group. This is an indication that the call may have
been terminated because of poor quality.
Total Packet Outage The summation of all packet outage durations (in milliseconds) whose
duration exceeds the configured minimum, which is experienced during
the current performance interval for the trunk group. The average packet
outage duration can be calculated by dividing this field by the number of
calls reporting packet outages.
Maximum Packet The single longest maximum reported packet outage duration (in
Outage milliseconds) experienced during the current performance interval for the
trunk group.
Packet Outages The number of Packet Outage Detection (POD) events detected for the
Detected trunk group. A POD event occurs when a configurable number of calls
experience a packet outage with duration exceeding a programmable
threshold.
Calls with Good Number of calls with all sub-intervals reporting GOOD playout buffer
Playout Quality quality for the trunk group.
Calls with Acceptable Number of calls with all sub-intervals reporting ACCEPTABLE or better
Playout Quality playout buffer quality for the trunk group
Calls with Poor Playout Number of calls with all sub-intervals reporting POOR or better playout
Quality buffer quality for the trunk group.
Calls with Number of calls with at least one sub-interval reporting
Unacceptable Playout UNACCEPTABLE playout buffer quality for this trunk group
Quality
Inbound COT Attempts The number of inbound continuity tests attempted.
Outbound COT The number of outbound continuity tests attempted.
Attempts
COT Completed The number of successful continuity tests.
Successfully
COT Failed The number of failed continuity tests.
COT Aborted The number of aborted continuity tests
Glare Encountered The number of calls on a trunk group that encountered glare.
Glare Inbound Blocked The number of ingress calls on a trunk group that were blocked due to
glare.
Glare Outbound The number of egress calls on a trunk group that were blocked due to
Blocked glare.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Call and Performance Statistics
You should observe the Failure Statistics to discern any recurrent problems on any trunk. A
steadily incrementing count in one Failure category may indicate such a problem. Table 3–191
provides additional detail about the Failure causes that are displayed.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call and Performance Statistics CLI Reference
NOTE
The “Routing Failures” categories are intermediate failures that are incremented
on an unsuccessful attempt to route to an egress trunk group. Such an
intermediate failure may either precede a successful rerouting of a call that
completes normally or it may precede a rerouting attempt that terminates with one
of the prior Failure Causes.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Call and Performance Statistics
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call and Performance Statistics CLI Reference
Command Parameters
Field
Parameter Length Description
intervalsize N/A The length of the interval for which performance statistics are
being sought, in minutes. Must be 5-1440 (minutes), default is
15.
numintervals N/A The number of intervals of length INTERVAL SIZE for which
performance statistics are being sought. Must be 1-288
(intervals), default is 4.
INTERVAL SIZE times NUMBER OF INTERVALS must be less
than or equal 1440 (minutes).
trunkgrp 1-23 The name of the trunk group for which performance statistics
are sought.
interval N/A A number that identifies the interval for which performance
statistics are sought. The number 1 selects the most recent
interval, the number 2 selects 2 intervals ago, and so on. Must
be 1-288.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Call and Performance Statistics
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call and Performance Statistics CLI Reference
To display the historical performance statistics of trunk group hammDS3in from 2 intervals ago:
% SHOW INTERVAL PERFORMANCE TRUNK GROUP hammDS3in2 INTERVAL 2 STATISTICS
Node: TPUBS Date: 2004/09/02 13:45:31 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Call and Performance Statistics
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call and Performance Statistics CLI Reference
Command Syntax
Table 3–193 provides additional detail about the statistics displayed by one or more of the above
commands.
Statistic Description
Calls Cancelled due The number of calls cancelled due to the implementation of Selective
to SILC Incoming Load Controls (SILC) on the gateway.
Calls Cancelled due The number of calls cancelled due to the implementation of Selective Trunk
to STR Reservation (STR) controls on the gateway.
Calls Skipped due The number of calls skipped due to the implementation of STR SKIP
to STR controls on the gateway.
Calls Skipped due The number of calls skipped due to the implementation of SKIP controls on
to SKIP the gateway.
Calls Cancelled due The number of calls cancelled due to the implementation of Cancel To
to CANT (CANT) controls on the gateway. CANT controls determine whether the
system cancels a portion of the calls to the specified trunk group on either a
percentage or call gap basis.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Call and Performance Statistics
Statistic Description
Calls Cancelled due The number of calls cancelled due to the implementation of Cancel From
to CANF (CANF) controls on the gateway. CANF controls determine whether the
system cancels a portion of the calls from the specified trunk group on
either a percentage or call gap basis.
Calls Cancelled due The number of calls cancelled due to the implementation of Automatic
to ACC Congestion Controls (ACC) on the gateway.
Calls Skipped due The number of calls skipped due to the implementation of Automatic
to ACC Congestion Controls (ACC) on the gateway.
Routing Failures No The number of outbound routing failures due to NO UNRESERVED
Unreserved Circuits CIRCUITS AVAILABLE.
Inbound No The number of inbound routing failures due to NO UNRESERVED
Unreserved CIRCUITS AVAILABLE
Circuits
Re-Route Attempts The number of calls where a re-route was attempted due to the
due to IRR implementation of Immediate Reroute (IRR) controls on the gateway.
Re-Route Attempts The number of calls where a re-route was attempted due to the
due to SIRR implementation of Spray Immediate Reroute (SIRR) controls on the
gateway.
Re-Route Attempts The number of calls where a re-route was attempted due to the
due to ORR implementation of Overflow Reroute (ORR) controls on the gateway.
Re-Route Attempts The number of calls where a re-route was attempted due to the
due to SORR implementation of Spray Overflow Reroute (SORR) controls on the
gateway.
Successful Re- The number of calls where an attempted re-route was successful due to the
Routes due to IRR implementation of Immediate Reroute (IRR) controls on the gateway.
Successful Re- The number of calls where an attempted re-route was successful due to the
Routes due to SIRR implementation of Spray Immediate Reroute (SIRR) controls on the
gateway.
Successful Re- The number of calls where an attempted re-route was successful due to the
Routes due to ORR implementation of Overflow Reroute (ORR) controls on the gateway.
Successful Re- The number of calls where an attempted re-route was successful due to the
Routes due to implementation of Spray Overflow Reroute (SORR) controls on the
SORR gateway.
Command Parameters
Field
Parameter Length Description
trunkgrp 1-23 The name of the trunk group for which traffic statistics are sought.
interval N/A A number that identifies the interval for which traffic statistics are
sought. The number 1 selects the most recent interval, the number
2 selects 2 intervals ago, and so on. Must be 1-12.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call and Performance Statistics CLI Reference
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Call and Performance Statistics
RTCP
The GSX Real Time Control Protocol (RTCP) implementation creates an RTCP session using the
same IP address and next available port as used by Real Time Protocol (RTP). The RTCP statistics
for individual calls may be displayed through the SHOW CALL COUNTS commands (see "Call
Counts" on page 3–968).
This RTCP implementation also supports traps that alert the Network Control Center (NCC) of the
following conditions:
• A measured RTP packet loss exceeds the configured threshold, indicated by a packet loss
threshold exceeded trap
• RTP or RTCP packets are absent for a configured period of time, resulting in a loss of “bearer
channel connectivity”, indicated by a peer absence trap
When the Sonus PSX manages calls, these thresholds are assigned in the Packet Service Profile
passed to the GSX from the PSX. When an MGCP softswitch manages calls, these thresholds are
assigned in the default Packet Service Profile and the RTCP administrative object described in this
section. See the examples below for more detail on the softswitch model.
RTCP instances running on the CNS modules generate these SNMP traps.
Because sudden network disruptions could result in the GSX generating bursts of SNMP traps, the
RTCP instance consolidates trapable events into one trap that enumerates these events to avoid
flooding the SNMP management platform. Fifteen seconds after an RTCP instance detects the last
occurrence of packet loss or peer absence, it generates an SNMP trap to alert the NCC that the
offending event has been cleared.
In the command syntax described below, the LOSS TABLE may be configured to contain one entry
for each IP connection, or link, that experiences sufficient packet loss to cause the corresponding
trap to be generated; the ABSENCE TABLE may be similarly configured to contain one entry for
each IP connection that experiences peer absence or loss of bearer plane connectivity for two or
more SRINTERVALs, causing the corresponding trap to be generated. This trap is defined as loss of
RTP packets and loss of RTCP packets.
The table contents may be displayed by the SHOW commands described below. The fields that are
displayed are shown in Table 3–195.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call and Performance Statistics CLI Reference
Initially this table contains 0 ENTRIES. If you do not configure a positive ENTRIES value, you will
never see any RTCP trap table output from the SHOW commands. (If this occurs when you know
that traps are being generated, configure the number of desired ENTRIES and RESET the table.)
Once configured, the ENTRIES remain in the tables indefinitely. If a table is fully populated and an
IP connection that is not represented in the table experiences a packet loss/peer absence trap
condition, that information will overwrite the oldest table entry that is in the FALSE state.
The RESET command clears every configured table entry. You will lose all previous trap
information, while providing table slots for new trap history on as many IP connections as there
are ENTRIES in the table.
Command Syntax
NOTE
When issuing RTCP commands on a GSX4000 series switch, omit the SHELF and
SLOT parameters.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Call and Performance Statistics
Command Parameters
Field
Parameter Length Description
shelf N/A The shelf number in the GSX node configuration. In this release,
one shelf is supported. Must be 1.
Note: This parameter does not apply to GSX4000 series switches.
cnsslot N/A The slot number occupied by the CNS module for which RTCP
statistics are being accessed. This number must be 3-16.
Note: This parameter does not apply to GSX4000 series switches.
srinterval N/A The sender report packet transmission interval (in seconds).
Sender report packets are transmitted at this fixed interval.
Initially, bearer plane connectivity is present whenever an RTP or
RTCP packet is received within ESTABLISHMENT MULTIPLE of
these intervals. Subsequently, the RTP or RTCP packet must be
received within two of these intervals or a PEER ABSENCE ACTION
(see "Packet Service Profile" on page 3–690), may be taken.
(That is, a trap may be issued and the call may be released.)
Must be 2-31, default is 5 (seconds).
estmultiple N/A The number of SRINTERVALs to wait before starting bearer plane
connectivity checks. Subsequently these checks (if enabled)
occur at every two of these intervals. Receipt of a packet within
these boundaries suggests bearer plane connectivity. Must be 1-5,
default is 2 (SRINTERVALs).
lttentries N/A The number of entries to be provided in the Loss Table. Each IP
connection, or link, that experiences packet losses that result in
traps being generated causes a table entry to be appropriated.
Must be 0-50, default is 0 (entries).
The Packet Service Profile must be appropriately configured for
these traps to be generated. See "Packet Service Profile" on
page 3–690.
attentries N/A The number of entries to be provided in the Absence Table. Each
IP connection, or link, that experiences peer absences that result
in traps being generated causes a table entry to be appropriated.
Must be 0-50, default is 0 (entries).
The Packet Service Profile must be appropriately configured for
these traps to be generated. See "Packet Service Profile" on
page 3–690.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call and Performance Statistics CLI Reference
Command Example
To set up RTCP to issue traps whenever packet losses exceed 6000 packets per 100,000 packets,
while running with an MGCP softswitch that uses the default packet service profile:
% CONFIGURE PACKET SERVICE PROFILE default RTCP enabled ..
PACKET LOSS THRESHOLD 6000 PACKET LOSS ACTION trap
To set up RTCP to issue a trap and disconnect the call whenever bearer plane connectivity is lost,
while running with an MGCP softswitch that uses the default packet service profile:
% CONFIGURE PACKET SERVICE PROFILE default ..
RTCP enabled PEER ABSENCE ACTION trapAndDisconnect
% CONFIGURE RTCP SHELF 1 SRINTERVAL 6 ESTABLISHMENT MULTIPLE 3
NOTE
The configuration sequence above causes the initial bearer plane connectivity
check to be performed after 3 sender report packet intervals or 18 seconds.
Subsequent checks occur after 2 intervals or 12 seconds. If connectivity is lost for
this period, the trap will be issued and the call disconnected. If an RTP or RTCP
packet is received subsequently, the condition will be cleared (however the
impacted call will have already been disconnected).
NOTE
Transmission of RTCP sender report packets will be performed at 6 second
intervals.
To create an RTCP loss table and absence table for two IP connections:
% CONFIGURE RTCP SHELF 1 TRAP LOSS TABLE ENTRIES 2
% CONFIGURE RTCP SHELF 1 TRAP ABSENCE TABLE ENTRIES 2
To display the packet loss trap history for the CNS module in slot 10:
% SHOW RTCP SHELF 1 SLOT 10 TRAP LOSS TABLE
Node: TPUBS Date: 2001/04/25 15:47:33 GMT
Zone: GMTMINUS05-EASTERN-US
Packet loss history on shelf: 1 slot:10
Source IP Dest IP Total Cnt Cnt Start Time Last Time Act
--------------- --------------- --------- ------ -------------- ------------- -
10.7.10.115 10.7.10.116 19 4 04-19,16:20:18 04-19,16:20:33 T
10.7.10.126 10.7.10.199 8 3 04-19,16:20:20 04-19,16:20:30 F
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Call and Performance Statistics
To display the peer absence trap history for the CNS module in slot 10:
% SHOW RTCP SHELF 1 SLOT 10 TRAP ABSENCE TABLE
Node: TPUBS Date: 2001/04/25 15:47:33 GMT
Zone: GMTMINUS05-EASTERN-US
Packet loss history on shelf: 1 slot:10
Source IP Dest IP Total Cnt Cnt Start Time Last Time Act
----------- ----------- --------- ------ -------------- --------
10.7.10.115 10.7.10.116 19 4 04-19,16:20:18 04-19,16:20:33 T
10.7.10.126 10.7.10.199 8 3 04-19,16:20:20 04-19,16:20:30 F
------------------------------------------------------
RTCP Configuration: Shelf: 1
------------------------------------------------------
SR interval: 6
Establishment Multiple: 3
Entries in loss history table: 2
Entries in absence history table: 2
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus Optical Interface CLI Reference
These objects identify the optical interface that CNS71/CNA70/CNA07, and CNS81/CNS86/
CNA81/CNA08 modules in the GSX9000HD may use to access a Synchronous Optical Network
(SONET) Optical Carrier 3 (OC-3) or Synchronous Digital Hierarchy (SDH) Synchronous
Transport Module 1 (STM-1) network.
NOTE
The Sonus Optical Interface is not available on GSX4000 series switches in this
release.
The procedure below calls out the CLI objects that must be configured and the order for doing so.
Before you begin this procedure, make sure that all the hardware components of your operating
environment, including the SONET or SDH network, are properly connected and configured.
The object descriptions that follow provide additional detail for each of these steps.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus Optical Interface
Optical Interface
This object specifies either a SONET OC-3, or an SDH STM-1 optical interface on the CNA70 or
CNA81 port that supports an abutting CNS71 server module. This object is automatically created
when a CNS71/CNA70, CNS81/CNA81, or CNS86/CNA81 module combination is created by the
CREATE SERVER .. HWTYPE CNS71 .. command. This port is automatically deleted when any of
the same combination is deleted by the DELETE SERVER command. Except under these
circumstances, this object may not be created or deleted.
The NETWORK TYPE parameter casts the specified CNS71/CNA70, CNS81/CNA81, or CNS86/
CNA81 module set with either a SONET OC-3 or SDH STM-1 optical interface. In order to
change the NETWORK TYPE, you must DELETE, CREATE, and CONFIGURE the CNS71 SERVER.
The PAYLOAD MAPPING parameter defines the payload mapping for the network that was specified
through NETWORK TYPE. Currently, PAYLOAD MAPPING can specify VT1.5 (t1BitAsync), VC-12
(e1BitAsync), or Japan payload mapping (stFrame). In order to change PAYLOAD MAPPING,
you must DELETE, CREATE, and CONFIGURE the CNS71 SERVER.
The default name of the optical interface port is OPTICAL-shn-sln-ptn, where shn is the shelf
number, sln is the slot number, and ptn is the port number (always 1 on the CNA70). For
example, OPTICAL-1-5-1 identifies the optical interface port on the CNS71/CNA70, CNS81/
CNA81, or CNS86/CNA81 modules residing in slot 5 on shelf 1. Both of the optical streams that
are connected to the respective CPIM slots on the CNA70 or CNA81 are designated by this single
identifier.
These dual optical interface streams are individually designated by LINE UPPER (upper CPIM
stream) and LINE LOWER (lower CPIM stream). Each optical stream may carry traffic at any
particular point in time. The OPTICAL INTERFACE requires that both streams must be enabled in
order for the OPTICAL INTERFACE to be put into service. You may not disable an individual
LINE. You may not place an individual LINE out of service.
When supporting T1 circuits, OPTICAL INTERFACE .. PATH designates one of the 3 Synchronous
Transport Signal level 1 (STS-1) or AU-3 streams within the SONET/SDH network, while
OPTICAL INTERFACE .. VT designates the Virtual Tributary Layer that carries one of the
(logical) T1 spans within the SONET or SDH network.
When supporting E1 circuits in SDH networks, OPTICAL INTERFACE .. PATH designates 1 VC-4
path, while OPTICAL INTERFACE .. VT designates the Virtual Tributary Layer that carries one of
the logical E1 spans.
As noted above, this optical interface name cannot be deleted. The name may however be changed
via the CONFIGURE OPTICAL INTERFACE .. NAME command shown in the command syntax
below.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus Optical Interface CLI Reference
The Performance Monitor (PERFMON) THRESHOLD parameters shown below are for specific types
of interface error conditions. Error counts of this magnitude will trigger an event log entry or trap
notification for each associated type of error, for an interval of either fifteen minutes or twenty-
four hours. PERFMON events are accumulated for the following periods:
When you configure a threshold for an individual error type, the identical threshold value is
established at both the near and far end of the circuit supported by the optical interface. You may
specify the threshold value, the error type, and the error layer (section, LINE, path, or VT/VC).
You may zero out (PERFMON RESET) the accumulated counts for these errors on the near or far
end, for either a 24 hour or a 15 minute interval, and for any of the error layers. The counts for all
the error types, rather than for individual error types, will be zeroed out. For additional
information, see:
General alarm reporting may be limited to root-cause problems only via ALARM REPORTING
HIERARCHY. Threshold crossing alerts may be selectively enabled or disabled for each error type
via TCA FILTER. See "Alarm and Threshold Crossing Reporting Hierarchies" on page 6–163 for
more information.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus Optical Interface
T1 Timeslot Mapping
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus Optical Interface CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus Optical Interface
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus Optical Interface CLI Reference
E1 Timeslot Mapping
Table 3–198, "E1/SDH/VC Map" provides a mapping of E1s to VC-12s in SDH networks. This
may assist in laying out your SDH network, as well as in interpreting the output from some SHOW
commands. In SDH networks, each combination of Tributary Unit Group (TUG-3), TUG-2, and
Tributary Unit (TU-12) maps to one E1 and one Virtual Container (VC-12) at 2.048 megabits per
second.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus Optical Interface
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus Optical Interface CLI Reference
Trace Messages
SONET/SDH Network Elements can set the J0, J1, or J2 byte in the SONET Path Overhead (POH)
to communicate information about the remote Path Terminating Equipment (PTE), thereby
continuously verifying the connection between two user devices on the SONET/SDH network.
The LINE .. TRACE MESSAGE is used to transmit repetitively a Section Access Point Identifier so
that a section receiver can verify its continued connection to the intended transmitter. The Section
Access Point Identifier uses a 16 byte Access Point Identifier format as defined in clause 3/G.831.
The J0 byte in the POH displays the section trace message.
The PATH .. TRACE MESSAGE is carried in the overhead channels of the specified SONET PATH.
Every Network Element along the PATH may monitor these messages by comparing the received
source to the expected value. Whenever the received value does not match the expected value, a
Path Trace Mismatch alarm is raised on that PATH.
Path messages are up to 61 bytes. The PTE at the remote end of the path may examine the message
to verify the connection with the sending device. The J1 byte in the POH may be displayed as the
Path Trace Buffer (PTB) on a test analyzer.
For STS-1 paths on an OC-3 interface, you may configure a unique path trace message for each of
the 3 paths.
The VT .. TRACE MESSAGE, similar to the PATH .. TRACE MESSAGE, is used in SDH networks.
The (up to 16 byte) VT path trace message is displayed in the J2 byte in the VT/TU Path OverHead
(VT POH) on a test analyzer.
This mechanism is intended to help pinpoint provisioning errors. See "Command Example" on
page 3–1033 for example TRACE MESSAGE use.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus Optical Interface
• SDH/ST (stFrame)
• SONET/T1 (t1BitAsync)
• SDH/E1 (e1BitAsync)
For each payload mapping group that you assign (to one or more CNS71/CNA70, CNS81/CNA81,
or CNS86/CNA81 module pairs), you must create a separate CNS71, CNS81, or CNS86
redundancy group, that includes a CNS71/CNA07, CNS81/CNA81, or CNS86/CNA81 redundant
module set, to provide redundancy for the associated circuits.
NOTE
CNS71, CNS81 or CNS86 module pairs cannot coexist with a different type of
module pairs. You must configure your GSX9000HD with only one of these types of
module pairs.
To create a CNS71, CNS81, or CNS86 redundancy group, first create a redundant CNS71,
CNS81, or CNS86 server without a payload mapping configuration. Then create a CNS71/
CNA70, CNS81/CNA81, or CNS86/CNA81 client module pair, assigning the network type and
payload mapping functions. Then add the client to the redundancy group using the CONFIGURE
REDUNDANCY CLIENT GROUP command. The payload mapping assignments must be present or the
CONFIGURE REDUNDANCY CLIENT GROUP command will be rejected. Once the redundancy group
is established, the network type and payload mapping cannot be changed. In order to change these
settings you must delete the redundancy clients, delete the redundant server module, and recreate
the redundancy group and the clients (with new mappings). A pair of CNS71 redundancy groups
are configured, using these conventions, in the command examples at the end of this section.
• INSERVICE
• OUTOFSERVICE
By default, each OPTICAL INTERFACE is initially OUTOFSERVICE and disabled. As with any
Sonus CLI object, you must take an OPTICAL INTERFACE OUTOFSERVICE before you may set an
OPTICAL INTERFACE to disabled. To bring an OPTICAL INTERFACE into service, you must set
an OPTICAL INTERFACEs to enabled before you may set it to INSERVICE.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus Optical Interface CLI Reference
The rules for manually changing operational states of the OPTICAL INTERFACE are:
TABLE 3–199
From
(operational
state) Changing to (operational state)
INSERVICE OUTOFSERVICE
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus Optical Interface
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus Optical Interface CLI Reference
EXPECTED strmessageexp
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus Optical Interface
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus Optical Interface CLI Reference
CV-L tcaf_state
CONFIGURE OPTICAL INTERFACE opticalifname LINE ALL PERFMON TCA FILTER ..
ES-L tcaf_state
CONFIGURE OPTICAL INTERFACE opticalifname LINE ALL PERFMON TCA FILTER ..
SES-L tcaf_state
CONFIGURE OPTICAL INTERFACE opticalifname LINE ALL PERFMON TCA FILTER ..
UAS-L tcaf_state
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus Optical Interface
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus Optical Interface CLI Reference
TRANSMIT ptrmessagetrans
CONFIGURE OPTICAL INTERFACE opticalifname PATH path TRACE MESSAGE ..
EXPECTED ptrmessageexp
CONFIGURE OPTICAL INTERFACE opticalifname PATH path STATISTICS ..
RESET COUNTERS
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus Optical Interface
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus Optical Interface CLI Reference
EXPECTED vtrmessageexp
CONFIGURE OPTICAL INTERFACE opticalifname VT vt STATISTICS ..
RESET COUNTERS
CONFIGURE OPTICAL INTERFACE opticalifname VT vt ..
BYTESYNC T1E1 FRAMING bytesyncframing
CONFIGURE OPTICAL INTERFACE opticalifname VT vt TESTPATTERN ..
SEND testpattern
CONFIGURE OPTICAL INTERFACE opticalifname VT vt TESTPATTERN ..
MONITOR testpattern
CONFIGURE OPTICAL INTERFACE opticalifname VT vt TESTPATTERN ..
ERRORINJECT errorinject
CONFIGURE OPTICAL INTERFACE opticalifname VT vt TESTPATTERN ..
RESET ERRORCOUNT
CONFIGURE OPTICAL INTERFACE opticalifname VT ALL TESTPATTERN ..
SEND testpattern
CONFIGURE OPTICAL INTERFACE opticalifname VT ALL TESTPATTERN ..
MONITOR testpattern
CONFIGURE OPTICAL INTERFACE opticalifname VT ALL TESTPATTERN ..
ERRORINJECT errorinject
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus Optical Interface
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus Optical Interface CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus Optical Interface
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus Optical Interface CLI Reference
Command Parameters
Field
Parameter Length Description
shelf N/A The shelf number in the GSX9000HD node configuration.
In this release, one shelf is supported. Must be 1.
slot N/A The slot occupied by the CNA70 or CNA81 module that
contains the target CPIMs that are being displayed.
Must be 3-16.
pim N/A Specifies the target CPIM module whose status is being
displayed:
• UPPER - the default APS WORKING channel for Uni-
directional APS; the default PRIMARY APS channel for
Bi-directional APS.
• LOWER - the default APS PROTECT channel for Uni-
directional APS; the default SECONDARY APS channel
for Bi-directional APS.
opticalifname 1-23 The name of the optical interface port on the CNA70 or
CNA80. This name is assigned automatically when the
CNS71/CNA70, or CNS81/CNA81, or CNS86/CNA81
module set is configured via CREATE SERVER. The default
value of this string is OPTICAL-shn-sln-ptn, where shn
is the shelf number sln is the slot number, and ptn is the
port number (always 1 on the CNA70 and CNA81), for
example OPTICAL-1-5-1. This name may be changed.
See newopticalifname.
admin-state N/A The administrative state of the optical interface:
• DISABLED - Not activated, able to be configured.
• ENABLED - The optical interface is either actively
carrying optical traffic or available to do so. The optical
interface is not able to be configured.
Both UPPER/LOWER optical interfaces will be configured to
ENABLED/DISABLED at the same time.
oper-state N/A The operational state of the optical interface:
• INSERVICE - The optical interface is either actively
carrying optical traffic or available to do so.
• OUTOFSERVICE - The optical interface is not available
to carry active calls, but could be used for LOOPBACK
tests.
Both UPPER/LOWER optical interfaces will be configured to
INSERVICE/OUTOFSERVICE at the same time.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus Optical Interface
Field
Parameter Length Description
action N/A The method by which active calls on the optical interface
are processed when MODE OUTOFSERVICE is requested:
• dryup (default) - all active calls are allowed to complete
until the timeout interval expires. When timeout
expires the calls are dropped.
• force - all calls are dropped immediately.
timeout N/A The time (in minutes) to wait to place this optical interface
into MODE OUTOFSERVICE. Must be 0-1440, default is 5
(minutes). A value of 0 causes the change immediately.
networktype N/A Specifies whether a SONET or SDH signal will be used
across this optical interface:
• notConfigured (default) - No network type is yet
assigned.
• sonet - SONET OC-3.
• sdh - SDH STM-1.
Once this value is set to sonet or sdh, it cannot be
changed except by deleting, and then creating, the CNS71
server.
plmapping N/A Specifies the signal payload mapping for the SONET or
SDH signal:
• notConfigured (default) - No payload mapping is yet
assigned.
• t1BitAsync - VT1.5 payload mapping
• e1BitAsync - VC-12 payload mapping
• stFrame - Japan payload mapping (t1bytesync + W-
byte)
• ds3Aync - OC3/T1 VT1.5 payload mapping
Once this value is set to t1BitAsync, e1BitAsync, or
stFrame, it cannot be changed except by deleting, and
then creating, the CNS71, CNS81, or CNS86 server.
scramststrans N/A Specifies whether the transmitted STS-N data stream
should be scrambled:
• enabled (default) - Scramble the transmitted STS-N
data stream (Sonus recommends that you always apply
this setting to this parameter).
• disabled - Do not scramble the transmitted STS-N
data stream.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus Optical Interface CLI Reference
Field
Parameter Length Description
scramstsreceive N/A Specifies whether the received STS-N data stream should
be de-scrambled:
• enabled (default) - De-scramble the received STS-N
data stream (Sonus recommends that you always apply
this setting to this parameter).
• disabled - Do not de-scramble the received STS-N
data stream.
scramatmtrans N/A Specifies whether the transmitted ATM payload data is
scrambled:
• enabled (default) - scramble the transmitted ATM
payload data stream
• disabled - do not scramble the transmitted ATM
payload data stream
This parameter value is not applicable unless the optical
interface carries ATM.
scramatmreceive N/A Specifies whether the received ATM payload data is de-
scrambled:
• enabled (default) - de-scramble the received ATM
payload data stream
• disabled - do not de-scramble the received ATM
payload data stream
This parameter value is not applicable unless the optical
interface carries ATM.
newopticalifname 1-23 A new name for the optical interface port on the CNA70 or
CNA81 described above in opticalifname. The
renaming operation will not be allowed if the automatically
created name is referenced by any other subsystem.
Therefore this operation should be performed right after
the CNS71/CNA70, CNS81/CNA81, or CNS86/CNA81
module set is configured via CREATE SERVER, if it is
performed at all.
loopback N/A The current loopback state of the optical interface:
• NOLOOP - Not in the loopback state. A device that is not
capable of performing a loopback on this interface shall
always return this value.
• FACILITYLOOP - The incoming received signal at this
interface is looped back out through the corresponding
transmitter. This occurs at the electrical (not optical)
level, and is physically implemented within the SONET/
SDH framer.
• TERMINALLOOP - The signal that is about to be
transmitted is connected to the incoming receiver. This
occurs at the electrical (not optical) level, and is
physically implemented within the SONET/SDH framer.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus Optical Interface
Field
Parameter Length Description
folaser N/A Controls whether the fiber-optic laser is on or off:
• on (default)
• off
cvs15 N/A In the Section Layer, the Coding Violations threshold value
for a 15 minute interval. These are Bit Interleaved Parity
(BIP) errors that occur on either optical interface LINE.
This number must be 1-16383.
cvsday N/A In the Section Layer, the Coding Violations threshold value
for a 24 hour interval. This number must be 1-11048575.
ess15 N/A In the Section Layer, the Errored Seconds threshold value
for a 15 minute interval. These are one second intervals in
which at least one BIP, Severely Errored Frame (SEF), or
Loss of Signal (LOS) error occurs on either optical
interface LINE. This number must be 1-16383.
essday N/A In the Section Layer, the Errored Seconds threshold value
for a 24 hour interval. This number must be 1-65535.
sess15 N/A In the Section Layer, the Severely Errored Seconds
threshold value for a 15 minute interval. These are one
second intervals in which at least 155 BIP errors, or one
SEF error, or one LOS error occurs on either optical
interface LINE. This number must be 1-900.
sessday N/A In the Section Layer, the Severely Errored Seconds
threshold value for a 24 hour interval. This number must be
1-65535.
sefs15 N/A In the Section Layer, the Severely Errored Frame
threshold value for a 15 minute interval. These are one
second intervals in which at least one SEF error occurs on
either optical interface LINE. This number must be 1-900.
sefsday N/A In the Section Layer, the Severely Errored Frame
threshold value for a 24 hour interval. This number must be
1-65535.
cvl15 N/A In the Line Layer, the Coding Violations threshold value for
a 15 minute interval. These are BIP errors that occur on
either optical interface LINE at the near end. This number
must be 1-16383.
cvlday N/A In the Line Layer, the Coding Violations threshold value for
a 24 hour interval. This number must be 1-1048575.
esl15 N/A In the Line Layer, the Errored Seconds threshold value for
a 15 minute interval. These are one second intervals in
which at least one BIP error occurs, or one Alarm
Indication Signal (AIS) is detected on either optical
interface LINE at the near end. This number must be 1-
900.
eslday N/A In the Line Layer, the Errored Seconds threshold value for
a 24 hour interval. This number must be 1-65535.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus Optical Interface CLI Reference
Field
Parameter Length Description
sesl15 N/A In the Line Layer, the Severely Errored Seconds threshold
value for a 15 minute interval. These are one second
intervals in which at least 154 BIP errors occur, or one AIS
is detected on either optical interface LINE at the near
end. This number must be 1-900.
seslday N/A In the Line Layer, the Severely Errored Seconds threshold
value for a 24 hour interval. This number must be 1-65535.
uasl15 N/A In the Line Layer, the Unavailable Seconds threshold value
for a 15 minute interval. These are one second intervals in
which neither optical interface LINE is available at the near
end. This condition begins with the onset of 10 consecutive
Line Layer Severely Errored Seconds. This condition ends
with the onset of 10 consecutive seconds with no Line
Layer Severely Errored Seconds. This number must be 1-
900.
uaslday N/A In the Line Layer, the Unavailable Seconds threshold value
for a 24 hour interval. This number must be 1-65535.
cvp15 N/A In the Path Layer, the Coding Violations threshold value for
a 15 minute interval. These are BIP errors that occur on
the optical interface path at the near end. This number
must be 1-16383.
cvpday N/A In the Path Layer, the Coding Violations threshold value for
a 24 hour interval. This number must be 1-1048575.
esp15 N/A In the Path Layer, the Errored Seconds threshold value for
a 15 minute interval. These are one second intervals in
which at least one of the following occurs:
• BIP error
• AIS
• Loss of Pointer (LOP-P) error
• Payload Unequipped (UNEQ-P) error
• Path Trace Identifier Mismatch (TIM-P) error
This number must be 1-900.
espday N/A In the Path Layer, the Errored Seconds threshold value for
a 24 hour interval. This number must be 1-65535.
sesp15 N/A In the Path Layer, the Severely Errored Seconds threshold
value for a 15 minute interval. These are one second
intervals in which at least of the following occurs:
• 2400 BIP errors occur
• AIS
• LOP-P error
• UNEQ-P error
• TIM-P defect
This number must be 1-900.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus Optical Interface
Field
Parameter Length Description
sespday N/A In the Path Layer, the Severely Errored Seconds threshold
value for a 24 hour interval. This number must be 1-65535.
uasp15 N/A In the Path Layer, the Unavailable Seconds threshold
value for a 15 minute interval. These are one second
intervals in which neither optical interface LINE is available
at the near end. This condition begins with the onset of 10
consecutive Path Layer Severely Errored Seconds. This
condition ends with the onset of 10 consecutive seconds
with no Path Layer Severely Errored Seconds. This
number must be 1-900.
uaspday N/A In the Path Layer, the Unavailable Seconds threshold
value for a 24 hour interval. This number must be 1-65535.
path N/A When PAYLOAD MAPPING is not e1BitAsync, the STS-1
or AU-3 stream within the SONET/SDH network. Must be
1-3.
When PAYLOAD MAPPING is e1BitAsync, the AU-4
stream within the SDH network. Must be 1.
ptracestate N/A Enables or disables the continuous sending and checking
of trace messages on the specified PATH:
• enabled - enables the generation of SONET/SDH path
trace messages in the J1 byte of the STS path
overhead, and enables the reception and checking of
received path trace messages with the Expected Path
Trace Message.
• disabled (default) - transmits all zeros in the J1 byte of
the STS path overhead, and disables the reception and
checking of received path trace messages with the
Expected Path Trace Message.
ptrmessagetrans 1-61 Text string of the trace message to be sent to the far end
switch, on the specified PATH in the J1 byte of the STS
Path overhead.
ptrmessageexp 1-61 Text string of the trace message expected to be received
back from the far end switch, on the specified PATH in the
J1 byte of the STS Path overhead.
stracestate N/A Enables or disables the continuous sending and checking
of trace messages on the specified section (LINE UPPER
or LINE LOWER):
• enabled - enables the generation of a Section Access
Point Identifier message in the J0 byte of the STM-N,
and enables the reception and checking of a received
trace message, using the Expected Section Trace
Message.
• disabled (default) - transmits all zeros in the J0 byte of
the STM-N, and disables the reception and checking of
received section trace messages with the Expected
Section Trace Message.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus Optical Interface CLI Reference
Field
Parameter Length Description
strmessagetrans 1-15 Text string of the trace message to be sent to the far end
switch, in the STM-N. This may be an up to 15 byte string
that conforms to the Access Point Identifier format as
defined in clause 3/G.831.
strmessageexp 1-15 Text string of the trace message expected to be received
back from the far end switch, in the STM-N. This may be
an up to 15 byte string that conforms to the Access Point
Identifier format as defined in clause 3/G.831.
pathequipstate N/A Specifies whether the SONET/SDH PATH is equipped or
unequipped:
• EQUIPPED (default) - Available and active.
• UNEQUIPPED - Not equipped. In this state, the
Unequipped signal label is sent in the Path overhead
and AIS-P is forced.
cvv15 N/A For all Virtual Tributaries/Virtual Containers (VTs), the
Coding Violations threshold value for a 15 minute interval.
These are BIP errors that occur on any logical span in the
optical interface. This number must be 1-16383.
cvvday N/A For all VTs, the Coding Violations threshold value for a 24
hour interval. This number must be 1-1048575.
esv15 N/A For all VTs, the Errored Seconds threshold value for a 15
minute interval. These are one second intervals in which at
least one of the following occurs on any logical span:
• BIP error
• AIS
• Loss of Pointer (LOP) error
• Unequipped (UNEQ) error
• TIM-P defect
This number must be 1-900.
esvday N/A For all VTs, the Errored Seconds threshold value for a 24
hour interval. This number must be 1-65535.
sesv15 N/A For all VTs, the Severely Errored Seconds threshold value
for a 15 minute interval. These are one second intervals in
which at least of the following occurs on any logical span:
• 2400 BIP errors occur
• AIS
• LOP error
• UNEQ error
• TIM-P defect
This number must be 1-900.
sesvday N/A For all VTs, the Severely Errored Seconds threshold value
for a 24 hour interval. This number must be 1-65535.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus Optical Interface
Field
Parameter Length Description
uasv15 N/A For all VTs, the Unavailable Seconds threshold value for a
15 minute interval. These are one second intervals in
which any logical span remains unavailable. This condition
begins with the onset of 10 consecutive Severely Errored
Seconds. This condition ends with the onset of 10
consecutive seconds with no Severely Errored Seconds on
the logical span. This number must be 1-900.
uasvday N/A For all VTs, the Unavailable Seconds threshold value for a
24 hour interval. This number must be 1-65535.
vtracestate N/A Enables or disables the continuous sending and checking
of trace messages on the specified SDH VT path:
• enabled - enables the generation of SDH path trace
messages in the J2 byte of the VT path overhead, and
enables the reception and checking of received VT path
trace messages.
• disabled (default) - transmits all zeros in the J2 byte of
the VT path overhead, and disables the reception and
checking of received VT path trace messages.
VT path TRACE is supported only for NETWORK TYPE sdh.
vtrmessagetrans 1-15 Text string of the trace message to be sent to the far end
switch, on the specified SDH VT path in the J2 byte of the
VT Path overhead.
vtrmessageexp 1-15 Text string of the trace message expected to be received
back from the far end switch, on the specified SDH VT path
in the J2 byte of the VT Path overhead.
bytesyncframing N/A For byte synchronous mapped VT payloads, specifies if F-
bit (for T1 payloads), or FAS (for E1 payloads) is carried in
the VT payload:
• enabled - F-bit or FAS is expected to be received, and
T1/E1 performance and alarm monitoring will be
performed.
• disabled - no T1/E1 performance or alarm monitoring
will be performed.
This configuration has no effect for ST Frame payload
mapping.
strmformat N/A Specifies the type of ST Framing (Japan Mode), when
PAYLOAD MAPPING is set to stFrame:
• trunk (default) - in this mode, S-bit and D-bit interrupts
are disabled (this is the only supported value for this
parameter)
dbittransmit N/A Specifies the setting of the 3 D-bits D2, D3, and D4 for the
specified T1 (STFRAME):
• allZero - zeroes
• allOne (default) - ones
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus Optical Interface CLI Reference
Field
Parameter Length Description
sbittransmit N/A Specifies the setting of the 6 S-bits S1, S2, S3, S4, S5, and
S6 for the specified T1 (STFRAME) for the specified
HANDLEGROUP:
• allZero - zeroes
• allOne (default) - ones
handlegroup N/A In Japan Mode, specifies one of the four Handling Groups
that make up a T1. Each T1 is made up of 4 Handling
Groups and each Handling Group is made up of 6
channels (DS0s) in the T1. Must be 1-4.
stframe N/A Specifies Japan payload mapping (t1bytesync + W-byte),
which is mapped to a T1. The first stframe is mapped to
the first T1, the last stframe is mapped to the last T1. Must
be 1-84.
interval N/A This number specifies the 15 minute interval for which you
seek statistics. Statistics are stored in “intervals” for every
15 minutes since the GSX was booted. When 32 intervals
(8 hours) are accumulated, the next interval overwrites the
earliest, so that no more than 8 hours of statistics may be
accessed.Interval 1 always contains the most recent
statistics and interval 32 (if existent) the oldest. Must be 1-
32.
tcaf_state N/A Specifies the state of the threshold crossing alert filter for
the particular error type:
• disabled (default) - Do not generate a threshold
crossing alert event when the threshold is exceeded for
this error type.
• enabled - Generate a threshold crossing alert event
when the threshold is exceeded for this error type.
See "Regulated Threshold Crossing Alert Reporting" on
page 6–166 for more information.
arh_state N/A Specifies whether the Alarm Reporting Hierarchy is in
effect for alarm state change events:
• disabled - Generate an alarm for every impacted
component in every individual layer downstream from
the original AIS defect.
• enabled (default) - Generate an alarm only for the root
cause problem at the lowest layer.
The Alarm Reporting Hierarchy is described in GR-253-
CORE, Issue 3, Section 6.2.1.8.2. See "Regulated Alarm
State Change Reporting" on page 6–165 for more
information.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus Optical Interface
Field
Parameter Length Description
testpattern N/A Specifies a test pattern for performing path continuity
testing at the VC11 and VC12 layers:
• none (default) - No test pattern. You should explicitly set
this pattern to end VT testing.
• pn15 - 215-1.
• pn15invert - 215-1 inverted.
See "CNS71, CNS81, and CNS86 Path Testing Overview"
on page 6–229 for a detailed explanation of the VT ..
TESTPATTERN facility.
errorinject N/A Specifies the test pattern error rate in number-of-error-bits
per TESTPATTERN bits:
• none (default) - No error bits. You should explicitly set
this rate to end VT testing.
• 10E-2 - One error bit in 100 bits.
• 10E-3 - One error bit in 1000 bits.
• 10E-4 - One error bit in 10000 bits.
• 10E-5 - One error bit in 100000 bits.
• 10E-6 - One error bit in 1,000,000 bits.
• 10E-7 - One error bit in 10,000,000 bits.
• singleBit - Force a bit error whenever the
CONFIGURE .. ERRORINJECT .. command is
executed.
See "CNS71, CNS81, and CNS86 Path Testing Overview"
on page 6–229 for a detailed explanation of the VT ..
TESTPATTERN facility.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus Optical Interface CLI Reference
Command Example
To bring up the CNS71 in slot 5 and put it into service without redundancy by defining the optical
interface as a SONET OC-3 network with VT1.5 payload mapping (and allowing all other
configuration parameters to take default values):
% CREATE SERVER SHELF 1 SLOT 5 HWTYPE cns71 ADAPTER cna70 normal
% CONFIGURE SERVER SHELF 1 SLOT 5 STATE enabled
% CONFIGURE SERVER SHELF 1 SLOT 5 MODE inService
% CONFIGURE OPTICAL INTERFACE OPTICAL-1-5-1 NETWORK TYPE sonet
% CONFIGURE OPTICAL INTERFACE OPTICAL-1-5-1 PAYLOAD MAPPING t1BitAsync
% CONFIGURE OPTICAL INTERFACE OPTICAL-1-5-1 STATE enabled
% CONFIGURE OPTICAL INTERFACE OPTICAL-1-5-1 MODE INSERVICE
To bring up the CNS71 in slot 6 and put it into service without redundancy by defining the optical
interface as an SDH network with E1 mapping (and allowing all other configuration parameters to
take default values):
% CREATE SERVER SHELF 1 SLOT 6 HWTYPE cns71 ADAPTER cna70 normal
% CONFIGURE SERVER SHELF 1 SLOT 6 STATE enabled
% CONFIGURE SERVER SHELF 1 SLOT 6 MODE inService
% CONFIGURE OPTICAL INTERFACE OPTICAL-1-6-1 NETWORK TYPE sdh
% CONFIGURE OPTICAL INTERFACE OPTICAL-1-6-1 PAYLOAD MAPPING e1BitAsync
% CONFIGURE OPTICAL INTERFACE OPTICAL-1-6-1 STATE enabled
% CONFIGURE OPTICAL INTERFACE OPTICAL-1-6-1 MODE INSERVICE
To create, configure and enable a redundancy group, cns71-1-16, to back up SONET/T1 circuits
supported by the CNS71/CNA70 module pair in slot 5, following the conventions suggested in
"CNS71, CNS81, and CNS86 Redundancy Groups" on page 3–1010:
% CREATE SERVER SHELF 1 SLOT 16 HWTYPE cns71 ADAPTER cna07 redundant
% CREATE SERVER SHELF 1 SLOT 5 HWTYPE cns71 ADAPTER cna70 normal
% CONFIGURE SERVER SHELF 1 SLOT 5 STATE enabled
% CONFIGURE SERVER SHELF 1 SLOT 5 MODE inService
% CONFIGURE OPTICAL INTERFACE OPTICAL-1-5-1 NETWORK TYPE sonet
% CONFIGURE OPTICAL INTERFACE OPTICAL-1-5-1 PAYLOAD MAPPING t1BitAsync
% CONFIGURE OPTICAL INTERFACE OPTICAL-1-5-1 STATE enabled
% CONFIGURE OPTICAL INTERFACE OPTICAL-1-5-1 MODE INSERVICE
% CREATE REDUNDANCY CLIENT GROUP cns71-1-16 SLOT 5
% CONFIGURE REDUNDANCY CLIENT GROUP cns71-1-16 SLOT 5 STATE enabled
% CONFIGURE REDUNDANCY GROUP cns71-1-16 STATE enabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus Optical Interface
To create, configure and enable another CNS71 redundancy group, cns71-1-15, to back up
SDH/E1 circuits supported by the CNS71/CNA70 module pair in slot 6, following the conventions
suggested in "CNS71, CNS81, and CNS86 Redundancy Groups" on page 3–1010:
% CREATE SERVER SHELF 1 SLOT 15 HWTYPE cns71 ADAPTER cna07 redundant
% CREATE SERVER SHELF 1 SLOT 6 HWTYPE cns71 ADAPTER cna70 normal
% CONFIGURE SERVER SHELF 1 SLOT 6 STATE enabled
% CONFIGURE SERVER SHELF 1 SLOT 6 MODE inService
% CONFIGURE OPTICAL INTERFACE OPTICAL-1-6-1 NETWORK TYPE sdh
% CONFIGURE OPTICAL INTERFACE OPTICAL-1-6-1 PAYLOAD MAPPING e1BitAsync
% CONFIGURE OPTICAL INTERFACE OPTICAL-1-6-1 STATE enabled
% CONFIGURE OPTICAL INTERFACE OPTICAL-1-6-1 MODE INSERVICE
% CREATE REDUNDANCY CLIENT GROUP cns71-1-15 SLOT 6
% CONFIGURE REDUNDANCY CLIENT GROUP cns71-1-15 SLOT 6 STATE enabled
% CONFIGURE REDUNDANCY GROUP cns71-1-15 STATE enabled
To enable threshold crossing alerts for path unavailable seconds (which are disabled by default) on
all paths of an optical interface:
% CONFIGURE OPTICAL INTERFACE OPTICAL-1-5-1 PATH ALL PERFMON TCA FILTER
UAS-P enabled
To display the configuration of all optical interfaces (in this case, the CNS71 in slot 5 that was
configured in the above example):
% SHOW OPTICAL INTERFACE ALL ADMIN
Node: TPUBS Date: 2004/01/12 23:38:14 GMT
Zone: GMTMINUS05-EASTERN-US
------------------------------------------------------
Shelf: 1 Slot: 5 Port: 1 IfIndex: 257
------------------------------------------------------
Adapter Location: UPPER
Circuit Identifier: OPTICAL-1-5-1
------------------------------------------------------
OPTICAL Interface Configuration
------------------------------------------------------
Network Type: SONET
Payload Mapping: T1BITASYNC
Admin State: ENABLED
Admin Mode: INSERVICE
Line Type: LONGSINGLE
Line Coding: NRZ
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus Optical Interface CLI Reference
To display the configuration of a CNS71 in slot 12 that has been configured to support E1 circuits
in an sdh network:
% SHOW OPTICAL INTERFACE optical-1-12-1 LINE ALL ADMIN
Node: TPUBS Date: 2004/02/25 16:34:07 GMT
Zone: GMTMINUS05-EASTERN-US
------------------------------------------------------
Shelf: 1 Slot: 12 Port: 1 IfIndex: 262
------------------------------------------------------
Adapter Location: UPPER
Circuit Identifier: OPTICAL-1-12-1
------------------------------------------------------
OPTICAL Interface Configuration
------------------------------------------------------
Network Type: SDH
Payload Mapping: E1BITASYNC
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus Optical Interface
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus Optical Interface CLI Reference
------------------------------------------------------
Shelf: 1 Slot: 11 Port: 1 IfIndex: 257
------------------------------------------------------
Adapter Location: UPPER
Circuit Identifier: OPTICAL-1-11-1
------------------------------------------------------
OPTICAL Interface Status
------------------------------------------------------
APS Channel Status: ACTIVE
Operational Status: UP
Section Layer Alarm Status: NOALARM
Line Layer Alarm Status: NOALARM
------------------------------------------------------
Shelf: 1 Slot: 11 Port: 1 IfIndex: 258
------------------------------------------------------
Adapter Location: LOWER
Circuit Identifier: OPTICAL-1-11-1
------------------------------------------------------
OPTICAL Interface Status
------------------------------------------------------
APS Channel Status: NOTACTIVE
Operational Status: UP
Section Layer Alarm Status: NOALARM
Line Layer Alarm Status: NOALARM
------------------------------------------------------
Shelf: 1 Slot: 12 Port: 1 IfIndex: 263
------------------------------------------------------
Adapter Location: UPPER
Circuit Identifier: OPTICAL-1-12-1
------------------------------------------------------
OPTICAL Interface Status
------------------------------------------------------
APS Channel Status: ACTIVE
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus Optical Interface
Operational Status: UP
Section Layer Alarm Status: NOALARM
Line Layer Alarm Status: NOALARM
------------------------------------------------------
Shelf: 1 Slot: 12 Port: 1 IfIndex: 264
------------------------------------------------------
Adapter Location: LOWER
Circuit Identifier: OPTICAL-1-12-1
------------------------------------------------------
OPTICAL Interface Status
------------------------------------------------------
APS Channel Status: NOTACTIVE
Operational Status: UP
Section Layer Alarm Status: NOALARM
Line Layer Alarm Status: NOALARM
-------------------------------------------------------------------
Shelf: 1 Slot: 11 Port: 1 IfIndex: 257
-------------------------------------------------------------------
Adapter Location: UPPER
Circuit Identifier: OPTICAL-1-11-1
-------------------------------------------------------------------
OPTICAL Interface Threshold Configuration
-------------------------------------------------------------------
Section Thresholds 15 Minute 24 Hour TCA Filter
-------------------------------------------------------------------
Coding Violations: 15 125 DISABLED
Errored Seconds: 12 100 DISABLED
Severely Errored Seconds: 4 7 DISABLED
Severely Errored Frame Seconds: 10 10 DISABLED
-------------------------------------------------------------------
Line Thresholds 15 Minute 24 Hour TCA Filter
-------------------------------------------------------------------
Coding Violations: 15 125 DISABLED
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus Optical Interface CLI Reference
------------------------------------------------------
Shelf: 1 Slot: 11 Port: 1 IfIndex: 259
------------------------------------------------------
Path 1 Configuration
------------------------------------------------------
Equipped State: EQUIPPED
Path Type: STS1
RDI Mode: NORMAL
Trace State: DISABLED
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus Optical Interface
-------------------------------------------------------------
Shelf: 1 Slot: 5 Port: 1 IfIndex: 265
-------------------------------------------------------------
Path 1 Thresholds
-------------------------------------------------------------
15 Minute 24 Hour TCA Filter
-------------------------------------------------------------
Coding Violations: 25 250 DISABLED
Errored Seconds: 20 200 DISABLED
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus Optical Interface CLI Reference
------------------------------------------------------
Shelf: 1 Slot: 11 Port: 1 IfIndex: 259
------------------------------------------------------
Path 1 Status
------------------------------------------------------
Operational Status: UP
Alarm Status: NOALARM
Received Signal Label: EQUIPPEDNONSPECIFIC
Received Trace Msg: N/A
------------------------------------------------------
Shelf: 1 Slot: 11 Port: 1 IfIndex: 260
------------------------------------------------------
Path 2 Status
------------------------------------------------------
Operational Status: UP
Alarm Status: NOALARM
Received Signal Label: EQUIPPEDNONSPECIFIC
Received Trace Msg: N/A
------------------------------------------------------
Shelf: 1 Slot: 11 Port: 1 IfIndex: 261
------------------------------------------------------
Path 3 Status
------------------------------------------------------
Operational Status: UP
Alarm Status: NOALARM
Received Signal Label: EQUIPPEDNONSPECIFIC
Received Trace Msg: N/A
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus Optical Interface
------------------------------------------------------------------------
Optical Interface Summary: Shelf: 1 Slot: 11 Port: 1
------------------------------------------------------------------------
Adapter | APS Chan | | | Oper |Section |Line
Loc | Status | State | Mode | Status |Alarm |Alarm
------------------------------------------------------------------------
UPPER |ACTIVE |ENABLED |INSERVICE |UP |NOALARM |NOALARM
LOWER |NOTACTIVE |ENABLED |INSERVICE |UP |NOALARM |NOALARM
--------------------------------------------------------------------
Path Summary: Shelf: 1 Slot: 11 Port: 1
--------------------------------------------------------------------
Path | Oper Status | Equipped State | Alarm Status
--------------------------------------------------------------------
1 | UP | EQUIPPED | NOALARM
2 | UP | EQUIPPED | NOALARM
3 | UP | EQUIPPED | NOALARM
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus Optical Interface CLI Reference
---------------------------------------------------------------------
Virtual Tributary Summary: Shelf: 1 Slot: 5 Port: 1
---------------------------------------------------------------------
VT | STS1/VTG/VT | Oper Status | Equipped State | Alarm Status
---------------------------------------------------------------------
1 | 1/1/1 | UP | EQUIPPED | NOALARM
2 | 1/1/2 | UP | EQUIPPED | NOALARM
3 | 1/1/3 | UP | EQUIPPED | NOALARM
4 | 1/1/4 | UP | EQUIPPED | NOALARM
5 | 1/2/1 | UP | EQUIPPED | NOALARM
6 | 1/2/2 | UP | EQUIPPED | NOALARM
7 | 1/2/3 | UP | EQUIPPED | NOALARM
8 | 1/2/4 | UP | EQUIPPED | NOALARM
9 | 1/3/1 | UP | EQUIPPED | NOALARM
10 | 1/3/2 | UP | EQUIPPED | NOALARM
11 | 1/3/3 | UP | EQUIPPED | NOALARM
12 | 1/3/4 | UP | EQUIPPED | NOALARM
13 | 1/4/1 | UP | EQUIPPED | NOALARM
14 | 1/4/2 | UP | EQUIPPED | NOALARM
15 | 1/4/3 | UP | EQUIPPED | NOALARM
16 | 1/4/4 | UP | EQUIPPED | NOALARM
17 | 1/5/1 | UP | EQUIPPED | NOALARM
18 | 1/5/2 | UP | EQUIPPED | NOALARM
19 | 1/5/3 | UP | EQUIPPED | NOALARM
20 | 1/5/4 | UP | EQUIPPED | NOALARM
21 | 1/6/1 | UP | EQUIPPED | NOALARM
22 | 1/6/2 | UP | EQUIPPED | NOALARM
23 | 1/6/3 | UP | EQUIPPED | NOALARM
24 | 1/6/4 | UP | EQUIPPED | NOALARM
25 | 1/7/1 | UP | EQUIPPED | NOALARM
26 | 1/7/2 | UP | EQUIPPED | NOALARM
27 | 1/7/3 | UP | EQUIPPED | NOALARM
28 | 1/7/4 | UP | EQUIPPED | NOALARM
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus Optical Interface
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus Optical Interface CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus Optical Interface
------------------------------------------------------------------------
ST Frame Summary: Shelf: 1 Slot: 5 Port: 1
------------------------------------------------------------------------
ST | SDH | BAIS | HG 1 | HG 2 | HG 3 | HG 4
Fr | Indx |Alarm Status |Alarm Status |Alarm Status |Alarm Status |Alarm Status
------------------------------------------------------------------------
1 | 1-1-1| NOALARM | NOALARM | NOALARM | NOALARM | NOALARM
2 | 1-2-1| NOALARM | NOALARM | NOALARM | NOALARM | NOALARM
3 | 1-3-1| NOALARM | NOALARM | NOALARM | NOALARM | NOALARM
4 | 1-4-1| NOALARM | NOALARM | NOALARM | NOALARM | NOALARM
5 | 1-5-1| NOALARM | NOALARM | NOALARM | NOALARM | NOALARM
6 | 1-6-1| NOALARM | NOALARM | NOALARM | NOALARM | NOALARM
7 | 1-7-1| NOALARM | NOALARM | NOALARM | NOALARM | NOALARM
8 | 1-1-2| NOALARM | NOALARM | NOALARM | NOALARM | NOALARM
9 | 1-2-2| NOALARM | NOALARM | NOALARM | NOALARM | NOALARM
10 | 1-3-2| NOALARM | NOALARM | NOALARM | NOALARM | NOALARM
...............................
80 | 3-3-4| NOALARM | NOALARM | NOALARM | NOALARM | NOALARM
81 | 3-4-4| NOALARM | NOALARM | NOALARM | NOALARM | NOALARM
82 | 3-5-4| NOALARM | NOALARM | NOALARM | NOALARM | NOALARM
83 | 3-6-4| NOALARM | NOALARM | NOALARM | NOALARM | NOALARM
84 | 3-7-4| NOALARM | NOALARM | NOALARM | NOALARM | NOALARM
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus Optical Interface CLI Reference
------------------------------------------------------
Shelf: 1 Slot: 11 Port: 1
------------------------------------------------------
ST Frame 1 Status
------------------------------------------------------
STS1: 1 VTG: 1 VT: 1
------------------------------------------------------
Alarm Status: NOALARM
Total BAIS Alarms: 0
------------------------------------------------------
Shelf: 1 Slot: 11 Port: 1
------------------------------------------------------
ST Frame 1 Handling Group 1 Status
------------------------------------------------------
STS1: 1 VTG: 1 VT: 1
------------------------------------------------------
Alarm Status: HG15MAIS
Total HGREC Alarms: 1
Total HGAIS Alarms: 1
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus Optical Interface
---------------------------------------------------------------------
Shelf: 1 Slot: 11 Port: 1 IfIndex: 257
---------------------------------------------------------------------
Adapter Location: UPPER
Circuit Identifier: OPTICAL-1-11-1
---------------------------------------------------------------------
OPTICAL Interface Error Statistics
---------------------------------------------------------------------
Section Layer
---------------------------------------------------------------------
LOS Defects: 0
LOF Defects: 0
LOS Alarms: 0
LOF Alarms: 0
Code Violations (CV): 0
---------------------------------------------------------------------
Line Layer
---------------------------------------------------------------------
AIS Defects: 0
RDI Defects: 0
AIS Alarms: 0
RFI Alarms: 1
Code Violations (CV): 0
Remote Error Indications (REI): 3
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus Optical Interface CLI Reference
------------------------------------------------------
Shelf: 1 Slot: 11 Port: 1 IfIndex: 258
------------------------------------------------------
Path 1 Error Statistics
------------------------------------------------------
AIS Defects: 1
LOP Defects: 0
RDI Defects: 1
AIS Alarms: 1
LOP Alarms: 0
RFI Alarms: 0
Remote Error Indications (REI): 21
Code Violations (CV): 6
------------------------------------------------------
Shelf: 1 Slot: 11 Port: 1 IfIndex: 277
------------------------------------------------------
Virtual Tributary 1 Error Statistics
------------------------------------------------------
STS1: 1 VTG: 1 VT: 1
------------------------------------------------------
AIS Defects: 0
LOP Defects: 0
RDI Defects: 0
AIS Alarms: 0
LOP Alarms: 0
RFI Alarms: 0
Remote Error Indications (REI): 2047
Code Violations (CV): 901
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus Optical Interface
To configure a path trace message for the purpose of verifying that the CNS71 subsystem in slot 5
is properly provisioned by viewing the Path Overhead J1 byte on a network analyzer. The string
cns71 should be displayed and that string should be terminated by a carriage return/line feed. If
there are other SONET Network Elements in the path between the CNS71 and the analyzer, each
must be enabled for Path Trace on that STS-1 as well. This action should cause the message
sonus to be transmitted on STS-1 #1 by the test equipment.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus Optical Interface CLI Reference
To see the transmitted and expected trace messages that result from the previous command set:
% SHOW OPTICAL INTERFACE OPTICAL-1-5-1 PATH 1 ADMIN
Node: TPUBS Date: 2003/04/23 23:01:03 GMT
Zone: GMTMINUS05-EASTERN-US
------------------------------------------------------
Shelf: 1 Slot: 5 Port: 1 IfIndex: 149
------------------------------------------------------
Path 1 Configuration
------------------------------------------------------
Equipped State: EQUIPPED
Path Type: STS1
RDI Mode: ENHANCED
Trace State: ENABLED
Transmit Trace Msg: cns71
Expected Trace Msg: sonus
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus Optical Interface
SONET Interface
This object specifies the SONET port on a CNA33. This object is automatically created when a
CNS30/CNA33 server/adapter module combination is created by the CREATE SERVER command.
This port is automatically deleted when any of the same combinations are deleted by the DELETE
SERVER command. Except under these circumstances, this object may not be created or deleted.
For OC-3 TDM subsystems characterized by a triplicate set of CNS30s, a Sonet Midplane
(SMP10), and one or two CNA33 adapter modules, the default name of the SONET port is
SONET-shn-sln-ptn, where shn is the shelf number, sln is the slot number of the originating
(or left-most) server slot in the triplicate, and ptn is the port number. The CNA33 behind the
originating slot (the right-most slot when facing the adapter modules) always takes port number 1.
The CNA33 behind the center slot of the triplicate always takes port number 2. For example,
SONET-1-5-1 identifies the SONET port on a CNA33 module residing in slot 5 behind a CNS30-
triplicate that occupies slots 5-7. SONET-1-5-2 identifies the SONET port on the CNA33 module
in slot 6. Note that adapter slot 7 in the above example will never be occupied. If the triplicate
contains only one CNA33, it may reside in slot 5 or 6, but its SONET Interface will always be
named according to the above conventions.
As noted above, this name cannot be deleted. The name may however be changed via the CONFIG
SONET INTERFACE...NAME command shown in the command syntax below.
For SONET ports, a single channel or path, which always takes the value 1, must be specified,
enabled, and put into service on each SONET Interface. For CNA33 SONET ports, the path range
is 1-3, where each path corresponds to one of the 3 T3 circuits carried by the OC-3 link. Other
attributes of the SONET port that must be configured are discussed in Command Parameters,
below.
A SONET Interface, or a SONET Interface path, is always in one of two administrative states:
• enabled
• disabled
A SONET Interface, or a SONET Interface path, is always in one of two operational states:
• inservice
• outofservice
The default operational state is outofservice. In this state, you may configure the SONET
Interface or a SONET Interface path. Your configuration changes take effect when you enable the
SONET Interface or the SONET Interface path.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus Optical Interface CLI Reference
TABLE 3–201
From
(operational
state) Changing to (operational state)
inservice outofservice
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus Optical Interface
Command Syntax
NOTE
The commands below act on a specified SONET port.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus Optical Interface CLI Reference
NOTE
The commands below act on a specified path within a SONET port.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus Optical Interface
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus Optical Interface CLI Reference
Command Parameters
Field
Parameter Length Description
sonetifname 1-23 The name of the SONET port on the CNA33. This name is
assigned automatically when the CNA30/CNA33 module set
is configured via CREATE SERVER. The default value of this
string is SONET-shn-sln-ptn, where shn is the shelf
number sln is the slot number, and ptn is the port number
(always 1 on the CNA33), for example SONET-1-5-1. This
name may be changed. See newsonetifname.
admin-state N/A The administrative state of this SONET Interface:
• disabled (default) - Not activated, able to be configured.
All NIFs defined on this SONET Interface must be
outOfService to disable it.
• enabled - Active. Not able to be configured.
pathovstate By default, when you set the STATE of a SONET port to
enable, or the MODE to inservice, the three paths carried
in the port are also set to the corresponding setting. If you do
want to set the paths to enable or inservice by default, you
can override the default enabling of the paths by specifying
PATHOVERRIDE enable. If you specify
• disabled (default) - leaves the default action in place,
which is to set all the paths in a port to the same state or
mode as the port.
• enabled - overrides the default path settings, so that
when you set a port to STATE enable or MODE inservice,
the paths carried by that port remain set to STATE disable
or MODE outofservice.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus Optical Interface
Field
Parameter Length Description
loopback N/A The current loopback state of the SONET Interface.
• sonetNoLoop - Not in the loopback state. A device that is
not capable of performing a loopback on this interface
shall always return this value.
• sonetFacilityLoop - The received signal at this
interface is looped back out through the corresponding
transmitter in the return direction.
• sonetTerminalLoop - The signal that is about to be
transmitted is connected to the associated incoming
receiver.
• sonetOtherLoop - Loopbacks that are not defined. (Not
currently supported.)
newsonetifname 1-23 A new name for the SONET port on the CNA33, described
above in sonetifname. The renaming operation will not be
allowed if the automatically created name is referenced by
any other subsystem. Therefore this operation should be
performed right after the CNS30/CNA33 module set is
configured via CREATE SERVER, if it is performed at all.
folaser N/A Controls whether the fiber-optic laser is on or off:
• on (default)
• off
scramble N/A Specifies whether to scramble the SONET layer (STS) in the
TRANSMIT or RECEIVE direction:
• disabled - scrambling inhibited
• enabled (default) - scrambling is performed
SONET layer scrambling is a requirement of Bellcore GR-
253-CORE. Disabling scrambling violates these
recommendations.
fifteenmin N/A A fifteen minute threshold of errors that indicates a
transmission degradation has reached an unacceptable level
and a Threshold Crossing Alert (SNMP Trap message) must
be issued. These errors are Coding Violations (CV), Errored
Seconds (ES), Severely Errored Seconds (SES), Unavailable
Seconds (UAS), and Severely Errored Framing Seconds
(SEFS). Each error may occur at a Section (S), Line (L), or
Path (P) layer. For example, CV-S is Coding Violations at the
Section layer. The threshold values that you specify must be
in the following ranges:
• CV-S/CV-L/CV-P - 0 to 16383
• ES-S - 0 to 16383
• ES-L/ES-P - 0 to 900
• SES-S/SES-L/SES-P - 0 to 900
• SEFS-S - 0 to 900
• UAS-L/UAS-P - 0 to 900
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus Optical Interface CLI Reference
Field
Parameter Length Description
day N/A A 24-hour threshold of errors that indicates a transmission
degradation has reached an unacceptable level and a
Threshold Crossing Alert (SNMP Trap message) must be
issued. These errors are discussed above. The threshold
values that you specify must be in the following ranges:
• CV-S/CV-L/CV-P - 0 to 1,048,575
• ES-S/ES-L/ES-P - 0 to 65,535
• SES-S/SES-L/SES-P - 0 to 65,535
• SEFS-S - 0 to 65,535
• UAS-L/UAS-P - 0 to 65,535
pathnum N/A A channel number within this SONET Interface.
For the CNA33 SONET Interface (OC-3), the path range is 1-
3 where each path corresponds to one of the 3 T3 circuits
carried by the OC-3 link.
path-admin-state N/A The administrative state of this path of this SONET Interface:
• disabled (default) - Not activated, able to be configured.
• enabled - Active. Not able to be configured.
ds3ovstate Controls whether the oper-state and admin-state of the
DS3 specified by pathnum are modified when the oper-
state and path-admin-state are modified:
• disabled (default) - propagate the specified settings to
the DS3.
• enabled - do not change the underlying DS3 settings
when the oper-state and path-admin-state are modified.
This parameter may not be used with the OC-12 SONET
Interface.
trace-state N/A Enables or disables the continuous sending and checking of
trace messages on the specified SONET path:
• enabled - enables the generation of SONET path trace
messages in the J1 bytes of the STS path overhead, and
enables the reception and checking of received path trace
messages with the Expected Path Trace Message.
• disabled (default) - transmits all zeros in the J1 bytes of
the STS path overhead, and disables the reception and
checking of received path trace messages with the
Expected Path Trace Message.
This parameter may not be used with the OC-12 SONET
Interface.
transmit-msg 1-62 Text string of the trace message to be sent to the far end
switch, on the specified SONET path.
This parameter may not be used with the OC-12 SONET
Interface.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus Optical Interface
Field
Parameter Length Description
expected-msg 1-62 Text string of the trace message expected to be received
back from the far end switch, on the specified SONET path.
This parameter may not be used with the OC-12 SONET
Interface.
rdimode N/A The desired type of SONET port Path Remote Defect
Indication to use:
• normal - use one-bit RDI-P signaling using bit 5 of G1.
• enhanced (default) - use three-bit RDI-P (ERDI-P)
signaling using bits 5-7 of G1.
This parameter may not be used with the OC-12 SONET
Interface.
interval N/A A number that identifies the previous fifteen minute or 24
hour interval for which SONET Interface statistics are sought.
The number 1 selects the previous day (or fifteen minutes),
the number 2 selects 2 intervals ago, and so on. You may
display up to one previous day, or 32 previous fifteen minute
intervals.
oper-state N/A The operational state of the SONET Interface or the SONET
Interface path:
• INSERVICE (default) - This state is set by default when
admin-state is enabled.
• OUTOFSERVICE - Set this state before changing admin-
state to disabled.
action N/A The method by which active calls on this SONET Interface or
this PATH of the interface are processed when MODE
OUTOFSERVICE is requested:
• dryup (default) - all active calls are allowed to complete
until the timeout interval expires. When timeout
expires the calls are dropped.
• force - all calls are dropped immediately.
timeout N/A The time (in minutes) to wait to place the SONET Interface or
this PATH of the SONET Interface in the outofservice
oper-state. Must be 0-1440, default is 5 (minutes). A value
of 0 causes the change immediately.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus Optical Interface CLI Reference
Command Example
To display the configuration of all SONET Interfaces (in this case, a pair of interfaces supporting a
CNS30-triplicate whose left-most slot is 3):
% SHOW SONET INTERFACE ALL ADMIN
Node: TPUBS Date: 2001/03/01 15:42:41 GMT
Zone: GMTMINUS05-EASTERN-US
------------------------------------------------------
Shelf: 1 Slot: 3 Port: 1
------------------------------------------------------
SONET Interface Configuration
------------------------------------------------------
Circuit Identifier: SONET-1-3-1
IfIndex: 36
State: ENABLED
Mode: INSERVICE
Medium Type: SONET
Line Type: LONGSINGLE
Line Coding: NRZ
Loopback State: SONETNOLOOP
STS Xmt/Rcv Scrambling: ENABLED/ENABLED
Laser State: ON
------------------------------------------------------
Section Thresholds: 15 Minute 24 Hour
CV-S : 15 125
ES-S : 12 100
SES-S : 3 7
SEFS-S : 10 10
------------------------------------------------------
Line Thresholds : 15 Minute 24 Hour
CV-L /CV-LFE : 15 125
ES-L /ES-LFE : 12 100
SES-L/SES-LFE : 3 7
UAS-L/UAS-LFE : 10 10
------------------------------------------------------
Shelf: 1 Slot: 3 Port: 2
------------------------------------------------------
SONET Interface Configuration
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Sonus Optical Interface
------------------------------------------------------
Circuit Identifier: SONET-1-3-2
IfIndex: 40
State: ENABLED
Mode: INSERVICE
Medium Type: SONET
Line Type: LONGSINGLE
Line Coding: NRZ
Loopback State: SONETNOLOOP
STS Xmt/Rcv Scrambling: ENABLED/ENABLED
Laser State: ON
------------------------------------------------------
Section Thresholds: 15 Minute 24 Hour
CV-S : 15 125
ES-S : 12 100
SES-S : 3 7
SEFS-S : 10 10
------------------------------------------------------
Line Thresholds : 15 Minute 24 Hour
CV-L /CV-LFE : 15 125
ES-L /ES-LFE : 12 100
SES-L/SES-LFE : 3 7
UAS-L/UAS-LFE : 10 10
------------------------------------------------------
Shelf: 1 Slot: 3 Port: 1
------------------------------------------------------
SONET Interface Status
------------------------------------------------------
Circuit Identifier: SONET-1-3-1
IfIndex: 36
Operational Status: UP
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Sonus Optical Interface CLI Reference
Valid Intervals: 1
Invalid Intervals: 31
------------------------------------------------------
Shelf: 1 Slot: 3 Port: 2
------------------------------------------------------
SONET Interface Status
------------------------------------------------------
Circuit Identifier: SONET-1-3-2
IfIndex: 40
Operational Status: UP
To display the accumulated statistics of SONET Interface SONET-1-3-1 for the current day:
% SHOW SONET INTERFACE SONET-1-3-1 STATISTICS CURRENT DAY
Node: TPUBS Date: 2001/03/01 15:58:35 GMT
Zone: GMTMINUS05-EASTERN-US
------------------------------------------------------------------------
Shelf: 1 Slot: 3 Port: 1
------------------------------------------------------------------------
SONET Interface Current Day Statistics
Time Elapsed: 1660
------------------------------------------------------------------------
Circuit Identifier: SONET-1-3-1
------------------------------------------------------------------------
IfIndex: 36
------------------------------------------------------------------------
Section Layer Near End
------------------------------------------------------------------------
Status: NODEFECT
Errored Seconds: 0
Severely Errored Seconds: 0
Severely Errored Framing Seconds: 0
Coding Violations: 0
------------------------------------------------------------------------
Line Layer Near End Far End
------------------------------------------------------------------------
Status: NODEFECT -
Errored Seconds: 0 0
Severely Errored Seconds: 0 0
Unavailable Seconds: 0 0
Coding Violations: 0 0
Failure Count: 0 0
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Automatic Protection Switching (APS) Interface
These objects provide a mechanism for achieving circuit redundancy within CNS30/CNA33 (OC-
3 TDM) and CNS71/CNA70, CNS81/CNA81, CNS86/CNA81 (OC-3/STM-1) subsystems.
NOTE
The APS Interface functionality is not available on GSX4000 series switches in this
release.
The Sonus APS implementation is intended to conform in all significant respects to the
recommendations in Bellcore GR-253-CORE. CNS71/CNA70, CNS81/CNA81, and CNS86/
CNA81 APS supports both SONET and Synchronous Digital Hierarchy (SDH) networks and
complies to ITU-T G.783, Telcordia GR-253-CORE, and JT-G.783.
APS Group
This object identifies a 1+1 APS SONET/SDH optical port that is automatically created when you
configure an OC-3 TDM subsystem or a CNS71/CNA70, CNS81/CNA81, or CNS86/ CNA81
module set:
• The OC-3 TDM subsystem is created by the CREATE SERVER HWTYPE CNS30 .. ADAPTER
cna33 command. This group is automatically deleted when the OC-3 TDM subsystem is
deleted by the DELETE SERVER command.
• The CNA70 or CNA81 SONET/SDH port is created by the CREATE SERVER HWTYPE
<server> .. ADAPTER <adapter> command. This group is automatically deleted when the
CNS71 server is deleted by the DELETE SERVER command.
Except under these circumstances, an APS group may not be created or deleted.
NOTE
Dual CNA33s are necessary for an APS group supporting an OC-3 TDM subsystem.
These are automatically created by a single CREATE SERVER .. CNS30 .. cna33
command. If you actually have only a single CNA33, you cannot provide circuit
redundancy for the OC-3 TDM subsystem and should not configure an APS group.
Also, CNS30/CNA33 module sets cannot coexist with a CNS71/CNA70, CNS81/
CNA81, or CNS86/CNA81 module sets. You must configure your GSX9000HD with
only one of these optical port types.
The default name of the CNA33 APS group is APS-shn-sln-ptn, where shn is the shelf number,
sln is the slot number of the originating (or left-most) CNS30 in the CNS30-triplicate, and ptn is
the port number (always 2) of the second CNA33 in the OC-3 TDM module set. Port number 2 is
located on the CNA33 behind the CNS30 in the middle slot of the triplicate, port number 1 is
located on the CNA33 behind the CNS30 in the originating slot of the triplicate. For example,
APS-1-4-2 identifies the redundant SONET network that connects to ports 1 and 2 on the
CNS30/CNA33 module set that originates in slot 4 of shelf 1 and occupies slots 4-6.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Automatic Protection Switching (APS) Interface CLI Reference
The default name of the CNA70 or CNA81 APS group is APS-shn-sln-ptn, where shn is the
shelf number, sln is the slot number of the CNS71/CNS81, and ptn is the port number (always 1)
of the CNS71/CNA70 or CNS81 module set. For example, APS-1-5-1 identifies the SONET/
SDH optical interface port that connects to the upper and lower CPIM71 modules in the CNA70
that resides behind the CNS71 in slot 5 of shelf 1.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Automatic Protection Switching (APS) Interface
The primary interface is defined as the active channel when an APS switch is clear. The
backup interface is defined as the active channel when an APS switch is set. Because the
primary/backup interfaces and the active channel are all "floating," determining which CPIM
(upper or lower) is currently the primary interface, and whether an APS switch is set or clear,
can be quite confusing. As an example, assume the upper CPIM is currently the active
channel; this could indicate that the upper CPIM is the primary interface and the APS switch is
clear, or the upper CPIM is the backup interface and the APS switch is set.
Each of these APS groups is activated when the OPTICAL INTERFACE LINEs (UPPER and LOWER)
associated with the CNS71/CNA70 or CNS81/CNA81 module sets are created, enabled, and
INSERVICE. When you set the OPTICAL INTERFACE OUTOFSERVICE, both LINEs become
unavailable and no APS command will be accepted. If you issue an APS command while a higher
priority previously issued command is active, the new command will not be accepted. If you place
the CNS71/CNA70 OPTICAL INTERFACE OUTOFSERVICE while a CLI APS command is
executing, the APS command will be cleared. See "Optical Interface" on page 3–1002 for more
information about that object.
A switchover between APS channels occurs when SONET/SDH error rates on those channels
exceed a threshold, or when directed by an operator. You can change APS configuration by:
CAUTION
Sonus recommends that you use caution before you issue a LOCKOUT command on
a onePlusOneOptimized APS channel. Locally, no APS switch actions will occur
under any circumstances, once this state is imposed. Furthermore, because this is
a local command, it is not signaled across the K1 byte to the far end. If channel
switching becomes necessary, it will not occur and service may be interrupted. For
this reason, the CLI requires you to confirm your intention when you issue this
command.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Automatic Protection Switching (APS) Interface CLI Reference
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Automatic Protection Switching (APS) Interface
Command Parameters
Field
Parameter Length Description
apsgname 1-23 The name of the APS group generated when the
corresponding OC-3 TDM subsystem or CNS71/CNA70,
CNS81/CNA81, CNS86/CNS81 module set is created.
The default value of this string is APS-shn-sln-ptn,
where shn is the shelf number sln is the slot number, and
ptn is the port number (always 1 for CNA70, CNA81, or
CNS86 based APS groups, always 2 for CNA33-based
APS groups), for example APS-1-5-1.
This string can be changed via the NAME object.
newapsgname 1-23 A new name for the APS group. After you execute this
command, the old name will cease to be recognized by
the GSX software.
reversion N/A The desired behavior when a switchover to the protection
channel has already occurred and a recovery of the
working channel is discovered and confirmed:
• nonrevertive (default) - Do not automatically restore
the working channel.
• revertive - Automatically switchover to the working
channel when it recovers.
This parameter is examined only if the architecture is
onePlusOne.
failthreshold N/A The Bit Error Rate (BER) threshold at which Signal Failure
(SF or “hard failure”) is declared. The default value of 3
means that one out of 103 bits are in error or one in 1000.
Must be 3-5. This condition may initiate a switchover.
degradethreshold N/A The Bit Error Rate (BER) threshold at which Signal
Degrade (SD or “soft failure”) is declared. The default
value of 5 means that one out of 105 bits are in error or
one in 100,000. Must be 5-9. This condition may initiate a
switchover.
commandtimeout N/A The time interval (in seconds) to wait before clearing a
locally initiated APS SWITCHCOMMAND ..
FORCEDSWITCH. If a Reverse Request is not received
from the far end in this timeout period, then the
SWITCHCOMMAND is cleared. (This condition could occur
if the far end is in a lockout state, because, in that state, it
will not issue the Reverse Request.) If this value is set to
0, then this feature is disabled and the FORCEDSWITCH
command will continue to be sent to the far end until you
manually cancel the command (the behavior defined in
the Annex B standard).
Must be 0-10 (seconds), default is 0.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Automatic Protection Switching (APS) Interface CLI Reference
Field
Parameter Length Description
waittime N/A The Wait to Restore time in seconds, before a (revertive)
switchover to the working channel can occur.
The working channel must remain recovered for this
interval before a reversion will occur. Must be 300-700,
default is 300 seconds (or 5 minutes).
architecture N/A The redundancy model (or architecture) used by this APS
GROUP:
• onePlusOne (default) - An architecture characterized
by permanent electrical bridging to service and
protective equipment. CNA33 based APS groups must
use this model. CNA70 and CNA81 based APS groups
may use this model. This architecture is fully compliant
with the procedures and requirements specified in
Bellcore GR-253-CORE SONET Transport
Systems: Common Criteria for the linear 1+1
architecture, unidirectional operation.
• resilientUNI - An architecture that must be used
with a Lucent GX550 ATM switch.
• onePlusOneCompatible - An architecture that is
fully compliant with the procedures and requirements
specified in Bellcore GR-253-CORE SONET
Transport Systems: Common Criteria for the
linear 1+1 architecture, bidirectional operation. Only
CNA70 based APS groups may use this model.
• onePlusOneOptimized - An architecture that is
optimized to use predominantly 1+1 bidirectional
switching and is fully compliant with the procedures and
requirements specified in ITU-T G.841 Digital
transmission systems - Digital networks -
SDH Network Characteristics, Annex B. Only
CNA70 based APS groups may use this model.
shelf N/A The shelf number in the GSX node configuration. In this
release, one shelf is supported. Must be 1.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Automatic Protection Switching (APS) Interface
Field
Parameter Length Description
slot N/A The slot occupied by the:
• originating CNS30 of the OC-3 TDM subsystem that
contains the SONET optical port summary that you are
displaying
• CNS71/CNA70, CNS81/CNA81, or CNS86/CNA81
module set that contains the SONET/SDH optical port
summary that you are displaying
Must be 3-16.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Automatic Protection Switching (APS) Interface CLI Reference
Field
Parameter Length Description
switchcommand N/A The “switch” command to be issued to the APS GROUP.
These commands are ARCHITECTURE dependent as
summarized below:
• CLEAR - Clears out the current command. Valid in all
ARCHITECTUREs.
• LOCKOUT - Prevents automatic APS GROUP switch
actions from occurring. (For example, an automatic
switch to the backup channel caused by a Signal
Failure would be prevented.) Valid only in
ONEPLUSONEOPTIMIZED ARCHITECTURE.
• FORCEDSWITCH - Forces the primary channel to the
backup channel. Valid only in
ONEPLUSONEOPTIMIZED ARCHITECTURE.
• LOCKOUTOFPROTECT - Prevents automatic APS
GROUP switch actions from occurring on the protection
channel. Valid only in ONEPLUSONE and
ONEPLUSONECOMPATIBLE ARCHITECTUREs.
• FORCEDSWITCHTOWORK - Forces the active channel
from protect to working. Valid only in ONEPLUSONE
and ONEPLUSONECOMPATIBLE ARCHITECTUREs.
This action is allowed even if the channel you are
switching to is in an SF or SD state.
• MANUALSWITCHTOWORK - Forces the active channel
from protect to working. Valid only in ONEPLUSONE
and ONEPLUSONECOMPATIBLE
ARCHITECTUREs.This action is not allowed if the
channel you are switching to is in an SF or SD state.
• FORCEDSWITCHTOPROTECT - Forces the active
channel from working to protect. Valid only in
ONEPLUSONE and ONEPLUSONECOMPATIBLE
ARCHITECTUREs.This action is allowed even if the
channel you are switching to is in an SF or SD state.
• MANUALSWITCHTOPROTECT - Forces the active
channel from working to protect. Valid only in
ONEPLUSONE and ONEPLUSONECOMPATIBLE
ARCHITECTUREs.This action is not allowed if the
channel you are switching to is in an SF or SD state.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Automatic Protection Switching (APS) Interface
Command Example
To display the APS K1K2 state within the APS group APS-1-3-1:
% SHOW APS K1K2 aps-1-3-1 STATE
Node: TPUBS Date: 2003/04/17 15:09:36 GMT
Zone: GMTMINUS05-EASTERN-US
------------------------------------------------------------------------------
APS GROUP K1K2 BYTE STATE SUMMARY
------------------------------------------------------------------------------
Transmit K1 Transmit K2
Chan Byte Request Chan Arch Mode
Receive K1 Receive K2
Name S/SL/P Chan Byte Request Chan Arch Mode
----------- ------ ---- ---- ----------------- ----- ---- -------------
APS-1-3-1 1 3 1 NULL 0000 No Request NULL 1+1 100 Unidir
NULL 0000 No Request NULL 1+1 100 Unidir
NOTE
See Bellcore GR-253-CORE for bit assignments for the K1 and K2 bytes.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Automatic Protection Switching (APS) Interface CLI Reference
To display the configuration of the APS groups that are automatically created by the CREATE
SERVER .. commands to define CNS71/CNA70 pairs in slots 11, 12, and 14 (before the NETWORK
TYPE and PAYLOAD MAPPING parameters are specified for these modules):
--------------------------------------------------------------------------------
UNIDIRECTIONAL
APS-1-12-1 1 12 1 1 + 1 NONREVERTIVE 10^-5 10^-3 300 sec
UNIDIRECTIONAL
APS-1-14-1 1 14 1 1 + 1 NONREVERTIVE 10^-5 10^-3 300 sec
UNIDIRECTIONAL
When you configure a CNS71 module to a NETWORK TYPE of sdh, and PAYLOAD MAPPING of
stFrame, a nonrevertive, optimized, bidirectional APS group, APS-1-3-1, is automatically
created:
% CONFIGURE OPTICAL INTERFACE optical-1-3-1 NETWORK TYPE sdh
% CONFIGURE OPTICAL INTERFACE optical-1-3-1 PAYLOAD MAPPING stFrame
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Automatic Protection Switching (APS) Interface
To display the configuration of the APS group created by either of the techniques shown above:
% SHOW APS GROUP APS-1-3-1 ADMIN
Node: TPUBS Date: 2003/12/11 22:35:37 GMT
Zone: GMTMINUS05-EASTERN-US
------------------------------------------------------------------------
APS GROUP ADMIN SUMMARY
------------------------------------------------------------------------
Architecture / BER BER
Name S/SL/P Direction Switching Degrade Fail WTR Timer
---------- ------ -------------- ------------ ------- ----- ------
APS-1-3-1 1 3 1 1+1 OPTIMIZED NONREVERTIVE 10^-5 10^-3 300 sec
BIDIRECTIONAL
Notice that all APS GROUP parameters that were not explicitly configured above, take default
values.
In the SHOW .. STATISTICS screen, an Active Channel value of UPPER or LOWER along with a
Switched Channel value of NULL, indicates that no APS switchover is in effect. To display these
statistics on a pair of optimized, bidirectional, APS groups that support CNS71/CNS70 module
sets in slots 7 and 8:
% SHOW APS GROUP ALL STATISTICS
Node: TPUBS Date: 2003/12/12 15:12:40 GMT
Zone: GMTMINUS05-EASTERN-US
------------------------------------------------------------------------
APS GROUP STATISTICS SUMMARY
------------------------------------------------------------------------
Switching Channel
Byte Fail Mismatch
/ Far End / Mode Active Switched
Name S/SL/P Line Fail Mismatch Channel Channel Status
---------- ------ --------- -------- ------- -------- -----------
APS-1-7-1 1 7 1 0 0 LOWER NULL NORMAL
0 0
APS-1-8-1 1 8 1 0 0 LOWER NULL NORMAL
0 0
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Automatic Protection Switching (APS) Interface CLI Reference
------------------------------------------------------------------------
APS COMMAND ADMIN SUMMARY
------------------------------------------------------------------------
APS-1-10-1 1 10 1 CLEAR
------------------------------------------------------------------------
APS CHANNEL STATE SUMMARY
------------------------------------------------------------------------
Channel
Name S/SL/P Adapter Status
------------------- ------ ------ ----------------------------------
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Automatic Protection Switching (APS) Interface
The SHOW APS .. screens vary slightly, depending on the ARCHITECTURE of the APS GROUP to
which they belong (onePlusOne/onePlusOneCompatible or onePlusOneOptimized). In the
examples that follow, these differences are illustrated by performing the same SHOW command on
one type, and then on the other type. APS group APS-1-7-1 is set to onePlusOne, while APS
group APS-1-8-1 is set to onePlusOneOptimized. These APS groups are defined on the
CNS71/CNA70 module sets in slots 7 and 8 respectively, as shown by the following command:
% SHOW APS GROUP ALL ADMIN
Node: TPUBS Date: 2005/11/14 22:05:20 GMT
Zone: GMTMINUS05-EASTERN-US
--------------------------------------------------------------------------------
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Automatic Protection Switching (APS) Interface CLI Reference
-----------------------------------------------------------------------
APS CHANNEL STATE SUMMARY
-----------------------------------------------------------------------
Channel
Name S/SL/P Adapter Status
------------------- ------ ------ ---------------------------------
To display the channel statistics within a unidirectional, linear, 1+1 APS group:
% SHOW APS CHANNEL aps-1-7-1 STATISTICS
Node: TPUBS Date: 2005/11/14 22:30:42 GMT
Zone: GMTMINUS05-EASTERN-US
--------------------------------------------------------------------------------
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Automatic Protection Switching (APS) Interface
To display the channel states within a bidirectional, nonrevertive, 1+1 APS group:
% SHOW APS CHANNEL aps-1-8-1 STATE
Node: TPUBS Date: 2005/11/14 20:56:31 GMT
Zone: GMTMINUS05-EASTERN-US
------------------------------------------------------------------------
APS CHANNEL STATE SUMMARY
------------------------------------------------------------------------
Channel
Name S/SL/P Adapter Status
------------------- ------ ------ ----------------------------------
APS-1-8-1 1 8 1 UPPER NORMAL
APS-1-8-1 1 8 1 LOWER NORMAL
-----------------------------------------------------------------------
APS LINE SUMMARY
-----------------------------------------------------------------------
Channel
Name S/SL/P Adapter IfIndex
------------------- ------ ------- ----------
APS-1-7-1 1 7 1 WORKING 155
APS-1-7-1 1 7 1 PROTECT 156
APS-1-8-1 1 8 1 UPPER 26
APS-1-8-1 1 8 1 LOWER 27
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
These objects configure the Channel Associated Signaling (CAS) call services.
Sonus Networks recommends the following approach to configuring CAS call services. See "CAS
Services" on page 6–114 for more about these procedures, as well as additional background about
CAS SIGNALTYPEs):
1. Create and configure all external (to CAS) profiles first. These include:
• Trunk Group (see "Trunk Group" on page 3–538)
• DTMF/MF Tone Profiles (see "Tone Profile" on page 3–1189)
• Call Progress and Alerting/Ringback Tone Packages (see "Tone Package" on page 3–
1201)
• Circuit Service (see "Circuit Service Profile" on page 3–685)
NOTE
Each T1 or E1 circuit must be explicitly configured for voiceonly or circuitonly.
Each T1 circuit must be restricted (56K). E1 circuits do not need to be restricted.
Each T1 span must be explicitly configured for a signaling mode of robbed bit.
Each E1 span must be explicitly configured for a signaling mode of bit oriented.
NOTE
The T1 or E1 span must be disabled and out of service to be assigned to a CAS
service, then placed back into service after the CAS service is enabled and put into
service. See the example in "CAS Channel" on page 3–1144.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
In addition to T1 E & M signaling, CAS MFC R2 signaling for India, Brazil, Mexico, and
International (ITU) R2, is supported, along with CAS loop start signaling, and CAS ground start
signaling. The SIGNALTYPE is the primary influence on CAS SERVICE behavior. Certain
configuration parameters are rendered meaningful or meaningless, depending on the
SIGNALTYPE. See "Overview of CAS MFC R2 Signaling" on page 6–116 for additional
instructions and considerations related to the use of this CAS signaling variant. See "CAS Loop
Start / Ground Start Signaling" on page 6–130 for background and call flows pertaining to these
signaling types.
This object creates a template for the CAS service group object (below). CAS service group
objects that are configured with a profile will silently take every parameter value specified in the
profile unless explicitly overridden.
The CAS Service Profile allows the GSX to make assumptions about how CAS calls should be
handled, speeding up call handling when parameters are not explicitly specified, by eliminating the
need to wait for those parameters until they time out.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
TXWINK txwink
TXFLASH txflash
GUARDTIME guardtime
AUTOBUSYTHRESHOLD autobusy
DTPROFILE dtprofile
SUSPENDTIME suspendtime
SWITCHSIDE switchside
SIGVARIANT sigvariant
BNUMENDDIGIT bnumenddigit
MFCR2PROFILE mfcr2profile
CLRTOIDLETIME clrtoidletime
E1CBIT e1cbit
E1DBIT e1dbit
MGCPACAGE mgcpackage
ANSWER SUPERVISION TIMEOUT ansupvto
LSGANSWERSUPV lsganswersupv
RXSEIZERING rxseizering
RXFXSANSWER rxfxsanswer
RXFXSDISC rxfxsdisc
RXLSFXSRINGCESS rxlsfxsringcess
TXLSFXODISC txlsfxodisc
TXFXORINGON txfxoringon
TXFXORINGOFF txfxoringoff
CRANKBACK PROFILE cbprofno
ANUMLENGTH anumlength
TXR2ENDDIGIT txr2enddigit
RXR2SEIZE rxr2seize
RXR2SEIZEACK rxr2seizeack
RXR2ANSWER rxr2answer
RXR2CLEARBACK rxr2clearback
RXR2CLEARFWD rxr2clearfwd
RXR2IDLEBACK rxr2idleback
RXR2BLOCK rxr2block
CONGESTION RELEASE TIMER cgrtimeout
LDC ACTION ldcaction
LDC EMERGENCY CALLS ldcemergcalls
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
Command Parameters
Field
Parameter Length Description
profilename 1-23 The name of the CAS profile that is being created to use as a
template for configuring a CAS service group.
tgname 1-23 The name of the trunk group that this CAS service belongs
to.
hunt N/A The hunt algorithm used to select channels for calls destined
to this CAS service group:
• top2Bottom - start the search at the highest physical
port number on the highest CNA slot number on the
highest shelf number in the node.
• bottom2Top (default) - start the search at the lowest
physical port number on the lowest CNA slot number on
the lowest shelf number in the node.
• circularTop2Bottom - start the search at the highest
physical port number on the highest CNA slot number on
the highest shelf number in the node. Start the succeeding
search at the next table position rather than back at the
top.
• circularBottom2Top - start the search at the lowest
physical port number on the lowest CNA slot number on
the lowest shelf number in the node. Start the succeeding
search at the next table position rather than back at the
bottom.
• mostIdle - Place the most recently used channel at the
end of a queue and select channels from the beginning of
the queue, first in, first out.
• leastIdle - Push the most recently used channel to the
top of a stack and select channels from the stack, last in,
first out.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
Field
Parameter Length Description
cost N/A The (relative) routing cost to the CAS service group. Must be
0-100, default is 50. A value of 100 represents the highest
possible cost.
signaltype N/A The CAS signaling type in use throughout the service:
• eM (default) - T1 E & M signaling.
• mfcr2 - multi-frequency compelled R2 signaling
• gsFxo -ground start foreign exchange office.
• gsFxs - ground start foreign exchange station.
• lsFxo - loop start foreign exchange office.
• lsFxs - loop start foreign exchange station.
The unique signaling parameters for each specific signaling
type are displayed as an appendix by the SHOW CAS
SERVICE .. command.
ingrsspname 1-23 Name of the signaling sequence profile to use for all ingress
calls.
egrsspname 1-23 Name of the signaling sequence profile to use for all egress
calls.
hkfsspname 1-23 Name of the signaling sequence profile to execute whenever
a hook flash is detected on an egress CAS channel in a
connected call.
This SSP is not meaningful for SIGNALTYPEs lsFxs,
gsFxs, and mfcr2.
pscsspname 1-23 Name of the signaling sequence profile to execute for a
permanent signal condition (PSC). PSC occurs when the
GSX has gone on-hook at the end of its call but the far end
remains off-hook. After disconnect treatment processing
completes for this call, this SSP will be executed.
maintbusy N/A Specifies whether the (T1 or E1) channels are taken off-hook
when they are put into maintenance mode (either manually
or automatically):
• enabled (default) - take channels off-hook.
• disabled - do not take the channels off-hook.
dtmfprofile 1-23 Name of the DTMF tone profile. This profile defines
parameters specific to DTMF tone generation. The
defaultDtmf profile is used by default for this function. See
"Tone Profile" on page 3–1189.
mfprofile 1-23 Name of the MF tone profile. This profile defines parameters
specific to MF tone generation. The defaultMfr1 profile is
used by default for this function. See "Tone Profile" on
page 3–1189.
This profile is not meaningful for SIGNALTYPE mfcr2.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
Field
Parameter Length Description
cptonepkg 1-23 Name of the call progress tone package. This profile defines
ring back tones, dial tones, etc. The default profile is used
by default for this function. See "Tone Package" on page 3–
1201.
cptonereq N/A Specifies whether call progress tones are required on
ingress calls:
• disabled (default) - not required.
• enabled - required.
cptoneprov N/A Specifies whether call progress tones are provided by the far
end switch for egress calls:
• disabled (default) - not provided.
• enabled - provided.
rxwinkmin N/A The minimum wink receive time. Must be 100-800, default is
100 (milliseconds).
This parameter is not meaningful for SIGNALTYPEs lsFxs,
lsFxo, gsFxs, and gsFxo.
rxwinkmax N/A The maximum wink receive time. Must be 100-800, default is
700 (milliseconds).
This parameter is not meaningful for SIGNALTYPEs lsFxs,
lsFxo, gsFxs, and gsFxo.
rxflashmin N/A The minimum flash receive time. Must be 300-1100, default
is 300 (milliseconds).
For SIGNALTYPEs lsFxo and gsFxo, if the duration of the
LO (on-hook) signal is less than the value of rxflashmin,
then the signal is ignored. If the duration of the LO signal is
between rxflashmin and rxflashmax, then it is
considered to be a hook-flash. If the duration of the LO is
greater than rxflashmax, then it is considered to be a
disconnect.
This parameter is not meaningful for SIGNALTYPEs lsFxs
and gsFxs.
rxflashmax N/A The maximum flash receive time. Must be 300-1100, default
is 700 (milliseconds).
This parameter does not apply to loop start / ground start
FXS.
For SIGNALTYPEs lsFxo and gsFxo, see the rxflashmin
explanation.
This parameter is not meaningful for SIGNALTYPEs lsFxs
and gsFxs.
txwink N/A The wink transmit time. Must be 100-800, default is 200
(milliseconds).
This parameter is not meaningful for SIGNALTYPEs lsFxs,
lsFxo, gsFxs, and gsFxo.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
Field
Parameter Length Description
txflash N/A The flash transmit time. Must be 300-1100, default is 500
(milliseconds).
This parameter is not meaningful for SIGNALTYPEs lsFxo
and gsFxo.
guardtime N/A The minimum time to allow the on-hook to propagate through
the network when the call is terminated at the GSX. This
interval allows the far end time to reuse the channel. The
GSX will not reuse this channel until this interval expires.
Must be 100-1500, default is 800 (milliseconds).
This parameter is not meaningful for SIGNALTYPE lsFxo.
autobusy N/A The number of signaling errors which are allowed prior to
placing the channel into auto maintenance state. Once in this
state the channel must be returned to service from the CLI.
Must be 0-255, default is 0.
Setting this field to 0 disables auto maintenance processing.
dtprofile 1-23 The name of the CAS Disconnect Treatment Profile that will
be used to map a disconnect reason code to a Disconnect
Signaling Sequence Profile (SSP) for this service group.
Default is casDefault.
suspendtime N/A The timeout value in milliseconds before a call in which the
called party disconnected first is terminated. This provides
the CAS equivalent of the SS7 NODE TSus timer (see "SS7
Timer Values" on page 3–318) provided for ISUP calls. Must
be 0-60000 (milliseconds); default is zero.
A value of zero causes immediate call termination when the
outgoing circuit disconnects.
This parameter is not meaningful for SIGNALTYPEs lsFxs,
and gsFxs.
switchside N/A The switch side the CAS Service Group should emulate:
• user - A switch on the network side.
• network (default) - A switch on the user side.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
Field
Parameter Length Description
sigvariant N/A The signaling variant that the CAS service group should
emulate:
• none (default) - none
• MexicoV1 - Network MFCR2 for Mexico.
• MexicoV2 - PBX MFCR2 for Mexico.
• itu - international R2
• indiaScheme5 - National R2 variant for India (Q421 line
signaling, 2-way operation)
• indiaScheme6Out - National R2 variant for India (non-
standard line signaling, one-way outbound operation only)
• indiaScheme6In - National R2 variant for India (non-
standard line signaling, one-way inbound operation only)
• indiaScheme7Out - National R2 variant for India (non-
standard line signaling, one-way outbound operation only)
• indiaScheme7In - National R2 variant for India (non-
standard line signaling, one-way inbound operation only)
• brazil - R2 national variant for Brazil
This parameter is meaningful only when SIGNALTYPE is
mfcr2.
bnumenddigit N/A BNUM End of Digits. Specifies whether the BNUM (or called
party number/DNIS) should be terminated with the end of
digits signal when dialed from the GSX:
• enabled - Send the end of digits signal.
• disabled (default) - Do not send the end of digits signal.
This parameter is meaningful only when SIGNALTYPE is
mfcr2.
mfcr2profile 1-23 The name of the DSP Digit Profile used for MFCR2 digit
reception and generation.
This profile is meaningful only when SIGNALTYPE is mfcr2.
clrtoidletime N/A Specifies the time, in milliseconds, that must elapse after a
clear forward is received in order for a channel to be
considered idle. This timer runs in parallel with the existing
(and configurable) guard timer. For a channel to be idle (or
available for a subsequent call):
• the forward and backward line signaling states must
indicate idle
• the clear to idle timer must have expired
• the guard timer must have expired
Must be 0-500, default is 100 (milliseconds).
This parameter is meaningful only when SIGNALTYPE is
mfcr2.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
Field
Parameter Length Description
e1cbit N/A Specifies the value of the forward/backward line signaling C-
bit on E1 channels. Must be 0 or 1, default is 0.
This parameter is meaningful only when SIGNALTYPE is
mfcr2.
e1dbit N/A Specifies the value of the forward/backward line signaling D-
bit on E1 channels. Must be 0 or 1, default is 1.
This parameter is meaningful only when SIGNALTYPE is
mfcr2.
mgcpackage N/A The package used to control a particular CAS service for
MGCP:
• none (default) - circuits are not to be controlled by the
MGCP Gateway service.
• md - North American MF Feature Group D EANA and
EAIN (for MGCP)
• mo - FGD Operator Services Signaling (for MGCP)
• ms - MF wink or immediate start (for MGCP)
ansupvto N/A When answer supervision is enabled, specifies the timeout
period, in seconds, from the egress receiving the first
backwards message from the called party exchange (Call
Proceeding, Alerting, Call Progress) until the call is
answered. If the timeout period expires, the answer
supervision action specified is triggered.
lsganswersupv N/A Specifies whether line side answer supervision is supported:
• disabled (default) - Line side answer supervision is not
supported.
• enabled - Answer supervision is supported. For
SIGNALTYPEs lsFxo and gsFxo, the RLCF signal will be
issued for ingress calls. For SIGNALTYPEs lsFxs and
gsFxs, the RLCF signal will be received on egress calls.
This parameter is not meaningful for SIGNALTYPEs eM and
mfcr2.
rxseizering N/A Specifies the time interval, in milliseconds, that a seizure
signal must be received in order to be considered a seizure/
ring. Must be 20-2000, default is 150 (milliseconds).
The seizure signal is:
• LC for SIGNALTYPE lsFxo
• RG for SIGNALTYPE gsFxo
• Ring for SIGNALTYPEs lsFxs and gsFxs
This parameter is not meaningful for SIGNALTYPEs eM and
mfcr2.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
Field
Parameter Length Description
rxfxsanswer N/A Specifies the time interval, in milliseconds, that the RLCF
signal must be received in order to be considered an answer.
Must be 20-2000, default is 100 (milliseconds).
This parameter is only meaningful for SIGNALTYPEs lsFxs
and gsFxs.
rxfxsdisc N/A Specifies the time interval, in milliseconds, that the LCFO
signal must be received in order to be considered a
disconnect. Must be 100-2000, default is 600 (milliseconds).
This parameter is meaningful only for SIGNALTYPEs lsFxS
and gsFxs.
rxlsfxsringcess N/A Specifies the time interval, in milliseconds, that the lack of a
Ring signal must be detected in order to be considered an
abandoned call. Must be 100-30000, default is 8000
(milliseconds).
This parameter is meaningful only for SIGNALTYPE lsFxs.
txlsfxodisc N/A Specifies the time interval, in milliseconds, that the LCFO
signal must be transmitted by the foreign exchange office
(FXO) side in order to release a call. Must be 0-2000, default
is 800 (milliseconds).
When you specify a value of 0, the LCFO signal is disabled.
This parameter is meaningful only for SIGNALTYPE lsFxo.
txfxoringon N/A Specifies the time interval, in milliseconds, that the Ring on
signal must be transmitted by the FXO side. Must be100-
10000, default is 800 (milliseconds).
This parameter is meaningful only for SIGNALTYPEs lsFxo
and gsFxo.
txfxoringoff N/A Specifies the time interval, in milliseconds, that the Ring off
signal must be transmitted by the FXO side. Must be 100-
10000, default is 4000 (milliseconds).
This parameter is meaningful only for SIGNALTYPEs lsFxo
and gsFxo.
cbprofno N/A The index number of the CRANKBACK PROFILE to use with
this CAS service group. This must specify a valid Call
Crankback profile index, in the range 1-10. The default is 1,
or Call Crankback Profile default. See"Call Crankback
Profile" on page 3–1171.
anumlength For R2, specifies the length of a transmitted calling party
number. A value of 0 implies variable length terminated by an
end of digits signal. Otherwise, the value specifies the fixed
length of the calling party number. Must be 0 to 30. The
default is 0.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
Field
Parameter Length Description
txr2enddigit N/A For R2, specifies the transmit end of the digits signal:
• r2Signal15 (default)
• r2Signal14
• r2Signal13
• r2Signal12
• r2Signal11
rxr2seize N/A For R2, specifies the duration (in milliseconds) that a seize
signal must be present before it is considered a valid signal.
Must be 20 to 2000; default is 20.
rxr2seizeack N/A For R2, specifies the duration (in milliseconds) that a seize
ACK signal must be present before it is considered a valid
signal. Must be 20 to 2000; default is 20.
rxr2answer N/A For R2, specifies the duration (in milliseconds) that an
answer signal must be present before it is considered a valid
signal. Must be 20 to 2000; default is 20.
rxr2clearback N/A For R2, specifies the duration (in milliseconds) that a clear
back signal must be present before it is considered a valid
signal. Must be 20 to 2000; default is 20.
rxr2clearfwd N/A For R2, specifies the duration (in milliseconds) that a clear
forward signal must be present before it is considered a valid
signal. Must be 20 to 2000; default is 20.
rxr2idleback N/A For R2, specifies the duration (in milliseconds) that an idle
back signal must be present before it is considered a valid
signal. Must be 20 to 2000; default is 20.
rxr2block N/A For R2, specifies the duration (in milliseconds) that a block
signal must be present before it is considered a valid signal.
Must be 20 to 2000; default is 20.
cgrtimeout N/A The time (in seconds) to wait to release a call when that call
was rejected due to congestion. This parameter effectively
prevents the machine congestion level from escalating due
to rapid repeated call attempts by equipment that does not
support congestion detection. Must be 0-5 (seconds), default
is 0. A value of 0 disables this timer.
If this value is nonzero, the timer is started when a call is
rejected due to congestion. When the timer expires, the
network release is sent and the call resources are de-
allocated. If a network release is received during the delay,
the timer is stopped and the call resources are de-allocated.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
Field
Parameter Length Description
ldcaction N/A Specifies the action to take if the Long Duration Call (LDC)
timer expires. The call may be released, a SNMP trap may
be generated, or both:
• noAction (default) - take no action on LDC timer expiry
(a debug log entry will be generated).
• trap - generate an SNMP trap.
• release - automatic call disconnect without generation of
a trap.
• trapAndRelease - generate an trap and release the call.
ldcemergcalls N/A Specifies whether emergency calls should be excluded from,
or included in Long Duration Call (LDC) disconnect
procedures:
• include
• exclude (default)
Note: Emergency call exclusion relies on the PSX call type
or other protocol-specific criteria to identify the call as an
“emergency” call.
ldcrelcause N/A Specifies the GSX disconnect reason used to release the call
if the call is released due to Long Duration Call (LDC) timer
expiry. Must be 1 to 127; default is 41 (Temporary Failure).
ldctimeout N/A Specifies the timeout value of the Long Duration Call (LDC)
timer in minutes. Must be 0 or 60-2880. A value of 0 disables
the timer; a value of 60-2880 set the timer. Default is 0.
admin-state N/A The administrative state of this CAS service profile:
• disabled (default) - Not activated, able to be
reconfigured or deleted.
• enabled - Activated, available for immediate use.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
Command Example
To display the configuration of the profilecas service profile (and to reveal the default values
for all parameters not specified above):
% SHOW CAS SERVICE PROFILE profilecas ADMIN
------------------------------------------------------------
Name: profilecas
------------------------------------------------------------
Admin State: DISABLED Trunk Group: ISUPTG
Cost 50 Hunt Algorithm: BOTTOM2TOP
Signal Type: MFCR2 Signal Variant: NONE
Switch Side: NETWORK CPTone Pkg:
Maint Busy: ENABLED Answer Timeout: 0
Auto Busy: 0 DTMF Profile:
Requires CPTone DISABLED Ingress SSP:
Provides CPTone DISABLED Egress SSP:
MGC Package: NONE PSC SSP:
Guard Time: 800 DT Profile:
Crank Back Prof: 1 Cong Rel Time: 0 (sec)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
CAS Service
This object binds a CAS service to a trunk group and assigns a name and properties to this binding.
You may temporarily remove and restore this service by toggling its operational state between
inservice and outofservice.
• enabled
• disabled
• inService
• outOfService
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
The rules for manually changing operational states of the CAS service are:
TABLE 3–205
From
(operational
state) Changing to (operational state)
inService outOfService
The GROUP operation resetStats clears all accumulated CAS service group statistics to zero.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
Command Parameters
Field
Parameter Length Description
servicename 1-23 The name of the CAS service that is being created and
configured.
tgname 1-23 The name of the trunk group of which this CAS service is a
member.
hunt N/A The hunt algorithm used to select channels for calls made to
or from this service group:
• top2Bottom - start the search at the highest physical
port number on the highest CNA slot number on the
highest shelf number in the node.
• bottom2Top (default) - start the search at the lowest
physical port number on the lowest CNA slot number on
the lowest shelf number in the node.
• Circulartop2Bottom - start the search at the highest
physical port number on the highest CNA slot number on
the highest shelf number in the node. Start the succeeding
search at the next table position rather than back at the
top.
• Circularbottom2Top - start the search at the lowest
physical port number on the lowest CNA slot number on
the lowest shelf number in the node. Start the succeeding
search at the next table position rather than back at the
bottom.
• mostIdle - Place the most recently used channel at the
end of a queue and select channels from the beginning of
the queue, first in, first out.
• leastIdle - Push the most recently used channel to the
top of a stack and select channels from the stack, last in,
first out.
cost N/A The (relative) routing cost to the CAS service group. Must be
0-100, default is 50. A value of 100 represents the highest
possible cost.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
Field
Parameter Length Description
signaltype N/A The CAS signaling type in use throughout the service:
• eM (default) - T1 E & M signaling.
• mfcr2 - Compelled MFR2, the common signaling type
used on E1 outside of the US.
• gsFxo -ground start foreign exchange office.
• gsFxs - ground start foreign exchange station.
• lsFxo - loop start foreign exchange office.
• lsFxs - loop start foreign exchange station.
The unique signaling parameters for each specific signaling
type are displayed as an appendix by the SHOW CAS
SERVICE .. command.
ingrsspname 1-23 Name of the signaling sequence profile to use for all ingress
calls.
egrsspname 1-23 Name of the signaling sequence profile to use for all egress
calls.
hkfsspname 1-23 Name of the signaling sequence profile to execute whenever
a hook flash is detected on an egress CAS channel in a
connected call.
This SSP is not meaningful for SIGNALTYPEs lsFxs,
gsFxs, and mfcr2.
pscsspname 1-23 Name of the signaling sequence profile to execute for a
permanent signal condition (PSC). PSC occurs when the
GSX has gone on-hook at the end of its call but the far end
remains off-hook. After disconnect treatment processing
completes for this call, this SSP will be executed.
maintbusy N/A Specifies whether the (T1 or E1) channels are taken off-hook
when they are put into maintenance mode (either manually or
automatically):
• enabled (default) - take channels off-hook.
• disabled - do not take the channels off-hook.
Channels may be placed into maintenance mode manually
by changing the operational state of the channel, named T1
span (see "T1" on page 3–588), or trunk group. A channel
may be placed into maintenance mode automatically by
executing an appropriate SCP when excessive signaling
errors occur during a call.
dtmfprofile 1-23 Name of the DTMF tone profile. This profile defines
parameters specific to DTMF tone generation. The
defaultDtmf profile is used by default for this function. See
"Tone Profile" on page 3–1189.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
Field
Parameter Length Description
mfprofile 1-23 Name of the MF tone profile. This profile defines parameters
specific to MF tone generation. The defaultMfr1 profile is
used by default for this function. See "Tone Profile" on
page 3–1189.
This profile is not meaningful for SIGNALTYPE mfcr2.
cptonepkg 1-23 Name of the call progress tone package. This profile defines
ring back tones, dial tones, etc. The default profile is used
by default for this function. See "Tone Package" on page 3–
1201.
cptonereq N/A Specifies whether call progress tones are required on ingress
calls:
• disabled (default) - Not required.
• enabled - Required.
cptoneprov N/A Specifies whether call progress tones are provided by the far
end switch on egress calls:
• disabled (default) - Not provided. This setting prevents
cut thru on any call until the answer is received, regardless
of the PARAM2 value of the report SSP token when the
PARAM1 value is progress or alert.
• enabled - Provided.
rxwinkmin N/A The minimum wink receive time. Must be 100-800, default is
100 (milliseconds).
This parameter is not meaningful for SIGNALTYPEs lsFxs,
lsFxo, gsFxs, and gsFxo.
rxwinkmax N/A The maximum wink receive time. Must be 100-800, default is
700 (milliseconds).
This parameter is not meaningful for SIGNALTYPEs lsFxs,
lsFxo, gsFxs, and gsFxo.
rxflashmin N/A The minimum flash receive time. Must be 300-1100, default
is 300 (milliseconds).
For SIGNALTYPEs lsFxo and gsFxo, if the duration of the
LO (on-hook) signal is less than the value of rxflashmin,
then the signal is ignored. If the duration of the LO signal is
between rxflashmin and rxflashmax, then it is
considered to be a hook-flash. If the duration of the LO is
greater than rxflashmax, then it is considered to be a
disconnect.
This parameter is not meaningful for SIGNALTYPEs lsFxs
and gsFxs.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
Field
Parameter Length Description
rxflashmax N/A The maximum flash receive time. Must be 300-1100, default
is 700 (milliseconds).
This parameter does not apply to loop start / ground start
FXS.
For SIGNALTYPEs lsFxo and gsFxo, see the rxflashmin
explanation.
This parameter is not meaningful for SIGNALTYPEs lsFxs
and gsFxs.
txwink N/A The wink transmit time. Must be 100-800, default is 200
(milliseconds).
This parameter is not meaningful for SIGNALTYPEs lsFxs,
lsFxo, gsFxs, and gsFxo.
txflash N/A The flash transmit time. Must be 300-1100, default is 500
(milliseconds).
This parameter is not meaningful for SIGNALTYPEs lsFxo
and gsFxo.
guardtime N/A The minimum time to allow the on-hook to propagate through
the network when the call is terminated at the GSX. This
interval allows the far end time to reuse the channel. The
GSX will not reuse this channel until this interval expires.
Must be 100-1500, default is 800 (milliseconds).
This parameter is not meaningful for SIGNALTYPE lsFxo.
autobusy N/A The number of signaling errors which are allowed prior to
placing the channel into auto maintenance state. Once in this
state the channel must be returned to service from the CLI.
Must be 0-255, default is 0.
Setting this field to 0 disables auto maintenance processing.
dtprofile 1-23 The name of the CAS Disconnect Treatment Profile that will
be used to map a disconnect reason code to a Disconnect
Signaling Sequence Profile (SSP) for this service group.
Default is casDefault.
suspendtime N/A The timeout value in milliseconds before a call in which the
called party disconnected first is terminated. This provides
the CAS equivalent of the SS7 NODE TSus timer (see "SS7
Timer Values" on page 3–318) provided for ISUP calls. Must
be 0-60000 (milliseconds); default is zero.
A value of zero causes immediate call termination when the
outgoing circuit disconnects.
This parameter is not meaningful for SIGNALTYPEs lsFxs,
and gsFxs.
switchside N/A The switch side the CAS Service Group should emulate:
• user - A switch on the network side.
• network - A switch on the user side.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
Field
Parameter Length Description
sigvariant N/A The signaling variant that the CAS service group should
emulate:
• none (default) - none
• MexicoV1 - Network MFCR2 for Mexico.
• MexicoV2 - PBX MFCR2 for Mexico.
• itu - international R2
• indiaScheme5 - National R2 variant for India (Q421 line
signaling, 2-way operation)
• indiaScheme6Out - National R2 variant for India (non-
standard line signaling, one-way outbound operation only)
• indiaScheme6In - National R2 variant for India (non-
standard line signaling, one-way inbound operation only)
• indiaScheme7Out - National R2 variant for India (non-
standard line signaling, one-way outbound operation only)
• indiaScheme7In - National R2 variant for India (non-
standard line signaling, one-way inbound operation only)
• brazil - R2 national variant for Brazil
This parameter is meaningful only when SIGNALTYPE is
mfcr2.
bnumenddigit N/A BNUM End of Digits. Specifies whether the BNUM (or called
party number/DNIS) should be terminated with the end of
digits signal when dialed from the GSX:
• enabled - Send the end of digits signal.
• disabled (default) - Do not send the end of digits signal.
This parameter is meaningful only when SIGNALTYPE is
mfcr2.
mfcr2profile 1-23 The name of the DSP Digit Profile used for MFCR2 digit
reception and generation.
This profile is meaningful only when SIGNALTYPE is mfcr2.
clrtoidletime N/A Specifies the time, in milliseconds, that must elapse after a
clear forward is received in order for a channel to be
considered idle. This timer runs in parallel with the existing
(and configurable) guard timer. For a channel to be idle (or
available for a subsequent call):
• the forward and backward line signaling states must
indicate idle
• the clear to idle timer must have expired
• the guard timer must have expired
Must be 0-500, default is 100 (milliseconds).
This parameter is meaningful only when SIGNALTYPE is
mfcr2.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
Field
Parameter Length Description
e1cbit N/A Specifies the value of the forward/backward line signaling C-
bit on E1 channels. Must be 0 or 1, default is 0.
This parameter is meaningful only when SIGNALTYPE is
mfcr2.
e1dbit N/A Specifies the value of the forward/backward line signaling D-
bit on E1 channels. Must be 0 or 1, default is 1.
This parameter is meaningful only when SIGNALTYPE is
mfcr2.
mgcpackage N/A The package used to control a particular CAS service for
MGCP:
• none (default) - circuits are not to be controlled by the
MGCP Gateway service.
• md - North American MF Feature Group D EANA and EAIN
(for MGCP)
• mo - FGD Operator Services Signaling (for MGCP)
• ms - MF wink or immediate start (for MGCP)
ansupvto N/A When answer supervision is enabled, specifies the timeout
period, in seconds, from the egress receiving the first
backwards message from the called party exchange (Call
Proceeding, Alerting, Call Progress) until the call is
answered. If the timeout period expires, the answer
supervision action specified is triggered.
lsgsanswersupv N/A Specifies whether line side answer supervision is supported:
• disabled (default) - Line side answer supervision is not
supported.
• enabled - Answer supervision is supported. For
SIGNALTYPEs lsFxo and gsFxo, the RLCF signal will be
issued for ingress calls. For SIGNALTYPEs lsFxs and
gsFxs, the RLCF signal will be received on egress calls.
This parameter is not meaningful for SIGNALTYPEs eM and
mfcr2.
rxseizering N/A Specifies the time interval, in milliseconds, that a seizure
signal must be received in order to be considered a seizure/
ring. Must be 20-2000, default is 150 (milliseconds).
The seizure signal is:
• LC for SIGNALTYPE lsFxo
• RG for SIGNALTYPE gsFxo
• Ring for SIGNALTYPEs lsFxs and gsFxs
This parameter is not meaningful for SIGNALTYPEs eM and
mfcr2.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
Field
Parameter Length Description
rxfxsanswer N/A Specifies the time interval, in milliseconds, that the RLCF
signal must be received in order to be considered an answer.
Must be 20-2000, default is 100 (milliseconds).
This parameter is only meaningful for SIGNALTYPEs lsFxs
and gsFxs.
rxfxsdisc N/A Specifies the time interval, in milliseconds, that the LCFO
signal must be received in order to be considered a
disconnect. Must be 100-2000, default is 600 (milliseconds).
This parameter is meaningful only for SIGNALTYPEs lsFxS
and gsFxs.
rxlsfxsringcess N/A Specifies the time interval, in milliseconds, that the lack of a
Ring signal must be detected in order to be considered an
abandoned call. Must be 100-30000, default is 8000
(milliseconds).
This parameter is meaningful only for SIGNALTYPE lsFxs.
txlsfxodisc N/A Specifies the time interval, in milliseconds, that the LCFO
signal must be transmitted by the foreign exchange office
(FXO) side in order to release a call. Must be 0-2000, default
is 800 (milliseconds).
When you specify a value of 0, the LCFO signal is disabled.
This parameter is meaningful only for SIGNALTYPE lsFxo.
txfxoringon N/A Specifies the time interval, in milliseconds, that the Ring on
signal must be transmitted by the FXO side. Must be100-
10000, default is 800 (milliseconds).
This parameter is meaningful only for SIGNALTYPEs lsFxo
and gsFxo.
txfxoringoff N/A Specifies the time interval, in milliseconds, that the Ring off
signal must be transmitted by the FXO side. Must be 100-
10000, default is 4000 (milliseconds).
This parameter is meaningful only for SIGNALTYPEs lsFxo
and gsFxo.
cbprofno N/A The index number of the CRANKBACK PROFILE to use with
this CAS service group. This must specify a valid Call
Crankback profile index, in the range 1-10. The default is 1,
or Call Crankback Profile default. See"Call Crankback
Profile" on page 3–1171.
anumlength For R2, specifies the length of a transmitted calling party
number. A value of 0 implies variable length terminated by an
end of digits signal. Otherwise, the value specifies the fixed
length of the calling party number. Must be 0 to 30. The
default is 0.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
Field
Parameter Length Description
txr2enddigit N/A For R2, specifies the transmit end of the digits signal:
• r2Signal15 (default)
• r2Signal14
• r2Signal13
• r2Signal12
• r2Signal11
rxr2seize N/A For R2, specifies the duration (in milliseconds) that a seize
signal must be present before it is considered a valid signal.
Must be 20 to 2000; default is 20.
rxr2seizeack N/A For R2, specifies the duration (in milliseconds) that a seize
ACK signal must be present before it is considered a valid
signal. Must be 20 to 2000; default is 20.
rxr2answer N/A For R2, specifies the duration (in milliseconds) that an
answer signal must be present before it is considered a valid
signal. Must be 20 to 2000; default is 20.
rxr2clearback N/A For R2, specifies the duration (in milliseconds) that a clear
back signal must be present before it is considered a valid
signal. Must be 20 to 2000; default is 20.
rxr2clearfwd N/A For R2, specifies the duration (in milliseconds) that a clear
forward signal must be present before it is considered a valid
signal. Must be 20 to 2000; default is 20.
rxr2idleback N/A For R2, specifies the duration (in milliseconds) that an idle
back signal must be present before it is considered a valid
signal. Must be 20 to 2000; default is 20.
rxr2block N/A For R2, specifies the duration (in milliseconds) that a block
signal must be present before it is considered a valid signal.
Must be 20 to 2000; default is 20.
cgrtimeout N/A The time (in seconds) to wait to release a call when that call
was rejected due to congestion. This parameter effectively
prevents the machine congestion level from escalating due to
rapid repeated call attempts by equipment that does not
support congestion detection. Must be 0-5 (seconds), default
is 0. A value of 0 disables this timer.
If this value is nonzero, the timer is started when a call is
rejected due to congestion. When the timer expires, the
network release is sent and the call resources are de-
allocated. If a network release is received during the delay,
the timer is stopped and the call resources are de-allocated.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
Field
Parameter Length Description
ldcaction N/A Specifies the action to take if the Long Duration Call (LDC)
timer expires. The call may be released, a SNMP trap may be
generated, or both:
• noAction (default) - take no action on LDC timer expiry
(a debug log entry will be generated).
• trap - generate an SNMP trap.
• release - automatic call disconnect without generation of
a trap.
• trapAndRelease - generate an trap and release the call.
Note: CAS Service Group LDC parameters can only be
updated when the ADMIN STATE of the service group is set
to disabled.
ldcemergcalls N/A Specifies whether emergency calls should be excluded from,
or included in Long Duration Call (LDC) disconnect
procedures:
• include
• exclude (default)
Note: Emergency call exclusion relies on the PSX call type or
other protocol-specific criteria to identify the call as an
“emergency” call.
ldcrelcause N/A Specifies the GSX disconnect reason used to release the call
if the call is released due to Long Duration Call (LDC) timer
expiry. Must be 1 to 127; default is 41 (Temporary Failure).
ldctimeout N/A Specifies the timeout value of the Long Duration Call (LDC)
timer in minutes. Must be 0 or 60-2880. A value of 0 disables
the timer; a value of 60-2880 set the timer. Default is 0.
oper-state N/A The operational state of the CAS service:
• inservice (default) - The CAS service can carry new
calls.
• outofservice - The CAS service is prevented from
carrying new calls.
action N/A The method by which calls on the channels using this CAS
service are processed when oper-state goes to
outOfService.
• force - all calls dropped immediately.
• dryup - all calls are allowed to complete normally until
timeout expires, when they are dropped.
timeout N/A The time (in minutes) to wait to place the CAS channels in
the outOfService oper-state. Must be 1-1440.
Default is 1.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
Field
Parameter Length Description
group N/A An operation to be applied to the underlying CAS service
group:
• noAction (default) - perform no group operations.
• resetStats - causes the statistics for each channel in
this service group to be reset.
admin-state N/A The administrative state of this CAS service group:
• disabled (default) - Not activated, able to be
reconfigured or deleted. (This state clears the CAS service
group call statistics.)
• enabled - Activated, available for immediate use.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
Command Example
To create and configure CAS service casinserv, with the default SIGNALTYPE eM:
% CREATE CAS SERVICE casinserv
% CONFIGURE CAS SERVICE casinserv TRUNKGROUP tg1
% CONFIGURE CAS SERVICE casinserv ..
INGRESS_SSP winkDTMFIngress
EGRESS_SSP winkDTMFEgress
HUNT bottom2top
COST 50
MAINTBUSY enabled
% CONFIGURE CAS SERVICE casinserv STATE enabled
% CONFIGURE CAS SERVICE casinserv MODE inService
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
To create CAS service ST_gsFxo, setting its SIGNALTYPE to gsFxo, and then view the default
gsFxo parameters:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
To create CAS service ST_gsFxs, setting its SIGNALTYPE to gsFxs, and then view the default
gsFxs parameters:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
To create CAS service ST_lsFxs, setting its SIGNALTYPE to lsFxs, and then view the default
lsFxs parameters:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
To create CAS service ST_lsFxo, setting its SIGNALTYPE to lsFxo, and then view the default
lsFxo parameters:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
To create CAS service ST_mfcr2, setting its SIGNALTYPE to mfcr2, and then view the default
mfcr2 parameters:
------------------------------------------------------------
Name: ST_mfcr2
------------------------------------------------------------
Admin State: DISABLED Trunk Group: ISUPTG
Cost 50 Hunt Algorithm: BOTTOM2TOP
Signal Type: MFCR2 Signal Variant: NONE
Switch Side: NETWORK CPTone Pkg:
Maint Busy: ENABLED Answer Timeout: 0
Auto Busy: 0 DTMF Profile:
Requires CPTone DISABLED Ingress SSP:
Provides CPTone DISABLED Egress SSP:
MGC Package: NONE PSC SSP:
Guard Time: 800 DT Profile:
Crank Back Prof: 1 Cong Rel Time: 0 (sec)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
This object creates the CAS Signaling Sequence Profile (SSP). The CAS SSP defines a set of
signaling sequences that are necessary to ultimately connect a call. Use CAS SSPs for Ingress/
Egress/Hookflash call establishment and Permanent Signal Condition (PSC) processing. Use
Disconnect SSPs for disconnect treatment (see "Disconnect Signaling Sequence Profile" on
page 3–1165).
The CAS SSP is “populated” when you create and configure these individual signaling sequences.
See "CAS Signaling Sequence" on page 3–1116 for more information on signaling sequences.
This object merely creates (names), or deletes a CAS SSP.
Command Syntax
Command Parameters
Field
Parameter Length Description
cassspname 1-23 The name of the CAS Signaling Sequence Profile.
Command Example
Name Index
----------------------- -----
winkDTMFIngress 1
DM 2
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
test 3
winkDTMFEgress 4
fgdDTMFIngress 5
fgdDTMFEgress 6
fgdIngressNAAccess 7
fgdEgressNAAccess 8
reorderSSP 9
sitSSP 10
testExecSSP 11
SSProuteNow 12
SSPcollectLocal 13
SSPcollectLD 14
SSPcollectCarr 15
SSPcollectIntl 16
PscSsp 17
hookFlashTransfer 18
ingressLsFxo 19
egressLsFxo 20
egressLsFxoDial 21
ingressLsFxs 22
ingressLsFxsR2 23
ingressLsFxsR3 24
egressLsFxs 25
egressLsFxsAns 26
ingressGsFxo 27
egressGsFxo 28
egressGsFxoDial 29
ingressGsFxs 30
ingressGsFxsR2 31
ingressGsFxsR3 32
egressGsFxs 33
egressGsFxsAns 34
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
This object creates the CAS Signaling Condition Profile (SCP). The SCP defines a set of signaling
conditions, each associated with an unexpected event or failure that might occur during the
execution of an SSP. The SCP is “populated” when you create and configure each individual
signaling condition. See "CAS Signaling Condition" on page 3–1136 for more information on
signaling conditions. This object merely creates (names), or deletes an SCP.
Command Syntax
Command Parameters
Field
Parameter Length Description
casscpname 1-23 The name of the CAS Signaling Condition Profile.
Command Example
Name Index
----------------------- --------
collectErrors 1
winkErrors 2
noAnswer 3
AllErrors 4
routeNow 5
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
collectLD 6
collectIntl 7
collectLocal 8
collectCarr 9
abortSCP 10
procSkipSCP 11
inMexV1CollectFail 12
inMexV1CalledPartyRem 13
inMexV2CollectFail 14
inMexV2CalledParty 15
egMexV1SeizeAck 16
egMexV1GroupA 17
egMexV1GroupB 18
egMexV1GroupC0 19
egMexV1GroupC1 20
egMexV2SeizeAck 21
egMexV2GroupA 22
egMexV2GroupB 23
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
This object creates and configures each step (or entry) in the CAS Signaling Sequence Profile
(SSP) object, described previously. A CAS signaling token is specified for each signaling
sequence, establishing an action to take or condition to be met before proceeding to the next entry
in the CAS SSP. For each entry, the optional SCPNAME parameter defines handling that is to occur
if an exception or an optional condition is encountered during processing of the CAS signaling
token.
• CAS Signaling Token - a well defined set of actions to perform or conditions to be met before
proceeding to the next entry in the CAS SSP.
• Parameter 1 (PARAM1) - an optional value used to complete the action or condition that is
unique to this signaling sequence.
• Parameter 2 (PARAM2) - a second optional value used to complete the action or condition, also
unique to this signaling sequence.
• Condition Profile - a Signaling Condition Profile (SCP) that defines the handling that occurs
when a specific exception or optional condition is encountered during the processing of the
CAS signaling token associated with this CAS signaling sequence.
If an exception condition occurs and the SCP is not specified in a signaling sequence, then the
default SCP token will be used to process the exception. If the default SCP token does
not exist, then the call will be disconnected when any exception occurs. If the SCP is specified,
it will be executed. (A timeout while collecting a DTMF digit is one example of an exception
condition.)
If an optional condition occurs and the SCP is not specified in a signaling sequence, then the
call processing continues at the next POSITION in the SSP. If the SCP is specified, it will be
executed. (A match of a collected digit field against a configured digit pattern is one example
of an optional condition.)
See Table 3–211, "CAS SIGNALCOND Parameters" on page 3–1137 for a list of exception
and optional conditions that may be handled by special SCPs.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
Circuit Testing
The CAS Signaling Sequence Profile is also used for configuring circuit test calls. The following
CAS Signaling Tokens are utilized for outgoing and incoming trunk testing:
• testCGPN
• testCDPN
• testOUTGW
• testOUTTG
• testCIC
• testSLOT
• testCHAN
• testINTG
• testORIGCARRIER
• testORIGCHARGE
• testCPC
• testTMR
• testISUPPREF
• testISDNACCESS
• testINGW
For more information on circuit test calls, see "Circuit Test Packages" on page 6–206.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
Command Parameters
Field
Parameter Length Description
cassspname 1-23 The name of the CAS Signaling Sequence Profile.
index N/A A unique key that is assigned to each entry.
position N/A The position in the CAS SSP at which to execute this step. This
parameter allows you to insert steps into the middle of a CAS SSP
without needing to renumber the index of the subsequent SSP
steps. Positions begin with zero, so to insert a step in front of step
3 in the current CAS SSP, you must declare a position of 2. Must
be 0 - 31. Default is 0.
token N/A The CAS signaling token (actions to be performed or conditions to
be met). See Table 3–210 "CAS Signaling Tokens" on page 3–
1119 for a list of these values.
param1 1-31 A text field used to pass parameter #1 to the CAS SSP signaling
sequence that is being configured. This parameter is dependent
on the CAS signaling token used in this signaling sequence. See
Table 3–210 "CAS Signaling Tokens" on page 3–1119.
param2 1-31 A text field used to pass parameter #2 to the CAS SSP signaling
sequence that is being configured. This parameter is dependent
on the signaling token used in this signaling sequence. See
Table 3–210 "CAS Signaling Tokens" on page 3–1119.
casscpname 1-23 The name of the CAS SCP to invoke in the event of an error in this
SSP signaling sequence.
admin-state N/A The administrative state of this CAS SSP signaling sequence:
• disabled (default) - Not activated, able to be reconfigured or
deleted.
• enabled - Activated, available for immediate use.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
Token Description
seize Go off hook.
The PARAM1 value may be:
• NOW - Send the seizure immediately.
• READY - Delay the seizure until the next digit collection is ready.
If CAS SERVICE SIGNALTYPE is:
• lsFxs or gsFxs - send the off-hook (LC) signal.
• lsFxo or gsFxo - send the answer (RLCF) signal.
wink Provide a timed on-hook/off-hook/on-hook transition of the signaling bits.
The wink transmit and receive duration is specified in the CAS service
group object.
The PARAM1 value may be:
• NOW - Send the wink immediately.
• READY - Delay the wink until the next digit collection is ready.
flash Provide a timed off-hook/on-hook/off-hook transition of the signaling bits.
The flash transmit and receive duration is specified in the CAS service
group object.
The PARAM1 value may be:
• NOW - Send the flash immediately.
• READY - Delay the flash until the next digit collection is ready.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
Token Description
dialMF Dial the digits specified by the digit field defined in PARAM1 via MF tones.
The PARAM1 value may be:
• calledParty - Destination of the call.
• callingParty - Originator of the call.
• ani - Automatic number Id (calling number). The Sonus KP ani ST
digit dial sequence is KP+ANI(10 digits)+ST.
• iani - Information digit + ani. (Information digits map to the
Originating Line Information (OLI) values in SS7.)
• iiani - 2 information digits + ani. The Sonus KP iiani ST digit dial
syntax is KP+II+ANI(10 digits)+ST, where II is two information digits.
• dnis - Dialed number Id service.
• internationalCountryCode - International country code. This field
abstract is 1NX+XXXX+CCC where 1NX is 138 (No Operator) or 158
(Operator Assisted), XXXX is the 4 digit carrier code, and CCC is the 3
digit country code.
• carrierId - Carrier identification code. This field abstract is
0ZZ+XXXX where 0ZZ is the call agent configurable trunk group
information to determine the type of call and XXXX is the 4 digit carrier
code.
• fgdStageOne - Field to dial either the Feature Group D (FGD)
CarrierId (EANA Signaling) or FGD International Country Code (EAIN
Signaling).
dialDTMF Dial the digits specified by the digit field defined in PARAM1 via DTMF
tones. The PARAM1 value may be:
• calledParty - Destination of the call.
• callingParty - Originator of the call.
• ani - Automatic number Id (calling number).
• iani - Information digit + ani. (Information digits map to the
Originating Line Information (OLI) values in SS7.)
• iiani - 2 information digits + ani.
• dnis - Dialed number Id service.
• internationalCountryCode - International country code. This field
abstract is 1NX+XXXX+CCC where 1NX is 138 (No Operator) or 158
(Operator Assisted), XXXX is the 4 digit carrier code, and CCC is the 3
digit country code.
• carrierId - Carrier identification code. This field abstract is
0ZZ+XXXX where 0ZZ is the call agent configurable trunk group
information to determine the type of call and XXXX is the 4 digit carrier
code.
• fgdStageOne - Field to dial either the Feature Group D (FGD)
CarrierId (EANA Signaling) or FGD International Country Code (EAIN
Signaling).
Overlap is not supported.
dialDigit Dial the DTMF digit specified in PARAM1.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
Token Description
playTone Play the tone specified in PARAM1 for the duration specified in PARAM2.
The PARAM1 value must match a defined tone type (see "Tone Type" on
page 3–1199). If PARAM2 is 0, play the tone indefinitely (or until it
completes on its own). Execution of the CAS SSP will be suspended until
the tone completes.
playAnn Play the announcement specified in PARAM1. The PARAM1 value must
match a previously established announcement number (see
"Announcements" on page 6–88).
delay Delay further execution of the SSP for the interval (in milliseconds)
specified in PARAM1.
waitWink Wait to receive a wink for the interval (in milliseconds) specified in
PARAM1. If a wink is not received in this interval, then a WinkTimeout is
declared.
A value of 0 causes an indefinite wait.
waitFlash Wait to receive a hook flash for the interval (in milliseconds) specified in
PARAM1. If a flash is not received in this interval, then a FlashTimeout is
declared.
A value of 0 causes an indefinite wait.
waitAnswer Wait to receive an answer for the interval (in milliseconds) specified in
PARAM1. If an answer is not received in this interval, then an
AnswerTimeout is declared.
A value of 0 (indefinite wait) causes the system imposed call
establishment timer to enforce the duration that the call waits for an
answer. The system imposed call establishment timer is 5 minutes or
300,000 milliseconds. When this timer expires, the call is released but the
CAS AnswerTimeout condition is not declared and CAS signaling
condition processing does not occur.
Hence to use this token to generate an AnswerTimeout condition, the
range must be 1-299,999 (milliseconds).
If CAS SERVICE SIGNALTYPE is:
• lsFxo or gsFxo - wait for the off-hook (LC) signal.
• lsFxs or gsFxs - wait for the answer (RLCF) signal.
collectField Collect a field of digits as defined by the collection profile specified in
PARAM1. Any tone or announcement prompt for digits must be specified
within the collection profile.
collectDigit Collect a single (DTMF only) digit to match against the value specified in
PARAM1. Wait for the digit for the interval (in milliseconds) specified in
PARAM2.
A PARAM2 value of 0, causes an indefinite wait.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
Token Description
report Issue a Q.931 indication to call control. This message is mapped to the
equivalent call control message. The values permitted in PARAM1 are
SetupComp, progress, alert, connect, or transfer. When PARAM1
is progress or alert, then the value of PARAM2 affects early cut thru for the
call as follows:
• FullDuplex (default) - cut thru in both forwards and backwards
directions
• Backwards - cut thru in the backward direction (audio will be heard
only by the ingress, or calling, party)
• Forwards - cut thru in the forward direction (audio will be heard only by
the egress, or called, party)
• NoCutThru - no cut thru until answer is received
• NotApplicable - early cut thru does not apply to this call
Early cut thru is cut thru after dialing but prior to answer. Cut thru after
answer is always full duplex. See also CAS SERVICE .. CPTONEPROV.
clear Initiate call clearing procedures on the call. The disconnect reason is an
integer that is specified in PARAM1. This value must be 1-255:
• 1-127, as specified in Q.931/Q.850
• 128-255, GSX extensions
See "Call Termination Reason Codes" on page 7–30.
exec Start execution of the CAS SSP specified in PARAM1.
matchDigits Match the digits that have been collected in the collection profile specified
in PARAM1 with digit pattern specified in PARAM2. This digit pattern must
be 1-31 characters in length. Valid PARAM2 pattern characters are:
• DTMF (or MF) digits 0-9
• DTMF digits A-D
• DTMF digit *
• DTMF digit #
• X - wildcard digit that matches any single digit 0-9
• N - wildcard digit that matches any single digit 2-9
• - - (dash character) wildcard character that matches any remaining
digits in the collected field (must be the last character in the pattern)
• K - KP MF start digit
• S - ST MF stop digit
• a - ST1 MF stop digit
• b - ST2 MF stop digit
• c - ST3 MF stop digit
The SCP optional condition, digitMatch, is set if the pattern matches. In
that case, the SCP specified by SCPNAME will be executed.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
Token Description
seizeAck Set the backward line signaling bits to a value of 1 or 0 to indicate seizure
acknowledgement. If PARAM1 is now, the seizure acknowledgement is
sent immediately. If PARAM1 is ready, the seizure acknowledgement is
not sent until the next digit collection is ready.
This token is meaningful only when the CAS SERVICE SIGNALTYPE is
mfcr2.
waitSeizeAck Wait for a seizure acknowledgement to be received. Wait for the number of
milliseconds specified in PARAM1. If PARAM1 is 0, wait indefinitely.
This token is meaningful only when the CAS SERVICE SIGNALTYPE is
mfcr2.
mfcFwdTimers Set new timeout values (in milliseconds) for the maximum forward on/off
timers. These values will override the defaults specified in the CAS
SERVICE MFCR2PROFILE. PARAM1 specifies the maximum forward on
time. PARAM2 specifies the maximum forward off time. If either parameter
is not specified, then the default value from MFCR2PROFILE is assigned to
that parameter. The range for each timer is 10000-50000 (milliseconds).
This token is meaningful only when the CAS SERVICE SIGNALTYPE is
mfcr2.
dialMFC Dial the digits specified by the digit field in PARAM1 via MFC R2 tones. The
possible values for PARAM1 are ANI, calling party, DNIS, called
party, calling party category, charge category, or
subscriber status. PARAM2 specifies the next digit acknowledgement
signal, for example 1. The possible values for PARAM2 are 0-15 or the
string any. A value of 0 means that there is no next digit acknowledgement
(only allowed for fields which are single digits). A value of any means that
any R2 signal is an acknowledgement.
This token is meaningful only when the CAS SERVICE SIGNALTYPE is
mfcr2.
dialMFP Dial the R2 signal specified in PARAM1 via pulsed MF tone signaling. The
possible values for PARAM1 are 3 or 4 (for Mexico).
This token is meaningful only when the CAS SERVICE SIGNALTYPE is
mfcr2.
waitMFP Wait for a pulsed R2 signal. Wait for the number of milliseconds specified
in PARAM1. If the value of PARAM1 is 0, then wait indefinitely.
This token is meaningful only when the CAS SERVICE SIGNALTYPE is
mfcr2.
dialIndex Set the dial index of the field specified in PARAM1 to the value specified in
PARAM2. The possible values for PARAM1 are ANI, calling party,
DNIS, called party, calling party category, charge category,
or subscriber status. The possible values for PARAM2 (for Mexico) are
1 (first digit), N (same digit), or N+1 (next digit).
This token is meaningful only when the CAS SERVICE SIGNALTYPE is
mfcr2.
test Perform additional conditional processing on the last event or condition
that occurred. A signal condition profile must be specified.
This token is meaningful for all CAS SERVICE SIGNALTYPEs.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
Token Description
ring Start and stop the ring cycle according to CAS SERVICE configuration.
Start the ring when PARAM1 is set to “on” and stop the ring when PARAM1
is set to “off”.
For CAS SERVICE SIGNALTYPE gsFxo, if PARAM2 is 0, the ring cycle is
initiated with the ring-on signal. If PARAM2 is non-zero, its value specifies
the number of milliseconds of duration for a ring cycle that is initiated with
the ring-off (LCF) signal.
This token is meaningful only when CAS SERVICE SIGNALTYPE is lsFxo
or gsFxo.
ringGround Send the ring ground (RG) signal.
This token is meaningful only when CAS SERVICE SIGNALTYPE is gsFxs.
tipGround Send the tip ground (LCF) signal.
This token is meaningful only when CAS SERVICE SIGNALTYPE is gsFxo.
waitTipGround Wait for the tip ground (LCF) signal for the number of milliseconds
specified in PARAM1.
This token is meaningful only when CAS SERVICE SIGNALTYPE is gsFxs.
testCGPN For test calls, the PARAM1 field specifies the calling party number (up to 30
digits) and the PARAM2 field specifies the calling party nature of address.
The PARAM2 value may be:
• subscriber
• national (default)
• international
• networkspecific
For more information on circuit test calls, see "Circuit Test Packages" on
page 6–206.
testCDPN For test calls, the PARAM1 field specifies the called party number (up to 30
digits) and the PARAM2 field specifies the called party nature of address.
The PARAM2 value may be:
• subscriber
• national (default)
• international
• networkspecific
For more information on circuit test calls, see "Circuit Test Packages" on
page 6–206.
testOUTGW For test calls, the PARAM1 field specifies the destination gateway signaling
address. The PARAM2 field specifies the IP port number (1 - 65535). The
PARAM1 field is required and must be a valid IP address or the string
"local." The PARAM2 field may be empty, in which case the default
gateway IP port address (2569) is used. When the PARAM1 field is set to
"local," a local PSTN-to-PSTN call is performed without gateway
signaling.
For more information on circuit test calls, see "Circuit Test Packages" on
page 6–206.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
Token Description
testOUTTG For test calls, the PARAM1 field specifies the outgoing trunk group.
For more information on circuit test calls, see "Circuit Test Packages" on
page 6–206.
testCIC For test calls, the PARAM1 field specifies the ISUP CIC number for the call.
For more information on circuit test calls, see "Circuit Test Packages" on
page 6–206.
testSLOT For test calls, the PARAM1 field specifies the GSX slot number (1 - 16) of
the card containing the desired outgoing channel.
For more information on circuit test calls, see "Circuit Test Packages" on
page 6–206.
testCHAN For test calls, the PARAM1 field specifies the linear DS1 (1 - 84) containing
the desired outgoing channel. The PARAM2 field specifies the DS0 (1 - 31)
for the call.
For more information on circuit test calls, see "Circuit Test Packages" on
page 6–206.
testINTG For test calls, the PARAM1 field specifies the incoming trunk. This signaling
token overrides that which is defined in the CAS Service for routing
purposes only. Allocation of internal resources still utilizes the trunk group
configured within the CAS Service.
For more information on circuit test calls, see "Circuit Test Packages" on
page 6–206.
testORIGCARRIER For test calls, the PARAM1 field specifies the originating carrier code (up to
5 digits).
For more information on circuit test calls, see "Circuit Test Packages" on
page 6–206.
testORIGCHARGE For test calls, the PARAM1 field specifies the originating charge area (up to
5 digits).
For more information on circuit test calls, see "Circuit Test Packages" on
page 6–206.
testCPC For test calls, the PARAM1 field specifies the calling party category:
• ordinarysubscriber
• prioritysubscriber
• test (default)
• payphone
For more information on circuit test calls, see "Circuit Test Packages" on
page 6–206.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
Token Description
testTMR For test calls, the PARAM1 field specifies the TMR:
• 3.1khz
• speech (default)
• res – 64K restricted
• unres – 64K unrestricted
For more information on circuit test calls, see "Circuit Test Packages" on
page 6–206.
testISUPPREF For test calls, the PARAM1 field specifies the ISUP preferred setting:
• 0 – mandatory (default)
• 1 – not-required
For more information on circuit test calls, see "Circuit Test Packages" on
page 6–206.
testISDNACCESS For test calls, the PARAM1 field specifies the ISDN access indicator:
• 0 – ISDN (default)
• 1 – non-ISDN
For more information on circuit test calls, see "Circuit Test Packages" on
page 6–206.
testINGW For test calls, the PARAM1 field specifies the Incoming Gateway name.
For more information on circuit test calls, see "Circuit Test Packages" on
page 6–206
NOTE
When you generate CAS SSPs for tokens that are capable of timing out, such as
waitWink, waitAnswer, waitFlash, collectDigit, and others, you should
always have an SCP defined to handle a timeout error. This policy allows you to
return an accurate error indication such as “no user responding” to the
administrator.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
Command Example 1
To display the configuration of CAS SSP winkDTMFIngress that was created and configured
above:
% SHOW CAS SIGNALSEQ SSP winkDTMFIngress SUMMARY
Node: TPUBS Date: 2002/11/22 00:40:01 GMT
Zone: GMTMINUS05-EASTERN-US
To clear the PARAM1 and PARAM2 residual values for a new token (such as CLEAR), so that those
values are never applied to the current token:
% CONFIGURE CAS SIGNALSEQ SSP winkDTMFIngress INDEX 4 ..
TOKEN CLEAR PARAM1 "" PARAM2 ""
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
The SSP below, ingressToneStart, collects the first 3 digits of the dialed number via the
dnisInitial Collection Profile. It then utilizes matchDigits token processing to examine the
digits. This token sets the SCP optional condition digitMatch to true if the collected digits match
the specified pattern. The specified SCP is invoked to branch to a new SSP when this condition is
true. Otherwise, processing continues with the next signaling sequence. Once all specified patterns
have been tested, the SSP assumes that a local number is being dialed so it collects the remaining
digits of the local number via the dnisLocal Collection Profile. See also "CAS Collection
Profile" on page 3–1150.
% CREATE CAS SSP ingressToneStart
% CREATE CAS SIGNALSEQ SSP ingressToneStart INDEX 1
% CREATE CAS SIGNALSEQ SSP ingressToneStart INDEX 2
% CREATE CAS SIGNALSEQ SSP ingressToneStart INDEX 3
% CREATE CAS SIGNALSEQ SSP ingressToneStart INDEX 4
% CREATE CAS SIGNALSEQ SSP ingressToneStart INDEX 5
% CREATE CAS SIGNALSEQ SSP ingressToneStart INDEX 6
% CREATE CAS SIGNALSEQ SSP ingressToneStart INDEX 7
% CREATE CAS SIGNALSEQ SSP ingressToneStart INDEX 8
% CREATE CAS SIGNALSEQ SSP ingressToneStart INDEX 9
% CREATE CAS SIGNALSEQ SSP ingressToneStart INDEX 10
% CREATE CAS SIGNALSEQ SSP ingressToneStart INDEX 11
% CONFIGURE CAS SIGNALSEQ SSP ingressToneStart INDEX 0 ..
TOKEN collectField PARAM1 dnisInitial SCPNAME collectErrors
% CONFIGURE CAS SIGNALSEQ SSP ingressToneStart INDEX 1 ..
TOKEN matchDigits PARAM1 dnis PARAM2 0 SCPNAME routeNow
% CONFIGURE CAS SIGNALSEQ SSP ingressToneStart INDEX 2 ..
TOKEN matchDigits PARAM1 dnis PARAM2 00 SCPNAME routeNow
% CONFIGURE CAS SIGNALSEQ SSP ingressToneStart INDEX 3 ..
TOKEN matchDigits PARAM1 dnis PARAM2 X SCPNAME clearNow
% CONFIGURE CAS SIGNALSEQ SSP ingressToneStart INDEX 4 ..
TOKEN matchDigits PARAM1 dnis PARAM2 XX SCPNAME clearNow
% CONFIGURE CAS SIGNALSEQ SSP ingressToneStart INDEX 5 ..
TOKEN matchDigits PARAM1 dnis PARAM2 411 SCPNAME routeNow
% CONFIGURE CAS SIGNALSEQ SSP ingressToneStart INDEX 6 ..
TOKEN matchDigits PARAM1 dnis PARAM2 911 SCPNAME routeNow
% CONFIGURE CAS SIGNALSEQ SSP ingressToneStart INDEX 7 ..
TOKEN matchDigits PARAM1 dnis PARAM2 011 SCPNAME collectIntx
% CONFIGURE CAS SIGNALSEQ SSP ingressToneStart INDEX 8 ..
TOKEN matchDigits PARAM1 dnis PARAM2 1XX SCPNAME collectLd
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
Command Example 2
The following example is a set of CAS SSPs that implement glare-yield and glare-proceed
signaling protocols. Relevant SCP examples are also provided. Refer to the CLI object CAS
SignalCondition for more details.
Create, configure, and enable an SSP for outgoing Feature Group D that will yield to an incoming
call during glare:
% CREATE CAS SSP glareyieldSSP
% CREATE CAS SIGNALSEQ SSP glareyieldSSP INDEX 1
% CREATE CAS SIGNALSEQ SSP glareyieldSSP INDEX 2
% CREATE CAS SIGNALSEQ SSP glareyieldSSP INDEX 3
% CREATE CAS SIGNALSEQ SSP glareyieldSSP INDEX 4
% CREATE CAS SIGNALSEQ SSP glareyieldSSP INDEX 5
% CREATE CAS SIGNALSEQ SSP glareyieldSSP INDEX 6
% CREATE CAS SIGNALSEQ SSP glareyieldSSP INDEX 7
% CREATE CAS SIGNALSEQ SSP glareyieldSSP INDEX 8
% CONFIGURE CAS SIGNALSEQ SSP glareyieldSSP INDEX 1 TOKEN ..
seize PARAM1 now SCP yielderrorsSCP
% CONFIGURE CAS SIGNALSEQ SSP glareyieldSSP INDEX 2 TOKEN ..
waitWink PARAM1 4000 SCPNAME yielderrorsSCP
% CONFIGURE CAS SIGNALSEQ SSP glareyieldSSP INDEX 3 TOKEN ..
dialMF PARAM1 iiani
% CONFIGURE CAS SIGNALSEQ SSP glareyieldSSP INDEX 4 TOKEN ..
dialMF PARAM1 dnis
% CONFIGURE CAS SIGNALSEQ SSP glareyieldSSP INDEX 5 TOKEN ..
waitWink PARAM1 4000
% CONFIGURE CAS SIGNALSEQ SSP glareyieldSSP INDEX 6 TOKEN ..
report PARAM1 progress
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
Create, configure, and enable an SSP for outgoing Feature Group D that will proceed with an
outgoing call during glare:
% CREATE CAS SSP glareproceedSSP
% CREATE CAS SIGNALSEQ SSP glareproceedSSP INDEX 1
% CREATE CAS SIGNALSEQ SSP glareproceedSSP INDEX 2
% CREATE CAS SIGNALSEQ SSP glareproceedSSP INDEX 3
% CREATE CAS SIGNALSEQ SSP glareproceedSSP INDEX 4
% CREATE CAS SIGNALSEQ SSP glareproceedSSP INDEX 5
% CREATE CAS SIGNALSEQ SSP glareproceedSSP INDEX 6
% CREATE CAS SIGNALSEQ SSP glareproceedSSP INDEX 7
% CREATE CAS SIGNALSEQ SSP glareproceedSSP INDEX 8
% CONFIGURE CAS SIGNALSEQ SSP glareproceedSSP INDEX 1 TOKEN ..
seize PARAM1 now SCP proceederrorsSCP
% CONFIGURE CAS SIGNALSEQ SSP glareproceedSSP INDEX 2 TOKEN ..
waitWink PARAM1 4000 SCP proceederrorsSCP
% CONFIGURE CAS SIGNALSEQ SSP glareproceedSSP INDEX 3 TOKEN ..
PARAM1 iiani
% CONFIGURE CAS SIGNALSEQ SSP glareproceedSSP INDEX 4 TOKEN ..
dialMF PARAM1 dnis
% CONFIGURE CAS SIGNALSEQ SSP glareproceedSSP INDEX 5 TOKEN ..
waitWink PARAM1 4000
% CONFIGURE CAS SIGNALSEQ SSP glareproceedSSP INDEX 6 TOKEN ..
report PARAM1 progress
% CONFIGURE CAS SIGNALSEQ SSP glareproceedSSP INDEX 7 TOKEN waitAnswer
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
Upon detecting a seizure/answer instead of a wink, the SCP, glareyieldSCP, clears the
connection with a specific cause value of 129 (Collision Backoff) which accepts the incoming
connection and hunts for a new resource for the outgoing connection. All other failures clear the
connection with a specific cause value of 111 (Protocol Error Unspecified).
% CREATE CAS SIGNALCOND SCP glareyieldSCP TOKEN rxAnswer
% CREATE CAS SIGNALCOND SCP glareyieldSCP TOKEN default
% CONFIGURE CAS SIGNALCOND SCP glareyieldSCP TOKEN rxAnswer ..
CONTROL abort PARAM 129
% CONFIGURE CAS SIGNALCOND SCP glareyieldSCP TOKEN default ..
CONTROL abortMB PARAM 111
% CONFIGURE CAS SIGNALCOND SCP glareyieldSCP TOKEN rxAnswer ..
STATE enabled
% CONFIGURE CAS SIGNALCOND SCP glareyieldSCP TOKEN default ..
STATE enabled
Upon detecting a seizure/answer instead of a wink, the SCP, glareproceedSCP, proceeds with
the current SSP and waits for an onhook which is interpreted as a wink. A timeout while awaiting
the wink returns a specific cause value of 17 (User Busy). All other failures clear the connection
with a specific cause value of 111 (Protocol Error Unspecified).
% CREATE CAS SIGNALCOND SCP glareproceedSCP TOKEN rxAnswer
% CREATE CAS SIGNALCOND SCP glareproceedSCP TOKEN winkTimeout
% CREATE CAS SIGNALCOND SCP glareproceedSCP TOKEN default
% CONFIGURE CAS SIGNALCOND SCP glareproceedSCP TOKEN rxAnswer ..
CONTROL proceed PARAM noskip
% CONFIGURE CAS SIGNALCOND SCP glareproceedSCP TOKEN ..
winkTimeout CONTROL abort PARAM 17
% CONFIGURE CAS SIGNALCOND SCP glareproceedSCP TOKEN default ..
CONTROL abortMB PARAM 111
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
Command Example 3
The following example is a set of CAS SSPs that implement glare-yield and glare-proceed
signaling protocols for outgoing Feature Group D calls (or Two Stage Outpulsing). The behavior
of these SSPs to process national and international tandem calls is annotated for each protocol. The
SCPs invoked from these SSPs are not shown. The SCPs shown immediately above are similar to
those required for these SSPs. See the CLI object CAS COLLECTION PROFILE for more on Feature
Group D calls.
% CREATE CAS SSP fgdEgress2GlareYield
% CREATE CAS SIGNALSEQ SSP fgdEgress2GlareYield INDEX 1
% CREATE CAS SIGNALSEQ SSP fgdEgress2GlareYield INDEX 2
% CREATE CAS SIGNALSEQ SSP fgdEgress2GlareYield INDEX 3
% CREATE CAS SIGNALSEQ SSP fgdEgress2GlareYield INDEX 4
% CREATE CAS SIGNALSEQ SSP fgdEgress2GlareYield INDEX 5
% CREATE CAS SIGNALSEQ SSP fgdEgress2GlareYield INDEX 6
% CREATE CAS SIGNALSEQ SSP fgdEgress2GlareYield INDEX 7
% CREATE CAS SIGNALSEQ SSP fgdEgress2GlareYield INDEX 8
% CONFIGURE CAS SIGNALSEQ SSP fgdEgress2GlareYield INDEX 1 ..
TOKEN SEIZE PARAM1 now SCP winkErrorsYield
% CONFIGURE CAS SIGNALSEQ SSP fgdEgress2GlareYield INDEX 2 ..
TOKEN WAITWINK PARAM1 4000 SCP winkErrorsYield
% CONFIGURE CAS SIGNALSEQ SSP fgdEgress2GlareYield INDEX 3 ..
TOKEN DIALMF PARAM1 FGDSTAGEONE
% CONFIGURE CAS SIGNALSEQ SSP fgdEgress2GlareYield INDEX 4 ..
TOKEN WAITWINK PARAM1 4000
# National tandem calls - 0ZZ+CCC or 0ZZ+CCCC
# (where C is the 3 or 4 digit carrier code).
# If the call is a national call then no need to wait
# for a second wink. Exec the SSP to complete the FGD
# egress call.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
Create, configure, and enable an SSP for outgoing Feature Group D (Two Stage Outpulsing) that
will proceed with an outgoing call during glare:
% CREATE CAS SSP fgdEgress2GlareProc
% CREATE CAS SIGNALSEQ SSP fgdEgress2GlareProc INDEX 1
% CREATE CAS SIGNALSEQ SSP fgdEgress2GlareProc INDEX 2
% CREATE CAS SIGNALSEQ SSP fgdEgress2GlareProc INDEX 3
% CREATE CAS SIGNALSEQ SSP fgdEgress2GlareProc INDEX 4
% CREATE CAS SIGNALSEQ SSP fgdEgress2GlareProc INDEX 5
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
STATE enabled
% CONFIGURE CAS SIGNALSEQ SSP fgdEgress2GlareProc INDEX 5 ..
STATE enabled
% CONFIGURE CAS SIGNALSEQ SSP fgdEgress2GlareProc INDEX 6 ..
STATE enabled
% CONFIGURE CAS SIGNALSEQ SSP fgdEgress2GlareProc INDEX 7 ..
STATE enabled
% CONFIGURE CAS SIGNALSEQ SSP fgdEgress2GlareProc INDEX 8 ..
STATE enabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
This object creates and configures each entry in the CAS Signaling Condition Profile object,
described previously. A signaling condition token is specified for each possible exception or
optional event that might occur during a signaling sequence.
If an exception condition occurs and the SCP is not specified in a signaling sequence, then the
default SCP token will be used to process the exception. If the default SCP token does not
exist, then the call will be disconnected when any exception occurs. If the SCP is specified, it will
be executed. (A timeout while collecting a DTMF digit is one example of an exception condition.)
If an optional condition occurs and the SCP is not specified in a signaling sequence, then the call
processing continues at the next POSITION in the SSP. If the SCP is specified, it will be executed.
(A match of a collected digit field against a configured digit pattern is one example of an optional
condition.)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
Command Syntax
Command Parameters
Field
Parameter Length Description
casscpname 1-23 The name of the CAS Signaling Condition Profile.
token N/A The CAS signaling condition token. Each of these is a well defined
exception or optional event that could occur during a signaling
sequence. See Table 3–212 "CAS Signaling Condition Tokens"
on page 3–1138 for the complete set of values that may be
assigned to this parameter.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
Field
Parameter Length Description
control N/A One of five courses of (SSP) action that may be taken as a result
of the signaling condition that has occurred:
• proceed - continue processing in the current SSP, by skipping
the current SSP signaling sequence (PARAM=SKIP).
• proceed - continue processing in the current SSP by repeating
the current SSP signaling sequence (PARAM=NOSKIP). Do not
use this option for the SCP error tokens firstDigitTimeout,
interDigitTimeout, or fieldTimeout because when
these errors are encountered, the collection cannot be
resumed.
• exec -initiate a new SSP (PARAM=SSP name).
• abort - abort the call and initiate call clearing procedures, but
do not increment the “auto make-busy count”
(PARAM=disconnect reason).
• abortMB - abort the call, initiate call clearing procedures,
increment the “auto make-busy count”, and put the channel into
maintenance mode if the count exceeds the “auto make-busy
count” threshold.
param 1-31 A text field used to pass a parameter to the control parameter, as
discussed above.
admin-state N/A The administrative state of this CAS SCP entry:
• disabled (default) - Not activated, able to be reconfigured or
deleted.
• enabled - Activated, available for immediate use.
Event
Token Type Description
default Exception A general purpose condition that always succeeds.
firstDigitTimeout Exception Indicates no digits were received during the processing
of a collectField or collectDigit token.
interDigitTimeout Exception Indicates that at least one digit was collected and that a
timeout occurred between digits.
fieldTimeout Exception Indicates that at least one digit was collected and that a
timeout occurred collecting all of the digits.
shortCollection Exception Indicates that less than the expected number of digits
was received.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
Event
Token Type Description
unexpectedDigit Exception Indicates that the collectDigit token did not receive
the expected digit.
rxWink Exception Indicates that an unexpected wink was received.
rxFlash Exception Indicates that an unexpected hook flash was received.
rxAnswer Exception Indicates that an unexpected answer was received.
If CAS SERVICE SIGNALTYPE is lsFxo or gsFxo, this
indicates that an unexpected off-hook (LC) signal was
received.
If CAS SERVICE SIGNALTYPE is lsFxs or gsFxs, this
indicates that and unexpected answer (RLCF) signal was
received.
winkTimeout Exception Indicates that a timeout occurred while waiting for a wink.
flashTimeout Exception Indicates that a timeout occurred while waiting for a hook
flash.
answerTimeout Exception Indicates that a timeout occurred while waiting for an
answer.
If CAS SERVICE SIGNALTYPE is lsFxo or gsFxo, this
indicates that a timeout while waiting for an off-hook (LC)
signal occurred.
If CAS SERVICE SIGNALTYPE is lsFxs or gsFxs, this
indicates that a timeout while waiting for an answer
(RLCF) signal occurred.
cutThrough Optional Indicates that no called number or DN (Dialed Number)
will be received, and the call is to be treated as a carrier
cut-through call.
digitMatch Optional Indicates that the SSP matchDigits token was
processed and the collected digits matched the digit
pattern.
rxSeizeAck Exception Indicates that an unexpected seizure acknowledge signal
was received (exception).
This condition token is meaningful only when the CAS
SERVICE SIGNALTYPE is mfcr2.
seizeAckTimeout Exception Indicates that a timeout occurred while waiting for the
seizure acknowledge signal (exception).
This condition token is meaningful only when the CAS
SERVICE SIGNALTYPE is mfcr2.
bwdSignalTimeout Exception Indicates that a timeout occurred while waiting for a
backward signal. This exception is declared on a timeout
of either of the maximum forward on/off timers.
This condition token is meaningful only when the CAS
SERVICE SIGNALTYPE is mfcr2.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
Event
Token Type Description
maxPulseRx Exception Indicates that a pulsed R2 signal was received that
exceeds the configured MAXIMUM PULSE DURATION in
the MFCR2 DIGIT PROFILE .
This condition token is meaningful only when the CAS
SERVICE SIGNALTYPE is mfcr2.
r2Signal1 Optional Indicates that a pulsed or compelled R2 signal 1 was
received.
This condition token is meaningful only when the CAS
SERVICE SIGNALTYPE is mfcr2.
r2Signal2 Optional Indicates that a pulsed or compelled R2 signal 2 was
received.
This condition token is meaningful only when the CAS
SERVICE SIGNALTYPE is mfcr2.
r2Signal3 Optional Indicates that a pulsed or compelled R2 signal 3 was
received.
This condition token is meaningful only when the CAS
SERVICE SIGNALTYPE is mfcr2.
r2Signal4 Optional Indicates that a pulsed or compelled R2 signal 4 was
received.
This condition token is meaningful only when the CAS
SERVICE SIGNALTYPE is mfcr2.
r2Signal5 Optional Indicates that a pulsed or compelled R2 signal 5 was
received.
This condition token is meaningful only when the CAS
SERVICE SIGNALTYPE is mfcr2.
r2Signal6 Optional Indicates that a pulsed or compelled R2 signal 6 was
received.
This condition token is meaningful only when the CAS
SERVICE SIGNALTYPE is mfcr2.
r2Signal7 Optional Indicates that a pulsed or compelled R2 signal 7 was
received.
This condition token is meaningful only when the CAS
SERVICE SIGNALTYPE is mfcr2.
r2Signal8 Optional Indicates that a pulsed or compelled R2 signal 8 was
received.
This condition token is meaningful only when the CAS
SERVICE SIGNALTYPE is mfcr2.
r2Signal9 Optional Indicates that a pulsed or compelled R2 signal 9 was
received.
This condition token is meaningful only when the CAS
SERVICE SIGNALTYPE is mfcr2.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
Event
Token Type Description
r2Signal10 Optional Indicates that a pulsed or compelled R2 signal 10 was
received.
This condition token is meaningful only when the CAS
SERVICE SIGNALTYPE is mfcr2.
r2Signal11 Optional Indicates that a pulsed or compelled R2 signal 11 was
received.
This condition token is meaningful only when the CAS
SERVICE SIGNALTYPE is mfcr2.
r2Signal12 Optional Indicates that a pulsed or compelled R2 signal 12 was
received.
This condition token is meaningful only when the CAS
SERVICE SIGNALTYPE is mfcr2.
r2Signal13 Optional Indicates that a pulsed or compelled R2 signal 13 was
received.
This condition token is meaningful only when the CAS
SERVICE SIGNALTYPE is mfcr2.
r2Signal14 Optional Indicates that a pulsed or compelled R2 signal 14 was
received.
This condition token is meaningful only when the CAS
SERVICE SIGNALTYPE is mfcr2.
r2Signal15 Optional Indicates that a pulsed or compelled R2 signal 15 was
received.
This condition token is meaningful only when the CAS
SERVICE SIGNALTYPE is mfcr2.
rxRing Exception A first ring is an exception, indicating that an unexpected
or Optional ring signal was received. This may indicate “glare” or
simultaneous seizure for different purposes of each end
of a line.
A subsequent ring is an optional condition.
This condition token is meaningful only when the CAS
SERVICE SIGNALTYPE is lsFxs or gsFxs.
rxRingGround Exception Indicates that an unexpected ring ground signal was
received. This may indicate “glare” or simultaneous
seizure for different purposes of each end of a line.
This condition token is meaningful only when the CAS
SERVICE SIGNALTYPE is lsFxo or gsFxo.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
Event
Token Type Description
rxTipGround Exception Indicates that an unexpected tip ground signal was
received. This may indicate a remote channel
maintenance condition.
This condition token is meaningful only when the CAS
SERVICE SIGNALTYPE is gsFxs.
tipGroundTimeout Exception Indicates that a timeout occurred while waiting for the tip
ground signal.
This condition token is meaningful only when the CAS
SERVICE SIGNALTYPE is gsFxs.
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
To create and configure the CAS SCP named routeNow, that may be invoked when the optional
condition digitMatch is true to execute the routeNow SSP:
% CREATE CAS SCP routeNow
% CONFIGURE CAS SIGNALCOND SCP routeNow TOKEN digitMatch ..
CONTROL EXEC PARAM routeNow
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
CAS Channel
This object assigns one or more DS0 channels to the CAS service group object.
You may temporarily remove and restore service to these channels by toggling their operational
state between inservice and outofservice.
• enabled
• disabled
• inService
• outOfService
The rules for changing operational states of the CAS channel service are:
TABLE 3–213
From
(operational
state) Changing to (operational state)
inService outOfService
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
TRUNK MEMBER
You may use the TRUNK MEMBER parameter to uniquely identify each circuit within the trunk
group. This number is used in accounting records.
You may assign a range of numbers between 0 and 65535. The GSX software maintains a list of
available trunk member numbers for every trunk group. If a valid range of trunk members, is
specified, the GSX software will complete the assignment and remove these numbers from the free
list. If the specified number or range of numbers is not available, the CONFIGURE command will
return an error. If no TRUNK MEMBER is specified, the value 65536 is assigned to the trunk member.
This value is displayed as UNSET in the SHOW .. ADMIN screen.
You may release one or more TRUNK MEMBERs within a trunk group by specifying TRUNK MEMBER
UNSET on that CHANNEL or range of CHANNELs. When you disable the circuit, the TRUNK MEMBER
is released.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
STATE admin-state
Command Parameters
Field
Parameter Length Description
servicename 1-23 The name of the CAS service to which the channels are
being assigned.
port 1-23 The automatically created (and possibly changed) name
of the T1 or E1 span that is assigned to the CAS
channels.
chanrange N/A A set of channels. Must be one or more ranges of
channels within the overall range 1-31, as discussed
below.
All CLI ranges specify a comma-separated list of
numbers and/or ranges. A range consists of two numbers
separated by a dash, for example, 5-8. An increment can
be specified after a range with the notation, +<incr>, for
example 4-10+2. No spaces are permitted in the
expression. All values and ranges must be in numerically
ascending order. Thus the expression:
1,3,5,8-12+2,14-16
is a valid range specification for the numbers:
1,3,5,8,10,12,14,15, and 16.
circuitprofilename 1-23 The name of the Circuit Service Profile that you are
applying to the designated channels.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
Field
Parameter Length Description
direction N/A The direction of traffic allowed on the designated
channel(s):
• twoWay (default) - accept all calls
• oneWayIn - accept only inbound calls
• oneWayOut - accept only outbound calls
tmember N/A A range of numbers with a one-to-one correspondence to
the CHANNEL range that uniquely identifies the circuit
endpoints within the trunk group. The GSX software
maintains a list of available trunk member numbers for
every trunk group. The size of the range must equal size
of the CHANNEL range and each member of the range
must be available. Must be 0-65535.
All CLI ranges specify a comma-separated list of
numbers and/or ranges. A range consists of two numbers
separated by a dash, for example, 5-8. An increment can
be specified after a range with the notation, +<incr>, for
example 4-10+2. No spaces are permitted in the
expression. All values and ranges must be in numerically
ascending order. Thus the expression:
1,3,5,8-12+2,14-16
is a valid range specification for the numbers:
1,3,5,8,10,12,14,15, and 16.
oper-state N/A The operational state of the designated channel(s):
• outOfService - All channels out of service.
• inService (default) - All channels active and in
service.
action N/A The method by which active calls on the designated
channels are processed when oper-state goes to
outOfService from inservice:
• dryup (default) - All calls are allowed to complete until
timeout expires, when they are dropped.
• force - All calls are dropped immediately.
timeout N/A The time (in minutes) to wait to place the channel in the
outOfService oper-state. Must be 1-1440, default
is 5.
channum N/A A single channel number. Must be in the range 1-24.
admin-state N/A The administrative state of these CAS channels:
• disabled (default) - Not activated, able to be
reconfigured or deleted.
• enabled - Activated, available for immediate use.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
Command Example
To create and configure the 24 channels on the T1 span t1-1-9-6 to the CAS service casserv1
and put them all into service:
% CREATE CAS CHANNEL SERVICE casserv1 PORT t1-1-9-6 CHANNEL 1-24
% CONFIGURE CAS CHANNEL SERVICE casserv1 PORT t1-1-9-6 ..
CHANNEL 1-24 CIRCUITPROFILE cas
% CONFIGURE CAS CHANNEL SERVICE casserv1 PORT t1-1-9-6 ..
CHANNEL 1-24 DIRECTION twoway
% CONFIGURE T1 t1-1-9-6 STATE disabled
% CONFIGURE T1 t1-1-9-6 MODE outOfService
% CONFIGURE CAS CHANNEL SERVICE casserv1 PORT T1-1-9-6 ..
CHANNEL 1-24 STATE enabled
% CONFIGURE T1 t1-1-9-6 STATE enabled
% CONFIGURE T1 t1-1-9-6 MODE inService
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
Trunk
Port Name Chan Membr State Mode Direction Profile
------------------- ---- ----- -------- --------- --------- -------
t1-1-9-6 1 100 ENABLED INSERVICE TWOWAY cas
t1-1-9-6 2 101 ENABLED INSERVICE TWOWAY cas
t1-1-9-6 3 102 ENABLED INSERVICE TWOWAY cas
t1-1-9-6 4 UNSET ENABLED INSERVICE TWOWAY cas
t1-1-9-6 5 103 ENABLED INSERVICE TWOWAY cas
t1-1-9-6 6 104 ENABLED INSERVICE TWOWAY cas
------------------------------------------------------------
CAS Service: casserv1
Port: T1-1-9-6
Channel: 1
------------------------------------------------------------
LocalHw: INSERVICE Trunk Group: casserv1
Usage: IDLE LocalMaint: INSERVICE
Busy Failures: 0 RemoteMaint: INSERVICE
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
This object creates the CAS collection profile object. A collection profile defines all of the
parameters required to complete a digit collection, using either Multi-Frequency (MF) or Dual
Tone Multi-Frequency (DTMF) tones as discussed below.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
Command Parameters
Field
Parameter Length Description
collectpname 1-23 The name of the CAS Collection Profile.
collectid N/A The CAS Collection ID defines the field where the collected
digits are to be stored:
• calledParty - Destination of the call.
• callingParty - Originator of the call.
• ani - Automatic number Id (calling number).
• iani - Information digit + ani. (Information digits map to
the Originating Line Information (OLI) values in SS7.)
• iiani - 2 information digits + ani.
• dnis - Dialed number Id service.
• carrierId - Carrier identification code. This field
abstract is 0ZZ+XXXX where 0ZZ is the Sonus PSX
configurable trunk group information to determine the type
of call and XXXX is the 4 digit carrier code.
• internationalCountryCode - International country
code. This field abstract is 1NX+XXXX+CCC where 1NX
is 138 (No Operator) or 158 (Operator Assisted), XXXX is
the 4 digit carrier code, and CCC is the 3 digit country
code.
• callingPartyCategory - the category of the calling
party. When TYPE is mfcr2, this value is defined by the
Group II signals.
• chargeCategory - When TYPE is mfcr2, this defines
the charge or billing category for a call; the field is sent
when requested by the Group II signals.
• subscriberStatus - Specifies the status of the called
party’s line. When TYPE is mfcr2, this value is defined by
the Group B signals which are sent in the backwards
direction during a call.
• fgdStageOne - Field to dial either the Feature Group D
(FGD) CarrierId (EANA Signaling) or FGD International
Country Code (EAIN Signaling).
• countryCodeIndicator - used to collect the first digit
of an international R2 call.
• langDiscIndicator - used to collect the language/
discriminating indicator of an international R2 call.
• natureOfConn - used to collect the nature of connection
indicator of an international R2 call.
• echoSupIndicator - used to collect the echo
suppressor indicator of an international R2 call.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
Field
Parameter Length Description
type N/A The type of digits to be collected:
• dtmf - Dual Tone Multi-Frequency.
• mf - Multi-Frequency.
• mfcr2 - Compelled MFR2, the common signaling type
used on E1 outside of the US.
mindigits N/A Minimum number of digits to be collected. Must be 0 to 30,
default is 0.
maxdigits N/A Maximum number of digits to be collected. Must be 1 to 30,
default is 1.
firstdigittimer N/A The number of milliseconds to wait for the first digit. Must be
0 to 30,000 (30 seconds), default is 0. A value of 0 disables
the first digit timer.
interdigittimer N/A The number of milliseconds to wait between each successive
digit. Must be 0 to 30,000 (30 seconds), default is 0. A value
of 0 disables the inter digit timer.
fielddigittimer N/A The number of milliseconds to wait for the entire collection.
Must be 0 to 30,000 (30 seconds), default is 0. A value of 0
disables the field collection timer.
termdigit N/A A digit that can be used to terminate the collection prior to the
maximum digits.
• none - no terminate character
• star - *
• pound - #
• dtmfA - A
• dtmfB - B
• dtmfC - C
• dtmfD - D
The following values may be selected only when
COLLECTIONPROFILE TYPE is mfcr2. Specifies the
transmit end of the digits signal:
• r2Signal15
• r2Signal14
• r2Signal13
• r2Signal12
• r2Signal11
If a terminate character is specified, then it must be different
from the restart and re-input character. (dtmf only, because
mf has its own start/stop digits.)
restartdigitseq 1-3 A 1-3 character digit that can be used to clear and restart a
collection. If a prompt is associated with the digit collection, it
is reissued. This sequence must differ from the terminate and
the re-input digit sequences. (dtmf only.)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
Field
Parameter Length Description
reinputdigitseq 1-3 A 1-3 character digit that can be used to clear and reset a
collection. If a prompt is associated with the digit collection, it
is not reissued. This sequence must differ from the terminate
and the restart digit sequences. (dtmf only.)
reportdigits N/A A length at which a partial digit report is to be issued. (This
facility can be used for enhanced services such as least call
routing.) Must be 0-24, default is 0. A value of 0 disables any
partial digit routing. (Not currently supported.)
firstdigitquiet N/A Specifies whether an announcement should be terminated
when the first digit is entered:
• disabled - do not terminate announcement.
• enabled - terminate announcement on first digit.
announceprompt N/A Announcement number to use for a prompt for digits. Must
be 0-65535, default is 0 (no announcement). See
"Announcements" on page 6–88. You cannot specify this
parameter if a tone prompt (below) has already been
specified.
toneprompt 1-23 Name of a call progress tone to play to prompt for digits. This
string must match a previously created and configured tone
type. See "Tone Type" on page 3–1199. You cannot specify
this parameter if an announcement (above) has already been
specified.
appenddigits N/A Specifies whether the digits that are being collected are
appended to the field specified by COLLECTID:
• disabled (default) - Store the digits into the field,
beginning at the first field position.
• enabled - Append the digits to the field. This applies only
to COLLECTIDs callingParty, ANI, calledParty,
and DNIS. All other COLLECTIDs are specific to MF
protocols (not DTMF). If this value is assigned to any other
COLLECTID, it will be silently overwritten to disabled.
signum1 N/A Specifies the normal backward signal to send after receiving
a forward signal. Typically, this is set to the send next digital
signal (digit A-1). Must be 0-15, default is 1. 0 indicates “no
acknowledgement”.
This parameter is meaningful only when the
COLLECTIONPROFILE TYPE is mfcr2.
signum2 N/A Specifies the backward signal to send after receiving the
maximum number of digits or an end of digits signal. The end
of digits signal, normally digit I-15 or digit III-15, is specified
by TERMDIGIT. Must be 0-15, default is 1. 0 indicates “no
acknowledgement”.
This parameter is meaningful only when the
COLLECTIONPROFILE TYPE is mfcr2.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
Command Example
To create and configure a CAS Collection Profile to collect the dnis field:
% CREATE CAS COLLECTIONPROFILE dnisToneStart
% CONFIGURE CAS COLLECTIONPROFILE dnisToneStart ..
TYPE DTMF
COLLECTID DNIS
MINDIGITS 1
MAXDIGITS 10
TONEPROMPT dial
FIRSTDIGITTIMER 6000
FIELDTIMER 20000
Name: dnisToneStart
Type: DTMF
CollectId: DNIS
MinDigits: 1
MaxDigits: 10
FirstDigit Timer: 6000
InterDigit Timer: 0
Field Timer: 20000
Term Digit: NONE
Restart Digit:
Reinput Digit:
Report Digits: 0
FirstDigit Quiet: DISABLED
Announce Prompt: 0
Tone Prompt: dial
Append Digits: DISABLED
Ack Signal 1: 1
Ack Signal 2: 1
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
To create and configure a CAS Collection Profile to collect the first 3 digits of the dialed number,
storing the digits in the DNIS field, and dial tone provided until the first digit is entered:
% CREATE CAS COLLECTIONPROFILE dnisInitial
% CONFIGURE CAS COLLECTIONPROFILE dnisInitial ..
TYPE DTMF
COLLECTID DNIS
MINDIGITS 1
MAXDIGITS 3
TONEPROMPT dial
FIRSTDIGITTIMER 6000
INTERDIGITTIMER 6000
FIELDTIMER 20000
TERM DIGIT pound
APPEND DIGITS disabled
To create and configure a CAS Collection Profile to collect the remaining 4 digits of a local
number, and append them to the DNIS field:
% CREATE CAS COLLECTIONPROFILE dnisLocal
% CONFIGURE CAS COLLECTIONPROFILE dnisLocal ..
TYPE DTMF
COLLECTID DNIS
MINDIGITS 4
MAXDIGITS 4
FIRSTDIGITTIMER 6000
INTERDIGITTIMER 6000
FIELDTIMER 20000
APPEND DIGITS enabled
To create and configure a CAS Collection Profile to collect the remaining 4 to 20 digits of an
international number (assuming the first 3 digits have been collected by the dnisInital
collection profile), and append them to the DNIS field:
% CREATE CAS COLLECTIONPROFILE dnisIntx
% CONFIGURE CAS COLLECTIONPROFILE dnisIntx ..
TYPE DTMF
COLLECTID DNIS
MINDIGITS 4
MAXDIGITS 20
FIRSTDIGITTIMER 6000
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
INTERDIGITTIMER 6000
FIELDTIMER 20000
APPEND DIGITS enabled
To create and configure a CAS Collection Profile to collect a dialed number and store the digits in
the Feature Group D field:
% CREATE CAS COLLECTIONPROFILE stage1FGD
% CONFIGURE CAS COLLECTIONPROFILE stage1FGD ..
TYPE MF
COLLECTID fgdStageOne
MINDIGITS 1
MAXDIGITS 24
FIRSTDIGITTIMER 6000
INTERDIGITTIMER 6000
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
This object creates the CAS R2 Translation Profile object. A Translation Profile provides the
parameters necessary to assign specific meanings and functions to and from CAS R2 signals.
These parameters are referenced from a CAS Signaling Sequence Profile during ingress and egress
calls to perform the mapping.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
Command Parameters
Field
Parameter Length Description
profilename 1-23 Indicates the name of the CAS R2 Translation Profile. Must
be 1-23 characters.
profileindex N/A Specifies the index of R2 Translation Profile in which the
entry is contained.
index N/A Specifies the index of the R2 Translation Entry.
r2signal N/A Indicates the R2 signal to be translated. Must be 1-15;
default is 1.
groupIfield N/A (Digit Field) - specifies the source or destination of the digits
to be translated.
• countryCodeIndicator
• langDiscIndicator
• natureOfConn
• echoSupIndicator
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
Field
Parameter Length Description
groupIsigmeaning N/A Specifies the meaning of the R2 signal for the Group I signal
grouping, as defined in other R2 national variants:
• unknown
Language/Discriminating Indicator options:
• lgdsFr - French
• lgdsEn - English
• lgdsGr - German
• lgdsRu - Russian
• lgdsSp - Spanish
• lgdsOt - Other language
• lgdsDisc - Other language 1
• lgdsTci - Other language 2
• lgdsOt1 - Discriminating digit
• lgdsOt2 - spare (Discriminating digit)
• lgdsDisc1 - test call Indicator
Nature of connection options:
• ncInc - Satellite link included
• ncNoi - satellite link not included
Echo Supression Indicator options:
• esOgrq - outgoing echo suppressor required
• esNrq - no echo suppressor required
• esOgins - outgoing echo suppressor inserted
• esIcrq - outgoing echo suppressor required
groupIIfield N/A (Digit Field) - specifies the source or destination of the digits
to be translated.
• callingPartyCategory
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference CAS Service Group
Field
Parameter Length Description
groupIIsigmeaning N/A Specifies the meaning of the R2 signal for the Group II signal
grouping, as defined in other R2 national variants.
• unknown
Subscriber Category options:
• scNnps - normal subscriber (National working)
• scNprs - priority subscriber (National working)
• scNmnt - maintenance equipment (National working)
• scNopr - operator call (National working)
• scNdt - data call (National working)
• scIsopr - subscriber or operator without forward transfer
facility (International working)
• scIoprf - Operator with forward transfer facility
(International working)
• scIdt - data call (International working)
• scIprs - priority subscriber (International working)
• scPaypn - pay phone
• scTest - test call
• scColl - collect call
• scCoin - coin phone
• scResv1 - reserved for future use
• scResv2 - reserved for future use
• scResv3 - reserved for future use
• scResv4 - reserved for future use
• scResv5 - reserved for future use
• scResv6 - reserved for future use
• scResv7 - reserved for future use
groupAfield N/A (Digit Field) - specifies the source or destination of the digits
to be translated.
• subscriberStatus
groupAsigmeaning N/A Specifies the meaning of the R2 signal for the Group A signal
grouping, as defined in other R2 national variants.
• unknown
Subscriber Status options:
• slsNk - network congestion
• slsCng - SLS not known, cut thru
groupBfield N/A (Digit Field) - specifies the source or destination of the digits
to be translated.
• subscriberStatus
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Service Group CLI Reference
Field
Parameter Length Description
groupBsigmeaning N/A Specifies the meaning of the R2 signal for the Group B signal
grouping, as defined in other R2 national variants.
• unknown
Subscriber Status options:
• slsUn - unallocated number
• slsSlb - subscriber's line busy
• slsSlfc - subscriber's line free, charge
• slsSlfnoc - subscriber's line free, no charge
• slsSoo - subscriber's line out of order
• slsSit - send special information tone
• slsNk - subscriber's line status Not Known
• slsCng - network congestion
• slsChgn - subscriber's line with changed number
• slsResv1 - reserved for future use
• slsResv2 - reserved for future use
• slsResv3 - reserved for future use
• slsResv4 - reserved for future use
• slsResv5 - reserved for future use
• slsResv6 - reserved for future use
• slsResv7 - reserved for future use
admin-state N/A The administrative state of the signal sequence:
• disabled (default) - Not activated, able to be
reconfigured or deleted.
• enabled - Activated, available for immediate use.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Call Disconnect Treatment
These objects are used by CAS, ISUP, ISDN, H323, and SIP call managers to handle call
disconnect processing.
This object creates a Disconnect Treatment Profile. Each profile maps up to 256 disconnect reason
codes to one or more Disconnect Signaling Sequence Profiles (SSPs) that direct call disconnect
processing. CAS, ISUP, ISDN, H323, and SIP calls may use this object and its underlying objects
to perform disconnect processing. Default profiles are defined for CAS, ISUP, ISDN, H323, and
SIP. You may associate CAS, ISUP, ISDN, and SIP service groups with other, unique Disconnect
Treatment Profiles. H.323 disconnect processing must be handled through the default H.323
Disconnect Treatment Profile, h323Default.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Disconnect Treatment CLI Reference
Command Parameters
Field
Parameter Length Description
dtprofile 1-23 The name of the Disconnect Treatment Profile that is being
created, configured, or deleted.
dscsspname 1-23 The name of a Disconnect SSP to be invoked when a call is
disconnected from the far end, prior to going stable, for one or
more of the reasons discussed below.
reasons N/A The ISDN call clearing cause values. Must be one or more cause
codes within the overall range 1-255 as specified in Q.931/Q.850.
Values greater than 127 are GSX extensions. See "Call
Termination Reason Codes" on page 7–30.
All CLI ranges specify a comma-separated list of numbers and/or
ranges. A range consists of two numbers separated by a dash, for
example, 5-8. An increment can be specified after a range with the
notation, +<incr>, for example 4-10+2. No spaces are permitted in
the expression. All values and ranges must be in numerically
ascending order. Thus the expression:
1,3,5,8-12+2,14-16
is a valid range specification for the numbers:
1,3,5,8,10,12,14,15, and 16.
Command Example
To add the Disconnect SSP reorderSSP to Disconnect Treatment Profile dtprof1 and associate
the SSP with disconnect reason code 16:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Call Disconnect Treatment
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Disconnect Treatment CLI Reference
This object creates a Disconnect Signaling Sequence Profile (SSP). The Disconnect SSP defines a
set of signaling sequences that are necessary to perform disconnect treatment of a call. The
Disconnect SSP is “populated” when you create and configure the individual signaling sequences.
See "Disconnect SignalSeq" on page 3–1167 for more information on Disconnect Signaling
Sequences. This object merely creates (names), or deletes a Disconnect SSP.
Command Syntax
Command Parameters
Field
Parameter Length Description
dscsspname 1-23 The name of the Disconnect Signaling Sequence Profile.
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Call Disconnect Treatment
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Disconnect Treatment CLI Reference
Disconnect SignalSeq
This object creates and configures each step (or entry) in the Disconnect Signaling Sequence
Profile (SSP) object, described previously. A specific signaling token is specified for each
sequence, establishing an action to take before proceeding to the next entry in the Disconnect SSP.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Call Disconnect Treatment
Command Parameters
Field
Parameter Length Description
dscsspname 1-23 The name of the Disconnect Signaling Sequence Profile.
index N/A A unique key that is assigned to each entry.
position N/A The position in the Disconnect SSP at which to execute this step.
This parameter allows you to insert steps into the middle of a
Disconnect SSP without needing to renumber the index of the
subsequent SSP steps. Positions begin with zero, so to insert a
step in front of step 3 in the current Disconnect SSP, you must
declare a position of 2.
token N/A The Disconnect signaling token (actions to be performed). See
"Disconnect Signaling Tokens" on page 3–1169 for a list of these
values.
param1 1-31 A text field used to pass parameter #1 to the Disconnect SSP
signaling sequence that is being configured. This parameter is
dependent on the Disconnect signaling token used in this
signaling sequence. See Table 3–220 on page 3–1169,
"Disconnect Signaling Tokens".
param2 1-31 A text field used to pass parameter #2 to the Disconnect SSP
signaling sequence that is being configured. This parameter is
dependent on the Disconnect signaling token used in this
signaling sequence. See Table 3–220 on page 3–1169,
"Disconnect Signaling Tokens".
admin-state N/A The administrative state of this Disconnect SSP signaling
sequence:
• disabled (default) - Not activated, able to be reconfigured or
deleted.
• enabled - Activated, available for immediate use.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Disconnect Treatment CLI Reference
Token Description
playTone Play the tone specified in PARAM1 for the duration specified in PARAM2. The
PARAM1 value must match a defined tone type (see "Tone Type" on page 3–
1199). If PARAM2 is 0, play the tone indefinitely (or until it completes on its
own). Execution of the Disconnect SSP will be suspended until the tone
completes.
playAnn Play the announcement specified in PARAM1. The PARAM1 value must match
a previously established announcement number (see "Announcements" on
page 6–88).
delay Delay further execution of the Disconnect SSP for the interval (in
milliseconds)specified in PARAM1.
clear Initiate call clearing procedures on the call. The disconnect reason is an
integer that is specified in PARAM1. This value must be 1-255:
• 1-127, as specified in Q.931/Q.850
• 128-255, GSX extensions
See "Call Termination Reason Codes" on page 7–30.
exec Start execution of the SSP specified in PARAM1.
Command Example
To display the configuration of Disconnect SSP reorderSSP that was created and configured
above:
% SHOW DISCONNECT SIGNALSEQ SSP reorderSSP SUMMARY
Node: TPUBS Date: 2000/10/05 21:04:52 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Call Disconnect Treatment
To bind the Disconnect Signaling Sequence Profile busySSP, created above, with the Disconnect
Treatment Profile sipDefault for the specific disconnect reason of 3 (see "Call Disconnect
Reason Field" on page 7–29):
% CONFIGURE DISCONNECT TREATMENT PROFILE sipDefault ..
ADD REASON 3 DISCONNECT SSP busySSP
NOTE
For SIP to PSTN call scenarios, this causes busySSP to be executed whenever an
early call release from PSTN with release code 3 occurs.
To display the steps of the Disconnect SSP numchanged from the sipDefault Disconnect
Treatment Profile displayed previously:
% SHOW DISCONNECT SIGNALSEQ SSP numchanged SUMMARY
Node: TPUBS Date: 2001/06/04 19:54:45 GMT
Zone: GMTMINUS05-EASTERN-US
To display the steps of the Disconnect SSP busyssp from the numchanged Disconnect SSP:
% SHOW DISCONNECT SIGNALSEQ SSP busyssp SUMMARY
Node: TPUBS Date: 2001/06/04 20:20:12 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Disconnect Treatment CLI Reference
This object creates a Call Crankback Profile. This profile is a table of call release codes that cause
the GSX to attempt to reroute (or “crankback”) the call when a matching code is returned by
Egress Signaling. The Call Crankback Profile contains the call release codes that automatically
cause the GSX software to attempt to reroute the call. Additional release codes may be added to
the table. Any release code that is in the table, including any default code, may be removed from
the table. Removing a release code from the table causes the GSX software to return that release
code to Ingress Signaling rather than attempting to reroute the call.
Up to 10 Call Crankback Profiles may be created, including default. As profiles are created,
they are assigned the indexes 2, 3, 4, and so on, by the GSX software. (Index 1 is assigned to
default.) The assigned index may be displayed by the SHOW commands. By using the
appropriate index, a particular Call Crankback Profile may be assigned to a particular CAS, ISUP,
or ISDN service group for ingress signaling. See "CAS Service Group" on page 3–1079, "ISUP
Service Group" on page 3–746, and "ISDN Service Group" on page 3–901.
See "ISUP Call Disconnect Code Mapping" on page 7–41, for a list of all call disconnect release
codes. See "GSX Call Rerouting Policy" on page 6–140 for further crankback detail.
NOTE
The default Call Crankback Profile is automatically created when the system is
initialized. All release codes except 129 (Channel Collision Backoff) and 134
(Channel COT Fail Backoff) can be configured in this profile. Release codes 129
and 134 unconditionally cause a rerouting attempt and hence cannot be
configured.
This object influences rerouting policy for SIP 3xx Redirection processing if you configure the IP
Profile on the PSX to use the Crankback Profile. Then, when a SIP 3xx Redirect is initiated and a
SIP INVITE message is issued, if a disconnect release code is returned in the SIP response, the
Crankback Profile is searched for a matching code. If a matching code is found and at least one
more SIP redirect destination is present, a SIP INVITE is issued to that destination. This scenario
is repeated up to ten times, after which additional SIP redirect destinations are disregarded as if not
present. (However, only four Contact headers in a redirect are accepted and processed. If more
than four Contact headers are sent, they are currently ignored.) If a matching code is found but no
additional SIP redirect destination is present, the SIP redirect is terminated with that code. If no
matching code is found in the Crankback Profile, then the SIP redirect is terminated with that
(unmatched) code.
If you configure the IP Profile on the PSX to skip the Crankback Profile (or if you do not configure
the IP Profile), then whenever any disconnect release code is returned as the SIP response to the
SIP INVITE, the INVITE is issued to the next SIP redirect destination (up to ten times). If no
additional SIP redirect destination is present, then the SIP redirect is terminated with this code.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Call Disconnect Treatment
Command Syntax
Command Parameters
Field
Parameter Length Description
cbprofilename 1-23 The name of the Call Crankback Profile, or the table of call
release codes that cause crankback by the GSX software.
releasecodes N/A The range of call termination reason codes (or call release
codes) that, when returned by Egress Signaling, cause the
GSX software to attempt to reroute the call. Must be 0-256.
See Table 7–9 on page 7–41, "ISUP Call Disconnect Code
Mapping".
All CLI ranges specify a comma-separated list of numbers and/
or ranges. A range consists of two numbers separated by a
dash, for example, 5-8. An increment can be specified after a
range with the notation, +<incr>, for example 4-10+2. No
spaces are permitted in the expression. All values and ranges
must be in numerically ascending order. Thus the expression:
1,3,5,8-12+2,14-16
is a valid range specification for the numbers:
1,3,5,8,10,12,14,15, and 16.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Disconnect Treatment CLI Reference
Field
Parameter Length Description
latecrankback N/A Specifies whether to allow crankback after an ALERTING,
PROCEEDING, or equivalent message (backwards call
message) has been received from the egress network:
• enabled - allow crankback after a backwards call message
is received from the egress network
• disabled (default) - do not allow any crankback after a
backwards call message is received from the egress
network
attemptrecord N/A Specifies whether the GSX should generate an ATTEMPT
accounting record (see "Accounting Records" on page 7–8)
whenever a call is rerouted (cranked back):
• enabled - generate an ATTEMPT record when a call is
rerouted by the GSX
• disabled (default) - do not generate an ATTEMPT record
when a call is rerouted by the GSX.
addlocation N/A Specifies the location value to add to a configured disconnect
reason:
• user
• privateLocal - private network serving the local user
(LPN)
• publicLocal - public network serving the local user (LN)
• transitNet - transit network (TN)
• publicRemote - public network serving the remote user
(RLN)
• privateRemote - private network serving the remote user
(RPN)
• natReserved6 - reserved
• internationalNet - international network (INTL)
• natReserved8 - reserved
• natReserved9 - reserved
• netBeyondInterPoint - network beyond interworking
point (BI)
• natReserved11 - reserved
• natReserved12 - reserved
• natReserved13 - reserved
• natReserved14 - reserved
• natReserved15 - reserved
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Call Disconnect Treatment
Field
Parameter Length Description
dellocation N/A Specifies the location value to delete from a configured
disconnect reason:
• user
• privateLocal - private network serving the local user
(LPN)
• publicLocal - public network serving the local user (LN)
• transitNet - transit network (TN)
• publicRemote - public network serving the remote user
(RLN)
• privateRemote - private network serving the remote user
(RPN)
• natReserved6 - reserved
• internationalNet - international network (INTL)
• natReserved8 - reserved
• natReserved9 - reserved
• netBeyondInterPoint - network beyond interworking
point (BI)
• natReserved11 - reserved
• natReserved12 - reserved
• natReserved13 - reserved
• natReserved14 - reserved
• natReserved15 - reserved
state N/A Specifies whether crankback on a specific disconnect location
is enabled:
• enabled
• disabled (default)
Command Example
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Disconnect Treatment CLI Reference
To enable calls to be rerouted after a backwards call message is received from the egress network:
% CONFIGURE CRANKBACK PROFILE default LATE CRANKBACK enabled
To display a list of all defined Call Crankback Profiles and their respective indexes:
% SHOW CRANKBACK PROFILE SUMMARY
Node: TPUBS Date: 2004/12/01 15:20:57 GMT
Zone: GMT
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Call Disconnect Treatment
To display the location values and the Use Location state configured for all disconnect reasons:
% SHOW CRANKBACK PROFILE default REASON ALL ADMIN
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Disconnect Treatment CLI Reference
------------------------------------
Crank Back Reason Code : 149
Use Location Value : DISABLED
Location Values:
------------------------------------
Crank Back Reason Code : 151
Use Location Value : DISABLED
Location Values:
------------------------------------
Crank Back Reason Code : 152
Use Location Value : DISABLED
Location Values:
------------------------------------
Location-Aware Crankback
The GSX allows crankback on combinations of Disconnect Reason and Disconnect Location
received from outgoing trunks. This Location-Aware crankback is configurable on a CRANKBACK
PROFILE basis.
To delete a location value from an existing disconnect reason, use the following command:
% CONFIGURE CRANKBACK PROFILE default REASON 42 DELETE LOCATION
INTERNATIONAL
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Call Disconnect Treatment
You can specify the Location Value to be set in the Cause Indicator in the ISUP REL message sent
to the ingress network for release cause 34 “No circuit/channel available” and release cause 42
“Switching equipment congestion.” using the following commands:
CONFIGURE ISUP SERVICE isupsvcgroup LOCATION OF REL34 location
CONFIGURE ISUP SERVICE PROFILE isupsvcprofile LOCATION OF REL34
location
Other disconnect reasons are unaffected by this configuration. For more information on these
commands, see the "ISUP Service Group" on page 3–746.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Monitor Endpoint and Monitor Target CLI Reference
The GSX provides the ability to monitor stable simple tandem voice call content (e.g. to determine
if a long duration call should be brought down) by setting up a 3-way conference with the target
call, with the monitor endpoint leg in listen-only mode receiving a mix of media from both the
endpoints. The monitor endpoint can be an IP or PSTN phone. You can monitor up to 25 target
calls simultaneously, but each call can have only one monitor. CDR records are be generated for
monitor legs.
Once the monitor leg drops out of the call (by hanging up the monitoring phone, or by a CLI
command to tear down the monitor) the simple tandem circuit-to-circuit call will be restored.
Additionally, the monitor and the other leg will be released if either leg of the call hangs up.
The CREATE, CONFIGURE, and DELETE MONITOR ENDPOINT ... commands manage the
monitor endpoints: the PSTN or IP (SIP) phones configured to perform the monitoring function.
These endpoints will subsequently be used to monitor active tandem calls being serviced by the
GSX.
The CREATE, CONFIGURE, and DELETE MONITOR TARGET ... commands intiate and terminate
call monitoring. A monitor call target identifies the call that needs to be monitored. The SHOW
MONITOR TARGET ... commands provide information on a monitor target during call
monitoring.
• Call Monitoring is only supported for circuit-to-circuit, G711 packet-to-circuit, and G711
circuit-to-packet calls.
• A FAX can be reliably detected by detecting a 2100 Hz tone and the V.21 preamble signals.
The GSX cannot currently support detection of the V.21 preamble. For calls with a circuit leg
(circuit-to-circuit, packet-to-circuit, and circuit-to-packet), FAX and modem detection is done
via detection of a 2100Hz tone on the VPAD. The limitations for this are as follows:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Call Monitor Endpoint and Monitor Target
• If a FAX is sent without the use of the 2100 Hz tone (which is valid), then it will not be
detected; thus, a monitor for such a call may be initiated.
• It is possible that if a false FAX tone is detected (a tone not followed by a preamble), a
voice call may end up being qualifying as a fax call. Monitor setup will fail for a call on
which a fax tone has been detected.
• Modem detection is also done via the VPAD and false positives may also be detected.
• There is a 70 millisecond voice path break when the monitor is added or removed.
For procedures on configuring a call monitoring session, as well as initiating and terminating call
monitoring, see "Call Monitoring" on page 6–243.
Command Syntax
Monitor Endpoint
CREATE MONITOR ENDPOINT endpoint
Monitor Target
CREATE MONITOR TARGET target
CONFIGURE MONITOR TARGET target CIC cic ISUP SERVICE GROUP isupsvcgroup
CONFIGURE MONITOR TARGET target ENDPOINT NAME endpoint
CONFIGURE MONITOR TARGET target GCID gcid
CONFIGURE MONITOR TARGET target PORTNAME port CHANNEL channel
CONFIGURE MONITOR TARGET target STATE targetstate
CONFIGURE MONITOR TARGET target TYPE type
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Monitor Endpoint and Monitor Target CLI Reference
Command Parameters
Field
Parameter Length Description
endpoint 0-24 Specifies the name for this monitor endpoint. Must be 0-24
characters.
phonenumber 0-30 Specifies the telephone number for this monitor endpoint. Must
be 0-30 digits.
endpointstate N/A Specifies the administrative state of this monitor endpoint:
• disabled (default)
• enabled
target 0-24 Specifies the name for this monitor target. Must be 0-24
characters.
cic N/A Specifies the name of the base circuit identity code (CIC) for
the Monitor Target. Must be 0-16383.
isupsvcgroup 0-23 Specifies the ISUP Service Group name. Must be 0-23
characters.
gcid N/A Specifies the Global Call ID (GCID) of the Monitor Target call
(the GCID string by which every call is tracked throughout the
duration of the call). This hex integer is unique within the GSX
node.
port N/A Specifies the physical port number of the Monitor Target. Must
be 1-65535 (or 1 to the maximum number of ports for your
hardware configuration).
channel N/A Specifies the logical channel of the Monitor Target. Must be 1-
32.
targetstate N/A Specifies the administrative state of this monitor target:
• disabled (default)
• enabled
type N/A Specifies the Monitor Target type:
• gcid (default)
• channel
• cic
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Call Monitor Endpoint and Monitor Target
Command Examples
----------------------------------------------------------
Target Name : 1
----------------------------------------------------------
Index : 1
State : ENABLED
Type : GCID
GCID : 0x90007
Endpoint Name : 1
------------------------------------------------------------------------
Target Name :1 GCID:0x90002 Call State:
Monitor Name:1 GCID:0x000703 Call State:Idle
Time Monitor Created: 2007/02/05 19:10:51
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Tone Processing CLI Reference
Tone Processing
These objects configure tone processing objects required by other call services, such as CAS and
Media Gateway.
Tone Resources
The GSX uses Tones and Announcements Packet Assembler Disassembler channels when
performing MF/DTMF digit/tone collection or generation. This includes:
The number of active calls using these resources is limited by the number of tone processing
channels resident on the CNS modules on a GSX9000, or GNS modules on a GSX4000 series
switch. The number of tone processing channels available depends on the module type. For
example, there are 500 tone processing channels available on GNS modules. When all of the tone
processing resources are in use, the next call that requires such a resource must await the release of
the resource. These resources are pooled, so that if all the resources on one module are in use, the
GSX software looks for resources on another module in the chassis in order to continue processing
the call.
The tone processing resource is released whenever a call completes one of the functions listed
above.
NOTE
CNS31 modules do not provide tone processing resources.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Tone Processing
NOTE
Stable SIP calls in the GSX that are transferred, using SIP Refer for example, may
require the GSX to play ringback tone to the SIP transferee. The transferee is the
calling or called party from the original call that will stay in the call after the SIP
transfer is complete. If the new called party (or the SIP Target in SIP REFER terms)
has ringback tone configured, the GSX will play the provisioned ringback tone to
the transferee.
Digit Profile
This object creates and configures a profile for digit collection. Digit profiles define the
parameters for DTMF/MFR1/MFR2 digit generation and collection.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Tone Processing CLI Reference
Command Parameters
Field
Parameter Length Description
dprofilename 1-23 The name of the digit profile that is being configured.
type N/A The tone type to use to generate and detect the digits. This must
be specified when the object is created and cannot be changed
(you must delete and recreate the object to change this
parameter):
• dtmf - Dual Tone Multi-Frequency.
• mfr1 - Multi-Frequency (R1).
• mfr2 - Register signaling protocol for South America.
power N/A Specifies the generation power in dBm0. Must be between -50
and 3, default is -10 (dBm0).
make N/A Specifies the time to hold on the tone that generates the digit, in
milliseconds. Must be 0-8000, default is 100 (milliseconds). All
values must be divisible by 5.
break N/A Specifies the period of silence between digits, in milliseconds.
Must be 0-8000, default is 100 (milliseconds). All values must be
divisible by 5.
makekp N/A Specifies the time to hold on the tone that generates the mfr1
KP digit, in milliseconds. Must be 0-8000, default is 105
(milliseconds). All values must be divisible by 5.
minpower N/A Specifies the minimum power (per frequency) that is required for
digit collection, in dBm0. Must be between -45 and -25, default is
-45.
onduration N/A Specifies the minimum on time to successfully collect the digit, in
milliseconds. Legal ranges are:
• dtmf - 25-80, default is 40.
• mfr1 - 25-100, default is 40.
• mfr2 - 25-100, default is 25 (applies to compelled and pulsed
digits).
All values must be divisible by 5.
offduration N/A Specifies the minimum off time to successfully collect the digit, in
milliseconds. Legal ranges are:
• dtmf - 25-80, default is 40.
• mfr1 - 10-100, default is 40.
• mfr2 - 15-100, default is 15 (applies to compelled and pulsed
digits).
All values must be divisible by 5.
twistcutoff N/A Specifies the maximum allowable ratio of high frequency level to
low frequency level (or vice versa) in dBm0. Must be 4, 6, 8, 10,
or 12, default is 8.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Tone Processing
Field
Parameter Length Description
freqrange N/A Specifies the frequency tolerance while detecting digits:
• narrow - For dtmf, must accept within 2%; for mfr1, must
accept within 1.5% + 5 hertz; for mfr2, must accept ± 10
hertz. This is the default for mfr2.
• medium - for dtmf, must accept within 2.5%; for mfr1, must
accept within 1.5% + 10 hertz; for mfr2, must accept ± 20
hertz. This is the default for dtmf and mfr1.
• wide - for dtmf, must accept within 3%; for mfr1, must
accept within 1.5% + 15 hertz; for mfr2, must accept ± 30
hertz.
• wider - for dtmf, must accept within 3.5%; for mfr2, must
accept ± 10 hertz.
prepdelay N/A Specifies the minimum delay between the end of the last
compelled signal and the start of a backward pulsed signal, in
milliseconds. Must be 0-8000, default is 100 (milliseconds). All
values must be divisible by 5.
This parameter is applicable when TYPE is mfr2.
fonduration N/A Specifies the maximum amount of time a forward signal is sent,
in milliseconds. Must be 100-60000, default is 15000
(milliseconds). All values must be divisible by 5.
This timer can be overridden with a CAS SIGNALSEQ SSP.
This parameter is applicable when TYPE is mfr2.
foffduration N/A Specifies the maximum amount of time between the removal of
a forward signal and the sending of the next forward signal, in
milliseconds. Must be 100-60000, default is 27000
(milliseconds). All values must be divisible by 5.
This timer can be overridden with a CAS SIGNALSEQ SSP.
This parameter is applicable when TYPE is mfr2.
finaldd N/A Specifies the minimum interval after the sending of the last
backward compelled signal is complete, that an answer line
signaling condition can be can be applied in the backward
direction, in milliseconds. Must be 0-8000, default is 50
(milliseconds). All values must be divisible by 5.
This timer can be overridden with a CAS SIGNALSEQ SSP.
This parameter is applicable when TYPE is mfr2.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Tone Processing CLI Reference
Field
Parameter Length Description
mpduration N/A Specifies the maximum duration of a pulsed signal, in
milliseconds. Must be 0-8000, default is 1000 (milliseconds). All
values must be divisible by 5.
This timer can be overridden with a CAS SIGNALSEQ SSP.
This parameter is applicable when TYPE is mfr2.
postpdelay N/A Specifies the duration after a pulsed signal is transmitted during
which no forward signals will be recognized, in milliseconds.
Must be 0-8000, default is 250 (milliseconds). All values must be
divisible by 5.
This timer can be overridden with a CAS SIGNALSEQ SSP.
This parameter is applicable when TYPE is mfr2.
Command Example
Generation Parameters
Power: -10 dBm
Make: 80 msec
Break: 80 msec
Detection Parameters
Minimum Power: -45 dBm
Minimum On Duration: 35 msec
Minimum Off Duration: 25 msec
Frequency Accept Range: MEDIUM
Twist Cutoff: 8 dB
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Tone Processing
Generation Parameters
Power: -7 dBm
Make: 65 msec
Break: 65 msec
Make KP: 105 msec
Detection Parameters
Minimum Power: -30 dBm
Minimum On Duration: 25 msec
Minimum Off Duration: 15 msec
Frequency Accept Range: NARROW
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Tone Processing CLI Reference
Tone Profile
This object creates and configures a profile for generating a tone consisting of a single frequency,
dual frequency, amplitude-modulated frequencies, or composite. Select the appropriate CREATE
and CONFIGURE commands and parameters for generating tones with the following signal
characteristics:
• Single Tone - generates a simple single tone (TONE1) specified by frequency and power.
Tone duration and periods of silence are specified using three sets of the tone cadence
parameters (make, break, and repeat). The single tone may be applied in all three cadences.
• Dual Tone - generates a tone that is the sum of two simple tones (TONE1 and TONE2) specified
by corresponding frequency and power. Tone duration and periods of silence are specified
using three sets of the tone cadence parameters (make, break, and repeat). The dual tone
may be applied in all three cadences.
• Modulated Tone - generates a carrier tone (CARRIER FREQUENCY and POWER) amplitude-
modulated by another frequency (SIGNAL FREQUENCY and MODULATION INDEX). The
modulated tone is a result of the following function:
signal(n) = A[1+M*sin(2π*f*n/8000)]*sin(2π*fc*n/8000)
where:
Tone duration and periods of silence are specified using three sets of the tone cadence
parameters (make, break, and repeat). The modulated tone may be applied in all three
cadences.
• Composite Tone - may be used to configure a single, dual, or a more complex signal
composed of up to four distinct tones (TONE1, TONE2, TONE3, and TONE4; specified by the
corresponding frequency and power).
Tone duration and periods of silence are specified using three sets of the tone cadence
parameters (make, break, and repeat). For this method, each tone may be applied in all
three cadences or, alternatively, a single tone may be selected to be a component in only
one cadence. Multiple tones assigned to the same cadence result in generating a composite
tone formed by the sum of the individual tones for that cadence. The signal amplitude and
power resulting from the sum in each cadence is derived from the following formulas. The
formulas illustrate a cadence where all four tones apply. For a cadence with fewer than four
tones, omit the expressions for those tones that do not apply.
signal(n) = [A1*sin(2π*f1*n/8000)] + [A2*sin(2π*f2*n/8000)] + [A3*sin(2π*f3*n/8000)]
+ [A4*sin(2π*f4*n/8000)]
where:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Tone Processing
A1..A4 = amplitude of the individual tone, derived from the tone power
f1..f4 = signal frequency in Hz
Ptotal = 10*log[10((p1)/10)+10((p2)/10)+10((p3)/10)+10((p4)/10)]
where:
Command Syntax
Single Tone:
CREATE TONE PROFILE tprofilename GENERATION METHOD SINGLE TONE
CONFIGURE TONE PROFILE tprofilename ..
TONE1 FREQUENCY frequency
TONE1 POWER power
MAKE1 make
BREAK1 break
REPEAT1 repeat
MAKE2 make
BREAK2 break
REPEAT2 repeat
MAKE3 make
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Tone Processing CLI Reference
BREAK3 break
REPEAT3 repeat
REPEAT seqrepeat
Dual Tone:
CREATE TONE PROFILE tprofilename GENERATION METHOD DUAL TONE
CONFIGURE TONE PROFILE tprofilename ..
TONE1 FREQUENCY frequency
TONE1 POWER power
TONE2 FREQUENCY frequency
TONE2 POWER power
MAKE1 make
BREAK1 break
REPEAT1 repeat
MAKE2 make
BREAK2 break
REPEAT2 repeat
MAKE3 make
BREAK3 break
REPEAT3 repeat
REPEAT seqrepeat
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Tone Processing
Modulated Tone:
CREATE TONE PROFILE tprofilename GENERATION METHOD MODULATED TONE
CONFIGURE TONE PROFILE tprofilename ..
CARRIER FREQUENCY frequency
CARRIER POWER power
SIGNAL FREQUENCY frequency
SIGNAL MODULATION INDEX moindex
MAKE1 make
BREAK1 break
REPEAT1 repeat
MAKE2 make
BREAK2 break
REPEAT2 repeat
MAKE3 make
BREAK3 break
REPEAT3 repeat
REPEAT seqrepeat
Composite Tone:
CREATE TONE PROFILE tprofilename GENERATION METHOD COMPOSITE TONE
CONFIGURE TONE PROFILE tprofilename ..
TONE1 FREQUENCY frequency
TONE1 POWER power
TONE1 APPLY CADENCE apply_cadence
TONE2 FREQUENCY frequency
TONE2 POWER power
TONE2 APPLY CADENCE apply_cadence
TONE3 FREQUENCY frequency
TONE3 POWER power
TONE3 APPLY CADENCE capply_adence
TONE4 FREQUENCY frequency
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Tone Processing CLI Reference
Command Parameters
Field
Parameter Length Description
tprofilename 1-23 Specifies the name of the tone profile that is being configured.
This name is applied to tone packages.
frequency N/A Specifies the tone frequency in Hertz. Must be 0-3999, default
is 0. A value of zero disables the tone.
power N/A Specifies the tone power in dBm0. Must be between -50 and 3,
default is 0.
moindex N/A Specifies the ratio of the signal amplitude to the carrier
amplitude in percent. Must be 0-300, default is 0. This
parameter is only applicable to a MODULATED TONE profile.
make N/A Specifies the make time for this cadence, that is the time to
hold the tone on, in milliseconds. Must be between -1 and
8000, default is 0. A value of -1 generates the tone
continuously.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Tone Processing
Field
Parameter Length Description
break N/A Specifies the break time for this cadence, that is the period of
silence between tone stop and start, in milliseconds. Must be
between -1 and 8000, default is 0. A value of -1 generates a
continuous silence.
repeat N/A Specifies the repeat count for this cadence, that is the number
of make/break repetitions. Must be 0-65535, default is 1. A
value of 0 causes the tone cadence to be repeated indefinitely.
seqrepeat N/A Specifies the number of times to repeat the entire sequence of
cadences. Must be 0-65535, default is 1. A value of 0 causes
the sequence to be repeated indefinitely.
apply_cadence N/A Specifies which cadence to apply to the tone. For composite
tones only. Values are allCadence, cadence1, cadence2,
or cadence3; default allCadence. Each tone may be
applied in all three cadences (specified by allCadence) or in
just one cadence (selecting cadence1, cadence2, or
cadence3).
Each numbered cadence selects the matching numbered set
of MAKE, BREAK, and REPEAT. For example, if cadence1 is
specified for any tone, then MAKE1, BREAK1, and REPEAT1
must also be specified. Selecting a numbered cadence for a
particular tone indicates that the tone is to be included as a
component of the signal generated during that cadence. When
more than one tone is configured for the same cadence, then
the generated signal made during that cadence is the sum of
those tones. See the example below.
A value of allCadence indicates that the selected tone is to
be a component of the generated signal during every non-zero
value of an instance of make.
decayTime N/A Specifies the decay time constant (in msec) to be applied to
tones identified in toneBitMap. The decayTime parameter
is used to change the tone amplitude as follows:
amp(t) = amp(0) *exp(-(t)/decayTime)
where: t is time in msec
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Tone Processing CLI Reference
Field
Parameter Length Description
frequencyDelta N/A Specifies the frequency delta (in Hz/sec) to be applied to tones
identified in toneBitMap. Must be 0-1000, in increments of
10, default is 0. The frequencyDelta parameter is used to
create a continuous phase variation in frequency as follows:
freq(t) = freq(0) + (t*frequencyDelta)
where: t is time in sec
toneBitMap N/A Specifies the hexadecimal representation of the selected tones
to which the decayTime and/or frequencyDelta are to be
applied. The value is between 0x0-0xf; default 0. 0 indicates
that no decay should be applied to any tone.
The values of 0x1, 0x2, 0x4, or 0x8 select the individual tones,
TONE1,TONE2, TONE3, or TONE4, respectively. To select a
group of tones, specify the value obtained as the hexadecimal
sum of the numbers that select the individual tones. For
example, to select the group of tones (TONE1, TONE2, and
TONE4), the toneBitMap value is 0xB (the sum of 0x1 + 0x2
+ 0x8).
Command Example
Create and configure a composite tone profile named callingCardTone.This tone consists of
60 milliseconds of the dual tone 941 Hz and 1477 Hz followed by 940 milliseconds of the dual
tone 350 Hz and 440 Hz. The 350 Hz and 440 Hz dual tone is decaying exponentially with the time
constant of 200 milliseconds.
% CREATE TONE PROFILE callingCardTone ..
GENERATION METHOD COMPOSITE TONE
% CONFIGURE TONE PROFILE callingCardTone ..
TONE1 FREQUENCY 941
TONE1 POWER -10
TONE1 APPLY CADENCE cadence1
TONE2 FREQUENCY 1477
TONE2 POWER -10
TONE2 APPLY CADENCE cadence1
TONE3 FREQUENCY 350
TONE3 POWER -10
TONE3 APPLY CADENCE cadence2
TONE4 FREQUENCY 440
TONE4 POWER -10
TONE4 APPLY CADENCE cadence2
MAKE1 60
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Tone Processing
BREAK1 0
MAKE2 940
BREAK2 0
REPEAT 0
DECAY TIMECONSTANT 200
DECAY APPLY TONEBITMAP 0xC
Signal Parameters
Tone 1 Frequency: 941 Hz
Tone 1 Power: -10 dBm
Tone 1 Cadence(s): CADENCE1
Tone 2 Frequency: 1477 Hz
Tone 2 Power: -10 dBm
Tone 2 Cadence(s): CADENCE1
Tone 3 Frequency: 350 Hz
Tone 3 Power: -10 dBm
Tone 3 Cadence(s): CADENCE2
Tone 4 Frequency: 440 Hz
Tone 4 Power: -10 dBm
Tone 4 Cadence(s): CADENCE2
Cadence Parameters
Cadence 1 Make: 60 msec
Cadence 1 Break: 0 msec
Cadence 1 Repeat: 1
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Tone Processing CLI Reference
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Tone Processing
Create and configure a single tone profile named TwProf. This Tone Profile enables GSX support
for Customized Application of Mobile Enhanced Logic (CAMEL) services for Global System for
Mobile Communication (GSM) wireless carriers. These enhanced CAMEL services include pre-
paid, VPN, and ringback tone. These services are not available via standard GSM services when
subscribers are roaming outside their Home Public Land Mobile Network (HPLMN). These
enhanced services run on Service Control Points (SCPs) known as GSM Service Control
Functions (gsmSCFs) and GSM Specialized Resource Functions (gsmSRFs), which comprise the
CAMEL service environment.
% CREATE TONE TYPE tw
% CREATE TONE PROFILE TwProf GENERATION METHOD SINGLE TONE
% CONFIGURE TONE PROFILE TwProf TONE1 FREQUENCY 900
% CONFIGURE TONE PROFILE TwProf TONE1 POWER -13
% CONFIGURE TONE PROFILE TwProf make1 200
% CONFIGURE TONE PROFILE TwProf break1 200
% CONFIGURE TONE PROFILE TwProf REPEAT 3
% CONFIGURE TONE PROFILE TwProf make2 0
% CONFIGURE TONE PROFILE TwProf break2 0
% CONFIGURE TONE PROFILE TwProf REPEAT 1
% CONFIGURE TONE PROFILE TwProf make3 0
% CONFIGURE TONE PROFILE TwProf break3 0
% CONFIGURE TONE PROFILE TwProf REPEAT 1
% CONFIGURE TONE PACKAGE default ADD TONE TYPE Tw TONE PROFILE TwProf
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Tone Processing CLI Reference
Tone Type
This object creates a tone type. The tone type gives names to call progress tones, such as dial, ring,
and busy. Tone types do not require configuration. They are mapped to tone profiles using the
Tone Package commands.
Command Syntax
Command Parameters
Field
Parameter Length Description
tonetype 1-23 The name of the tone type. The GSX creates default names as
follows:
• dial
• ring
• busy
• reorder
• sit1
• sit2
• sit3
• ringback
• confirm
• congestion
• oldMw
• newMw
• testLine
• networkBusy
• ringing
• noCircuit
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Tone Processing
To display tone types, use the following command. The first 16 tone types are the GSX default
tone type names. They are not used by the Media Gateway.
% SHOW TONE TYPE SUMMARY
Node: TPUBS Date: 2003/10/29 23:54:43 GMT
Zone: GMTMINUS05-EASTERN-US
Tone Types
Index: 2 Name: ring
Index: 3 Name: busy
Index: 4 Name: reorder
Index: 5 Name: sit1
Index: 6 Name: sit2
Index: 7 Name: sit3
Index: 8 Name: ringback
Index: 9 Name: confirm
Index: 10 Name: congestion
Index: 11 Name: oldMw
Index: 12 Name: newMw
Index: 13 Name: testLine
Index: 14 Name: networkBusy
Index: 15 Name: ringing
Index: 16 Name: noCircuit
Index: 17 Name: L/s(1)
Index: 18 Name: L/z
Index: 19 Name: H/z
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Tone Processing CLI Reference
Tone Package
This object creates and configures a tone package, which defines a set of call progress tones for a
given country or carrier. Tone packages are configured by assigning tone types to tone profiles.
You may add a tone type to a tone package. You may delete a tone type from a tone package. You
may modify a tone type within a tone package by specifying a different tone profile. The tone
package name may be used by the Media Gateway Service, CAS Service, and CAS Service Profile
objects.
Command Syntax
Command Parameters
Field
Parameter Length Description
tonepackage 1-23 The name of the tone package.
tprofilename 1-23 The name of the tone profile to be used to generate the tone
type.
tonetype 1-23 The name of the tone type.
id N/A A unique identifier across all GSXs. Must be 0-65535. All tone
packages with this identifier must be identical.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Tone Processing
To add the Calling Card Service Tone to the default MGCP tone packages, Lmg and Hmg:
% CONFIGURE TONE PACKAGE Lmg ..
ADD TONE TYPE L/z TONE PROFILE callingCardTone
% CONFIGURE TONE PACKAGE Hmg ..
ADD TONE TYPE H/z TONE PROFILE callingCardTone
To change the tone profile assigned to the tone type L/z in the Lmg tone package to
callingCardTone2:
To delete the tone type L/z from the Lmg tone package:
% CONFIGURE TONE PACKAGE Lmg ..
DELETE TONE TYPE L/z
By properly configuring ukRingBack and its unique ID to the PSX Signaling Tone Package and
Signaling Profile entities, egress SIP and H.323 calls may use this package to provide local
ringback. Local ringback mode must be enabled.
NOTE
For egress CAS trunk groups, Sonus does not recommend the use of “ringback”
call progress tones in the SSP through the use of the report PARAM1 alert
sequence. Currently the GSX does not incorporate any DSP call progress tone
detection to indicate the actual call state at the remote switch; so, to avoid call
progress state inconsistency on the ingress trunk, the remote switch should be
allowed to generate all call progress tones after dialing has been completed. For
SSPs that use the report PARAM1 progress token to generate ringback, the
progress value should be changed to alert to maintain the previous
functionality.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Tone Processing CLI Reference
The SIP DTMF Trigger Detection and Notification functionality enables the GSX to look for
specific DTMF trigger patterns and to notify an external SIP entity when such patterns are
detected. If a mid-call trigger is configured for a call, it is activated as soon as the call is connected.
When the GSX detects DTMF input matching the pattern criteria of the trigger, it sends the DTMF
input in a SIP INFO message with content type application/dtmf to the SIP call peer with content
type application/dtmf. For more information on mid-call digit detection, see "Mid-Call Digit
Detection" on page 6–175.
The selection of a trigger profile for a call is based on profile name. For an ingress SIP call, the
GSX checks for a trigger profile named "ingress." Similarly, for an egress SIP call, the GSX
checks for a trigger profile named "egress." Ingress and egress triggers correspond to the following
call flows:
• Ingress triggers are used to detect DTMF input on SIP-to-PSTN calls when DMTF keys are
pressed on the PSTN side.
• Egress triggers are used to detect DTMF input on PSTN-to-SIP calls when DMTF keys are
pressed on the PSTN side.
• Ingress or egress triggers can be used simultaneously to detect DTMF input on SIP-to-SIP
transcoded calls when DTMF digits are received via RFC 2833, or via in-band or out-of-band
messages (in SIP-INFO) from either peer.
To enable this feature, you configure and enable the GSX DTMF trigger for the appropriate leg of
the call and select the "Digit Detect Send Enabled" flag on the PSX Packet Service Profile.
Changes to configuration parameters do not effect existing calls.
NOTE
Packet Service Profiles are associated with Gateway Groups, and therefore are
also considered ingress or egress, depending on your configuration and call flow.
Digit patterns are specified using digit-regular expressions, according to the rules in Table 3–228:
Entity Matches
character Digits 0-9 and A-D (case insensitive)
* *
# #
[character selector] Any character in selector
[^digit selector] Any digit (0-9) NOT in selector
[range1-range2] Any digit (0-9) in range from range1 to range2, inclusive
x Any digit 0-9
. Zero or more repetitions of previous pattern.
| Alternation
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Tone Processing
Entity Matches
Lc The character c if it is “long;” c is a digit 0-9 and A-D, #, or *.
S# The GSX V6.0 pattern L# | ## (either long # or double #), but behaves as
in pre-V6.0 manner where only a single # is reported even when a ## is
(Sonus #)
matched.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Tone Processing CLI Reference
Command Parameters
Field
Parameter Length Description
triggerprofile N/A Indicates the profile name to check for:
• ingress - checks for a trigger profile named ingress.
• egress - checks for a trigger profile named egress.
pattern 0-30 Indicates the pattern in digit-regular expression on which the
GSX should match. Multiple patterns can be strung together
using “|.”
See Table 3–227 on page 3–1203, "Valid Pattern Matches"
and Table 3–228 on page 3–1204, "Pattern Match
Examples" for more information.
If you do not enter a pattern value, S# is assumed to be the
default.
interdigtimeout N/A Specifies the interdigit timer (maximum time between digits)
in milliseconds. If 0 is specified, the timer is disabled. Must
be 0 to 65535. The default value is 4000.
longdigduration N/A Specifies the minimum duration in milliseconds for a digit to
be considered long. If 0 is specified, long digits are disabled.
Must be 0 to 65525. The default value is 2000.
state N/A Indicates the administrative state of this DTMF Trigger:
• disabled (default)
• enabled
Command Example
DTMF Triggers:
Index: 1 Name: ingress
Index: 2 Name: egress
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Manual Calls
Manual Calls
Static Call
This object creates and configures a static (or “nailed up”) call. This mechanism allows you to
define a static call by specifying both endpoints. These endpoints permit the specification of
permanent PSTN to PSTN, PSTN to IP, or IP to PSTN connections. A static call will remain up
through a system reboot, a failure in the T1/E1 circuit and/or a loss of NIF. A failure in an
unprotected CNS module on a GSX9000, or a GNS module on a GSX4000 series switch is the
only hardware event that will tear down this call. You may manually remove the call via the
CONFIGURE CALL GCID.. command discussed below.
You may set up static calls in order to pass SS7 F-links to the SGX through one or more GSX. In
international SS7 environments, you may combine signaling channels via this Digital
Crossconnect System (DCS) to achieve groomed SS7 F-links.
A static call does not generate any call statistics nor does it create any accounting records.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Manual Calls CLI Reference
Command Parameters
Field
Parameter Length Description
callname 1-23 A name by which to identify this permanent, “nailed up”,
connection.
circuitmode N/A Specifies the type of call that this permanent connection will
support:
• data - data call.
• voice -voice call.
This places additional constraints on other circuit parameters
for this object. For example, a CNS31 module must not
reside in any slot specified for a voice call.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Manual Calls
Field
Parameter Length Description
e1portname N/A The name of the E1 object. The default names are
constructed as follows:
• CNS20/25/40/45 based E1 - E1-shn-sln-spn where
shn is the shelf number, sln is the slot number, and spn
is the span number (1-8 for CNS20s, 1-12 for CNS25s).
For example, E1-1-3-2 identifies the second E1 span on
the E1 circuit that connects to the port on the CNA that
resides behind the CNS20 or CNS25 in slot 3 of shelf 1.
• CNS71/81/86 based E1 - E1-shn-sln-1-spn, where
shn is the shelf number, sln is the slot number, and spn
is the span number (1-63). For example, E1-1-3-1-45
identifies the 45th E1 span on the OC-3 circuit that
connects to the port on the CNA70 via the CPIM71 in slot
3 of shelf 1.
• GSX4000 based E1 - E1-port, where port is the port
number (1-12). For example, E1-2 identifies the second
E1 port that connects to the port on the GSX4000.
This name may be changed via the CONFIGURE E1..NAME
command.
t1portname N/A The name of the T1 object. The default names are
constructed as follows:
• CNS10/40/45 based T1 - T1-shn-sln-spn where shn is
the shelf number, sln is the slot number, and spn is the
span number (1-12). For example, T1-1-3-2 identifies
the second T1 span on the T1 circuit that connects to the
port on the CNA10 that resides behind the CNS10 in slot 3
of shelf 1.
• CNS30/31/61/80/85 based T1 - T1-shn-sln-port-spn
where shn is the shelf number, sln is the slot number,
port is the T3 index (always 1 for CNS30/CNS31, or 1-3
for CNS60) and spn is the span number (1-28). For
example, T1-1-3-2-2 identifies the second T1 span on
the second T3 circuit that connects to the corresponding
port on the CNA60 that resides behind the CNS60 in slot 3
of shelf 1.
• CNS71/81/86 based T1 - T1-shn-sln-1-spn, where
shn is the shelf number, sln is the slot number, and spn
is the span number (1-84). For example, T1-1-3-1-45
identifies the 45th T1 span on the OC-3 circuit that
connects to the port on the CNA70 via the CPIM71 in slot
3 of shelf 1.
• GSX4000 based T1 - T1-port, where port is the port
number (1-12). For example, T1-2 identifies the second
E1 port that connects to the port on the GSX4000.
This name may be changed via the CONFIGURE T1..NAME
command.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Manual Calls CLI Reference
Field
Parameter Length Description
channum N/A The channel number of the connection endpoint. For a T1
channel, must be 1-24. For an E1 channel, must be 1-31. If
this channel is a member of an ISUP, ISDN, or CAS service
group, it will be rejected for this use.
servprofilename 1-23 The name of the packet service profile or circuit service
profile to use for the IP/circuit endpoint that is being
configured. In the current GSX software, this packet service
profile must be provided and may not be the default
profile.
lrtpport N/A The logical number of the local Realtime Transport Protocol
(RTP) port of the IP endpoint. This must be an even number,
equal or greater than 5000.
ipaddress N/A The 32-bit IP address of the RTP port in dotted decimal form
(for example 128.127.50.224)
rrtpport N/A The logical number of the remote RTP port of the IP
endpoint.
admin-state N/A The administrative state of the static call:
• disabled (default) - Not activated, able to be
reconfigured or deleted (by GCID).
• enabled - Activated, available for immediate and
permanent use.
Command Example
To create and configure a PSTN to PSTN static connection between a T1 channel connected to a
CNA10 in slot 3 and a T3 channel connected to a CNA30 in slot 5:
% CREATE STATIC CALL flink1
% CONFIGURE STATIC CALL flink1 ENDPOINT A T1PORTNAME T1-1-3-4 ..
CHANNEL 16 SERVICE PROFILE default
ENDPOINT B TYPE CIRCUIT T1PORTNAME T1-1-5-1-28
CHANNEL 1 SERVICE PROFILE default
% CONFIGURE STATIC CALL flink1 STATE enabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Manual Calls
The segment below creates and configures a PSTN to IP static connection between a T1 channel
connected to a CNA10 in slot 3 and an IP address associated with one of the NIFs on the PNA10 in
slot 4. Notice that 10 UDP ports are reserved for static calls, but only one is used in this segment.
Notice also that the Packet Service Profile, packetsp1, is created and used to configure the
packet end point. Because this profile is never configured, it takes all default packet service profile
parameter values.
% CREATE STATIC CALL pstn_ip
% CREATE PNS RESERVED UDP PORTS SHELF 1 SLOT 4 NUMBER 10
% CREATE PACKET SERVICE PROFILE packetsp1
% CONFIGURE STATIC CALL pstn_ip ENDPOINT A ..
T1PORTNAME T1-1-3-4 CHANNEL 16
SERVICE PROFILE default
ENDPOINT B TYPE PACKET LOCAL RTP PORT 5000
LOCAL IP ADDRESS 128.10.10.10 REMOTE RTP PORT 5000
REMOTE IP ADDRESS 128.10.100.110
SERVICE PROFILE packetsp1
% CONFIGURE STATIC CALL pstn_ip STATE enabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Manual Calls CLI Reference
NOTE
This command may be used to obtain the call GCID that will be necessary to use
the command below to tear down and remove the connection.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Manual Calls
Call GCID
This object permits you to manually tear down and delete a call from the system, using the call’s
Global Call Identifier (GCID). Any connection may be removed including static and long-duration
calls, as long as you supply the intended GCID.
Command Syntax
Command Parameters
Field
Parameter Length Description
gcid N/A The GCID number of a call to be torn down and removed.
Command Example
To tear down and remove the static call created in the above example:
% CONFIGURE STATIC CALL flink1 STATE disabled
% SHOW STATIC CALL flink1 STATUS
Node: TPUBS Date: 2000/07/27 23:15:50 GMT
Zone: GMTMINUS05-EASTERN-US
NOTE
The call is actually torn down by the disable command issued above.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Manual Calls CLI Reference
Test Call
This object allows you to set up a test call and use tone swapping to check for power loss on a
specific channel (sometimes referred to as a DS0 in the US) between two GSXs that have a trunk
connection. Note that test calls may be used on all GSX9000 circuit network server modules
except the CNS31, and all GSX4000 series switches.
An operator can use a test call for testing the continuity of a given hard-wired path between two
GSX channels or a GSX and another channel interface. This functionality allows an operator to
generate or listen for a tone of configurable frequency and power and display the results received
(for test call type listen only). The T1 that includes the channel to be tested must be set to mode
inservice and state enabled. The channel must also be inservice.
All test call parameters and the target channel must be configured before enabling the test call
endpoint. Once the state is enabled the test call will begin listening for or playing a tone as defined
in the call parameters until the call is disabled. Note that for test call type play, the tone will be
generated indefinitely until the call is disabled. For test call type listen, the test call will go out
and sample the incoming tone only once, and will time out after 5 seconds. In order to listen on a
line a second time, the test call type listen call must be disabled and then enabled.
To use the test call functionality, there must be an operator at either end of the channel line to be
tested. These two operators must be in contact with one another on a separate voice line so that the
operator at one end can communicate the fact that a tone of an agreed upon frequency is now being
generated, and the operator at the other end can report the power level of the tone detected at that
frequency.
• When a test call is enabled on a channel, that channel resource is not accessible by the system
for any other purpose.
• There is no loopback functionality.
• Test calls should be disabled when not in use as each test call consumes a channel.
• Test calls are not preserved during a switchover or a reboot. This means that after a switchover
or a system reboot, all configured test calls will disappear, and all the resources associated
with those test calls will be de-allocated.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Manual Calls
Before enabling a test call, the operator must first verify that there is a valid IN_SYNC NTP server
available and that the target channel is not owned by a service group.
In order for a test call to be of any use, a test call must be created and configured on two channel
endpoints connected by wire. Each test call created is configured to reside on one and only one
endpoint. It can have its type set as listen or play. The frequency and power levels may also
be configured between 0 and 3999Hz and -50 to +3 dBm respectively.
GSX GSX/5ESS
Generate a tone at configured
frequency and amplitude on a
given INSERVICE channel Listen for tone.
(DS0).
Operator 1 Operator 2
When the test call is enabled as type play, the channel will generate a tone with the configured
frequency and power level until the user disables the test call.
When the test call is enabled as type listen, the DSP will detect a tone once at the configured
frequency and display the received power level via the SHOW TEST CALL STATUS command.
NOTE
Once a test call of type listen is enabled, the call times out after 5 seconds.
Therefore, you must configure the play side test call state to enable first, before
setting the listen call’s state to enable.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Manual Calls CLI Reference
Command Syntax
Command Parameters
Field
Parameter Length Description
callname 1-23 A name by which to identify this test call.
e1portname N/A The name of the E1 object. The default names are constructed as
follows:
• CNS20/25/40/45 based E1 - E1-shn-sln-spn where shn is
the shelf number, sln is the slot number, and spn is the span
number (1-8 for CNS20s, 1-12 for CNS25s). For example, E1-
1-3-2 identifies the second E1 span on the E1 circuit that
connects to the port on the CNA that resides behind the CNS20
or CNS25 in slot 3 of shelf 1.
• CNS71/81/86 based E1 - E1-shn-sln-1-spn, where shn is
the shelf number, sln is the slot number, and spn is the span
number (1-63). For example, E1-1-3-1-45 identifies the 45th
E1 span on the OC-3 circuit that connects to the port on the
CNA70 via the CPIM71 in slot 3 of shelf 1.
• GSX4000 based E1 - E1-port, where port is the port number
(1-12). For example, E1-2 identifies the second E1 port that
connects to the port on the GSX4000.
This name may be changed via the CONFIGURE E1..NAME
command.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Manual Calls
Field
Parameter Length Description
t1portname N/A The name of the T1 object. The default names are constructed as
follows:
• CNS10/40/45 based T1 - T1-shn-sln-spn where shn is the
shelf number, sln is the slot number, and spn is the span
number (1-12). For example, T1-1-3-2 identifies the second
T1 span on the T1 circuit that connects to the port on the
CNA10 that resides behind the CNS10 in slot 3 of shelf 1.
• CNS30/31/61/80/85 based T1 - T1-shn-sln-port-spn where
shn is the shelf number, sln is the slot number, port is the T3
index (always 1 for CNS30/CNS31, or 1-3 for CNS60) and spn
is the span number (1-28). For example, T1-1-3-2-2
identifies the second T1 span on the second T3 circuit that
connects to the corresponding port on the CNA60 that resides
behind the CNS60 in slot 3 of shelf 1.
• CNS71/81/86 based T1 - T1-shn-sln-1-spn, where shn is
the shelf number, sln is the slot number, and spn is the span
number (1-84). For example, T1-1-3-1-45 identifies the 45th
T1 span on the OC-3 circuit that connects to the port on the
CNA70 via the CPIM71 in slot 3 of shelf 1.
• GSX4000 based T1 - T1-port, where port is the port number
(1-12). For example, T1-2 identifies the second T1 port that
connects to the port on the GSX4000.
This name may be changed via the CONFIGURE T1..NAME
command.
channum N/A The channel number of the connection endpoint. For a T1
channel, must be 1-24. For an E1 channel, must be 1-31. If this
channel is a member of an ISUP, ISDN, or CAS service group, it
will be rejected for this use.
state N/A The operational state of the test call:
• disabled (default) - test call is configured but not activated.
Able to be reconfigured or deleted.
• enabled - test call is configured and active.
type N/A The type of test call to be configured:
• play - configured call will generate the tone indefinitely, until
the call is disabled.
• listen (default) - configured call will sample the incoming tone
only once. To sample the line again, the listen call must be
disabled and then enabled. A test call of type listen displays
the received power level of the received tone at the configured
frequency. Note that a listen call times out after 5 seconds.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Manual Calls CLI Reference
Field
Parameter Length Description
freq N/A The frequency of the tone to be played on a test call of type play
or the frequency of the tone to be detected for a test call of type
listen. Must be a value between 0 and 3999 Hz. Default is 1004
Hz.
power N/A The power level of the tone to be played on a test call of type play.
Range is -50 to =3 dBm. Default is -6 dBm.
Command Example
GSX GSX
Operator 1 / GSX A Operator 2 / GSX B
Generates a tone at 1004 Hz Listens for tone.
with power level of -6 dDm on
a given CNS10 channel Endpoint:
(DS0). shelf 1
Endpoint: slot 7
shelf 1 span 1
slot 5 channel 3
span 1
channel 3
Two operators want to test for power loss between two GSXs with a trunk connection between
GSX-A: slot 5, port 1 and GSX-B: slot 7, port 1. The operators decide ahead of time that Operator
1 will play a tone and Operator 2 will listen for that tone. It is assumed that the operators are able
to communicate with each other throughout the test on a separate voice line.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Reference Manual Calls
NOTE
The play side of the test call must always be enabled first, before the listen side,
as shown above. This is because the test call on the listen side will always time
out after 5 seconds.
CAUTION
Test calls should be set to STATE disable when no longer in use, as each test call
consumes a channel. Deleting a test call is not absolutely necessary as this only
removes a test call entity from a table on the MNS module.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
CHAPTER 4 Using the GSX in Local Policy
Mode
Overview
This chapter provides information for using the GSX in Local Policy mode, an enhanced version
of the GSX, capable of executing basic call routing and simple policy decisions and storing the
required configuration data without a need for an external routing node or policy server node.
Basic routing capabilities can be performed on SIP-ISUP, SIP-SIP, and ISUP-to-ISUP
interworking.
Topics include:
• "GSX Local Policy" on page 4–2
• "CLI Commands for GSX Local Policy" on page 4–9
• "Configuring the GSX for Local Policy" on page 4–33
The PSX Policy Server provides a number of services and routing capabilities based on various
entity types. PSX processing involves input call processing, number translation, services, standard
routing, and output call processing. GSX Local Policy route processing is modeled on the PSX
providing a subset of routing capabilities using a Local Policy server including:
GSX Local Policy follows the basic model of the PSX, where most of the policy data is
provisioned on the trunk groups. Trunk groups on a GSX Local Policy system use a Local Policy
Trunk Group Profile to hold the local policy data associated to the trunk group, which is equivalent
to the PSX trunk group object. The same Local Policy Trunk Group Profile can be assigned to
multiple GSX trunk groups, whereas only one trunk group can be associated with a PSX trunk
group object.
The Local Policy Trunk Group Profile contains pointers to a Dial Plan, a Packet Service Profile, an
IP Signaling Profile, and a Signaling Profile, associated to the trunk group. GSX Local Policy also
implements a system-wide routing table and supporting entities like IP Signaling Peers to support
local routing.
NOTE
GSX Local Policy provides basic routing and policy services. If more intelligent
high-order routing is needed, additional routing and policy service products (for
example, the PSX Policy Server) should be present in your network configuration.
GSX Local Policy provides user interfaces and functionality to create, delete, modify, and
permanently save a subset of the configuration objects and tables that currently reside within the
PSX databases. These are described in the sections that follow.
A GSX in Local Policy mode operates without a PSX, however detailed information on the policy
services and routing functionality described in this chapter can be found in the PSX Policy Server
Product Description and the PSX Policy Server Provisioning Guide.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
GSX Local Policy Using the GSX in Local Policy Mode
Input call processing involves retrieving call-related information from a policy request and
combining it with information in the database to determine the data used for subsequent call
processing. Input call processing on the GSX Local Policy server involves Number Analysis and
Call Type Analysis.
Number Analysis
The GSX Local Policy server analyzes the called, redirecting, and calling party numbers for calls
received from ISUP side based on the Nature of Address (NOA) field received in the IAM. The
number will be categorized as National or International accordingly. The GSX Local Policy
server accepts both globalized and non-globalized SIP phone numbers and adds and removes the
leading "+" sign, SIP inter digit delimiter (e.g. ".", "-", etc.), and the country code from the call
address digits.
Figure 4–1 illustrates the analysis done at the GSX Local Policy server for incoming calls on
ISUP trunks as a part of number globalization.
FIGURE 4–1 GSX Local Policy Input Number Analysis on PSTN Trunk Group
Numbers received in
IAM
Check NOA is
International
No Yes
Add the
country code
National international
from the
Number Ingress TG to number
the number
The GSX Local Policy server analyzes the called and calling party numbers for calls received from
SIP side based on the presence or absence of "+." The number is categorized as International, if a
leading "+" is present.
The GSX Local Policy server also analyzes if the number starts with an International Access Code
or National Access Code if a leading "+" is missing. If the number starts with International or
National Access Code, the access code is removed and the remaining digits are treated as an
International or National number accordingly.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the GSX in Local Policy Mode GSX Local Policy
The NATIONAL ACCESS CODE and INTERNATIONAL ACCESS CODE in the DIAL PLAN
parameters configure access codes associated with a trunk group:
Figure 4–2 shows how the The GSX Local Policy server analyzes called and calling party
numbers in SIP URIs to perform globalization.
No
No
No
Add the
country code international
National Number from the number
Ingress TG to
the number
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
GSX Local Policy Using the GSX in Local Policy Mode
The GSX Local Policy server performs number analysis to determine the following call types:
• National
• International
The GSX Local Policy server does not perform digit analysis to determine call types other than
mentioned above, Consequently, it will not make any call type-based services and routing
decisions. The GSX Local Policy server does not support call analysis based on prefix and
numbering plan profile. See "Dial Plan" on page 4–21 for information on configuring a local DIAL
PLAN.
Routing
The GSX Local Policy server supports routing based on the destination number and Ingress trunk
group, and performs the following as a part of standard routing:
The GSX Local Policy server always uses the globalized called party number for route lookup. If
the country code of the called party number is not received in incoming signaling, then the country
code configured on the Ingress trunk group is used to globalize the called party number.
If the destination number is not received in the incoming IAM, and the NOA of the destination
number is Operator, the GSX uses the Operator Number associated to Ingress trunk group as
destination number for the route lookup.
Route Lookup
The GSX maintains a system-wide routing table which, for each entry, holds all route match
criteria and matching route labels for each route. The STANDARD ROUTE configuration object
provides a mechanism to add a Policy Route in the policy Standard Route Table. You can specify
one or more of the following match criteria for a route:
See "Standard Route" on page 4–31 for more information on the STANDARD ROUTE configuration
object.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the GSX in Local Policy Mode GSX Local Policy
The GSX determines the best match based on the input criterion match in the following order of
the priority:
The GSX then returns a Routing Label containing one primary and one secondary egress route.
The ROUTING LABEL object creates and configures the primary and secondary routes. See
"Routing Label" on page 4–28 for more information on the ROUTING LABEL configuration
object.
An egress route in the Routing Label is represented by either an Egress Trunk group for PSTN
trunks, or an IP Signaling Peer for IP trunk groups. The GSX resolves the IP trunk group
associated with a IP Signaling Peer, when the route lookup returns a IP Signaling Peer. The IP
Signaling peer may contain the IP address or a fully-qualified domain name (FQDN) of the IP
Signaling Peer. See "IP Signaling Peer" on page 4–26 for more information on the IP
SIGNALING PEER configuration object. The GSX uses the policy data associated with the IP
Trunk Group, defaultiptg, if the IP Signaling Peer could not be resolved to an Egress IP trunk
group, when operating in the default zone of INTERNAL.
Output call processing is the final call processing prior to returning a policy response to the GSX
or other source of the policy request. Output call processing is carried out at both the call level
(e.g. call type, Ingress PSP) and at the level of individual routes returned for the call (e.g. egress
trunk group signaling). The GSX Local Policy server output call processing performs the
following functions:
• Return the PACKET SERVICE PROFILEs associated with Ingress and Egress trunk groups to
determine audio encoding methods for calls.
• Determine the signaling parameters for call using the IP SIGNALING PROFILE and the
SIGNALING PROFILE.
The GSX uses controls in IP SIGNALING PROFILE, PACKET SERVICE PROFILE, and
SIGNALING PROFILEs for configuring specific customizations for all calls, for example Number
globalization based on IP Signaling Profile flag for egress IP trunk group calls. See the section,
"CLI Commands for GSX Local Policy" on page 4–9 for information on these configuration
objects.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
GSX Local Policy Using the GSX in Local Policy Mode
IP Signaling Profile
The GSX Local Policy server uses the IP Signaling Profile associated to an ingress trunk group to
determine IP signaling parameters for customization and control of Ingress and Egress IP signaling
attributes. See "IP Signaling Profile" on page 4–10 for more information on the IP SIGNALING
PROFILE configuration object.
Table 4–1 lists the IP Signaling Profile parameters configurable when using GSX Local Policy:
Non-Configurable Parameters
The GSX returns the default values of the IP Signaling parameters which are not configurable on
IP signaling profile in GSX Local Policy mode. Most of the default values are disabled with the
following exceptions:
• Reject Refer by default, is enabled (the GSX rejects SIP REFER messages from the peer and
responds with a 405 Method Not Allowed message).
• Redirect Mode by default, is set to Reject Redirection (if a Redirect is received, crank back is
performed).
For a complete list and description of all IP Signaling attributes, see the PSX Policy Server
Provisioning Guide.
Type Field
Common IP Attributes
Discard Received Reason Header
Include Reason Header
No Silence Suppression
Create P-Charging Vector
Call Hold Interworking
Terminal Portability Interworking
Insert Peer Address As Top Route Header
Egress IP Attributes
IP Protocol Type
MIME Content Type Version
Transport Type 1, 2, 3, 4
Flags Disposition Handling Required
Globalize Numbers
Map 181 or 182 Message to 183
BCI BCI Interwork Encountered
BCI ISDN Access
Number Portability NPDI Options
Attributes
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the GSX in Local Policy Mode GSX Local Policy
Type Field
Number Portability Disable rn
Attributes - Flags
Privacy Transparency
Privacy Information
Privacy - Flags Include Privacy
Privacy Required by Proxy
SIP Cause Mapping Internal to SIP Cause Mapping
SIP to Internal Cause Mapping
SIP Headers and Parameters SIP to Header Mapping
SIP Headers and Parameters Include CPC Information
- Flags
Include NPI
Include OLIP
Ingress IP Attributes Flags
181 Supported
182 Supported
No SDP in 180 Supported
Send SDP in 200 OK if 18x is Reliable
Signaling Profile
The SIGNALING PROFILE object creates and configures a signaling profile containing the various
PSTN signaling behavioral controls for a trunk group. The following signaling profile parameters
are configurable on the GSX Local Policy server:
Ingress Flags
• Don’t Generate Exit Message
• Propagate FE Parameter
Egress Flags
• Convert Numbers to E164 Format
See "Signaling Profile" on page 4–19 for more information on the SIGNALING PROFILE
configuration object.
The GSX returns the default values of the Signaling parameters which are not configurable on the
Signaling Profile in GSX Local Policy mode. Most of the default values are disabled.
For a complete list and description of all Signaling attributes, see the PSX Policy Server
Provisioning Guide.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Commands for GSX Local Policy Using the GSX in Local Policy Mode
The following configuration objects described in this section are used to configure, control, and
display the status the GSX when functioning in Local Policy mode:
These objects allow the GSX to make routing and policy decisions locally. For information on the
order in which you configure these objects, see "Configuring the GSX for Local Policy" on
page 4–33.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the GSX in Local Policy Mode CLI Commands for GSX Local Policy
IP Signaling Profile
The IP SIGNALING PROFILE object creates and configures the various IP signaling behavioral
controls for a trunk group. The GSX uses the IP signaling profile associated to Ingress trunk group
to determine IP signaling parameters for customization and control of Ingress IP signaling
attributes and the IP signaling profile associated to local Egress trunk group to determine IP
signaling attributes for the route.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Commands for GSX Local Policy Using the GSX in Local Policy Mode
Command Parameters
Field
Parameter Length Description
ipsigprof 1-23 The name of this IP Signaling Profile. Must be 1-23 characters.
discreasnhdr N/A Discard Received Reason Header (Common IP Attribute) -
Specifies whether to use the cause code in the Reason header
received from the remote peer.
• true - the GSX ignores the cause code in the received
Reason header.
• false (default) - the GSX uses the cause code in the
received Reason header
inclreashdr N/A Include Reason Header (Common IP Attribute):
• true - the GSX includes the Reason header in 18x, 4xx,
5xx, Cancel, and Bye messages in the forward direction. It
is provisioned on the egress trunk group.
• false (default)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the GSX in Local Policy Mode CLI Commands for GSX Local Policy
Field
Parameter Length Description
nosilsupr N/A No Silence Suppression (Common IP Attribute) - Specifies
whether the GSX sends silence suppression to the remote
peer.
• true - the GSX does not send silence suppression (no
a=silenceSupp is sent) in the SDP to the remote peer.
• false (default) - and when silence suppression is off, the
GSX sends a=silenceSupp:off in the SDP to the remote
peer.
Note: a=silenceSupp:on is never sent to the remote peer in
the Sonus implementation when silence suppression is on.
createpchngvectr N/A Create P-Charging-Vector (Common IP Attribute) - controls
whether a P-Charging-Vector header is created in outgoing
SIP messages:
• true - the GSX/NBS creates a new P-Charging-Vector
header in the outgoing message.
• false (default) - the GSX/NBS does not create a new P-
Charging-Vector header. Creating P-Charging-Vector
headers is supported in INVITE and REGISTER messages.
It is also supported in SUBSCRIBE, OPTIONS, and
NOTIFY messages when received from the same direction
as the REGISTER message. The P-Charging-Vector
header contains the ICID value, which is used to correlate
charging records among Sonus entities Egress IP
Attributes.
callholdinter N/A Call Hold Interworking (Common IP Attribute) - controls Call
Hold Interworking service between ISUP and SIP by
converting an ISUP call hold to SIP call hold, or vice-versa.
Call holds are invoked by ISUP endpoints. When disabled, call
hold indications are dropped.
• true - Call Hold Interworking is enabled.
• false - Call Hold Interworking is disabled.
Note: This feature cannot be enabled simultaneously on the
same call with TERMINAL_PORTABILITY_INTERWORKING.
termportinterw N/A Terminal Portability Interworking (Common IP Attribute) -
controls Terminal Portability Interworking service between
ISUP and SIP enabling a terminal to be moved from one
socket to another, or a call to be moved from one terminal to
another within one call while the call is active.
• true - Terminal Portability Interworking is enabled.
• false - Terminal Portability Interworking is disabled.
Note: This feature cannot be enabled simultaneously on the
same call with CALL_HOLD_INTERWORKING.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Commands for GSX Local Policy Using the GSX in Local Policy Mode
Field
Parameter Length Description
insertpeeradd N/A Insert Peer Address as Top Route Header (Common IP
Attribute):
• true - the GSX inserts the IP address of the next hop in the
top route header of the egress INVITE.
• false (default)
ipprotocol N/A IP Protocol Type (Egress IP Attribute) - Specifies the protocol
being supported by the associated trunk group:
• siponly (default)
• sipi
sigmimevers N/A MIME Content Type Version (Egress IP Attribute) - Specifies
the unique identifier for the version of the content type
selected (the version of ISUP in the MIME body of the SIP-I
call). By specifying a particular number here, you select the
associated version of ISUP specified by the GSX ISUP
SIGNALING GROUP VERSION ID.
Must be 1-128; default is 1.
transtype N/A Specifies the first, second, third, and fourth preference for
Transport Type (Egress IP Attribute):
• none (default) - Transport selection falls through to other
sources.
• tcp - Use SIP over TCP
• udp - Use SIP over UDP
• tls-tcp - Use SIP over TLS/TCP
flgshandlrequ N/A Disposition Handling Required (Egress IP Attribute) - Specifies
how the receiving SIP peer should handle MIME content
(either a content type or a content type version) that it does not
understand. The setting of this flag is used to create a
Content-Disposition header that is included in the INVITE
message.
• true - if MIME content is not understood, the receiver
should reject the call.
• false (default) - if the receiver does not understand the
MIME contents, those contents can be ignored.
flgsglobalize N/A Globalize Numbers (Egress IP Attribute) - Specifies whether
calling, called, redirecting, redirection original, and dialed
numbers will be converted into SIP global number format:
• true - numbers are converted into SIP global number
format.
• false (default) - the number format is not modified.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the GSX in Local Policy Mode CLI Commands for GSX Local Policy
Field
Parameter Length Description
flgsmapto183 N/A Map 181 or 182 Message To 183 (Egress IP Attribute) -
Specifies how the GSX processes SIP responses:
• true - the GSX maps 181 or 182 response messages to
183.
• false (default) - the GSX handles 1xx response messages
normally.
bciinterwkenc N/A BCI Interwork Encountered (Egress IP Attribute). This is
applicable to SIP Servers:
• true - the GSX sets the Interworking Indicator bit in the
BCI parameter of backward SS7 messages (e.g., ACM or
ANM).
• false (default)
bciisdnaccess N/A BCI ISDN Access (Egress IP Attribute) - This parameter is
applicable to SIP Servers:
• true - the GSX sets the ISDN Access Indicator bit in the
BCI parameter of backward SS7 messages (e.g., ACM or
ANM).
• false (default)
npattrnpdi N/A NPDI Options (Egress IP Attribute) - Specifies whether the
GSX sends the SIP NPDI parameter in the egress INVITE
message when LNP translation has been performed either by
PSX call processing or by the preceding switch.
• includenpi - the GSX and PSX SIP proxy/redirector
sends the NPDI parameter in the userinfo portion of the
Request URI.
• includenpdiyes - the GSX sends npdi=yes.
• donotincludenpdi - the GSX do not send the NPDI
parameter.
npattrflgsdisrn N/A Disable RN (Egress IP Attribute) - Specifies whether the GSX
sends the SIP RN parameter in the egress INVITE message
when an LNP translated number is present:
• true - the GSX does not send the rn parameter.
• false (default) - the GSX sends rn=NNNN in the userinfo
portion of the Request URI, where NNNN is the LNP
translated number.
privacytrans N/A Transparency (Egress IP Attribute):
• true - the ingress Privacy information is passed through
unchanged
• false (default)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Commands for GSX Local Policy Using the GSX in Local Policy Mode
Field
Parameter Length Description
privacyinfo N/A Privacy Information (Egress IP Attribute) - Specifies which of
the following headers the GSX will use when sending privacy
information in the outgoing SIP INVITE messages:
• ppreferredid (default) - Used by a User Agent (UA) to
carry the identity the caller wishes to be used, and sent to a
trusted proxy to be inserted in the P-Asserted-Identity field.
• passertedid - Used among trusted SIP entities (typically
intermediaries) to carry the identity of the caller as it was
verified by authentication.
• remotepartyid - Used among trusted SIP entities
(typically intermediaries) to carry the identity of the caller as
it was verified by authentication. This header is specified in
an earlier RFC that continues to be supported.
prvcyflgsinclprvcy N/A Include Privacy (Egress IP Attribute) - Specifies whether the
GSX includes privacy information in outgoing SIP INVITE
messages.
• true (default) - the GSX will include either a P-Preferred-
Identity header or a P-Asserted-Identity header (provisioned
in Privacy Information above) in outgoing SIP INVITE
messages. The GSX will also insert an Anonymous
identifier in the SIP From field and the GSX will include a
Privacy header that contains a Critical token.
• false - the GSX will not include a P-Preferred-Identity
header or a P-Asserted-Identity header, an Anonymous
identifier in the SIP From field, or a Privacy header that
contains a Critical token in outgoing SIP INVITE messages.
prvcyflgsrequ N/A Privacy Required by Proxy (Egress IP Attribute):
• true - indicates that privacy service is mandated for any
calls to the SIP trunk (proxy). In this case the GSX will
include a Proxy-Require header with a privacy value, and a
critical token in the Privacy header of the INVITE message.
The privacy service must be applied by the proxy or the call
will be rejected
• false (default) - the GSX will not include a Proxy-Require
header with privacy value. The proxy will accept the call
even if it cannot provide privacy service.
sipcausmapintsip N/A Internal To SIP Cause Mapping (Egress IP Attributes) - The
specified index number will be used by the GSX to locate the
corresponding CPC-to-SIP cause mapping profile on the GSX.
The profile maps internal CPC (Call Processing Component)
cause codes to SIP status codes.
Must be 1-16; default is 1.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the GSX in Local Policy Mode CLI Commands for GSX Local Policy
Field
Parameter Length Description
sipcausmapsipint N/A SIP To Internal Cause Mapping (Egress IP Attribute) - The
specified index number will be used by the GSX to locate the
corresponding SIP-to-CPC cause mapping profile on the GSX.
The profile maps SIP status codes to internal CPC (Call
Processing Component) cause codes.
Must be 1-16; default is 1.
sipheadermapping N/A SIP to Header Mapping (Egress IP Attributes) - Specifies
which number is mapped and returned in the outgoing SIP To
header:
• callednumber (default)
• orginalcallednumber
• gapcallednumber - Generic Address Parameter dialed
number
inclcpcinfo N/A Include CPC Information (Egress IP Attribute) - The CPC
parameter characterizes the station used to originate a call,
such as ordinary, priority, data, test, operator, payphone,
prison, hotel, or unknown.
• true - the GSX includes the Calling Party Category (CPC)
parameter value in the From header of outgoing SIP INVITE
messages.
• false (default)
inlcudenpi N/A Include NPI (Egress IP Attribute):
• true - the GSX will include the Numbering Plan Indicator in
a npi= parameter in outgoing INVITE messages
• false (default)
inlcudeolip N/A Include OLIP (Egress IP Attribute):
• true - the GSX will include the Originating Line Information
Parameter in a oli= parameter in outgoing INVITE
messages.
• false (default) -
181supported N/A 181 Supported (Ingress IP Attribute Flag):
• true - the GSX supports SIP 181 Call Is Being Forwarded
messages in the backward direction.
• false (default)
182supported N/A 182 Supported (Ingress IP Attribute Flag):
• true - the GSX supports SIP 182 Queued messages in the
backward direction
• false (default)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Commands for GSX Local Policy Using the GSX in Local Policy Mode
Field
Parameter Length Description
nosdpin180supp N/A No SDP In 180 Supported (Ingress IP Attribute Flag) - By
default, the GSX includes SDP in outbound 180 messages.
• true - the GSX does not include SDP in outbound 180
messages. It converts the 180 message to a 183 message
instead.
• false (default) - the GSX includes SDP in outbound 180
messages.
sendsdpin200ok N/A Send SDP in 200 OK If 1 8x Reliable (Ingress IP Attribute
Flag):
• true - the GSX sends SDP in final 200 OK response
messages when provisional 18x responses are reliable.
• false (default) - the GSX does not send SDP in final 200
OK response messages. The default behavior in previous
releases was to send SDP in final 200 OK response
messages, and during an upgrade to this release, this flag
is automatically selected for current IP signaling
configurations.
Command Examples
----------------------------------------------------------------------
Local Policy IP Signaling Profile : ipsigprof1
----------------------------------------------------------------------
Common IP Attributes
Discard Received Reason Header : FALSE
Include Reason Header : FALSE
NO Silence Suppression : FALSE
Create P-Charging-Vector : FALSE
Call Hold Interworking : FALSE
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the GSX in Local Policy Mode CLI Commands for GSX Local Policy
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Commands for GSX Local Policy Using the GSX in Local Policy Mode
Signaling Profile
The SIGNALING PROFILE object creates and configures a signaling profile containing the various
PSTN signaling behavioral controls for a trunk group. The Signaling profile on the GSX Local
Policy server implements the selected number of controls from the PSX Signaling Profile. See the
PSX Provisioning Guide for additional information on Signaling Profiles.
Command Syntax
Command Parameters
Field
Parameter Length Description
sigprofile 1-23 Specifies the name of this signaling profile. Must be 1-23
characters.
ingrflgnoexit N/A Don’t Generate Exit Message (Ingress Flag) - Controls the
generation of the Exit message (EXM) on the associated
ingress trunk group. EXM is an SS7/ISUP message that is
generated when a call is passed from one network to another
(e.g. an access tandem generates this message when passing
a call to an IXC).
• true
• false (default)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the GSX in Local Policy Mode CLI Commands for GSX Local Policy
Field
Parameter Length Description
ingrflgpropfe N/A Propagate FE Parameters (Ingress Flag) - controls the
propagation of the FE parameter in the backward directions for
call arriving on the associated trunk group. The FE parameter
includes the terminating switch ID, the terminating trunk group
ID, and the trunk member on which a call completed.
• true - the FE parameter is propagated in the backward
direction for calls arriving on that trunk group. The FE is
passed to provide call termination information in the billing
record generated by the switch that originated the call.
• false (default)
egrflgconvtoE164 N/A Convert Numbers to E164 Format (Egress Flag) - Specifies
whether to globalize the calling, called, redirecting, redirection
original, and dialed numbers on Egress ISUP trunks in E.164
format.
• true - numbers are converted to E.164 format.
• false (default) -
Command Examples
-----------------------------------------------------------------------
Local Policy Signaling Profile : sigprof1
----------------------------------------------------------------------
Ingress
Flags
Don't Generate Exit Message : FALSE
Propagate FE Parameter : FALSE
Egress
Flags
Convert Number to E.164 Format : FALSE
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Commands for GSX Local Policy Using the GSX in Local Policy Mode
Dial Plan
This object creates and configures a DIAL PLAN used for Number and call type analysis on the
GSX in Local Policy mode for Input Call Processing. The Dial Plan associates to the LOCAL
POLICY TRUNK GROUP PROFILE.
Command Syntax
Command Parameters
Field
Parameter Length Description
dialplan 1-23 Specifies the name of the LOCAL POLICY TRUNK GROUP
PROFILE. Must be 1-23 characters.
See "Local Policy Trunk Group Profile" on page 4–23 for more
information.
natnlaccess N/A Specifies the national access code dialed by the caller to
reach another subscriber in different service areas in the same
country. Must be 0-10 characters.
intnlaccess N/A Specifies the International access code dialed by the caller to
reach another subscriber in a different country. Must be 0-10
characters.
opnumber N/A Specifies the operator numbers for the serving area or country
(used for Operator Call route lookup). Must be 0-30
characters.
Note: If you do not configure this parameter, Operator Calls
will fail.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the GSX in Local Policy Mode CLI Commands for GSX Local Policy
Command Examples
----------------------------------------------------------------------
Local Policy Dial Plan : usa
----------------------------------------------------------------------
National Access Code : 1
International Access Code : 011
Operator Number : 00
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Commands for GSX Local Policy Using the GSX in Local Policy Mode
The LOCAL POLICY TRUNK GROUP PROFILE creates and configures data needed for the GSX to
operate in Local Policy mode.
Command Syntax
Command Parameters
Field
Parameter Length Description
lptrunkgrpprof 1-23 Specifies the name of the Local Policy Trunk Group Profile.
Must be 1-23 characters.
ipsigprof 1-23 Specifies the IP SIGNALING PROFILE assigned to this LP
Trunk Group Profile. Must be 1-23 characters.
See "IP Signaling Profile" on page 4–10 for more information.
sigprof 1-23 Specifies the SIGNALING PROFILE assigned to this LP Trunk
Group Profile. Must be 1-23 characters.
See "Signaling Profile" on page 4–19 for more information.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the GSX in Local Policy Mode CLI Commands for GSX Local Policy
Field
Parameter Length Description
packetsvcprof 1-23 Specifies the PACKET SERVICE PROFILE assigned to this
LP Trunk Group Profile. The default PACKET SERVICE
PROFILE is DEFAULT.
See "Packet Service Profile" on page 3–690 for more
information.
dialplan 1-23 Specifies the DIAL PLAN applied for incoming calls on the
trunk group.
See "Dial Plan" on page 4–21 for more information.
countrycode N/A Specifies the Country Code served by the trunk group. Must
be 1-3.
destswitch N/A Specifies the destination switch type the switch at the far-end
of a trunk group connected to a GSX. A Destination Switch
Type is provisioned for each Trunk Group. In the Sonus
architecture, a trunk group may connect to any one of the
following destination switch types in North America:
• access (default)
• eaeo - Equal Access End Office
• international -
• ixc - Inter Exchange Carrier
• noneaeo - non Equal Access End Office
• tandem
signalingflag N/A Specifies the type of call control signaling used to set up and
tear down calls on this trunk group.
• btiup
• gr317isup
• gr394isup
• itu
• japanisup
• chinaisup
• sip
• sipi
adminstate N/A Specifies the administrative state of this trunk group profile:
• enabled -
• disabled -
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Commands for GSX Local Policy Using the GSX in Local Policy Mode
Command Examples
To display a list of the configured parameters of a Local Policy Trunk Group Profile:
% SHOW LOCAL POLICY TRUNK GROUP PROFILE cisco5300_1 ADMIN
----------------------------------------------------------------------
Local Policy Trunk Group Profile : cisco5300_1
----------------------------------------------------------------------
Admin State : ENABLED
Signaling Profile : sigprof1
IP Signaling Profile : ipsigprof1
Packet Service Profile : g711
Dial Plan : usa
Country Code : 1
Signaling Flag : SIP
Destination Switch Type : ACCESS
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the GSX in Local Policy Mode CLI Commands for GSX Local Policy
IP Signaling Peer
The IP SIGNALING PEER object creates and configures an IP Signaling Peer with a Signaling
Peer IP Address or Fully-qualified domain name (FQDN) and IP port number.
In order for egress call routing of a route with an IP Signaling Peer to be successful, it must have
an entry in the IP Network Selection Table matching its IP address and zone.The Network Selector
Table entry must also define the Direction as egress and the Signaling type as SIP (see "Network
Selector Table" on page 3–558 for configuration information). Without this, the call is routed to
the default IP Trunk Group if the IP Signaling Peer's zone is INTERNAL (the default zone). If the
zone is non-default, the call is routed to the default IP Trunk Group (0.0.0.0 entry) of the zone, if
configured. Otherwise, the routing for this route will fail.
Command Syntax
Command Parameters
Field
Parameter Length Description
ipsigpeer 1-23 Specifies a unique name of this IP Signaling Peer. Must be 1-
23 characters.
zone N/A Specifies the Signaling ZONE this peer belongs to. Must be 1-
23 characters.
See "Zone" on page 3–511 for more information.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Commands for GSX Local Policy Using the GSX in Local Policy Mode
Field
Parameter Length Description
ipaddress N/A Specifies the 32-bit IP address of this IP Signaling Peer
specified in dotted decimal form (for example
128.127.50.224). Default is 0.0.0.0.
fqdn 0-127 Specifies the Fully Qualified Domain Name (FQDN) of this IP
Signaling Peer. Must be 0-127 characters.
port N/A Specifies the UDP/TCP port number of this IP Signaling Peer.
Must be 1 to 65535; default is 5060.
Command Examples
----------------------------------------------------------------------
IP Signaling Peer : cisco5300_1_sip
----------------------------------------------------------------------
IP Address : 10.160.100.218
IP Port : 5060
Full Qualified Domain Name :
Zone Name : INTERNAL
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the GSX in Local Policy Mode CLI Commands for GSX Local Policy
Routing Label
The ROUTING LABEL object creates and configures a routing label--a group of routes, where each
route includes either a IP signaling peer or a trunk group. Routing Labels provide the link between
an entry in the Policy Standard Route Table and the set of routes associated with that Standard
Route Table entry.
You can create a routing label containing up to two routes (primary and secondary) which specify:
• Route Type
• Egress Trunk Group or IP Signaling Peer (depending on route type)
This table stores the trunk group or IP signaling peer associated with this routing label and the
priority of the route in the routing label. The primary route is selected before the secondary route.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Commands for GSX Local Policy Using the GSX in Local Policy Mode
Command Parameters
Field
Parameter Length Description
routinglabel 1-23 Specifies the name of the routing label. Must be 1-23
characters.
routetype N/A Specifies the primary or secondary route signaling type:
• gsx - for PSTN trunk groups only (and not gateway-to-
gateway IP signaling).
• sip
• none
pstntrgrp 1-23 Specifies the primary or secondary PSTN trunk group name.
Must be 1-23 characters.
See "Trunk Group" on page 3–538 for more information.
ipsigpeer 1-23 Specifies the primary or secondary IP SIGNALING PEER
name. Must be 1-23 characters.
See "IP Signaling Peer" on page 4–26 for more information.
state N/A Specifies the administrative state of the primary or secondary
route. The route is skipped if it is not enabled.
• enabled
• disabled - the route is skipped.
Command Examples
To display a summary of
% SHOW ROUTING LABEL SUMMARY
Node: TPUBS Date: 2007/09/17 13:20:08 GMT
Zone: GMTMINUS05-EASTERN-US
Routing Label
-------------------------------
tg6
tg8
tg9
cisco5300_1_sip
cisco5300_2_sip
cisco5300
rahway
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the GSX in Local Policy Mode CLI Commands for GSX Local Policy
-----------------------------------------------------------------------
Routing Label : cisco5300_1_sip
-----------------------------------------------------------------------
Primary:
PSTN Trunk Group :
IP Signaling Peer : cisco5300_1_sip
Route Type : SIP
Admin State : ENABLED
Secondary:
PSTN Trunk Group :
IP Signaling Peer :
Route Type : NONE
Admin State : DISABLED
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CLI Commands for GSX Local Policy Using the GSX in Local Policy Mode
Standard Route
The STANDARD ROUTE object provides a mechanism to add a Policy Route in the policy Standard
Route Table. A route entry contains the match criteria (either Destination Number Prefix and/or
Ingress Trunk Group) and the associated Routing label. When using the Destination Number
Prefix match criteria, the GSX uses the longest prefix match method, in which the longest, most
specific entry in the list will be selected.
When a Trunk Goup is specified, the GSX uses the called number and the ingress trunk group of a
call to perform a look-up. The look-up first matches on all standard route entries with a trunk
group specified. If there is a match, the look-up is complete. Otherwise, it repeats with all Standard
Route entries with no trunk group specified.
You can change only the ROUTING LABEL parameter after a Standard Route entry is created. To
change the other Standard Route parameters, you must first delete the Standard Route (DELETE
STANDARD ROUTE INDEX <routeindex>) and create another one with the new attributes. Use
the SHOW STANDARD ROUTE SUMMARY to determine the Route Index.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the GSX in Local Policy Mode CLI Commands for GSX Local Policy
Command Parameters
Field
Parameter Length Description
destprefix 0-16 Specifies the destination number prefix to be matched with the
called party number in the route query. Must be 0-16
characters. This is optional, however either a DESTINATION
NUMBER PREFIX or a TRUNK GROUP must be specified.
routinglabel 1-23 Specifies the ROUTING LABEL name used to retrieve the
Egress routes (Trunk group or IP Signaling Peer). Must be 1-
23 characters.
See "Routing Label" on page 4–28 for more information.
trunkgrp 0-23 Specifies the Source Trunk group name to be matched with
the source trunk group of a call. Must be 1-23 characters. This
is optional, however either a DESTINATION NUMBER PREFIX
or a TRUNK GROUP must be specified.
See "Trunk Group" on page 3–538 for more information.
routeindex N/A Specifies a unique route identifier for each Standard Route
entry, as listed in the SHOW STANDARD ROUTE SUMMARY
command.
Command Examples
Destination
Index Source Trunk Group Number Prefix Routing Label
----- ----------------------- ---------------- -----------------------
1 140686 cisco5300_1_sip
2 124637 cisco5300_2_sip
3 141223 tg6
4 141255 tg8
5 tg6 140686 cisco5300_1_sip
6 1599 rahway
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Configuring the GSX for Local Policy Using the GSX in Local Policy Mode
Follow these general configuration steps when setting up a GSX for Local Policy functionality.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the GSX in Local Policy Mode Configuring the GSX for Local Policy
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
CHAPTER 5 Using the GSX as a Border
Gateway Function (BGF)
Overview
This chapter provides information for using the GSX as a TISPAN Border Gateway Function
(BGF), controlled by the H.248 protocol. The Telecoms & Internet converged Services &
Protocols for Advanced Networks (TISPAN) is a standardization body of the European
Telecommunications Standards Institute (ETSI), that has defined an architecture for creating the
Next Generation Network (NGN). This architecture has been implemented in the GSX software,
as the GSX H.248 TISPAN BGF. The BGF functions in the bearer plane, acting as a packet-to-
packet gateway between two IP-transport domains. A pair of Core BGFs (hereafter C-BGFs for
BGF physically located in the Core network) is depicted in Figure 5–1, "Sonus C-BGFs". The
Resource and Admission Control Subsystem (RACS) shown in this illustration takes on the role of
the traditional H.248 Call Agent or Media Gateway Controller (MGC).
RACS
(Call Agent, MGC)
Logical Mgmt
Inteface
IP Addresses
GENET-1-3-1 192.168.0.1
GENET-1-3-2 10.0.0.1
Logical Mgmt Interface 192.168.10.1
C-BGF A SPDF (Call Agent) 192.168.20.1
In the sections that follow, the individual H.248 provisioning objects that provide the BGF
infrastructure are introduced. The BGF Solutions Guide provides additional internal detail on the
BGF as well as a provisioning example that draws on all of the infrastructure presented in this
chapter.
Topics include:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
H.248 Media Gateway Model Using the GSX as a Border Gateway Function (BGF)
To configure the GSX9000 Media Gateway for an H.248 TISPAN BGF environment, you must
configure the H.248 Gateway, the H.248 Session, one or more H.248 Call Agents, one or more
H.248 Connections per Call Agent, and a Media Gateway Interface. These objects are shown in
Figure 5–2. This figure shows the conceptual relationships between the software objects on the
GSX that allow it to perform as an H.248 TISPAN BGF.
GATEWAY
SESSION
SERVICE
PROFILE
CONNECTION
CONNECTION CONNECTION SERVICE
CONNECTION PROFILE
CONNECTION CONNECTION
CONNECTION
The H.248 Gateway object is created automatically by the GSX9000 software, and contains global
configuration data for the entire GSX Media Gateway (MG). Each of the configurable parameters
has a default value that accommodates most applications, for example, the listening port number of
2944 for H.248. You can either accept each default value, or reconfigure it.
The rest of the configuration objects form an object hierarchy. At the highest level is the H.248
Session, which serves as the BGF interface to the Service Layer applications.
A Session has one or more Call Agents bound to it. The Session acts as access control for the
GSX.
Each Call Agent has a name plus one or more connections bound to it. Each connection is an
address (IP address and port number) of a Call Agent that can send messages to the GSX MG and
that is used by the GSX to send messages to the applications. The GSX verifies the connection
address in every incoming H.248 message (command or response) against the list of valid
connection addresses. The GSX silently ignores requests from unknown connection addresses.
This is a security feature.
Call agent names are used to convert Notified Entity parameters in H.248 commands into IP
addresses.
The session uses a service profile to provide defaults for the attributes for H.248 connections made
in this session.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the GSX as a Border Gateway Function (BGF) H.248 Media Gateway Model
If you are using H.248, you have the option of partitioning the GSX into non-physical objects.
This is done with the H248 DEVICE NAME parameter in the CONFIGURE MEDIA GATEWAY
SERVICE command. Each media gateway partition will share the GSX root termination and will
be configured to exchange messages with its Media Gateway Controller (MGC). You will be able
to assign CONNECTION IPADDRESSes to a particular partition, and the device name will be used
as the Message Identifier (MID) when sending commands from this partition to an MGC. Other
GSX resources, such as IP ports, will be available to all the partitions. If the H248 DEVICE
NAME parameter is not configured, then the GSX node name will be used as the MID.
You also have the option of assigning to a particular Call Agent, and therefore to the Call Agent’s
H.248 MGC, the H248 CONNECTION IPADDRESSes that are bound to a Media Gateway
Service group. This is done with the H248 CALL AGENT parameter in the CONFIGURE MEDIA
GATEWAY SERVICE command. Calls that use this Media Gateway Service group will be sent to
the call agent’s H.248 MGC. If the H248 CALL AGENT parameter is not configured, then the
default Call Agent will be used.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
H.248 Media Gateway Model Using the GSX as a Border Gateway Function (BGF)
H.248 Gateway
The H248 GATEWAY object contains global configuration data for the entire GSX Media
Gateway. Each of the configurable parameters has a default value that accommodates most
applications. You are not required to create or configure this object.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the GSX as a Border Gateway Function (BGF) H.248 Media Gateway Model
Command Parameters
Field
Parameter Length Description
Port N/A H.248 listen port number. Range is 1 - 65535.
Default is 2944.
rcvCmdThrottle N/A Receive flow control threshold. Sets maximum limit
on number of concurrent outstanding H.248
commands that have not been responded to. The
value 0 disables flow control. Range is 0 - 65535.
Default is 0.
rcvCmdThrottle_add N/A Receive flow control threshold for ADD commands
per slot. This sets a maximum limit on number of
concurrent outstanding H.248 commands that have
not been responded to. The value 0 disables flow
control. Range is 0 - 65535. Default is 40.
rcvCmdThrottle_all N/A Receive flow control threshold for all commands per
slot. This sets a maximum limit on number of
concurrent outstanding H.248 commands that have
not been responded to. The value 0 disables flow
control. Range is 0 - 65535. Default is 80.
rcvCmdThrottle_crcx N/A Receive flow control threshold for CRCX commands
per slot. This sets a maximum limit on number of
concurrent outstanding H.248 commands that have
not been responded to. The value 0 disables flow
control. Range is 0 - 65535. Default is 40.
reXmitCnt N/A Multiply this value by cmdTimeout to determine the
maximum retry delay in milliseconds of one H248
command. The product of this multiplication
represents T-MAX as described in RFC-2705,
section D.1.5. No more retries will be sent beyond
this time after the transmission of the initial
command. Range is 1 – 5000. Default is 5.
cmdTimeout N/A The initial value for H.248 command re-transmission
timeout in milliseconds. Range is 1 - 10000. Default
is 250. After the initial re-transmission timeout,
subsequent re-transmission timeouts are calculated
with the method described in RFC-2705, section
3.6.3.
rspTimeout N/A Response cache purge timeout interval in
milliseconds. Range is 1 - 65535. Default is 1000.
crtTimeout N/A Specifies the value of the H.248 digit map "T-critical"
timer, in milliseconds. Range is 50 - 60000. Default
is16000.
prtTimeout N/A Specifies the value of the H.248 digit map "T-partial"
timer, in milliseconds. Range is 50 - 60000. Default is
4000.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
H.248 Media Gateway Model Using the GSX as a Border Gateway Function (BGF)
Field
Parameter Length Description
discdlylmt N/A Specifies the initial delay between repeated Restart
In Progress with method “disconnected” messages
(RSIP[DISC]) to a Call Agent in milliseconds. Range
is 50 to 60000, default is 5000 (milliseconds).
pwrdlylmt N/A Specifies the initial delay between repeated RSIP
messages generated by initial power on, to a Call
Agent in milliseconds. Range is 50 to 60000, default
is 5000 (milliseconds).
discdlybnd N/A Specifies the maximum delay on subsequent
repeated (RSIP[DISC]) messages to a Call Agent in
milliseconds. Range is 50 to 300000, default is 5000
(milliseconds).
lipaddress N/A Specifies the logical 32-bit IP address to be used as
the local address of this GSX in its role as the Media
Gateway (MG) as configured with the command
CONFIGURE LOGICAL MGMTIF SHELF 1
IPADDRESS, see "Management Packet Interface
(Management NIF)" on page 3–172 in this
environment. Specified in dotted decimal form (for
example 128.127.50.224). Default is 0.0.0.0, which
disables this feature and the source address reverts
to the value from the node NVS. When specifying a
logical IP address, lipaddress is an alternative
source IP address of the MG that enables the MG to
be reached via both pairs of MNA Network Interfaces
with a single IP source address.
encoding N/A The encoding of H.248 messages:
• binary - Not currently supported
• text - Full text encoding
• shorttext - Short text encoding
prttimer N/A Indicates the time in milliseconds within which the
MGC should expect a Pending Response from the
MG that requires additional time to process a
Transaction. Must be 1-9999, default is 1000
(milliseconds).
piggybacking N/A Specifies whether or not to permit piggy backing of
H.248 messages sent to Call Agents:
• true (default) - permit piggy back messages
• false - do not permit piggy back messages.
caatthresh N/A The maximum consecutive re-transmissions to one
Call Agent IP address allowed by the system. The
range is 1 to 5000, default is 5.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the GSX as a Border Gateway Function (BGF) H.248 Media Gateway Model
H.248 Session
The H.248 Session object represents H.248 control of the GSX MG resources. The Call Agent
objects reference the Session. The Session also has the Service Profile object which is used to
provide connection defaults for the session.
The Media Gateway Service object references a Session object. For more information, see "Media
Gateway Service" on page 5–15.
You may not delete a Session that is being referenced by Call Agents. You must first delete the
Call Agents.
Command Syntax
Command Parameters
Field
Parameter Length Description
sessionName 1 - 23 An alphanumeric name that you assign to the H.248 session.
servProfileName 1 - 23 Name of the H.248 service profile to be applied to
connections in this session. Default name is “default”.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
H.248 Media Gateway Model Using the GSX as a Border Gateway Function (BGF)
Field
Parameter Length Description
protocolID N/A The protocol for this session:
• mgcpstd - standard control
• mgcpcmnctl (default) - common control
• tgcp - TGCP protocol
• h248v1vmg - H.248 protocol version 1, virtual MG mode
• h248v2vmg - H.248 protocol version 2, virutal MG mode
• h248v1std - H.248 protocol version 1, standard mode
• h248v1std - H.248 protocol version 2, standard mode
• h248v3bgf - H.248 protocol version 3, BGF mode
operState N/A The operational state of the session:·
• inService - Ready for use.
• outOfService - Not in use. You must set this state to
change adminState to disabled.
adminState N/A The administrative state of the session:·
• enabled - the session must be in this state to activate its
current configuration.
• disabled (default) - in this state the session is inactive.
In this state the Session may be re-configured, or it may
be deleted.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the GSX as a Border Gateway Function (BGF) H.248 Media Gateway Model
The H248 CALL AGENT object represents one remote Media Gateway Controller (MGC) that is
allowed to use the resources of the parent Session.
You may not delete a Call Agent that is being referenced by Connections. You must first delete the
Connections.
Command Syntax
Command Parameters
Field
Parameter Length Description
callAgentName 1 - 23 An alphanumeric name that you assign to the Call Agent. The
name space of all callAgentNames defines the allowable set of
strings the transaction ID in H.248 messages.
sessionName 1 - 23 The alphanumeric name of the parent session.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
H.248 Media Gateway Model Using the GSX as a Border Gateway Function (BGF)
Field
Parameter Length Description
isDNE N/A Indicates this Call Agent is the session H.248 default
transaction ID. When a Call Agent is made the default
transaction ID, any previous default is demoted. If there is no
enabled Call Agent who is the default transaction ID, the first
available Call Agent is used.
• true
• false (default)
adminState N/A The administrative state of the Call Agent:
• disabled (default) - in this state the Call Agent is inactive.
In this state the Call Agent may be re-configured, or it may
be deleted.
• enabled - the Call Agent must be in this state to activate its
current configuration.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the GSX as a Border Gateway Function (BGF) H.248 Media Gateway Model
H248 Connection
The H248 Connection represents one softswitch address and port, by which the parent Call Agent
can be reached and from which H.248 messages may be sent to the Session.
Command Syntax
Command Parameters
Field
Parameter Length Description
ipAddress N/A A 32-bit IP address of this softswitch specified in Dotted
decimal form (for example 128.127.50.224).
port N/A Port number for this connection address. Range is 1 - 65535.
Default when creating for H.248 is 2944.
callAgentName 1 - 23 The alphanumeric name of the parent Call Agent.
adminState N/A The administrative state of the connection:
• disabled (default) - in this state the connection may be
deleted.
• enabled - the connection must be in this state to activate its
current configuration.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
H.248 Media Gateway Model Using the GSX as a Border Gateway Function (BGF)
The H248 Service Profile provides defaults for connections when the Call Agent in a connection
request does not specify the parameters.
You may not delete a Service Profile which is being referenced by a session. You must first
remove the reference from the session.
A default version of the H.248 Service Profile, named default, is created by the GSX the first
time you boot the GSX. The user can modify this default Service Profile but cannot delete it. If
you use Parameter Loading, your modified default profile will load as the default Service Profile
the next time the GSX is booted. All profiles are stored on the GSX. The Binary Parameter File
acts as the archive of the current configuration of the GSX.
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the GSX as a Border Gateway Function (BGF) H.248 Media Gateway Model
Command Parameters
Field
Parameter Length Description
servProfileName 1-23 An alphanumeric name that you assign to the Service
Profile.
packetPeriod N/A RTP packet size in milliseconds. Size must be in 5
millisecond increments. Range is 10 - 40. Default is 10
(milliseconds).
typeOfService N/A Network type of service byte. Range is 0 - 255. Default is 0.
echoCancel N/A Echo cancellation treatment:
• off
• on
• USECKT (default) - use the value of ECHO CANCEL from
the CIRCUIT SERVICE PROFILE that is bound to the
media gateway circuit.
cotctrlmode N/A The type of originating or terminating Continuity Check
Message (COT) (for more details refer to "Manual Continuity
Check (COT)" on page 6–84.)
• ca - The Call Agent controls the type of COT according to
the conventions described below.
• mg (default) - The type of COT is controlled by the value
of CONTINUITYTEST TYPE configured in the CIRCUIT
SERVICE PROFILE that is bound to the Media Gateway
circuit, according to the conventions described below.
silenceSuppress N/A Silence Suppression treatment (if supported by the codec):
• off (default)
• on
admnState N/A The administrative state of the service profile:
• disabled (default) - in this state the service profile may
be re-configured, or it may be deleted.
• enabled - the service profile must be in this state to
activate its current configuration.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
H.248 Media Gateway Model Using the GSX as a Border Gateway Function (BGF)
This object creates and configures a Media Gateway Service group for defining the protocol to be
used to communicate with a remote Media Gateway Controller (MGC). This object is used to bind
a group of GSX IP Connections that are associated with a Media Gateway Interface, to an MGC
that will manage all connections and signaling on the group using a suitable Media Gateway
control protocol. This protocol is H.248 for the BGF.
If you are using H.248, you have the option of partitioning the GSX into non-physical objects.
This is done with the H248 DEVICE NAME parameter in the CONFIGURE MEDIA GATEWAY
SERVICE command. Each media gateway partition will share the GSX root termination and will
be configured to exchange messages with its MGC. The Media Gateway Connections that are
bound to the Media Gateway Service group will therefore be assigned to a particular partition, and
the device name will be used as the Message Identifier (MID) when sending commands from this
Service group to an MGC. These objects are shown in Figure 5–3. If the H248 DEVICE NAME
parameter is not configured, then the node name will be used as the MID.
If you are using H.248, you also have the option of assigning to a particular Call Agent, and
therefore to the Call Agent’s H.248 MGC, the IP Connections that are bound to a Media Gateway
Service group. This is done with the H248 CALL AGENT parameter in the CONFIGURE MEDIA
GATEWAY SERVICE command. Calls that use this Media Gateway Service group will be sent to
the call agent’s H.248 MGC. If the H248 CALL AGENT parameter is not configured, then the
default Call Agent will be used. More than one Media Gateway Service group can be assigned to
the same Call Agent. Figure 5–3 shows one Media Gateway Service group assigned to one Call
Agent, and two other Media Gateway Service groups assigned to a second Call Agent.
SESSION
You may temporarily remove and restore this service by toggling its operational state between
blocked and unblocked. When you remove service in this manner you could disrupt existing calls,
so you will be prompted to affirm your command. The mechanisms used to carry out these
configuration changes are summarized below.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the GSX as a Border Gateway Function (BGF) H.248 Media Gateway Model
• enabled
• disabled
• blocked - the service is denied to all new requestors and removed from any existing users
according to the settings of the action parameter.
• unblocked - the service is active and available to all requestors.
TABLE 5–6
From
(operational
state) Changing to (operational state)
unblocked blocked
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
H.248 Media Gateway Model Using the GSX as a Border Gateway Function (BGF)
Command Syntax
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the GSX as a Border Gateway Function (BGF) H.248 Media Gateway Model
Command Parameters
Field
Parameter Length Description
mgsname 1-23 An alphanumeric name that you assign to the service group that
will be used to communicate with the MGC using the designated
protocol. A maximum of 4 service groups may be created.
mgcname 1-23 The name of an MGC that will provide the (above) service. This
may be an H248 SESSION.
type N/A The media gateway protocol that the Media Gateway Controller
will use to manage the service:
• MGCP
• H248
devName 1-23 The name of the media gateway partition to which this Media
Gateway Service Group belongs. This name will be used as the
Message Identifier (MID) when sending commands from this
Service Group to an H.248 MGC. If this field is not configured,
then the node name will be used as the MID.
caName 1-23 The name of the call agent to which this Media Gateway Service
Group belongs. Calls that use this Media Gateway Service will be
sent to the call agent’s H.248 MGC. If this field is not configured,
then the default Call Agent will be used.
oper-state N/A The operational state of the service:
• blocked (default) - the service is denied to all new requestors
and removed from any existing users according to the settings
of the action parameter.
• unblocked - the service is active and available to all
requestors.
action N/A The method by which active calls that use this service are
processed when oper-state goes to blocked:
• dryup (default) - all calls are allowed to complete until
timeout expires, when they are dropped.
• force - all calls are dropped immediately.
timeout N/A The time (in minutes) to wait to place the service group in the
blocked oper-state. Must be 1-1440, default is 60.
admin-state N/A The administrative state of the service:
• disabled (default) - not active.
• enabled - active.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
H.248 Media Gateway Model Using the GSX as a Border Gateway Function (BGF)
Command Example
To display the operational status of all Media Gateway Service group services:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the GSX as a Border Gateway Function (BGF) H.248 Media Gateway Model
This object defines the GSX hardware, and the NIFGROUP/VLAN_ID pair (or pairs) that will
support a physical IP termination (IpPterm), on behalf of the Media Gateway Border Gateway
Function. This definition allows the Media Gateway Controller (MGC) to select a particular GSX
NIF that the BGF should use to allocate resources for an IP termination.
The GSX hardware is the PNS40 server module on which the underlying NIF or NIFs already
reside. Usage of the GSX VLAN_ID features is optional, as explained in the parameter
descriptions below.
You may temporarily remove and restore service on the interface by toggling the operational state
between blocked and unblocked. When you remove service in this manner you could disrupt
existing calls, so you will be prompted to affirm your command. The mechanisms used to carry out
these configuration changes are summarized below.
• blocked - the interface is denied to all new requestors and removed from any existing users
according to the settings of the action parameter.
• unblocked - the interface is active and available to all requestors.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
H.248 Media Gateway Model Using the GSX as a Border Gateway Function (BGF)
TABLE 5–8
From
(operational
state) Changing to (operational state)
unblocked blocked
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the GSX as a Border Gateway Function (BGF) H.248 Media Gateway Model
Command Syntax
Command Parameters
Field
Parameter Length Description
interface 1-23 This name defines the BGF interface. This interface serves as a
base for selecting particular GSX NIFs for IP terminations on
behalf of packet-to-packet calls under MGC/BGF control.
vlan_tag N/A A unique VLAN ID that you may optionally assign to the
NIFGROUP that you specify for this BGF interface. This number
must be in the range 1-256. If the VLAN tag property in the Add
command sent by MGC does not match with the VLAN tags
provisioned for the interface, then the BGF will reject the Add
command. If the SET VLAN command is omitted, then a NULL
VLAN tag is implicitly specified. If the VLAN Tag property is
omitted from the Add command then NULL VLAN tag is assumed
and must be provisioned, or the Add command will be rejected by
the BGF.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
H.248 Media Gateway Model Using the GSX as a Border Gateway Function (BGF)
Field
Parameter Length Description
mgsname 1-23 The name of the MEDIA GATEWAY SERVICE Group to bind to
this BGF interface.
nifgroup 1-23 This object is a named group of physical network interfaces
(NIFs) that support the Network Border Switch (NBS) and Border
Gateway Function features of the GSX.
slot N/A The PNS40 module that hosts the NIFGROUP NIFs that belong
to this interface.
An H.248 Service Change message (SCHG) will be sent from this
module.
oper-state N/A The operational state of the BGF interface service:
• blocked (default) - the service is denied to all new requestors
and removed from any existing users according to the settings
of the action parameter.
• unblocked - the service is active and available to all
requestors.
action N/A The method by which active calls that use this BGF interface are
processed when oper-state goes to blocked:
• dryup (default) - all calls are allowed to complete until
timeout expires, when they are dropped.
• force - all calls are dropped immediately.
timeout N/A The time (in minutes) to wait to place the BGF interface service
into the blocked oper-state. Must be 1-1440, default is 60.
admin-state N/A The administrative state of the BGF interface service:
• disabled (default) - not active.
• enabled - active.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the GSX as a Border Gateway Function (BGF) H.248 Media Gateway Model
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
CHAPTER 6 Managing the GSX
Overview
This chapter discusses the means available to manage day-to-day GSX operations. Topics include:
Administration
This chapter discusses the means available to manage day-to-day GSX operations through the
CLI.
NOTE
The parameters discussed below are initially set by the CREATE/CONFIGURE ST
SOURCE SHELF command.
On the GSX9000, you must provide a timing signal to the Management Timing Adapter (MTA)
for distribution to all CNS modules via the Sonus mid-plane. The MTA10a provides T1 Building
Integrated Timings Source (BITS) inputs, the MTA20a and MTA21a provide E1 Synchronous
Equipment Timing Source (SETS) inputs, and the MTA30 provides North American and Japanese
Composite Clock inputs.
For circuit timing on the GSX4010, the chassis has redundant ports for Building Integrated
Timings Source (BITS) or Synchronous Equipment Timing Source (SETS) clocking. In addition,
timing may be pulled from any PSTN interface, or the internal Stratum 3 clock.
NOTE
A configuration of mixed MTA types, such as one MTA10a and one MTA20a is
valid, but not recommended by Sonus.
The CLI interface symmetrically supports a pair of matched MTA types, as explained below. This
signal may originate from one of six sources:
• External Clock A:
MTA10a - BITS 1 input. Chapter 5 of the GSX9000 Open Services Switch Installation and
Upgrade Guide discusses how to connect your external timing source to the BITS port on the
MTA10a. To connect, attach your primary BITS source to the BITS 1 port on this adapter.
MTA20a/MTA21a - SETS (SDH Equipment Timing Source) 1 input. Chapter 5 of the
GSX9000 Open Services Switch Installation and Upgrade Guide discusses how to connect your
external timing source to the SETS port on the MTA20a/MTA21a. To connect, attach your
primary SETS source to the SETS 1 port on this adapter.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Administration Managing the GSX
MTA30 - DCS 1 input. Chapter 5 of the GSX9000 Open Services Switch Installation and
Upgrade Guide discusses how to connect your external timing source to the DCS port on the
MTA30. To connect, attach your primary DCS source to the DCS 1 port on this adapter.
• External Clock B:
MTA10a - BITS 2 input. To connect, attach your secondary BITS source to the BITS 2 port on
this adapter. This provides a redundant BITS timing source.
MTA20a/MTA21a - SETS 2 input. To connect, attach your secondary SETS source to the
SETS 2 port on this adapter. This provides a redundant SETS timing source.
MTA30 - DCS 2 input. To connect, attach your secondary DCS source to the DCS 2 port on
this adapter.
• REFCLK-A - derived timing signal #1, taken from a T1 or E1 span on one of the CNS
modules or one of the SONET channels in the shelf.
• REFCLK-B - derived timing signal #2, taken from a T1 or E1 span on one of the CNS
modules or one of the SONET channels in the shelf; where the source should, but need not,
differ from the REFCLK-A source.
• HOLDOVER - a (replay) mode internal to the MTA which is derived from current active
source.
• OSCILLATOR - the MTA on-board stratum 3 oscillator.
Each MTA accommodates these six inputs, resulting in a combined total of twelve possible timing
sources in a shelf containing dual MTAs.
You may configure these twelve sources such that each is a successive backup that is invoked if
the previous source fails. The list should be prioritized such that the preferred sources are utilized
first. Any source may be removed and subsequently added. Previously failed sources may be
recovered and reused, instead of a less preferred successor. This section presents the policies,
rules, and procedures for managing these timing sources.
The twelve member prioritized list of timing sources is the Timing Source Sequence Table. The
default priority is:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Administration
You may add, remove, and re-prioritize members of this list. However no changes ever take effect
until you specifically commit them with the command:
CONFIGURE ST SHELF 1 RESEQUENCE
NOTE
All configuration changes are saved but not enacted until the commit command is
issued. Once committed, the current timing source continues active until it faults
or until a higher priority previously used source is recovered and made available
for reuse. With revertive behavior enabled, this action occurs automatically when
the source is recovered. When revertive behavior is disabled, a previously used
source must be manually returned to service
removes the External Clock A source into MTA2 from the list. The command,
% CREATE ST SOURCE SHELF 1 MTA 2 SOURCE extClkA
% CONFIGURE ST SOURCE SHELF 1 MTA 2 SOURCE extClkA SEQNUM 7
% CONFIGURE ST SOURCE SHELF 1 MTA 2 SOURCE extClkA STATE enabled
% CONFIG ST SHELF 1 RESEQUENCE
adds the External Clock A source into MTA2 back to the list as the seventh most preferred source.
This source must have been previously deleted for the above command to be accepted.
Sonus strongly recommends that you observe the following conventions when you configure this
table:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Administration Managing the GSX
The REFCLK sources are provided so that the user may connect a derived timing signal to the
MTA as a clock source. To provision the REFCLKs, the user must bind a T1 or E1 span to a
REFCLK. Because there are two REFCLKs, there can be at most two bindings in effect at once.
A REFCLK signal is directed to both MTAs so that REFCLK-A on MTA 1 is the identical timing
source as REFCLK-A on MTA 2.
You can select any valid T1 or E1 on any valid slot as the source of either or both bindings. Thus
the same E1 span could be simultaneously bound to REFCLK-A and REFCLK-B, or another E1
span on the same CNS module could be bound to the second REFCLK. Sonus strongly
recommends that you avoid this strategy and instead select different spans on different slots to
provide additional protection in case one CNS module fails.
You may remove a REFCLK binding. In the command sequence that follows, the REFCLK-A
binding to E1 span 1, serviced by the CNS20 module in slot 5, is removed. This timing source is
also removed from the Timing Source Sequence Table on each MTA. Finally, these changes are
committed by the RESEQUENCE command.
% DELETE ST REFCLK BINDING SHELF 1 SLOT 5 SPAN 1 CLOCK refClkA
% DELETE ST SOURCE SHELF 1 MTA 1 SOURCE refClkA
% DELETE ST SOURCE SHELF 1 MTA 2 SOURCE refClkA
% CONFIGURE ST SHELF 1 RESEQUENCE
You may create a new REFCLK binding. The command sequence below creates a REFCLK
binding, creates the MTA 1 REFCLK-A source in the Timing Source Sequence Table at a priority
level of 3, and commits these changes. This derived timing source is then made available for
consideration as an active source.
% CREATE ST REFCLK BINDING SHELF 1 SLOT 5 SPAN 1 CLOCK refClkA
% CREATE ST SOURCE SHELF 1 MTA 1 SOURCE refClkA
% CONFIGURE ST SOURCE SHELF 1 MTA 1 SOURCE refClkA SEQNUM 3
% CONFIGURE ST SHELF 1 RESEQUENCE
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Administration
You may re-prioritize a REFCLK binding. The command sequence below re-prioritizes the
REFCLKs ahead of the External clock sources and commits these changes.
% CONFIGURE ST SOURCE SHELF 1 MTA 1 SOURCE refClkA SEQNUM 1
% CONFIGURE ST SOURCE SHELF 1 MTA 1 SOURCE refClkB SEQNUM 2
% CONFIGURE ST SOURCE SHELF 1 MTA 2 SOURCE refClkA SEQNUM 7
% CONFIGURE ST SOURCE SHELF 1 MTA 2 SOURCE refClkB SEQNUM 8
% CONFIGURE ST SHELF 1 RESEQUENCE
NOTE
The parameters discussed below are initially set by the CONFIGURE ST SHELF
command.
If the current active timing source fails, the GSX software will automatically initiate a timing
source switchover to an alternate source. This source will be the Timing Source Sequence Table
entry at the next lower priority (next higher Sequence Number) than the current source. The events
are:
NOTE
The switchover is initiated only by a failure in the current active source. You may
not force the switchover with a CLI command.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Administration Managing the GSX
Revertive Switching
NOTE
The parameters discussed below are initially set by the CONFIGURE ST SHELF
command.
This subject refers to the strategy used by GSX software to detect and restore timing sources that
have previously failed.
Without revertive switching, timing failure switchovers result in increasingly less preferred new
timing sources. (You must manually restore a recovered MTA or timing source in this case.
See"System Timing MTA" on page 3–672 and "System Timing Source" on page 3–678.)
The mechanism by which a source is restored when revertive switching is enabled is:
1. After failing and being removed from service, the source begins to recover.
2. The GSX software waits for a period of RECOVERYGUARDTIME before proceeding to insure
that the recovery is legitimate rather than periodically bouncing to a valid state. If the source is
still good after RECOVERYGUARDTIME expires, then it will be made available for consideration
as a timing source. If the current source subsequently fails, a switchover to the “recovered”
source may occur as depicted in the table below.
3. If a failure is again detected after RECOVERYGUARDTIME expires, the source will remain out of
service and left out of consideration as a source until it again shows signs of recovering.
NOTE
The detection of an MTA failure requires the cooperation of the software managing
the GSX9000 server modules and typically results in a series of Event Log entries
announcing the “votes” of the participating modules.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Administration
Daisy Chaining
The synchronized timing signal may be daisy chained to another shelf via the MTA timing out port
as depicted in Figure 6–1, "Daisy Chaining from MTA10a Timing Out Port". If you use this
mechanism to propagate timing signals, you should be aware that:
• Given a Primary Reference Source (PRS) into GSX #1, you may propagate this signal to the
BITS, SETS, or DCS port on a maximum of 5 additional daisy chained GSXs. The signal
quality cannot be assured beyond the sixth GSX in the chain.
• Using the scenario above, if you perform a SHOW ST SOURCE .. STATUS command on GSX
#2 through #6, the Stratum Traceability of the External Clock whose source is daisy chained in
will display INDETERMINATE.
• Resets to any propagating shelf will disrupt the timing signal to the receiving shelf.
• If all configured input sources to the propagating shelf fail, the OSCILLATOR signal will be
propagated.
• If the propagating MTA is not in service, the OSCILLATOR signal will be propagated.
• If the propagating MTA fails, no timing signal will be propagated.
• If both MTA10a and MTA10 modules are in the daisy chain, the first MTA10 must come after
the last MTA10a. Otherwise, the timing signal will not be forwarded to some of the MTA10a
modules.
(Daisy chaining from the MTA20a/MTA21a/MTA30 Timing Out also behaves as above.)
MTA10
Active
Fault
MTA10
ports BITS 1
Daisy
BITS 2
chain
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Administration Managing the GSX
The SPS70 and SPS80 are high-density Signal Processing Servers. These server modules provide
and manages DSP resources for both the GSX9000 and GSX9000HD.
The SPS70 and SPS80 are fully N:1 redundant servers providing DSP resources. You may
dynamically reconfigure these resources, using a set of Sonus-prescribed DSP media profile types,
with minimal impact to service. To do so, you use the existing server dryup mechanism to allow
calls to complete across the server before reloading all DSPs with new images or functions.
You may configure the SPS70 or SPS80 as an N:1 redundancy participant. The SPS70 and SPS80
do not use an adapter or the redundancy plane. Therefore client and standby servers are
configurable in any valid slot.
You also may configure multiple N:1 SPS redundancy groups in a single shelf. Multiple SPS
redundancy groups and non-redundant SPS servers may operate autonomously; all configuration
rules and procedures are confined only to each redundancy group or each standalone server.
You configure SPS70, SPS80, CNS25, CNS45, CNS85, and CNS86 DSP resources from a limited
group of pre-defined, Sonus-supplied DSP media profiles (see next section for specifics on each
profile). Using these hard-coded profiles provides predictable, practical network configurations, as
well as performance reliability for differing DSP image types under load.
DSP media profile configuration and management is accomplished with the MEDIA PROFILE
management object. You must define a media profile according to one of a set of pre-defined base
profile types, and then you may enable or disable individual DSP capabilities as needed. The
SPS70, SPS80, CNS45, CNS85, and CNS86 support "Universal Compression" in which
compression capabilities G.729AB, G.726, G.723.1, iLBC (Internet Low Bit-Rate Codec), GSM,
and PXPAD can be simultaneously supported on the same server. The CNS25 supports only a
single compression type per server and must be assigned a media profile which meets this
requirement.
NOTE
iLBC and iLBCSS is not supported on the CNS25 modules.
Tone, announcement, and bridge conferencing resources are also allocated through DSP media
profiles, as explained in the sections that follow.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Administration
• When you create an SPS70, SPS80, CNS25, CNS45, CNS85, and CNS86 server, via CREATE
SERVER, the default media profile is automatically assigned to that server module. You may
not modify the default media profile because it is a system standard. You may retain this
assignment or create and assign another media profile to the server.
• Within a redundancy group, the media profiles assigned to all redundancy clients must match.
• The media profile that is assigned to the redundant module in a redundancy group must match
the media profiles assigned to all the redundancy clients.
• If the media profile assigned to the redundant module does not match the media profile of the
enabled clients, then a command to enable the redundancy group will be rejected with proper
explanation.
• If the media profile assigned to a disabled client does not match the media profile of the
redundant module that has become active because of a switchover, then a command to enable
the redundancy client will be rejected with proper explanation.
• After initial configuration and activation of a redundancy group, you may assign a new media
profile to the entire redundancy group. Follow the steps below to carry out this process.
See “Media Profile Dryup and Reconfiguration Process” on page 6-16 for a detailed example
of this procedure, including the SHOW commands that help you to confirm the completion of
any previous step.
• Runtime DSP re-configuration is asynchronous, so each new profile must be downloaded to a
particular server and must complete loading before the server may be re-enabled.
• You cannot re-enable a redundancy group until all its enabled clients have completed dryup (if
applicable), the new media profile configuration has been fully loaded, and all DSPs are
operational across all active and standby servers.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Administration Managing the GSX
You may create a media profile for server types SPS70, SPS80, CNS25, CNS45, CNS85, and
CNS86. To display the media profile base types:
% SHOW BASEMEDIAPROFILE ALL ADMIN
Node: TPUBS Date: 2004/09/30 15:56:53 GMT
Zone: GMTMINUS05-EASTERN-US
------------------------------------------------------
Media Profile Base Types
------------------------------------------------------
Index Description
----- -----------
1 Voice Compression
2 Compr+Tone(4:1)+ Bridge
3 Compr+Tone(1:1)+ Bridge
4 Bridge Conference
----------------------------------------------------------
Media Profile Base Types
---------------------------------------------------------
Number Description
------ -----------
1 Voice Compression
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Administration
----------------------------------------------------------------------------
Media Profiles
----------------------------------------------------------------------------
Index Name State Status Base G729 G726 G723 iLBC GSM PXPAD
----- ---- ----- ------ ---- ---- ---- ---- ---- --- -----
1 default ENABLED IS 1 DIS ENA DIS DIS DIS DIS
2 compress_9chan DISABLED OOS 1 ENA ENA DIS DIS DIS DIS
3 compress_6chan DISABLED OOS 1 DIS DIS ENA DIS DIS DIS
----------------------------------------------------------------------------
Media Profiles
----------------------------------------------------------------------------
Index Name State Status Base G729 G726 G723 iLBC GSM PXPAD
----- ---- ----- ------ ---- ---- ---- ---- ---- --- -----
2 compress_9chan DISABLED OOS 1 ENA ENA DIS DIS DIS DIS
The default media profile is also supplied. The default media profile is base profile type 1
(Voice Compression only), with the G.726 compression type capability enabled. The default
media profile may not be modified as it is a system standard profile.
NOTE
All compression capability can be disabled by configuring each compression type
to DISABLED. In this case DSP support is provided only for G.711 plus T.38. A no-
compression media profile is only assignable to the SPS70, SPS80, CNS45, CNS85,
or CNS86 server supporting Universal Compression codecs; it is not assignable to
the CNS25.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Administration Managing the GSX
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Administration
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Administration Managing the GSX
---------------------------------------------------------------
DSP Resource Summary: Shelf: 1
---------------------------------------------------------------
G711 HDLC Tone Conference Compression
Tot Util Fail Tot Util Fail Tot Util Fail Tot Util Fail Tot Util Fail
Slot % % % % % % % % % %
---- ------------- ------------- ------------- ------------- -------------
8 0 0 0 0 0 0 0 0 0 0 0 0 1296 0 0
9 0 0 0 0 0 0 0 0 0 0 0 0 1296 0 0
------------------------------------------------------
DSP Resource Status: Shelf: 1 Slot: 8
------------------------------------------------------
Total Utilization Allocation
% Failures %
----- --------- -----------
G711+Echo Cancellation: 0 0 0
G711: 0 0 0
HDLC: 0 0 0
Tone: 0 0 0
---- --- ---
Conference: 0 0 0
Participant: 0 0 0
---- --- ---
Total Compression: 1296 0 0
G729A+B: 0 0 0
G723.1: 0 0 0
G726: 1296 0 0
iLBC: 0 0 0
GSM 0 0 0
Packet Outages total: 0
Packet Outages during interval: 0
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Administration
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Administration Managing the GSX
• 100% Voice Compression. This profile includes only compression resources. For the CNS25
only a single-compression type media profile may be configured from this base type. For the
SPS70, SPS80, CNS45, CNS85, and CNS86 the Universal DSP allows this base type to be
used to configure multiple compression types on the same server. Software configures the
DSPs to use the highest possible channel density, based on the user-configured media profile.
If the profile includes G.723 compression, internally 6-channel compression mode is
employed; if not, 9-channel compression mode is employed.
• A mix of compression and tone/announcement resources, in a 4:1 ratio, as well as bridge
conferencing resources. This profile type includes compression resources, tone/announcement
resources, and bridge conferencing resources to support call processing treatments. As with
the 100% Voice Compression profile, software configures the DSPs to use the highest possible
channel density, based on the user-configured media profile.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Administration
Each base profile type is hard-coded. You cannot change these percentages and ratios through the
CLI.
You can use the MEDIA PROFILE and BASEMEDIAPROFILE objects to allocate compression,
tones/announcements, and bridge conferencing resources in up to seven different ways. The seven
resource appropriations that are available on an SPS70 or SPS80 server module are identified and
quantified in Table 6–3 and Table 6–4 below. As shown in the table, these resources may be
concentrated on behalf of full compression (all codecs), partial compression (all codecs except
G.723.1/A), tones/announcements/full compression, tones/announcements/partial compression,
and bridge conferencing.
BASE-
MEDIA- MEDIA PROFILE
Allocation Type Resources Provisioned PROFILE Settings
100% Compression Full 864 compression channels 1 G729AB enabled
supporting any mix of G729AB,
G726 enabled
G726, G723.1/A, iLBCSS, G711,
T.38, and DTMF relay via G7231 enabled
RFC2833
ILBC enabled
no tones/announcements
no bridge conferencing
100% Compression 1296 compression channels 1 G729AB enabled
Partial supporting any mix of G729AB,
G726 enabled
G726, G711,T.38, and DTMF
relay via RFC2833 G7231 disabled
no tones/announcements ILBC disabled
no bridge conferencing
4:1 Compression/Tone 828 compression channels 2 G729AB enabled
Full supporting any mix of G729AB,
G726 enabled
G726, G723.1/A, ILBCSS, G711,
T.38, and DTMF relay via G7231 enabled
RFC2833
ILBC disabled
192 tone/announcement
channels
96 bridge conferencing channels
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Administration Managing the GSX
BASE-
MEDIA- MEDIA PROFILE
Allocation Type Resources Provisioned PROFILE Settings
4:1 Compression/Tone 1224 compression channels 2 G729AB enabled
Partial supporting any mix of G729AB,
G726 enabled
G726, G711,T.38, and DTMF
relay via RFC2833 G7231 disabled
288 tone/announcement ILBC enabled
channels
96 bridge conferencing channels
1:1 Compression/Tone 756 compression channels 3 G729AB enabled
Full supporting any mix of G729AB,
G726 enabled
G726, G723.1/A, ILBCSS, G711,
T.38, and DTMF relay via G7231 enabled
RFC2833
ILBC enabled
768 tone/announcement
channels
96 bridge conferencing channels
1:1 Compression/Tone 1062 compression channels 3 G729AB enabled
Partial supporting any mix of G729AB,
G726 enabled
G726, G711,T.38, and DTMF
relay via RFC2833 G7231 disabled
1056 tone/announcement ILBC disabled
channels
192 bridge conferencing
channels
100% Bridge 3744 bridge conferencing 4 Not Applicable
Conferencing channels
no compression
no tones/announcements
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Administration
BASE-
MEDIA- MEDIA PROFILE
Allocation Type Resources Provisioned PROFILE Settings
100% Compression Full 3348 compression channels 1 G729AB enabled
supporting any mix of G729AB,
G726 enabled
G726, G723.1/A, iLBCSS, G711,
T.38, and DTMF relay via G7231 enabled
RFC2833
ILBC enabled
no tones/announcements
GSM disabled
no bridge conferencing
100% Compression 4464 compression channels 1 G729AB enabled
Partial supporting any mix of G729AB,
G726 enabled
G726, G711,T.38, and DTMF
relay via RFC2833 G7231 disabled
no tones/announcements ILBC enabled
no bridge conferencing GSM disabled
4:1 Compression/Tone 3042 compression channels 2 G729AB enabled
Full supporting any mix of G729AB,
G726 enabled
G726, G723.1/A, ILBCSS, G711,
T.38, and DTMF relay via G7231 enabled
RFC2833
ILBC enabled
1400 tone/announcement
channels GSM disabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Administration Managing the GSX
BASE-
MEDIA- MEDIA PROFILE
Allocation Type Resources Provisioned PROFILE Settings
1:1 Compression/Tone 3312 compression channels 3 G729AB enabled
Partial supporting any mix of G729AB,
G726 enabled
G726, G711,T.38, and DTMF
relay via RFC2833 G7231 disabled
4500 tone/announcement ILBC disabled
channels
GSM disabled
225 bridge conferencing
channels
100% Compression Full 3348 compression channels 1 G729AB disabled
supporting GSM and DTMF relay
G726 disabled
via RFC2833
G7231 disabled
no tones/announcements
ILBC disabled
no bridge conferencing
GSM enabled
100% Bridge 13950 bridge conferencing 4 Not Applicable
Conferencing channels
no compression
no tones/announcements
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Administration
Access Security
The CLI provides access security with a User ID and password (passwords are stored in encrypted
format), and by supporting three access levels:
• System Administrator
• User
• Read-only
Sonus sets the User ID to admin and the password to gsx9000 for the System Administrator on
each system before it ships. If you change the factory default User ID and password, Sonus
recommends that you record this information in a secure location.
CAUTION
DO NOT FORGET THE VALUE OF THIS USERID AND PASSWORD. If you forget
either or both, and need to replace them, you must reboot your GSX with default
parameters in order to initiate the replacement.
User Access
Users can display and modify information, and change his/her password. Users do not
automatically have access to all information. However, user access is granted for the following
kinds of information:
• Configuration
• Event Log
• Status
• Diagnostics
Read-only Access
Users with read-only access can only display information. Modification of the information is not
permitted.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Administration Managing the GSX
Whenever you add hardware modules to a GSX9000, you must configure them through the CLI
CREATE/CONFIGURE SERVER commands. See "Server" on page 3–17.
On a GSX4000 series switch, GNS hardware modules are only added as standby modules in order
to create redundancy. For instructions on adding a GNS15 module to a GSX4010 switch, see
Chapter 6 of the GSX4010 Hardware, Installation, and Upgrade Guide.
CAUTION
You can only add a GNS module to a GSX4000 series switch if the switch has been
configured for GNS redundancy. Replacing the GNS module on a system not
configured for redundancy is service-affecting and should be avoided.
In order to subsequently execute these configuration commands whenever the GSX is booted, the
commands must be inserted into the CLI Startup Script File. This file is located in the GSX System
Tree which is depicted in Figure 6–15 on page 6–91. By default this file’s path is <BASEDIR>/
cli/scripts/sysinit.tcl. You may modify this file name through the NVS Configuration
Menus described of the GSX9000 Open Services Switch Installation and Upgrade Guide or the
GSX4010 Open Service Switch Hardware, Installation, and Upgrade Guide
To maintain NFS server redundancy (see "NFS Server Redundancy" on page 6–34) this file must
be identical in content and name on each NFS server.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Redundancy
Redundancy
The GSX, certain hardware modules and network components support various models of
redundancy. Each of these is redundancy options is provided in this section.
CNS Redundancy
Sonus supports the N:1 redundancy model for CNS modules on the GSX9000. You may configure
a redundant (standby) CNS module to monitor the active CNS redundancy client (or clients).
When an active CNS module experiences an unrecoverable fault, reset, or removal, a switchover
will automatically occur. A switchover may be manually invoked by the CONFIGURE
REDUNDANCY GROUP...SWITCHOVER or the CONFIGURE REDUNDANCY GROUP...REVERT
commands. (See "Redundancy Group" on page 3–48 for more detail about these operations.)
A switchover results in the standby CNS module becoming active immediately and replacing the
previously active CNS module. All calls that were active in the failed CNS module when the fault
occurred will be preserved. Calls that were not yet stable when the fault occurred will be dropped.
You must observe these guidelines when configuring CNS modules for redundancy:
• Any CNS10 redundant module must have a CNA01 adapter module installed behind it in the
corresponding adapter slot
• Any CNS20 redundant module must have a CNA02 adapter module installed behind it in the
corresponding adapter slot
• Any CNS25 redundant module must have a CNA05 adapter module installed behind it in the
corresponding adapter slot
• Any CNS30 or CNS31 redundant module must have a CNA03 adapter module installed
behind it in the corresponding adapter slot
• Any CNS40 or CNS45 redundant module must have a CNA04 adapter module installed
behind it in the corresponding adapter slot
• Any CNS60 redundant module must have a CNA06 adapter module installed behind it in the
corresponding adapter slot
• Any CNS71 redundant module must have a CNA07 adapter module installed behind it in the
corresponding adapter slot
• Any CNS80 or CNS81 or redundant module must have a CNA08 adapter module installed
behind it in the corresponding adapter slot.
• Any CNS85 or CNS86 or redundant module must have a CNA08 adapter module installed
behind it in the corresponding adapter slot.
• A CNS30 redundant module can protect CNS30 or CNS31 redundancy clients, but a CNS31
redundant module can protect only CNS31 redundancy clients
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Redundancy Managing the GSX
Certain combinations of circuit redundancy groups must not be configured in a GSX. The CNS
servers are divided into seven server classes for the purpose of defining these restrictions:
• CNS/10/20/25
• CNS30/31
• CNS60
• CNS71
• CNS40/45
• CNS80/85
• CNS81/86
Table 6–5 depicts the applicable rule for each server class combination in a GSX chassis. The
GSX software will enforce these rules and restrictions.
NOTE
The “more than one” designations in this table effectively declare that you may
define multiple CNS redundancy groups of the indicated type in one GSX chassis.
While this is indeed possible, be aware that if you have two CNS redundancy
groups of the same type configured and a switchover to the redundant module
occurs in one group, redundancy in the second group is compromised as long as
the redundant module in the first group is active. The second group will be unable
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Redundancy
to perform a switchover under these conditions. When the first redundancy group
REVERTs back to the previously failed module, then the second redundancy group
could carry out a switchover if necessary.
PNS10 Redundancy
Sonus supports the N:1 redundancy model for PNS10 modules on the GSX9000. A PNS10
redundancy group is created by the CREATE SERVER .. HWTYPE PNS10 .. REDUNDANT
command. For example, the command:
% CREATE SERVER SHELF 1 SLOT 5 HWTYPE PNS10 redundant
creates the redundancy group PNS10-1-5. You may configure this redundancy group as you
would another, and carry out the set of operations that are valid on a redundancy group object. See
"Redundancy Group" on page 3–48. Subsequently, a primary PNS10 in a different slot can be
added to this redundancy group by creating a redundancy client. See "Redundancy Client" on
page 3–57 for additional detail.
The configuration segment below creates the redundancy group PNS10-1-5, adds redundancy
client PNS10-1-6 to the redundancy group and sets the administrative state of each module to
enabled:
% CREATE SERVER SHELF 1 SLOT 6 HWTYPE PNS10
% CREATE SERVER SHELF 1 SLOT 5 HWTYPE PNS10 redundant
% CONFIGURE SERVER SHELF 1 SLOT 6 STATE enabled
% CONFIGURE SERVER SHELF 1 SLOT 5 STATE enabled
% CREATE REDUNDANCY CLIENT GROUP PNS10-1-5 SLOT 6
% CONFIGURE REDUNDANCY GROUP PNS10-1-5 STATE enabled
% CONFIGURE REDUNDANCY CLIENT GROUP PNS10-1-5 SLOT 6 STATE enabled
The link verification facility provides a means of specifying the conditions that constitute an
Ethernet link failure, and hence a switchover to the redundant PNS10 module.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Redundancy Managing the GSX
Layer 3 PNS redundancy, using PNS10, PNS30, PNS40, or GNS modules may be achieved
through the Sonus OSPF Interface. In Layer 2 PNS redundancy, a separate Ethernet switch is
required for each redundancy group and each subnet. In this N:1 redundancy model, a redundant
PNS/PNA pair backs up one or more PNS/PNA clients. The interfaces on the backup PNS/PNA
pair are not numbered. When an active PNS fails, the NIF addresses assigned to the interfaces of
the failing PNS/PNA pair are moved to the redundant PNS/PNA pair in the same redundancy
group. These physical IP interface addresses and MAC binding information are sent to the
attached switch and routers. All traffic from CNS modules to the failed PNS is rerouted to the
redundant PNS/PNA pair. In this model:
• All PNS/PNA pairs in a redundancy group are on the same LAN segment
• There is no IP topology change on a switchover
• Only the MAC layer path is changed between an Ethernet switch and a PNA port on a
switchover
This redundancy model is referred to as switched redundancy.
This scheme requires an Ethernet switch on each subset on each redundancy group. These
switches introduce additional devices to the subnet paths, complicating the redundant network
design and increasing the chances of a single failure in the network. These drawbacks are
eliminated in the Layer 3 model.
In Layer 3 PNS redundancy, the PNS/PNA pairs are directly connected to neighbor routers. This
includes the redundant PNS/PNA pair, as well as all client PNS/PNA pairs. Every physical PNA
port has an IP address assigned, rather than client ports only, as in the Layer 2 model. Each of
these links to a neighbor router is assigned to a separate IP subnet. The OSPF interface running on
each link maintains IP connectivity, causing each link to be continually ready to send and receive
data, including the link or links (PNS10) to the redundant PNS/PNA pair. This redundancy model
is referred to as routed redundancy.
The N:1 Layer 3 PNS redundancy group contains 1 or more PNS/PNA clients, and one PNS/PNA
redundant pair, just as with the Layer 2 redundancy group. In the Layer 2 model, the redundant
pair is not assigned an IP address and hence is not active. In the Layer 3 model, the redundant pair
is assigned an IP address and is continuously capable of active use in the network. Although
available for use, the redundant PNS/PNA pair is not enabled for sending or receiving bearer
channel (endpoints of voice connections) or signaling traffic. The client pairs are enabled for bearer
channel traffic. If a client PNS/PNA pair fail, the redundant pair is activated and the bearer traffic
that formerly went through the failing PNS/PNA pair is redirected, under OSPF control, to the
interface associated with the redundant pair. In this “switchover”, the failing PNS/PNA pair gets
rebooted and placed into standby mode. This pair then takes on the redundant role the redundancy
group.
In the Layer 3 model, a logical bearer address is a loop back address. As loop back addresses, these
IP addresses belong to the system and are not bound to physical ports, or thereby, MAC addresses.
By using logical bearer addresses as the endpoints of voice connections, these connections remain
independent from the physical PNS/PNA interfaces. Blocks of logical bearer addresses are defined
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Redundancy
and made available to each physical PNA port in a PNS Layer 3 redundancy group. The OSPF
process will advertise all logical bearer addresses as host routes to its neighbor routers. Call
processing uses logical bearer addresses as endpoints during a call setup. The underlying IP
network process will map the logical bearer addresses to the necessary physical IP addresses.
NOTE
In this model, each loopback or logical bearer address is virtually associated with
one and only one active PNS/PNA interface. Hence, an outgoing voice packet can
only be sent through the IP interface associated with the source logical bearer
address. This one-to-one relationship doesn’t usually apply to loop back
addresses.
For each valid physical IP interface on an active (client) PNS/PNA pair, a logical bearer address is
requested from the pool and an association between that interface and that logical bearer address is
established. If the pool of logical bearer addresses is empty, then that physical interface will not be
used to carry bearer traffic. To distribute load, the number of active connections using logical
bearer address should be evenly distributed among available logical bearer addresses within a
redundancy group.
If a failure occurs on an active PNS/PNA pair, a switchover to the redundant PNS/PNA pair is
initiated. The logical bearer addresses associated with the IP interface(s) on the failing pair are
reassociated with the IP interface(s) on the redundant pair. The OSPF process will immediately
propagate the topology change to its neighbors. To ensure that rerouting occurs as intended, the
cost of the new path to the logical bearer addresses is set lower than the cost of the previous path to
the failed IP interfaces. This is important in the case of a hub or switch that resides between the
PNS/PNA pair and the router. The PNS does not send failure indications to routers, so the router
would not otherwise know of the failure. Hence the importance of assigning a lower cost to the
new path toward the same logical bearer address through OSPF. (In the case of a direct connection
between the failing PNS30/PNA30 pair and the router, the router itself would detect the link
failure and routes using those links would be updated appropriately.) Approximately 40 seconds
after the switchover, the old OSPF adjacencies expire and the cost of the new path is adjusted back
to normal. The failed (and rebooted) PNS/PNA pair becomes the redundant pair running in
standby mode. The OSPF adjacency from this interface is established as usual, as it was for the
previously redundant, now active, pair. To maintain active calls during such a Layer 3 PNS
switchover, full connectivity between the GSX and the outside IP network should be restored
within two seconds. This means that the neighbor routers should recompute routes and be ready to
forward data traffic onto the new path within one second of notice. This may require custom
configuration of certain routers.
NOTE
In the redundant Layer 3 PNS/PNA pair, NIF creation and maintenance is identical
to that on the active or client pairs. NIFs must be created, link integrity for links to
the neighbor routers must be maintained, and all routing traffic, unicast/multicast/
broadcast, must be allowed. The NIF must as well be maintained in the ARP and
routing table. These requirements are unique to the Layer 3 model. In the Layer 2
model, redundant PNS/PNA pair NIFs are not maintained in this way.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Redundancy Managing the GSX
You must designate a Layer 3 redundant pair when you create the PNS server module or a Layer 2
pair will be created by default. The command below creates a redundant PNS40/PNA40 pair in
slot 3 to be used for Layer 3 redundancy:
% CREATE SERVER SHELF 1 SLOT 3 HWTYPE PNS40 ADAPTER pna40 FUNCTION ..
enetLayer3 redundant
These commands create two client PNS40/PNA40 pairs that may become part of a Layer 3 PNS
redundancy group; these pairs are in slots 4 and 5:
% CREATE SERVER SHELF 1 SLOT 4 HWTYPE PNS40 ADAPTER pna40 FUNCTION ..
enetLayer3
% CREATE SERVER SHELF 1 SLOT 5 HWTYPE PNS40 ADAPTER pna40 FUNCTION ..
enetLayer3
Once the PNS server modules have been created as potential members of a Layer 3 redundancy
group, they cannot be dynamically reconfigured into a Layer 2 redundancy group. In order to
change PNS redundancy models, either from Layer 3 to Layer 2 or from Layer 2 to Layer 3, you
must delete each PNS server and then recreate it as a member of the new model. The command
below deletes the Layer 3 PNS server module that was created in slot 5:
% DELETE SERVER SHELF 1 SLOT 5
To add previously created PNS30 server modules in slots 4 and 5 to this redundancy group:
% CREATE REDUNDANCY CLIENT GROUP pns30-1-3 SLOT 4
% CREATE REDUNDANCY CLIENT GROUP pns30-1-3 SLOT 5
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Redundancy
Once you have configured the PNS redundancy group as shown above, you must set up the OSPF
process appropriately. This entails creating the OSPF process, defining one or more OSPF areas,
enabling the OSPF process, and specifying the OSPF routing domain. Each OSPF interface is
created by assigning each physical PNA port to an IP address. The collection of OSPF interfaces is
the routing domain. Each PNA port, whether it is active or standby, must be assigned and enabled.
For more information on the OSPF interface, see "Open Shortest Path First (OSPF) Interface" on
page 3–213.
The sequence below sets up the OSPF process on the three PNS/PNA pairs that formed the PNS30
Layer 3 redundancy group shown previously. In this example, each PNA port is assigned to the
subnet 10.10.4.1, 10.10.5.1, or 10.10.6.1.
% CREATE OSPF SHELF 1
% CONFIGURE OSPF SHELF 1 AREA 0.0.0.0 TYPE common
% CONFIGURE OSPF SHELF 1 STATE enabled
A pool of logical bearer addresses must be provisioned to process calls using the Layer 3 model.
Once provisioned, the GSX Call Management software will take addresses from the pool and
assign them to call endpoints. The pool size must match or exceed the number of physical PNA10
or PNA30 ports in the PNS redundancy group that may be simultaneously active. The command
below allocates four consecutive logical bearer IP addresses, beginning at 21.0.0.1:
% CREATE LOGICAL BEARER ADDRESS 21.0.0.1 SIZE 4
When a pool is allocated, the GSX software must be able to confirm that each logical bearer
address is otherwise not configured in the system. When a pool is released, the GSX software must
be able to confirm that no addresses in the pool are in use.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Redundancy Managing the GSX
Figure 6–2 illustrates the PNS30 Layer 3 redundancy group, that is configured as a result of the
example shown above. The logical bearer addresses are always used for call endpoints. These two
logical bearer addresses are initially assigned to subnets 10.10.4.1 and 10.10.5.1. However, if a
failure should occur on one of those routes, the associated logical bearer address would be
assigned to subnet 10.10.6.1 and the failing PNA/PNA pair would be reset and placed into standby
mode.
NOTE
When Layer 3 redundancy is in use, the gateway signaling timers (see "Gateway
Signaling Link" on page 3–390) should be set to approximately 10 seconds. This
ensures that the gateway signaling channel remains active upon PNS switchover.
Otherwise, the TCP traffic won’t move to new routes quickly enough on many
routers, and the gateway signaling channel’s KEEPALIVETIMER facility may report
link failure.
active PNS
OSPF
Router
10.10.5.1
standby PNS
10.10.6.1
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Redundancy
Sonus supports the 1:1 redundancy model for MNS modules on the GSX9000 and GNS modules
on GSX4000 series switches. By default, the redundant (standby) MNS or GNS module (MNS10,
MNS11, MNS20, or GNSxx) monitors the active module from the time the GSX is booted. When
the active module experiences an unrecoverable fault, reset, or removal, a switchover will
automatically occur. A switchover may be manually invoked by the CONFIGURE REDUNDANCY
GROUP .. SWITCHOVER command. A switchover results in the standby module becoming active
immediately and replacing the previously active module. If a core dump was initiated on the
previously active module (due to the failure condition), it will complete before that module
reinitializes itself as the new standby. All calls that were stable when the fault occurred will be
preserved. Although a core dump could continue on (in the background), the newly active MNS or
GNS module will be able to process new calls approximately five seconds after the switchover
began. Transient calls, or calls that were not yet stable will be lost, and must be reissued.
See "Redundancy Group" on page 3–48 for CLI commands to manually invoke this switchover.
When you boot a GSX with redundant MNS or GNS modules the first time, you must configure
the NVS parameters. This configuration is performed on the active MNS or GNS module while the
standby module is “locked out” as explained in the GSX9000 Open Services SwitchInstallation and
Upgrade Guide or the Hardware, Installation, and Upgrade Guide for your GSX4000 series switch.
Once both are booted and initialized, all configuration commands are synchronized between them.
Subsequent boots allow, but do not require, NVS configuration.
The NVS parameters require certain unique values for each MNS or GNS module. Parameters for
both modules are specified to the active module through the NVS Configuration Menu when you
install your GSX (see the GSX9000 Open Services Switch Installation and Upgrade Guide or the
Hardware, Installation, and Upgrade Guide for your GSX4000 series switch). The active MNS or
GNS module will copy its NVS parameters to the standby when the NVS configuration is
completed and both modules are reset. Subsequent changes to the NVS configuration will be
similarly replicated to the standby module (regardless of whether the original active/standby
pairings have changed through switchovers). This procedure is referred to as NVS Mirroring.
Subsequently, when both modules are running redundantly, CLI commands to configure NVS
parameters may be issued. These commands will simultaneously effect the parameters in the
active and the standby modules through NVS Mirroring.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Redundancy Managing the GSX
This section pertains to IP call signaling with redundant MNS or GNS modules when executing
with a Sonus PSX.
The call signal ports may be configured to use the MNS management or PNS ports on a GSX9000,
or the packet ports on a GSX4000 series switch.
To work with MNS redundancy, call signaling on a GSX9000 must be routed over the PNS
interfaces. This allows the call signal port to be associated with the PNS and not the MNS. See
"Gateway Signaling Port" on page 3–384 for more information about this configuration step. On a
GSX4000 series switch, call signaling is associated with the GNS module’s packet interfaces. The
effect of this routing is that the router will reference the PNS or packet interfaces (see "Network
Configuration Considerations" on page 6–49).
If the gateway signal port is configured to use management ports (as outlined in "Network
Configuration Considerations") then the router(s) must be configured with references to the MNA
interface addresses. If the standby MNS becomes active via switchover, the router would not know
which interface should receive the call signal traffic.
One consideration when using PNS or packet interfaces is that call signal traffic is sent over the
same network as the voice traffic. This means the network capacity must be planned with this
additional traffic in mind. The GSX reserves bandwidth (locally) for call signaling to prevent
overload of the link carrying the call signal traffic.
When a Sonus PSX is part of your configuration, you must pre-register each MNS pair on each
GSX with the SGX using the create-CC-client commands on the SGX. See the SGX SS7
Gateway Operations Guide for detail on this operation.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Redundancy
NFS server redundancy adds robustness to the NFS server functions of event logging, call
accounting, software loading of server modules, core dumping, loading of TCL scripts and CLI
screens, parameter loading and saving, and the storing and playing of announcements. The Data
Stream Integrator (DSI) Level 0 provides an NFS equivalent function. See "DataStream
Integrator" on page 1–7 for more information.
NOTE
NFS Server Redundancy is not necessary if your GSX utilizes local disks on the
management modules, and an NFS server is not used.
The NVS parameters are configured with the IP addresses and mount-points of two NFS servers,
the PRIMARY and SECONDARY servers. User IDs, group IDs, and the path of the GSX System
Tree (see Figure 6–15, GSX System Tree on page 6–91) are also configured. The PRIMARY and
SECONDARY servers’ IP addresses necessarily differ, but the user and group IDs, and GSX
System Tree path (NFS LOAD PATH) must be identical to achieve NFS redundancy.
Both NFS servers are accessible by both MNS modules on the GSX9000 and by GNS modules on
the GSX4000 series switches at all times as shown in Figure 6–3. In practice, only the active MNS
or GNS module accesses the NFS servers unless NFS commands specify the standby MNS or
GNS module.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Redundancy Managing the GSX
MNS1
MNS2
Switch
/SonusNFS
/SonusNFS
Data Data
SECONDARY
GSX9000
PRIMARY
NFS Server NFS Server
GNS1
GNS2
Switch
/SonusNFS
/SonusNFS
Data Data
GSX4000
PRIMARY SECONDARY
NFS Server NFS Server
Once the GSX is booted and running, the two NFS servers are viewed by the GSX software as
ACTIVE and STANDBY, rather than PRIMARY and SECONDARY. When the GSX is booted,
an ACTIVE NFS server is chosen from the PRIMARY/SECONDARY pair accessed by the boot
software as discussed below. Normally, both NFS servers are successfully mounted by booting
and the SECONDARY becomes the STANDBY NFS server. However if one of the PRIMARY/
SECONDARY NFS server pair was not successfully mounted by booting, then after the ACTIVE
NFS server is chosen, the GSX software will attempt (at intervals) to mount a STANDBY NFS
server until successful. Thereafter, NFS switchovers (invoked by the CONFIGURE...TOGGLE
ACTIVE command) may occur such that at any point in time, either the PRIMARY or
SECONDARY is ACTIVE.
The remainder of this section will discuss certain system activities that rely on NFS, and the
relevant strategies and CLI tools for managing them.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Redundancy
Booting
When the GSX is booted, the boot software attempts to mount both the PRIMARY and
SECONDARY NFS servers, if they have both been configured. The PRIMARY is tried first. If
neither is successful, the GSX is rebooted and steps above are repeated. If both are successful, the
PRIMARY is used for the remainder of the boot process. If one but not both is successful, that
NFS server is used exclusively for the remainder of the boot process.
The boot software does not participate in the validation of the STANDBY NFS server.
Parameter file loading is in effect when the PARAMETER MODE parameter of the NVS
Parameters object is set to binaryFile. This setting ensures that the current configuration is
restored whenever the active MNS module is booted. These values will always be copied to the
standby MNS module. See "Non-Volatile Storage (NVS) Parameters" on page 3–62 for more
information on parameter file loading.
The parameter file is saved whenever a configuration change is made by the GSX software,
regardless of the value of the PARAMETER MODE parameter. The saved parameters are always
written to both NFS servers. When the parameters are loaded, they are always read from the
ACTIVE NFS server.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Redundancy Managing the GSX
Only the STANDBY NFS server may be manually unmounted. Thus if you wish to unmount the
ACTIVE NFS server to perform maintenance, you must successfully make it the STANDBY, and
then unmount it. The steps below illustrate this process:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Redundancy
When you reconfigure the IP address or the mount-point of one of the NFS servers, the new
settings do not take effect until the NFS server is unmounted and remounted. This may result in
different displays in the SHOW ... ADMIN and SHOW ... STATUS commands. For example, if
after Step (2) above, you changed the mount-point by issuing the command:
% CONFIG NFS SHELF 1 PRIMARY MOUNTPOINT /TrainingNFS
By performing Steps (4) and (5) above, the PRIMARY NFS server may be unmounted and the
new mount-point activated. See "Administrative Versus Operational States" on page 2–8 for more
detail on the differences between configured parameters and operational parameters.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Redundancy Managing the GSX
NFS Errors
If errors are detected on the NFS server, the management client is notified via SNMP traps.
NOTE
Sonus recommends that you configure your GSX to notify a management client of
any NFS trap, including SWITCHOVER, OUT_OF_SERVICE, IN_SERVICE, and
NOT_WRITABLE. See "Using SNMP" on page 6–71 for these procedures.
If the error occurs on the ACTIVE NFS server and the STANDBY is mounted, a switchover will
occur automatically within 3 seconds to avoid the loss of accounting records. The GSX will
thereafter attempt to recover the STANDBY, in the same manner as during the boot process
discussed previously.
If the ACTIVE NFS server runs out of writable storage, a switchover will occur if a STANDBY is
mounted. The full NFS server will remain mounted and flagged as read-only by the GSX software.
If necessary (because of the absence of a mounted STANDBY), the full NFS server can be used
for read operations. However, all event logging and all call accounting will be shut down.
The read-only condition is automatically cleared by the GSX software when a minimum of 10
Megabytes of disk storage is freed up. (This may require your manual intervention.) At this point,
event logging and call accounting will resume.
The NFS server may be internally configured with a maximum number of files or with a disk
storage quota that is assigned to the UNIX User ID. If one of these quotas exist and is exceeded, a
switchover will automatically occur if a STANDBY is mounted, as in the server full condition
above. The quota-exceeded NFS server will remain mounted and flagged as read-only by the GSX
software. If necessary (because of the absence of a mounted STANDBY), the full NFS server can
be used for read operations. However, all event logging and all call accounting will be shut down.
Unlike the server full condition, there is no automatic clearing of this condition by the GSX
software. Once you remove the condition on the NFS server, you must issue the WRITE-ENABLE
command to clear the read-only condition in the GSX software. For example,
% CONFIGURE NFS SHELF 1 SLOT 1 WRITE-ENABLE PRIMARY
NOTE
Sonus recommends that you do not implement a disk quota for the NFS User ID of
the GSX.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Event Monitoring
Event Monitoring
Event log files are saved below the <BASEDIR>/evlog/<GSXNODEID>/subdirectory of the GSX
System Tree on the NFS server (see Figure 6–15 on page 6–91). Accounting files are saved in the
ACT subdirectory, debugging files are saved in the DBG subdirectory, trace files are saved in the
TRC subdirectory, and system event log files are saved in the SYS subdirectory.
This section pertains to the system, trace, and debug event types. Although Call Accounting
utilizes the same logging mechanism as the above types, it is better represented as a special case of
event logging and described separately. See Chapter 7, "Call Accounting", for this information.
The LOG SERVER object is used to create and configure a link to the DSI and initiate log
streaming. (see the section "Log Server" on page 3–96 for more information).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Event Monitoring Managing the GSX
File Names
The file names for log files differ depending on which event logging method is used.
Where,
Thus a file named 100003A.SYS designates a system event log file for shelf 1, sequence number
58.
For stream-based event logging to the DSI, the file name format is as follows:
GSXNodeName.XXXXXXXXXX.TTT
Where,
Thus a file named GSX2Boston.0000000876.SYS designates a system event log file for
“GSX2Boston,” sequence number 876.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Event Monitoring
File Size
For NFS-based event logging, the size of each event log file is established by the FILESIZE
parameter of the corresponding Event Log object (see "Event Log" on page 3–90). By default this
size is 2048K bytes.
Each event log file record is queued in MNS server module memory until either of two
circumstances forces it to be written:
• the number of queued records matches the value of the QUEUE parameter of the Event Log
object (by default this parameter is 10)
• a one-second timer expires
Whenever a file is filled to the FILESIZE limit with event records, a new file is created and named
using the above scheme.
For NFS-based event logging, the number of coexisting event log files is established by the
NUMFILES parameter of the corresponding Event Log object. By default this number is 32. This
means that, in a default configuration for an arbitrary event type, a maximum of 32 event log files
may be created.
You must process and possibly save these files elsewhere in a timely fashion.
When the number of files in the subdirectory reaches the NUMFILES parameter value, the name of
the first log file will be used to name the next file that is created. If a current copy of this file exists,
it will be deleted. If you haven’t processed or copied the original log file, you will lose its contents.
The log file names will be reused and “wrap around” to the first file in this manner indefinitely.
where,
is maintained by the GSX software in the /TTT subdirectory for incrementing the sequence
number in order to name the next event log file that is created. The content of this file is the six
ASCII digits of the next sequence number to use to name the next event log file. Each time a new
log file is opened, the sequence number file is updated to reflect the sequence number to be used
when creating the next file name. This file allows the event log file names to remain uniquely and
incrementally named even if the GSX is rebooted.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Event Monitoring Managing the GSX
CAUTION
To guarantee that this naming strategy is not violated, do not alter or remove the
NEXTTTTn file.
Table 6–6 gives examples using shelf 1 system event log (in the /SYS subdirectory) to illustrate
the GSX software strategies for creating, naming, and maintaining these files.
current system
NUMFILES event log file content of
value name NEXTSYS1 GSX Action to create a new file
32 100000C.SYS 00000D • delete 100000D.SYS
• create 100000D.SYS
• write “00000E” into NEXTSYS1
32 no existing file non-existent file • delete 1000001.SYS
(see note) • create 1000001.SYS
• create NEXTSYS1 and write “000002”
into it
32 1000020.SYS 000021 * • delete 1000001.SYS
* This overflow • create 1000001.SYS
value is noted • write “000002” into NEXTSYS1
and corrected
by the
subsequent
GSX action
32 100000C.SYS non-existent file • delete 100000D.SYS
• create 100000D.SYS
• create NEXTSYS1 and write “00000E”
into it
NOTE
Zero existing .SYS files with no existing NEXTSYS1 file represents the initial
system boot scenario. However, if NEXTSYS1 is removed for any reason and the
GSX is rebooted, then this scenario is also applicable regardless of any .SYS files
present. Notice that in this situation, an existing version of 1000001.SYS would be
lost (because it is recreated).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Event Monitoring
Configuration
Configuration of event logging differs depending on which method of logging is used. NFS-based
logging configuration tasks mainly consist of configuring log files, including setting file size,
number of files, destination, etc. Configuration of stream-based logging involves establishing a
link from the GSX to the DSI, configuring priority, and setting up user access.
You can modify the FILESIZE, QUEUE, NUMFILES, and other parameters at any time through the
CLI interface. For information on the syntax and parameters of these commands, refer to "Event
Log" on page 3–90 and "Event Filter" on page 3–103.
The LOG SERVER object facilitates the connection between the GSX and the DSI Stream Server
for stream-based event logging. A unique name and priority is created for each Log Server
connection established. You can configure the GSX for four possible log streaming destinations;
each is assigned a priority, from 1 to 4. The GSX selects a Log Server based on priority and
availability (a Log Server is considered available if TCP streams for both event log and CDR data
are established).
After creating a Log Server, you configure the IP address and set the user name and password. The
user name and password are also configured at the DSI to ensure proper authentication.
In order for stream-based logging to begin, you must then change the logging interface from NFS
(the default) to STREAM. For detailed information of each of the commands and necessary
parameters for configuring stream-based logging, see the section, "Log Server" on page 3–96 in
the CLI Reference chapter.
You can also modify the QUEUE, SAVETO, and EVMEMSIZE parameters at any time through the
EVENT LOG object. For information on the syntax and parameters of these commands, refer to
"Event Log" on page 3–90.
For stream-based logging events, the GSX spools log data when connectivity to the Log Server is
unavailable. A log spooler is maintained for each log type, and can spool a maximum of 5000
records per log type. After re-connection of the Log Server, the GSX sends the spooled messages
to the Log Server. You can specify and manage log spooler utilization as a congestion criterion
through the use of the OVERLOAD PROFILE object. See "Congestion Control" on page 3–285 for
more information. By issuing the SHOW LOG STATUS SUMMARY command, you can monitor the
status of the spooled logs.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Event Monitoring Managing the GSX
Destination of Events
You can direct the logging of events to disk (that is the GSX System Tree discussed previously),
internal MNS module memory, disk and memory, or neither through the SAVETO parameter of the
corresponding Event Log object. The size of the memory buffer is controlled by the EVMEMSIZE
parameter. By default, these logs are written to both disk and memory, using a 16 Kb memory
buffer.
NOTE
If you disable internal memory logging (for example by changing the SAVETO
parameter from both to disk), all existing memory events are erased.
Event Filters
For NFS-based event logging, event filters allow you to fine tune the event log by adding criteria
to event selection. You can select events:
The software subsystem is specified by the CLASS parameter to the Event Filter object (see "Event
Filter" on page 3–103). The set of software subsystems to select from are:
The specific criticality is specified by the LEVEL parameter. The set of criticalities to select from
are:
• none (noevents)
• critical (critical)
• major (major)
• minor (minor)
• informational (info)
Each group in the above list is a subset of the group below it. Thus none is the most selective
criticality, while informational is the least selective. The default criticality is major.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Event Monitoring
Modules are specified by the SLOT parameter. You may specify a single module or different
combinations of multiple modules. For example, a parameter value of:
Show Commands
The example below shows the configured parameters for all event types when using NFS-based
logging:
% SHOW EVENT LOG ALL ADMIN
Node: TPUBS Date: 2005/08/25 20:00:55 GMT
Zone: GMTMINUS05-EASTERN-US
This example shows the configured parameters for system event types (a subset of the above
display):
% SHOW EVENT LOG system ADMIN
Node: TPUBS Date: 2005/08/25 20:05:08 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Event Monitoring Managing the GSX
This example shows the event log status for all event types. The first line of this display lists
statistics pertaining to the event log file while the second line lists statistics pertaining to events
that are currently resident only in memory.
% SHOW EVENT LOG ALL STATUS
Node: HAWK Date: 2005/08/25 20:08:04 GMT
Zone: GMTMINUS05-EASTERN-US
By default the MNS module retains the last 16 kilobytes of event messages in memory, even if
they have already been written to the GSX System Tree. To show all events currently in the MNS
server module memory:
% SHOW EVENT MEMORY ALL
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Event Monitoring
This example shows the status of all Log Servers, including the number of CDRs and events that
are currently being logged:
% SHOW LOG SERVER STATUS SUMMARY
Node: TPUBS Date: 2006/06/02 16:09:43 GMT
Zone: GMTMINUS05-EASTERN-US
This example shows the link status of the Log Server streams. The GSX initiates two links (TCP
streams) to each Log Server, one for accounting files and the second for all other event files. Both
links must be in READY state to be considered available to receive log data:
% SHOW LOG SERVER LINK STATUS SUMMARY
This example show the status of data spooling when a Log Server is or becomes unavailable. A log
spooler is maintained for each log type, and can spool a maximum of 5000 records per log type.
% SHOW LOG STATUS SUMMARY
Node: TPBUS Date: 2006/06/02 20:25:59 GMT
Zone: GMTMINUS05-EASTERN-US
Log Destination: STREAM
Connectivity Errors: 2
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Configuration Considerations Managing the GSX
The GSX provides local “logical” IP addresses for call signal links between GSXs. This section
describes how to configure the GSX for various IP network structures.
This configuration provides the greatest robustness in the event of network link failures, as well as
relative ease of configuration.
The GSX connects directly to router(s). Each GSX IP link connects to a separate router link, which
is configured as separate subnet. In Figure 6–4, the Call Signal Link is configured to share PNS
interfaces with the Voice data traffic.
Static Routes:
Default Routes: Default Routes:
12.1.1.1/10.8.1.45
intf 1: 10.8.1.47 intf 1: 10.7.1.63
12.1.1.1/10.9.1.46
intf 2: 10.9.1.48 intf 2: 10.10.1.64
12.1.1.2/10.7.1.61
Net Routes: Net Routes:
12.1.1.2/10.10.1.62
intf 1: 12.1.x.x/10.8.1.47 intf 1: 12.1.x.x/10.7.1.63
intf 2: 12.1.x.x/10.9.1.48 intf 2: 12.1.x.x/10.10.1.64
GSX1 is configured to listen for call signal links at IP address 12.1.1.1 and GSX2 is configured to
listen for call signal links at IP address 12.1.1.2. Sonus recommends that call signal addresses be
allocated within a subnetwork. In this example the call signal addresses are allocated from the
network 12.1.x.x. This allows the configuration of simple network routes on the GSX to reach the
call signal addresses of the other GSXs. (If the call signal addresses are allocated from multiple
networks, then each network will have to be represented by a host route on the GSX. It is possible
to provide a host route for each specific GSX call signal address that may need be to reached but
this necessarily adds maintenance costs.). A network route for the call signal network is configured
(as shown in Figure 6–4), on each GSX on each PNS interface.
For the call signal links to be established, the GSXs and the router(s) must be properly configured
to route packet data to the appropriate GSX interfaces. Default routes must be configured on each
GSX to send packet data to the appropriate router links and the router(s) must be configured with
static routes that use the appropriate GSX interface ports. As shown in Figure 6–4 the routing
table on the PNS is configured with IP addresses of the router interfaces to which the GSX ports
are directly connected. The router must be configured to send packet data to the GSX interfaces.
The GSX will use the routing table to determine which port to send the traffic on, under all
conditions.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Network Configuration Considerations
In this configuration, when GSX1 places its first call to GSX2 a call signal link from GSX1
(12.1.1.1) to GSX2 (12.1.1.2) will be established. GSX1 will first attempt to use interface port 1 to
establish the connection. If interface port 1 is not available, port 2 will be tried. The router will first
try to route the packet data for 12.1.1.2 to GSX2 interface port 1. If this link is not available GSX2
interface port 2 will be used. Assuming that everything has been properly configured and no link
failures are present, the call signal link from GSX1 (12.1.1.1) to GSX2 (12.1.1.2) will be routed
from 10.8.1.45 to 10.8.1.47 to 10.7.1.63 to 10.7.1.61.
The GSX always reserves bandwidth for call signaling on the PNS interfaces, if gateway signaling
is configured for nif. (None is reserved if gateway signaling is configured for mgtnif.) When
gateway signaling is configured for nif, the GSX reserves a block of bandwidth on every
interface that may carry call signal traffic. In this case there is a reservation on interface ports 1
and 2 of each GSX. Voice data bandwidth is load balanced on these channels using the remaining
bandwidth.
In the event of a link failure, any call with voice data traffic on that link will be terminated. If the
link failure affects the call signal link the call signal traffic is automatically re-routed. In this case,
if the link between GSX1 interface port 1 and router port ‘a’ fails (for example, the cable is
severed), both the GSX and the router will detect this. The GSX will automatically move its
outbound call signal traffic to interface port 2. For call signal traffic to GSX1 the router will use
the next available static route, which in this case, is GSX1 interface port 2.
The relevant GSX configuration commands on GSX1 for this case are:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Configuration Considerations Managing the GSX
Create network routes to the call signal network for each PNS interface:
% CONFIG IP ROUTE ADD NIF ENET-1-4-1 IPADDRESS 12.1.0.0 ..
MASK 255.255.0.0 NEXTHOP 10.8.1.47
% CONFIG IP ROUTE ADD NIF ENET-1-4-2 IPADDRESS 12.1.0.0 MASK 255.255.0.0
NEXTHOP 10.9.1.48
The relevant GSX configuration commands on GSX2 for this case are:
Create network routes to the call signal network for each PNS interface:
% CONFIG IP ROUTE ADD NIF ENET-1-4-1 IPADDRESS 12.1.0.0 ..
MASK 255.255.0.0 NEXTHOP 10.7.1.63
% CONFIG IP ROUTE ADD NIF ENET-1-4-2 IPADDRESS 12.1.0.0
MASK 255.255.0.0 NEXTHOP 10.10.1.64
To implement this example in a real life environment, the remaining PNS interfaces, ENET-1-4-3
and ENET-1-4-4, would be configured and the static routes to the router would be added. The
router configuration, shown in Figure 6–4, would be correspondingly amended.
Configuration of the management ports is similar, using the MGMT NIF object. The call signal port
is configured by default to use mgtnif, but the PNA10 interface (nif) is specified in this
procedure to support Redundancy (see "Configuring the Gateway Call Signal Port Interface" on
page 6–33). The network routes are added just as shown, using management interface addresses.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Network Configuration Considerations
This network configuration provides robustness in the event of network link failures, but requires
more configuration support in the router(s).
The GSX connects to router(s) directly. Each GSX IP link connects to a separate router link, but in
this case a single subnet is shared by the links between the GSX and the router.
GSX1 1 a c 1 GSX2
signaling 10.8.1.45 10.8.1.47 10.7.1.63 10.7.1.61 signaling
2 Router d 2
addr 10.8.1.46 10.8.1.48 b 10.7.1.64 10.7.1.62 addr
12.1.1.1 12.1.1.2
Host Routes:
Default Routes: 10.8.1.45 on intf a Default Routes:
intf 1: 10.8.1.47 10.8.1.46 on intf b intf 1: 10.7.1.63
intf 2: 10.8.1.48 10.7.1.61 on intf c intf 2: 10.7.1.64
Net Routes: 10.7.1.62 on intf d Net Routes:
intf 1: 12.1.x.x/10.8.1.47 intf 1: 12.1.x.x/10.7.1.63
intf 2: 12.1.x.x/10.8.1.48 Static Routes: intf 2: 12.1.x.x/10.7.1.64
12.1.1.1/10.8.1.45
12.1.1.1/10.8.1.46
12.1.1.2/10.7.1.61
12.1.1.2/10.7.1.62
In this case the router must be configured with “host routes” which tell the router which of its
interface ports to use when sending packet data to the GSX. For example, assuming things are
properly configured and no network failures, when a packet is sent from GSX1 on address 12.1.1.1
to GSX2 at address 12.1.1.2, the packet is sent from GSX interface port 1 to router interface port
‘a’ (address 10.8.1.47). The router needs to forward this packet to address 12.1.1.2. The static
route table tells the router to send the packet to address 10.7.1.61. The host route tells the router to
reach 10.7.1.61 it must use interface port ‘c’.
Link failures are handled the same as with Separate Routed Subnets.
Each NIF in the above configuration should have a network route to the router address configured,
as with Separate Routed Subnets.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Configuration Considerations Managing the GSX
This network configuration will work, however it does not provide any robustness in the event of
network failures. The GSX connects to a switch, which is then connected to a single router subnet
on a single link.
Static Routes:
10.8.1.46 10.7.1.61
12.1.1.1/10.8.1.45
10.8.1.45 12.1.1.2/10.7.1.61 10.7.1.62
1 2 2 1
GSX1 GSX2
signaling signaling
addr addr
12.1.1.1 12.1.1.2
One limitation of the Figure 6–6 configuration is that the router cannot detect link failures
between the GSX and its switch. Similarly, the GSX cannot detect link failures between the switch
and the router. This inability to detect such failures means that there is little value in configuring
multiple default routes in the GSX or multiple static routes in the router.
The other limitation of this configuration is that all traffic from interface ports 1 and 2 is
multiplexed onto a single link between the switch and the router. As described earlier, the GSX
balances the bandwidth load on GSX interface ports 1 and 2. However, if the link between the
switch and the router has the same capacity as the GSX interface link the router link can become
overloaded.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Network Configuration Considerations
This network configuration provides GSX voice traffic data balancing, but like the GSX with
switched interfaces to a single routed subnet, does not provide any robustness in the event of
network failures. The GSX connects to a switch, which is then connected to a router with a
corresponding number of interface links. The traffic balancing occurs at the expense of increased
configuration requirements.
FIGURE 6–7 GSX with Switched Interfaces to Multiple Routed Subnet Links
a c 10.7.1.63
10.8.1.47
switch1 Router switch2
b d
10.8.1.48 10.7.1.64
Host Routes:
10.8.1.46 10.8.1.45 on intf a 10.7.1.61
10.8.1.45 10.8.1.45 on intf b 10.7.1.62
1 2 10.7.1.63 on intf c 2 1
10.7.1.63 on intf d
GSX1 GSX2
Static Routes:
signaling signaling
12.1.1.1/10.8.1.45
addr addr
12.1.1.2/10.7.1.61
12.1.1.1 12.1.1.2
This configuration, like the GSX with switched interfaces to a single routed subnet, in the event of
a failure on interface port 1, will terminate all calls between this GSX and other GSXs.
By adding default routes on the GSXs for interface port 2 and additional host routes on the router,
traffic on the interfaces will be kept balanced by the GSXs.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Configuration Considerations Managing the GSX
This configuration is sometimes used in test labs (where router resources may be scarce).
GSX1 1 1 GSX2
10.8.1.1 10.8.1.2
signaling signaling
addr 2 2 addr
12.1.1.1 10.8.1.5 10.8.1.6 12.1.1.2
The configuration in Figure 6–8 allows both GSXs to detect that the path between them on a
specific interface is down. A switch may be inserted (as depicted in Figure 6–9), but in the event
that link goes down, the GSX on the other side of the switch will not be aware of the failure and
can not take actions to route around the problem. Without the switch, if interface 1 becomes
unavailable, although the calls on that link will be lost, the call signal traffic will be routed to
interface 2.
Without the switch, the connected NIFs must be on different IP networks. The link between IP
addresses 10.8.1.1 and 10.8.1.2 shown in Figure 6–8 requires a MASK value of 255.255.255.252 to
achieve this result. With the switch present, the NIFs may be on the same network, as shown in
Figure 6–9.
Whenever a NIF is connected back to back with another NIF, as in Figure 6–8, the NIF should
configure a NEXTHOP to the opposite GSX interface instead of using default routes. The following
CLI command accomplishes this for one NIF on GSX1:
# Configure a PNS10 interface
CONFIGURE NIF ENET-1-4-1 IPADDRESS 10.8.1.1 MASK 255.255.255.252 ..
NEXTHOP 10.8.1.2
A host route may be added to each NIF with the address of the opposite GSX NIF and a NEXTHOP
of 0.0.0.0. For example, the CLI command,
# Add a host route to GSX2
CONFIGURE IP ROUTE ADD NIF ENET-1-4-1 IPADDRESS 10.8.1.2 ..
MASK 255.255.255.255 NEXTHOP 0.0.0.0
explicitly sets NEXTHOP to 0.0.0.0, forcing the route to be added as an interface route. This route
will allow GSX1 to ping GSX2 on 10.8.1.2.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Network Configuration Considerations
GSX1 1 1 GSX2
10.8.1.45 10.8.1.61
signaling signaling
switch
addr 2 2 addr
12.1.1.1 10.8.1.46 10.8.1.62 12.1.1.2
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Network Configuration Considerations Managing the GSX
In order to change the IP address and/or the subnet mask in an Management Network Interface
(MGMT NIF), you must first set the NEXTHOP IP address to all zeros. Internal check logic requires
that the subnet portion of the IP address of the NEXTHOP entry match the subnet portion of the IP
address of the MGMT NIF. This requirement holds even if the MGMT NIF’s administrative state is
disabled. By setting the NEXTHOP entry to zero as an intermediate step, this requirement is fulfilled
and CLI error messages are avoided.
a MGMT NIF’s IP address is changed from 128.2.3.4 to 128.5.6.7 after it is taken out of service and
disabled. This sequence would fail with an error message from the CLI if the NEXTHOP 0.0.0.0
directive was not included. To re-enable this MGMT NIF and put it back into service, issue the
command sequence:
% CONFIG MGMT NIF SHELF 1 SLOT 1 PORT 1 IPADDRESS 128.5.6.7 STATE enabled
% CONFIG MGMT NIF SHELF 1 SLOT 1 PORT 1 IPADDRESS 128.5.6.7 MODE active
NOTE
When issuing these commands on a GSX4000 series switch, omit the SHELF
parameter.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Initial GSX Network Setup
The sections that follow provide strategies and examples for provisioning NIFs, enabling
redundancy groups, setting up link verification, and setting up default routes in your GSX
network.
Sonus recommends that you always provision Management and Packet NIFs with no NEXTHOP.
This prevents automatic default routes from being added by the GSX.
NOTE
When a route is added using a nonzero NEXTHOP parameter, a default route is
added to the (single) GSX routing table. Then, if the PREFERENCE parameter is
omitted for all routes, the last route that is configured takes precedence. This
could lead to a routing ambiguity such as communicating to the NFS though a
packet NIF because the MNA interface is temporarily unavailable.
As an example, to provision and activate a management NIF in this manner on Port 1 of the
MNA20 in Slot 1:
% CONFIGURE MGMT NIF SHELF 1 SLOT 1 PORT 1 IPADDRESS 10.121.2.2 ..
MASK 255.255.255.0 NEXTHOP
% CONFIGURE MGMT NIF SHELF 1 SLOT 1 PORT 1 STATE enabled
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Initial GSX Network Setup Managing the GSX
All management applications that are local (directly connected) are supported by this scheme. This
typically includes SGX, PSX, NFS, and signaling networks. You will need to add routes to any
applications that are not directly connected. Use the IP ROUTE ADD command to add routes to
non-local management destinations. Use the IPADDRESS of the directly connected router as the
NEXTHOP parameter.
NOTE
On a GSX9000, if the NFS is not on the local LAN (directly connected), you should
contact Sonus Network Services to discuss your configuration strategy.
As an example of configuring a remote application, the commands below add a route to a High
Availability EMS network at IPADDRESS 10.121.4.0 using the management NIFs and directly
connected routers that are pictured in Figure 6–10.
The above display informs you that NIF indexes 3, 4, 5, and 6 apply respectively to management
NIFs (SLOT-PORT) 1-1, 1-2, 2-1, and 2-2.
NOTE
When nonzero NEXTHOPs are provisioned on management NIFs, they are written
to Non-Volatile Random Access Memory (NVRAM). If they are subsequently
removed, the procedure in "Removing NEXTHOPs on the Management NIFs" on
page 6–67 must used to remove them.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Initial GSX Network Setup
Link verification is the only (user interface) means of directing a MNS or PNS module switchover
because of ethernet link failures. Software directed switchovers can occur on these modules for
other reasons, but not because of link failures. The link verification procedure consists of the GSX
sending an ICMP Echo to a target address and confirming the ICMP Echo Reply. In this way, the
link and the network are checked. Sonus recommends that you direct this exchange between the
MNA/PNA port and the directly connected device on the interface (switch, router, or switch/
router). To do so, configure your LINK DETECTION parameters to SWITCHONLY LINKTEST
for both management and packet NIFs. You specify the single target through the ETHERNET
SWITCH .. IPADDRESS (the address of the directly connected device).
By configuring a failure THRESHOLD, you specify the conditions under which the active module
will switchover to the redundant module due to a link failure. The VERIFY TIMER and
REATTEMPT TIMER specify the intervals for sending and awaiting the ICMP Echos. The
VERIFY interval applies initially; the REATTEMPT interval applies after a “no-response” during
the VERIFY interval. A failure is defined by the absence of an ICMP Echo Reply to the ICMP
Echo after the number of retries specified by RETRY COUNT.
NOTE
If the default timer settings for the frequency of ICMP Echos is too frequent for
your router, contact Sonus Network Services to discuss alternative timer values.
See "Link Detection Group" on page 3–207 for more on the Link Verification command syntax
and related.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Initial GSX Network Setup Managing the GSX
MNS20 Setup
Figure 6–10 illustrates a GSX9000 system with MNS20s cross connected to a pair of redundant
switch/routers (referred to as routers in what follows) with IPADDRESSes 10.121.3.1 and
10.121.2.1. In each MNA20, Port 1 is connected to one router and Port 2 is connected to the other.
P1
P2
(Ethernet Switch)
MNA20
Router 1
SLOT 1
10.121.3.1
P3
P4
P1
P2
(Ethernet Switch)
MNA20
Router 2
SLOT 2
10.121.2.1
P3
P4
The commands below illustrate an example setup for the system portrayed above. A LINK
DETECTION GROUP is then created on each MNS20. Ports 1 and 2 on each MNA20 are added to
the corresponding LINK DETECTION GROUP. Because each group has two links (one to Router
1, one to Router 2), its THRESHOLD is set to 2. That is, an MNS switchover should not occur
unless 2 links in the group fail. (A failure of one link will not cause a switchover because the link
to the second Router remains viable for management and signaling traffic.) Finally, the
SWITCHONLY LINKTEST and STATE are enabled on each port in each group.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Initial GSX Network Setup
1. Configure the link verification target as the directly connected switch/router address:
% CONFIGURE SERVER ETHERNET SWITCH IPADDRESS SHELF 1 ..
SLOT 1 PORT 1 IPADDRESS 10.121.3.1
% CONFIGURE SERVER ETHERNET SWITCH IPADDRESS SHELF 1 ..
SLOT 2 PORT 1 IPADDRESS 10.121.3.1
% CONFIGURE SERVER ETHERNET SWITCH IPADDRESS SHELF 1 ..
SLOT 1 PORT 2 IPADDRESS 10.121.2.1
% CONFIGURE SERVER ETHERNET SWITCH IPADDRESS SHELF 1 ..
SLOT 2 PORT 2 IPADDRESS 10.121.2.1
2. Create the MNA Link Detection Group:
% CREATE LINK DETECTION GROUP mns20-1 SHELF 1 SLOT 1
% CREATE LINK DETECTION GROUP mns20-2 SHELF 1 SLOT 2
3. Add ports to the proper group and set thresholds:
% CONFIGURE LINK DETECTION GROUP mns20-1 ADD PORT 1
% CONFIGURE LINK DETECTION GROUP mns20-1 ADD PORT 2
% CONFIGURE LINK DETECTION GROUP mns20-2 ADD PORT 1
% CONFIGURE LINK DETECTION GROUP mns20-2 ADD PORT 2
4. Set the Link Detection Group Threshold for MNA to 2:
% CONFIGURE LINK DETECTION GROUP mns20-1 THRESHOLD 2
% CONFIGURE LINK DETECTION GROUP mns20-2 THRESHOLD 2
5. Enable Switch Only Link Test for all MNA Ports:
% CONFIGURE LINK DETECTION PERPORT PARAMETER SHELF 1 ..
SLOT 1 PORT 1 SWITCHONLY LINKTEST ENABLED
% CONFIGURE LINK DETECTION PERPORT PARAMETER SHELF 1 ..
SLOT 1 PORT 2 SWITCHONLY LINKTEST ENABLED
% CONFIGURE LINK DETECTION PERPORT PARAMETER SHELF 1 ..
SLOT 2 PORT 1 SWITCHONLY LINKTEST ENABLED
% CONFIGURE LINK DETECTION PERPORT PARAMETER SHELF 1 ..
SLOT 2 PORT 2 SWITCHONLY LINKTEST ENABLED
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Initial GSX Network Setup Managing the GSX
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Initial GSX Network Setup
PNS40 Setup
Figure 6–11 illustrates a GSX9000 system with PNS40s directly connected to a pair of redundant
routers (10.121.5.1 and 10.121.5.2) running Virtual Router Redundancy Protocol (VRRP). This
protocol enables these routers to behave as a single “virtual” router with IPADDRESS 10.121.1.1.
In each PNA45, Port 1 and Port 2 are connected to one of the redundant routers.
P1
(GigEthernet Switch)
P2 Router 1
PNA45 10.121.5.1
SLOT 3 Virtual Router
Virtual Redundancy
10.121.1.1 Protocol (VRRP)
allows these 2
physical routers to
function as 1
virtual router
P1
(GigEthernet Switch)
P2
Router 2
PNA45 10.121.5.2
SLOT 4
Virtual
10.121.1.1
The commands below illustrates an example setup for a GSX system with PNS40s in slots 3 and 4,
as portrayed above. A 1:1 PNS40 redundancy group is established, declaring the PNS40 in slot 4
as the redundant module and the PNS40 in slot 3 as the redundancy client. (The redundancy group
PNS40-1-4 is automatically created by the CREATE SERVER .. SLOT 4 .. REDUNDANT
command.)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Initial GSX Network Setup Managing the GSX
In the example below, a LINK DETECTION GROUP is created on each PNS40. Ports 1 and 2 on
each PNA45 are added to the corresponding LINK DETECTION GROUP. Because each group is
linked directly to one of the routers, its THRESHOLD is set to 1. That is, a PNS40 switchover
should occur whenever one of the two links in the group fail. (A failure of one link takes out 50%
of the capacity previously supported by that module, so a switchover to a module that supports
100% of the capacity is appropriate.) Finally, the SWITCHONLY LINKTEST and STATE are
enabled on each port in the non-redundant module’s group.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Initial GSX Network Setup
You also need to add a static default route on each active bearer (packet) NIF. In these commands,
the NEXTHOP parameter should be the appropriate bearer network gateway address, such as the
VRRP router IPADDRESS (see Figure 6–11 on page 6–64).
The example below adds the VRRP router IPADDRESS 10.121.1.1 to the active bearer NIFs
GENET-1-3-1 and GENET-1-3-2 as the default route.
% CONFIGURE IP ROUTE ADD NIF GENET-1-3-1 IPADDRESS 0.0.0.0 ..
MASK 0.0.0.0 NEXTHOP 10.121.1.1
% CONFIGURE IP ROUTE ADD NIF GENET-1-3-2 IPADDRESS 0.0.0.0 ..
MASK 0.0.0.0 NEXTHOP 10.121.1.1
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Initial GSX Network Setup Managing the GSX
NOTE
This procedure should only be performed when no production traffic is being
carried.
To re-provision any necessary NEXTHOPs, use the IP ROUTE ADD command as described in
"Provisioning Management and Packet NIFs" on page 6–58.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX OC-3 TDM Interface Subsystem
Sonus offers a Synchronous Optical Network Optical Carrier 3 Time Division Multiplexing
Interface (SONET OC-3 TDM) for connecting to the PSTN.
An OC-3 is an optical link that carries three T3 data streams. Each of the three T3 data streams is
handled by the GSX as if it had come in on a separate, physical T3 interface.
NOTE
This functionality is not supported on GSX4000 series switches in this release.
The hardware configuration for an OC-3 TDM subsystem includes these elements:
• Three CNS30 modules, composing a “CNS30-triplicate” in 3 adjacent slots within slots 3 - 16.
In an OC-3 TDM configuration, these three CNS30 modules act as a single unit. See the
GSX9000 Open Services Switch Installation and Upgrade Guide, Chapter 2, for a summary
description of the CNS30 server module.
• A SONET Midplane Adapter (SMP10), three slots wide, which attaches to the GSX9000
midplane on the back side of the slots containing the CNS30-triplicate.
• One or two CNA33 adapter modules. The CNA33 was developed specifically to support the
OC-3 TDM interface. The CNA33 adapter modules must be positioned in the two low-order
slots on the back side of the CNS30-triplicate. They plug into the two open slots on the
SMP10.
• A redundant CNS30 in slot 16 may be used to protect any member of this CNS30-triplicate,
according to the conventions discussed in "Redundancy Group" on page 3–48 and
"Redundancy Client" on page 3–57 in Chapter 3.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
OC-3 TDM Interface Subsystem Managing the GSX
Figure 6–12 shows how the above hardware elements are positioned in a GSX9000 chassis:
Adapter
Modules
Midplane
Server
Modules
Slots 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
CNS30 (3)
The CNA33 adapter module provides the OC3 interface to the SONET network (a second CNA33
is available for failure protection). This adapter includes an optical interface, a SONET framer/
overhead processor device, and reference clock distribution logic.
To distribute the three T3 streams from a single CNA33 network adapter to the three CNS30
modules, an SMP10 is utilized. The SMP10 physically plugs into three adjacent slots in the GSX
midplane, and the CNA33 network adapter cards plug directly into the SMP10.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX OC-3 TDM Interface Subsystem
You specify this subsystem by using the CREATE SERVER .. HWTYPE CNS30 .. with the
ADAPTER cna33 parameter. The SLOT must be the left-most (or originating) slot occupied by the
CNS30-triplicate.
All three CNS30s, two CNA33s, two SONET Interfaces, and an Automatic Protection Switching
(APS) group to support SONET channel redundancy are configured by the single CREATE SERVER
.. command described above.
To create and activate an OC-3 TDM subsystem that occupies slots 5-7:
% CREATE SERVER SHELF 1 SLOT 5 HWTYPE cns30 ADAPTER cna33
% CONFIG SERVER SHELF 1 SLOT 5 STATE enabled
% CONFIG SERVER SHELF 1 SLOT 6 STATE enabled
% CONFIG SERVER SHELF 1 SLOT 7 STATE enabled
The default name of the SONET port is SONET-shn-sln-ptn, where shn is the shelf number, sln
is the slot number of the originating (or left-most) server slot in the triplicate, and ptn is the port
number. The CNA33 behind the originating slot (the right-most slot when facing the adapter
modules) always takes port number 1. The CNA33 behind the center slot of the triplicate always
takes port number 2. For example, SONET-1-5-1 identifies the SONET port on a CNA33 module
residing in slot 5 behind a CNS30-triplicate that occupies slots 5-7. SONET-1-5-2 identifies the
SONET port on the CNA33 module in slot 6. Note that adapter slot 7 in the above example will
never be occupied. If the triplicate contains only one CNA33, it may reside in slot 5 or 6, but its
SONET Interface will always be named according to the above conventions.
The command sequence above that created the OC-3 TDM subsystem also created, as a side effect,
the SONET Interfaces SONET-1-5-1 and SONET-1-5-2. These objects may be configured and
interrogated as discussed in "SONET Interface" on page 3–1052.
The default name of the CNA33 APS group is APS-shn-sln-ptn, where shn is the shelf number,
sln is the slot number of the originating (or leftmost) CNS30 in the CNS30-triplicate, and ptn is
the port number (always 2) of the second CNA33 in the OC-3 TDM module set. Port number 2, as
noted above, is located on the CNA33 behind the CNS30 in the middle slot of the triplicate. For
example, APS-1-5-2 identifies the redundant SONET network that connects to ports 1 and 2 on
the CNS30/CNA33 module set that originates in slot 5 of shelf 1 and occupies slots 5-7, as in the
above example.
If your OC-3 TDM subsystem contains only one physical CNA33, then you must not further
configure the APS Group. Although the APS Group was created by default, your system does not
have the hardware that is necessary to provide APS.
If two CNA33s are present, you may proceed with the configuration of the APS Group as
discussed in "Automatic Protection Switching (APS) Interface" on page 3–1064.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using SNMP Managing the GSX
Using SNMP
You may use the Simple Network Management Protocol (SNMP) to create, configure, and access
management objects. In order to use SNMP you must create and configure a management client
through the CLI. After properly carrying out this procedure, you will be enabled for subsequent
access to management objects through SNMP. This procedure is a security measure that prevents
unauthorized access to management objects through SNMP. See "Management Client" on page 3–
75.
The files below assist the implementation of a Network Management System (NMS) to manage
GSXs. These files reside in the /sys subdirectory within the GSX system tree (see Figure 6–15
on page 6–91).
marlinMib.sum
This file contains a summary of all SNMP MIB Objects that are supported by the GSX. It specifies
the name, type, access and description of each MIB object. The purpose of this file is to assist with
the integration of GSX support into a custom NMS.
marlinTraps.sum
This file contains a summary of all SNMP Notifications (that is, traps) that are supported by the
GSX. It specifies detailed information about each Notification and its associated event that appears
in the Event Log. The purpose of this file is to assist with the integration of GSX support into a
custom NMS.
ovLoadMibs
This file contains a list of UNIX commands that will load the Sonus GSX MIB objects into a
particular NMS, the Hewlett-Packard OpenView Network Node Mananger (HP-NNM). The
xnmloadmib application, within HP-NNM, is used to load the MIB objects individually. Refer to
the xnmloadmib HP-NNM man page for more information about the use of this application.
sonusTrapd.conf
This file contains definitions of all SNMP Notifications that are supported by the GSX. The file is
loaded into HP-NNM to provide customization for its Alarm Browser application. The definitions
within this file specify how SNMP Trap and InformRequest PDUs that are received by HP-NNM
are displayed in the Alarm Browser application.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Using SNMP
NOTE
In HP-NNM 6.0, the Event Browser application was renamed to Alarm Browser.
Consequently, if sonustrapd.conf is to be loaded into earlier versions of HP-
NNM, all occurrences of “Error Alarms” within this file will have to be replaced with
“Error Events” before it can be successfully loaded.
This action updates trapd.conf, the central repository for alarm definitions.
To force all HP-NNM processes, including the Alarm Browser application, to reread
trapd.conf, execute the command:
xnmevents -event
Refer to the trapd.conf and xnmevents HP-NNM man pages for more information about these
files and applications.
See the Sonus Alarm Troubleshooting Guide for all GSX traps and the full MIB name of the trap.
See the referenced MIB source file for further detail.
See the Sonus Alarm Troubleshooting Guide for all PSX, EMS, and DSI trap MIB names. These
traps cannot be configured through SNMP.
See the Sonus Alarm Troubleshooting Guide for all SGX trap MIB names. These traps cannot be
configured through SNMP.
SNMPv1 network management applications must load only MIBs that are defined in Structure of
Management Information version 1 (SMIv1). SNMPv2 network management applications should
load only MIBs that are defined in SMIv2.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using SNMP Managing the GSX
Load the Sonus MIBs into a Network Management in the following order:
NOTE
The RFC2514 MIB (ATM-MIB) that is shipped with the GSX software may fail to
compile in SNMP Research's Brass Agent MIB compiler. The reason for this
possible failure is that the atmMIB MIB object is defined in both RFC2514 and
RFC2515 in order to prevent other vendors' MIB compilers from failing. SNMP
Research's MIB compiler interprets the duplicate, though equivalent definitions as
a conflict, thus causing the failure. To overcome this problem, use the -i option
with mgrtool to allow the MIB compiler to ignore the conflicting MIB object
definitions.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Using SNMP
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using SNMP Managing the GSX
5. Load order dependant Sonus PSX Policy Server MIBs, replacing any existing
versions. If the GSX MIBs were just loaded, load only the last four PSX MIBs below
(beginning with sonusSsTc.mib).
6. Load Sonus SGX and Sonus Insight MIBs, replacing any existing versions. The MIB
file below is included in InsightAllMibs.tar under path ./GATEWAY/agent/
mib/SMIv(1 or 2).
NOTE
Refer to your Network Management System documentation for the specific
instructions for loading all of the above MIBs.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Verifying ISUP Circuits
You may verify one or more ISUP circuits between the near and far-ends through the CLI. Sonus
provides facilities to:
Circuit Conformance
The ISDNUP Call Setup Test suite is described in Bellcore GR-905-CORE. The Circuit
Validation Test (CVT) and the Circuit Query Message (CQM) are among the defined tests. These
tests effectively request a far end accounting of the ISUP circuit’s:
• configuration(CVT)
• status (CQM)
A pair of CLI SHOW commands initiate CVT and CQM sequences into the SS7 network. The
configuration is returned via a Circuit Validation Response message (CVR). The status is returned
via a Circuit Query Response message (CQR). If the SS7 signaling point that receives these
sequences is configured accordingly, the tests will proceed and the circuit status and configuration
at the remote end will be displayed on your console.
In the first form, the CVT is sent to the far end and the results are returned and displayed. In the
second form, the CVT is sent to the far end and the result of the CVT is stored by the GSX
software, but not displayed. To retrieve and display the stored result, add the CURRENT option to
the first command form:
This command (3.) may also be used to retrieve and display the result that was obtained from
command (1.), without initiating another CVT at the far end.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Verifying ISUP Circuits Managing the GSX
In the example below, the CVT is issued for CIC 10000 in the ss72 ISUP service group:
% SHOW ISUP CIRCUIT SERV ss72 CIC 10000 FAREND ADMIN
Node: TPUBS Date: 2002/12/04 16:24:31 GMT
Zone: GMTMINUS05-EASTERN-US
You can also initiate the same CVT as above with the command:
% CONFIGURE ISUP CIRCUIT SERV ss72 CIC 10000 FAREND TEST cvt
After sending the CVT to the far end, you would retrieve the result of that command by adding the
CURRENT option to the SHOW command:
% SHOW ISUP CIRCUIT SERV ss72 CIC 10000 FAREND CURRENT ADMIN
Node: TPUBS Date: 2002/12/04 16:35:44 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Verifying ISUP Circuits
In both cases, the displayed result indicates the CVT was successful, CIC control at the far-end is
NOCICS, a continuity test is performed on each call, and so on. Rcvd Trunk Number, Local
Trunk Number, OfficeA, OfficeZ, and Location are optional parameters that have not been
set at the far-end.
The following example shows another successful CVT response, this time with most optional
parameters present:
% SHOW ISUP CIRCUIT SERV ss71 CIC 1000 FAREND ADMIN
Node: TPUBS Date: 2002/12/04 16:24:31 GMT
Zone: GMTMINUS05-EASTERN-US
If command form (3.) is issued after the GSX software has sent a CVT and is awaiting a CVR
response, then an asterisk (“*”) is displayed next to the CIC number:
% SHOW ISUP CIRCUIT SERV ss71 CIC 1250 FAREND CURRENT ADMIN
Node: TPUBS Date: 2002/12/04 16:34:31 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Verifying ISUP Circuits Managing the GSX
If command form (3.) is issued after the GSX software has sent a CVT but has timed out awaiting
the CVR response, the Number of Failed Retries is incremented as follows:
% SHOW ISUP CIRCUIT SERV ss71 CIC 1250 FAREND CURRENT ADMIN
Node: TPUBS Date: 2002/12/04 16:34:31 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Verifying ISUP Circuits
In the first form, the CQM is sent to the far end and the results are returned and displayed. In the
second form, the CQM is sent to the far end and the result of the CQM is stored by the GSX
software, but not displayed. To retrieve and display the stored result, add the CURRENT option to
the first command form:
This command (3.) may also be used to retrieve and display the result that was obtained from
command (1.), without initiating another CQM at the far end.
In the example below, the CQM is issued for CIC 2000 in the ss72 ISUP service group:
% SHOW ISUP CIRCUIT SERV ss72 CIC 2000 FAREND STATUS
Node: TPUBS Date: 2002/11/14 18:28:13 GMT
Zone: GMTMINUS05-EASTERN-US
The displayed result indicates the CQM was successful and that the circuit is available (unblocked)
at both ends. The forced retrieval of the far end status displays the same result in a similar format:
% SHOW ISUP CIRCUIT SERV ss72 CIC 2000 FAREND CURRENT STATUS
Node: TPUBS Date: 2002/12/04 17:24:59 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Verifying ISUP Circuits Managing the GSX
The near end circuit status may also be displayed by a local SHOW .. STATUS command as
illustrated below:
% SHOW ISUP CIRCUIT SERV ss72 CIC 2000 STATUS
Node: TPUBS Date: 2000/11/14 18:28:13 GMT
Zone: GMTMINUS05-EASTERN-US
Notice that this result agrees with the CQM initiated result, as expected.
If command form (3.) is issued after the GSX software has sent a CQM and is awaiting a CQR
response, then an asterisk (“*”) is displayed next to the CIC number:
% SHOW ISUP CIRCUIT SERV ss72 CIC 2000 FAREND CURRENT STATUS
Node: TPUBS Date: 2005/01/25 22:39:23 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Verifying ISUP Circuits
If command form (3.) is issued after the GSX software has sent a CQM but has timed out awaiting
the CQR response, the Number of Failed Retries is incremented as follows:
% SHOW ISUP CIRCUIT SERV ss72 CIC 2000 FAREND CURRENT STATUS
Node: TPUBS Date: 2005/01/25 22:39:23 GMT
Zone: GMTMINUS05-EASTERN-US
Table 6–7 lists the set of far end circuit status that may be reported by the Circuit Query Message.
Note that in this nomenclature, LOCAL indicates the far end local, and REMOTE indicates the far
end remote, or near end.
Status Explanation
NORESPONSE No CQR was detected, indicating a possible
configuration error.
TRANSIENT The circuit is in an intermediate state, for example,
“Releasing”.
UNEQUIPPED The circuit is unequipped at the far-end.
INBUSYACTIVE The circuit has an active call inbound.
INBUSYLOCALBLOCKED The circuit has an inbound call and has been
administratively blocked at the far end.
INBUSYREMOTEBLOCKED The circuit has an inbound call and has received a
blocking notification from the near (or our) end.
INBUSYLOCALREMOTEBLOCKED The circuit has an inbound call and has been
administratively blocked at the near and far end.
OUTBUSYACTIVE The circuit has an active call outbound.
OUTBUSYLOCALBLOCKED The circuit has an outbound call and has been
administratively blocked at the far end.
OUTBUSYREMOTEBLOCKED The circuit has an outbound call and has received a
blocking notification from the near (or our) end.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Verifying ISUP Circuits Managing the GSX
Status Explanation
OUTBUSYLOCALREMOTEBLOCKED The circuit has an outbound call and has been
administratively blocked at the near and far end.
IDLE The circuit has no calls active.
IDLELOCALBLOCKED The circuit does not have a call and has been blocked
at the far end.
IDLEREMOTEBLOCKED The circuit does not have a call and has received a
blocking notification from the near (or our) end.
IDLELOCALREMOTEBLOCKED The circuit does not have a call and has been
administratively blocked at the near and far end.
NOTAVAILABLE The circuit has not yet registered with the SGX.
NOTE
The SS7 signaling point must be properly set up to receive the CVT/CQM
messages or an error will result from these SHOW commands. The setup within
the SS7 network is beyond the scope of this guide.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Verifying ISUP Circuits
You may initiate a continuity check procedure on one or more idle, blocked circuits between the
GSX and the far-end switch of the circuit via the command:
% CONFIG ISUP CIRCUIT SERVICE icsname CIC cicrange MODE cot ..
TIMEOUT timeout
By omitting the TIMEOUT parameter, you force the continuity check to run until it succeeds or is
aborted. See "ISUP Circuit" on page 3–848 for additional detail about this command, including
how to place circuits into blocked operational state.
To run a COT for up to five minutes on CIC 6000 in ISUP service group ss72, enter the
command:
% CONFIG ISUP CIRCUIT SERVICE ss72 CIC 6000 MODE cot TIMEOUT 5
indicates that the transitional operational state of COT (MODE) was the last operational state that
was specified and that the result of the COT was PASS (Man Cot). Table 6–8 lists the meanings
of all values that may be displayed in Man Cot.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Verifying ISUP Circuits Managing the GSX
The interactions that make up the continuity check procedure are discussed below.
At the start of the procedure, the GSX directs the SGX to send a Continuity Check Request
message (CCR) to the far-end switch. This message requests the far-end to connect:
The GSX connects a transceiver to the circuit, and waits time interval TCCR (2 seconds) for a Loop
Back Acknowledgement message from the far-end switch that either a check-loop or a transponder
has been connected.
(If the acknowledgement does not arrive within TCCR , the transceiver is removed and a Man Cot
of LPA_F will be displayed.)
When the LPA message arrives before TCCR expires, the GSX sends a check tone on the circuit.
When the backward tone is detected within time interval T24 (2 seconds), the GSX removes the
tone. Then when the backward tone disappears within T24, the procedure is considered a success.
The GSX removes the transceiver, returns the circuit to idle, executes a Release (REL) procedure,
and executes a Release Complete (RLC) procedure. Man Cot will be PASS.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Verifying ISUP Circuits
TIME
GSX/SGX
Loop back
CCR tone on the
circuit
Tccr T24
If no backward tone in the specified frequency range comes back before T24 expires, the GSX
directs the SGX to send a COT with a failure indication to the far-end switch. A trap message
reporting the failure is sent after the first but not after any subsequent failures. When time interval
T26 (1-3 minutes) expires, the GSX initiates a subsequent check beginning with the CCR message.
These repeated checks terminate under one of three circumstances:
NOTE
If the GSX receives an IAM on a circuit for which it has already sent out a CCR, the
GSX will resend a Blocking Message (BLO) to direct the far-end switch to retry the
call on another circuit. Either a BLO or Circuit Group Blocking Message (CGB) had
been sent to place the circuit in blocked before the check was initiated.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Verifying ISUP Circuits Managing the GSX
TIME
Tone Tone
not not
detected detected
GSX/SGX
CCR
T26 Subsequent
Retry
Tccr T24
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Announcements
Announcements
You may direct the GSX to play announcements on PSTN circuits. The initiation of an
announcement sequence is controlled by either the PSX Policy Server or a third party MGCP
softswitch. The softswitch selects an announcement file residing in the GSX system tree. This tree
is illustrated in Figure 6–15. This section describes the procedures for adding, deleting, and
modifying announcements. The message sequence for playing announcements under the control of
a third party MGCP softswitch is described in detail. See the PSX Policy Server Provisioning Guide
for detail on playing announcements under the control of the PSX.
Announcement Files
Each announcement file is a Waveform Audio File Format file (.wav) that is “played” according to
controls that are embedded in the announcement command sequence. Many widely available tools,
such as Windows Sound Recorder, can record .wav files.
As part of configuring the GSX, you create your own announcement files using any tool that
records .wav files according to the file format specifications and naming requirements listed
below. As you record your announcements and place them in these directories, you should keep a
list of the file name and contents of each announcement. You will need this list when you wish to
delete or update an announcement file.
You must store the .wav files in the announcements/preload and announcements/
ondemand subdirectories under the base directory, as shown in Figure 6–15, GSX System Tree on
page 6–91. The files in preload are read by the GSX when it is booted and then cached locally
on each CNS module on the GSX9000 and the GNS module on GSX4000 series switch. The files
in ondemand are not read until a request to play a particular announcement is received from the
softswitch. At the time of this request the file is retrieved and cached locally on the CNS or GNS
module that will play it.
where XXX is the announcement ID in decimal and must be in the range 1- 65535. Zero is not a
valid announcement ID and leading zeros are not valid in the announcement ID field in the
announcement file name. For example, s134.wav is valid but s004.wav is not a valid name.
NOTE
Under Sonus SoftSwitch control, this ID is specified in the Service Information
Building Block (see "Playing Announcements under Sonus SoftSwitch Control" on
page 6–96).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Announcements Managing the GSX
The CNS or GNS module caches up to 34 minutes of announcements. Therefore, the total time for
the .wav files (one or more) stored in the CNS or GNS module cache may not exceed 34 minutes
(2048 seconds). Sonus Networks recommends a .wav file size of five minutes. Then, if each
.wav file size is five minutes, the CNS or GNS module will be able to cache up to six
announcements.
After you record a .wav announcement file, you may use the Sonus utility program,
verifyAnnFile, to validate your file. This program is found at GSX9000/<Version#>/
verifyAnnFile on the distribution media. Sonus suggests that you install this program in /
announcements in the GSX System Tree (see Figure 6–15).
You may thereafter invoke it to determine whether or not a file will play properly on the GSX. The
command syntax for the utility is:
verifyAnnFile filename [-v]
where -v is an optional verbose flag that causes all applicable format fields to be printed. An
example of a non-verbose file validation is:
> verifyAnnFile s32.wav
Segment ID: 32
Announcement File Status: VALID
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Announcements
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Announcements Managing the GSX
/ announcements
/ preload
*.wav
/ ondemand
*.wav
/ evlog
/ SerialNumber (Serial Number of GSX Midplane)
/ ACT
*.act
/ DBG
*.dbg
/ TRC
*.trc
/ SYS
*.trc
/ security
*.p12
/ coredump
core.*
/ cli
/ sys
screens_gsx9000.sda or screens_gsx4000.sda
sysinit.tcl
sessinit.tcl
login.txt
banner.txt
*.tcl
/ scripts
*.tcl
/ logs
/ SerialNumber
sysinit.tcl.out
/ param sysinit.tcl.out.last
*.prm
*.bck
*.diff
/ images
mns10.bin gns15.bin
cns10.bin or gns15b.bin
pns10.bin
.
cns30.bin
.
.
/ security
*.der
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Announcements
Sonus provides prerecorded announcement files that allow the PSX/GSX “seeded” scripts to work
“out-of-the-box”. By executing these scripts, you can verify that the system is playing
announcements properly. These announcement files are provided on the GSX software CD. You
can replace these prerecorded announcements if you want to customize the voice or localize the
language, however the message or prompt should be the equivalent.
These filenames and the corresponding announcement IDs used in GSX scripts are “reserved” for
audio messages. Certain PSX applications assume their presence under those names. For example,
file s10002.wav will be sought when announcement ID 10002 is encountered in a GSX script.
The announcement ID and filename ranges shown in Table 6–10 are reserved for Sonus
prerecorded announcement files that will be populated as necessary to support the scripts seeded in
the PSX.
Announcement ID
Filename Range Range Audio Message Purpose
s1xx.wav 1xx Services Announcements
s2xx.wav 2xx Application Announcements
s9xx.wav 9xx
s100xx.wav 100xx Infodigit Announcements
Services Announcements
Table 6–11 shows the announcement IDs and filenames used to provide services announcements.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Announcements Managing the GSX
Application Announcements
Table 6–12 lists the announcement IDs and filenames used by Conversational TCAP, VPN, and
other applications on the PSX/GSX.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Announcements
Infodigit Announcements
During a Conversational TCAP application a series of infodigit announcements may be requested
of the Sonus Softswitch by the SS7 Service Control Point (SCP).
Table 6–13 lists the announcement IDs and filenames dedicated to infodigit announcements.
Announceme Audio
Filename nt ID Message
s10000.wav 10000 “0”
s10001.wav 10001 “1”
s10002.wav 10002 “2”
s10003.wav 10003 “3”
s10004.wav 10004 “4”
s10005.wav 10005 “5”
s10006.wav 10006 “6”
s10007.wav 10007 “7”
s10008.wav 10008 “8”
s10009.wav 10009 “9”
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Announcements Managing the GSX
Updating Announcements
You can remove announcements from system memory by simply deleting the corresponding file
from NFS.
To determine which file to delete, refer to the list of announcement file names and contents that
you created when you originally recorded the announcement files and placed them in the NFS
directories.
To update an announcement file, copy a new file to the same filename and directory of the
announcement being replaced. The GSX checks the preload and ondemand directories for
deletions and modifications every 600 seconds.
When the GSX detects that an announcement file has been removed, the GSX flushes the
announcement from all CNS or GNS modules which have the announcement loaded. If a CNS/
GNS is actively playing the announcement, then the flush will be postponed until all playback has
completed.
When an announcement file's last modification time changes (that is, the file has been replaced),
then the old file version is flushed in the manner described above. Once the old version has been
flushed from a given CNS or GNS module, the new version will be loaded onto the same module.
NOTE
If a new announcement file has the same modification time as the file being
replaced, the GSX will not recognize the change. If this happens, then use the UNIX
touch command to change the new file's last modification time.
Once a CNS or GNS module's announcement memory is full, a new announcement will force the
least recently used segment(s) to be flushed from CNS/GNS memory to make room for the new
file, unless all loaded segments are busy as discussed below. No user intervention is necessary.
If memory is full and all loaded segments are playing, then no segments will be flushed.
In this scenario under MGCP control, an RQNT command that requests the playing of an
announcement that is not currently loaded in memory will be rejected. In addition, a major event
will be logged to the system event log file (evlog/SYS/*.SYS). This message format is:
...MAJOR .ARMA : Shelf 1, Slot 7: Segment Memory is Full, cannot load
SegId:16, Len:40000
In this scenario under Sonus SoftSwitch control, the same major ARMA event shown above is
logged. In this case however, call processing will continue; the call is not released because of the
inability to play an announcement.
You should periodically remove obsolete or unused announcements from the announcements
directories to ensure minimal announcement playback latency.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Announcements
The maximum number of simultaneous announcements that can be played depends on the module
type. The number of simultaneous announcements being played does not affect the traffic handling
capacity of the GSX.
Table 6–14 lists the maximum number of simultaneous announcements that can be played by each
type of CNS, SPS70, and GNS module.
In a Sonus SoftSwitch controlled environment, the announcement is part of one of the services that
is configured on the PSX Policy Server. For each service to be supported, you must create a script
using the Sonus Script Creation Tool. If that service requires an announcement, you must add that
component or Service Information Building Block (SIBB) to the script. When a policy request is
made of the PSX by the GSX, this script is part of the policy response returned by the PSX, for
execution on the GSX. Announcement caching, updating, and memory flushing are handled as
discussed above.
For details on configuring PSX Policy Server services to include announcements, see the PSX
Policy Server Provisioning Guide.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
MGCP Continuity Tests Managing the GSX
Single tone and dual tone continuity tests may be performed on media gateway circuits as
determined by the Circuit Service Profile to which the circuit is bound. The default Circuit
Service Profile results in single tone continuity tests.
NOTE
This functionality is not available for GSX4000 series switches in this release.
1. Create a new Circuit Service Profile (dualtone), or use the default profile (single
tone).
2. Configure the CONTINUITYTEST TYPE parameter appropriately (dualtone).
3. Enable the profile for dualtone (the default profile is enabled by the GSX
software):
4. Configure the media gateway circuits to use the new or default profile.
5. Enable the media gateway circuits.
6. Connect the media gateway circuits to be tested appropriately.
7. Issue the necessary commands to each circuit to initiate the continuity tests.
End of Procedure
The steps necessary to generate a dual tone continuity test are elaborated in the following example.
If the second test circuit is also controlled by a GSX9000, then remote4wire is the required
CONTINUITYTEST TYPE parameter value. This value must be remote4wire or remote2wire
according to the T1 termination cabling at the second switch.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX MGCP Continuity Tests
Once the new profile is activated, you need to configure a pair of T1 test circuits to use this profile.
The commands below create and configure the T1 circuits T1-1-3-1 and T1-1-3-2
appropriately:
% CREATE MEDIA GATEWAY CIRCUIT PORT T1-1-3-1 CHANNEL 1-24
% CONFIGURE MEDIA GATEWAY CIRCUIT PORT T1-1-3-1 CHANNEL 1-24 ..
SERVICEGROUPNAME mgcptest
% CONFIGURE MEDIA GATEWAY CIRCUIT PORT T1-1-3-1 CHANNEL 1-24 ..
MODE unblocked
% CONFIGURE MEDIA GATEWAY CIRCUIT PORT T1-1-3-1 CHANNEL 1-24 ..
SERVICEPROFILENAME dualtone
% CREATE MEDIA GATEWAY CIRCUIT PORT T1-1-3-2 CHANNEL 1-24
% CONFIGURE MEDIA GATEWAY CIRCUIT PORT T1-1-3-2 CHANNEL 1-24 ..
SERVICEGROUPNAME mgcptest
% CONFIGURE MEDIA GATEWAY CIRCUIT PORT T1-1-3-2 CHANNEL 1-24 ..
MODE unblocked
% CONFIGURE MEDIA GATEWAY CIRCUIT PORT T1-1-3-2 CHANNEL 1-24 ..
SERVICEPROFILENAME dualtone
Assuming that a connection between the T1s that correspond to T1-1-3-1 and T1-1-3-2 is in
place, the softswitch must next successfully issue a Set Group of Channels to a Given Status (SCS)
message to T1-1-3-2. This message specifies a status of Loopback. Upon its successful
completion, the softswitch must issue a Prepare Channel for Continuity Test (PCT) message,
followed by a Start Continuity Test Procedure (SCT) message, to T1-1-3-1. The dual tone
continuity test will be initiated when the SCT message is received by the GSX. The GSX will
respond to the SCT with a Continuity Test Result (ASCT) message upon completion of the test.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Call Support Through the Sonus SoftSwitch Managing the GSX
PRI ISDN connections between the GSX and an ISDN switch are supported through a Sonus
SoftSwitch, as depicted in Figure 6–16, and discussed in "Adding an ISDN PRI" on page 6–100.
10/100M Ethernet
Sonus
SoftSwitch
GSX9000
ISDN Switch
B-channels
D-channel MNA10
PRI CNA10 IP
PNA10
(T1)
100M Ethernet
ISDN PRIs may be combined to form a Non-Facility-Associated Signaling (NFAS) group. You
must provide backup D-channel support by assigning at least two PRIs to the NFAS group. This
setup is discussed in "Adding an ISDN NFAS Group" on page 6–105.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX ISDN Call Support Through the Sonus SoftSwitch
Each ISDN 23B+D PRI occupies a T1 span on a CNA30/CNA10 on the GSX9000 and the
GNA10 module on a GSX4010 switch. Each ISDN B-channel and D-channel uses a channel on
this span. The Sonus SoftSwitch can route the call into the IP network through the GSX. Such a
call would be routed to a remote (Sonus SoftSwitch controlled) GSX that is similar in function and
configuration to this one.
• The name that you will assign to the ISDN service that you will bind to this PRI line.
• The name of the trunk group that you will bind to the above service.
• The name of the T1 span that carries the PRI line to the GSX.
• The ISDN Interface (logical PRI or T1) that contains the primary D-channel for this ISDN
service.
• The switch side that the ISDN service should act as, either “network” or “user” (usually
determined by the configuration of the ISDN switch).
• The network switch type that the ISDN service will emulate.
The following example illustrates the configuration sequence. Default values are installed for all
parameters that are not explicitly set.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Call Support Through the Sonus SoftSwitch Managing the GSX
The configuration of the ISDN service isdnserv1 may be displayed with the command:
% SHOW ISDN SERVICE isdnserv1 ADMIN
Node: TPUBS Date: 2000/02/07 22:12:08 GMT
Zone: GMTMINUS05-EASTERN-US
----------------------------------------------------
Trunk Group : tg1
ISDN Service: isdnserv1 State: ENABLED Mode: INSERVICE
Default Directory Number :
Calling Party Number Provision : NECESSARY
Calling Party Number Discard : NO
Calling Party Number Delivery : YES
Calling Party Subaddress Transfer : YES
Calling Party Subaddress Delivery : YES
B-channel Availability Signaling : YES
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX ISDN Call Support Through the Sonus SoftSwitch
The status of the ISDN service isdnserv1 may be displayed with the command:
% SHOW ISDN SERVICE isdnserv1 STATUS
Node: TPUBS Date: 2000/02/07 22:27:55 GMT
Zone: GMTMINUS05-EASTERN-US
----------------------------------------------------
Trunk Group : outpri Mode: INSERVICE
ISDN Service: isdnserv1 Mode: INSERVICE Status: AVAILABLE
Bchannels Configured: 23 Available: 23
NOTE
ISDN service group status (like the example above) is only available after the
primary D-channel Interface is enabled and the CNS server module that drives that
interface is also running.
The configuration of Interface 0 of the ISDN service isdnserv1 may be displayed with the
command:
% SHOW ISDN INTERFACE SERVICE isdnserv1 INTERFACE 0 ADMIN
Node: TPUBS Date: 2000/02/07 23:03:20 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Call Support Through the Sonus SoftSwitch Managing the GSX
The configuration of the B-channels assigned to Interface 0 of the ISDN service isdnserv1 may
be displayed with the command:
% SHOW ISDN BCHANNEL SERVICE isdnserv1 INTERFACE 0 BCHAN ALL ADMIN
Node: TPUBS Date: 2000/02/07 23:14:53 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX ISDN Call Support Through the Sonus SoftSwitch
The status of the B-channels assigned to Interface 0 of the ISDN service isdnserv1 may be
displayed with the command:
% SHOW ISDN BCHANNEL SERVICE isdnserv1 INTERFACE 0 BCHAN ALL STATUS
Node: TPUBS Date: 2000/02/07 23:14:53 GMT
Zone: GMTMINUS05-EASTERN-US
NOTE
The Remote B-channel status is as polled from the ISDN switch.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Call Support Through the Sonus SoftSwitch Managing the GSX
An NFAS group may consist of up to 12 or 28 T1 spans, one of which must be a 23B+D PRI for
the primary D-channel. The limit is 12 if the primary D-channel is driven by a CNS10. The limit is
28 if the primary D-channel is driven by a CNS30/CNS31. Sonus recommends that you allocate a
second PRI for a backup D-channel, driven by the same CNS server module as the primary D-
channel. The remaining T1 spans are each capable of utilizing all 24 B-channels, with all signaling
handled by the primary (or if necessary the backup) D-channel. Each of these spans making up the
NFAS group is configured as an ISDN Interface and is numbered in the range 0-28. These T1
spans need not be connected to the same CNS server module as the PRI(s), as discussed
subsequently in this section.
10/100M Ethernet
Sonus
SoftSwitch
GSX9000
ISDN Switch
PRI (T1)
PRI (T1)
(T1)
MNA10
CNA10
PNA10
IP
100M Ethernet
Figure 6–17 depicts an NFAS group on a GSX9000, made up of three interfaces. Each NFAS
group must contain at least one PRI containing the primary D-channel. A second PRI is
recommended for the backup D-channel. To configure your GSX for this environment, you must
know all of the information listed earlier for each ISDN PRI. Additionally, you must know the
interface that will contain the primary D-channel and the interface that will contain the backup D-
channel. You will typically assign Interface 0 to the primary D-channel and Interface 1 to the
backup D-channel.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX ISDN Call Support Through the Sonus SoftSwitch
The configuration commands below explicitly make these assignments using the T1 spans T1-1-
14-1, T1-1-14-2, and T1-1-14-3 after creating the service group isdnserv1. The trunk group
tg1 is assigned to isdnserv1 and the service group is enabled. The T1 spans are assigned to
Interfaces 0, 1, and 2. The primary and backup D-channels are put into service. Finally, each
Interface is enabled and the B-channels on each are enabled and put into service.
% CREATE ISDN SERVICE isdnserv1
% CONFIGURE ISDN SERVICE isdnserv1 TRUNK GROUP tg1
% CONFIGURE ISDN SERVICE isdnserv1 STATE enabled
% CREATE ISDN INTERFACE SERVICE isdnserv1 INTERFACE 0
% CONFIGURE ISDN INTERFACE SERVICE isdnserv1 INTERFACE 0 ..
PORT T1-1-14-1
% CREATE ISDN INTERFACE SERVICE isdnserv1 INTERFACE 1
% CONFIGURE ISDN INTERFACE SERVICE isdnserv1 INTERFACE 1 ..
PORT T1-1-14-2
% CREATE ISDN INTERFACE SERVICE isdnserv1 INTERFACE 2
% CONFIGURE ISDN INTERFACE SERVICE isdnserv1 INTERFACE 2 ..
PORT T1-1-14-2
% CONFIGURE ISDN SERVICE isdnserv1 BACKUP DCHANNEL MODE inService
% CONFIGURE ISDN INTERFACE SERVICE isdnserv1 INTERFACE 0 ..
STATE enabled
% CONFIGURE ISDN BCHANNEL SERVICE isdnserv1 INTERFACE 0 ..
BCHANNEL 1-23 STATE enabled
% CONFIGURE ISDN BCHANNEL SERVICE isdnserv1 INTERFACE 0 ..
BCHANNEL 1-23 MODE inService
% CONFIGURE ISDN INTERFACE SERVICE isdnserv1 INTERFACE 1 ..
STATE enabled
% CONFIGURE ISDN BCHANNEL SERVICE isdnserv1 INTERFACE 1 ..
BCHANNEL 1-23 STATE enabled
% CONFIGURE ISDN BCHANNEL SERVICE isdnserv1 INTERFACE 1 ..
BCHANNEL 1-23 MODE inService
% CONFIGURE ISDN INTERFACE SERVICE isdnserv1 INTERFACE 2 ..
STATE enabled
% CONFIGURE ISDN BCHANNEL SERVICE isdnserv1 INTERFACE 2 ..
BCHANNEL 1-24 STATE enabled
% CONFIGURE ISDN BCHANNEL SERVICE isdnserv1 INTERFACE 2 ..
BCHANNEL 1-24 MODE inService
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Call Support Through the Sonus SoftSwitch Managing the GSX
Figure 6–18 depicts an NFAS group with 4 interfaces that uses Interface 0 as the primary D-
channel and Interface 1 as the backup D-channel.
10/100M Ethernet
Sonus
SoftSwitch
PRI (T1)
ISDN Switch PRI (T1) GSX9000
B-channels
B-channels
(T1)
(T1)
CNA10 MNA10
PNA10 IP
100M Ethernet
The T1 spans that belong to a single NFAS group may be connected to more than one CNS/CNA
module set, as depicted in Figure 6–19, ISDN NFAS Group across CNS/CNA Modules on a
GSX9000 on page 6–108.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX ISDN Call Support Through the Sonus SoftSwitch
10/100M Ethernet
Sonus
SoftSwitch
GSX9000
ISDN Switch
PRI (T1)
PRI (T1)
(T1)
CNA10 MNA10
IP
CNA10
PNA10
100M Ethernet
PRI ISDN connections between the GSX and a Euro-ISDN switch are also supported by the Sonus
SoftSwitch. However, because NFAS is not part of the Euro-ISDN specification, NFAS groups are
not supported between the GSX and a Euro-ISDN switch.
This section, using the examples and illustrations from "Adding an ISDN PRI" on page 6–100,
describes procedures and considerations for adding a Euro-ISDN PRI by replaying the referenced
procedure and examining the steps that differ in the Euro-ISDN procedure.
The PRI ISDN connection depicted in Figure 6–16 illustrates the Euro-ISDN connection except
that E1 spans make up the PRI instead of T1 spans. Hence the PRI (T1) depicted in Figure 6–16
would be replaced by a PRI (E1). Sonus CNS20 and CNS25 server modules support E1 spans, so
the CNA10 that is depicted would be replaced by a CNA20, CNA21, or CNA25. Since E1 spans
carry 31 channels, each ISDN PRI is a 30B+D. Finally, Euro-ISDN switches assign E1 channel 16
to the D-channel, instead of T1 channel 24.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISDN Call Support Through the Sonus SoftSwitch Managing the GSX
The following Euro-ISDN example is modeled after the example in "Adding an ISDN PRI" on
page 6–100. Default values are installed for all parameters that are not explicitly set below:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX ISDN Call Support Through the Sonus SoftSwitch
The configuration of the ISDN service isdneserv1 may be displayed with the command:
% SHOW ISDN SERVICE isdneserv1 ADMIN
Node: TPUBS Date: 2000/02/07 22:12:08 GMT
Zone: GMTMINUS05-EASTERN-US
----------------------------------------------------
Trunk Group : tg1
ISDN Service: isdneserv1 State: ENABLED Mode: INSERVICE
NOTE
B channel availability signaling is not supported by the Euro-ISDN switch.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Japan Call Support Managing the GSX
Sonus provides support for Japan’s ISDN Primary Rate Interface (PRI) variant INS-1500. The
Sonus implementation conforms to NTT Technical Reference Interface for INS NET Service:
By specifying a SWITCHTYPE of ins1500, you direct the GSX software to conform to the Japan
INS 1500 ISDN variant. See "ISDN Service Group" on page 3–901 for additional configuration
information.
By specifying a REVISION of nttcom, you direct the GSX software to conform to the NTTCom
variant of Japan ISUP. The Sonus implementation conforms to the following NTT ISUP
specifications:
See "ISUP Service Group" on page 3–746 for additional configuration information.
Sonus' PRI-PBX functionality extends GSX9000 Media Gateway support to Japan PBX
equipment and Remote Access Servers (RAS). For PSTN interconnection, the GSX allows calls to
be established between:
• Japan INS-1500 PRI and Japan ISUP
• Japan INS-1500 PRI and Japan INS-1500 PRI
• Japan INS-1500 PRI and ANSI NI-2 PRI
The GSX support is PRI standardized with Japan DSS1, supporting Japan PRI call origination and
termination of calls. Sonus' implementation conforms to NTT Technical Reference Interface for
INS NET Service Specifications.
The GSX implementation of Japan PRI includes support for the following supplementary services:
• Calling line identification presentation (CLIP) including forced CLIP
• Calling line identification restriction (CLIR)
• Sub-address (SUB)
• User-to-user signaling (UUS)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Japan Call Support
NOTE
If the protocol interworking between Japan ISUP and Japan ISDN mandates that
certain ISUP/ISDN parameters be set to specific values, the PSX configured values
may be overwritten by the values mandated by the interworking requirement.
NOTE
In an ISUP to ISDN call scenario, if a GroupReset (GRS) message is received from
the ISUP network, a DISCONNECT message is sent out to the ISDN side. However,
even if a Disconnect SSP or Disconnect Treatment with a specific cause number
has been configured to provide a tone/announcement for the ISDN service group,
the tone or announcement will not be played.
Sonus' Internet Offload solution has been extended to support INS-1500 to Japan ISUP signaling
interworking. The GSX9000 Media Gateway delivers Internet-bound traffic from the PSTN (NTT
ISUP) onto Japan PRI bundles for termination at the ISP's RAS facilities.
The following ISUP message types are identified in support of the Internet Offload solution.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Japan Call Support Managing the GSX
Pre-subscription functionality
Pre-subscription service provides carriers in Japan PSTN the ability to override the dialed carrier
access code with a pre-registered access code at an originating exchange, an intermediate national
exchange or a terminating exchange.
When a pre-subscription enabled exchange receives an IAM message with the Transit Network
Selection parameter containing its own carrier access code, it takes the following actions:
• If the call is a 3.1 kHz audio or speech, the pre-subscription enabled exchange returns an early
ACM. The exchange then provides an announcement to the caller specifying the carrier being
used for the call.
• If the destination is an ISUP circuit, the exchange discards the Transit network selection
parameter and sends the IAM to the succeeding exchange to continue the call.
• If the pre-subscription enabled exchange receives an ACM from the succeeding exchange, it
copies all the parameters of the ACM to a CPG message and sends the CPG to the preceding
exchange.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX CAS Services
CAS Services
Sonus Networks recommends configuration of the CAS objects in the order discussed in "CAS
Service Group" on page 3–1079. This section adds some considerations that apply to CAS call
services.
Ingress Calls
Each CAS service must define an ingress Signaling Sequence Profile (SSP) for incoming calls.
The ingress SSP is initiated when an incoming seizure/off-hook is detected on a CAS channel. If
no SSP is configured, the call will be cleared. When the SSP exists, it is executed sequence by
sequence. Each successful completion of a sequence moves processing to the next sequence. The
SSP may define when the call setup phase is complete by reporting a call setup. Once a call setup
is reported, SSP processing is terminated on this incoming call. This initiates normal call routing
and a cut-through of the call.
When an SSP sequence does not complete successfully, call handing is turned over to the
Signaling Condition Profile (SCP) in that sequence. This SCP may clear the call, continue
executing the current SSP, or invoke a new SSP. If the failure occurs in a sequence that does not
designate an SCP, the call is cleared with a default value of 127, Protocol Error Unspecified.
Egress Calls
Each CAS service must also define an egress SSP. This SSP is initiated when an outgoing call
request is made on a CAS channel. If no SSP is configured, the call will be cleared without any
network interactions.
When the SSP exists, it is executed sequence by sequence as above. If a sequence fails, the call
handling is turned over to the SCP to be cleared, continue executing the current SSP, or invoke a
new SSP as above. If the failure occurs in a sequence that does not designate an SCP, the call is
cleared with a default value of 127, Protocol Error Unspecified.
An egress SSP must perform wait for answer processing. It may perform timed answer
supervision, such that an answer timeout is considered an answer condition. If wait for answer is
not performed within the SSP and the call is not answered when the SSP completes, then a default
wait for answer is performed. The default processing of this automatic wait for answer should be
to issue a call progress message for the ingress call and wait for 30 seconds for an answer from the
far end. If there is no answer, the call will be cleared with a disconnect reason of “no user
responding”. If the SCP continues the SSP after an answer timeout condition, the call is considered
answered and the default wait for answer processing is not performed.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Services Managing the GSX
This egress SSP controls the propagation of call progress tones to the incoming caller. One of two
methods may be used:
• Cut-through the call and allow the caller to hear the tones from the far end
• Generate and provide the tones from the GSX
If the CAS service group used by the egress call has CPTONEPROV enabled, then a call progress
message is issued to the ingress call and a cut through is made after all dialing is complete.
If the CAS service group used by the egress call has CPTONEPROV disabled, then a call progress
message may be issued, but the cut through may not occur unless the ingress call service group has
CPTONEREQ disabled. If CPTONEREQ is enabled on the ingress call service group, then the cut
through must be delayed until an answer is received. Ring back tone will be generated locally until
the answer is received. The alert tone must be configured or the cut-through is made after dialing.
The alert tone should be set to “ring”.
This scenario is the same as the above, except that a call progress tone will not be provided back to
the incoming caller by the GSX. When a progress message is issued by the egress call SSP, a
corresponding message is issued to the ingress caller to indicate the presence or absence of in band
tones. If the egress call service group has CPTONEPROV enabled, the message will indicate in-
band tones are present; if CPTONEPROV is disabled, the message will indicate in-band tones are
absent. Similarly, when the egress call SSP reports an alerting message or attempts to clear a call
due to detecting a call progress tone, a corresponding message is issued to ingress call controller
indicating the presence/absence of in band tones.
The cut-through is controlled by the events reported by the egress call service group. If a progress
or alerting message is received which indicates the presence of in-band tones or if the ingress call
service group does not require call progress tones, then the cut-through can be performed when the
above messages are received. Otherwise, the GSX should provide ring back tone to the ingress
caller. The cut-through would occur after the connect (or other message indicating the presence of
in-band tones) is received. If the egress call service group clears the call (indicating the presence of
in-band tones), the cut-through will also be performed.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX CAS Services
• Line signaling - controls the supervisory state of a call (for example, onhook and offhook).
• Register signaling - transfers address and billing information (for example, calling and called
party).
CAS MFC R1 utilizes a robbed bit mechanism as the basis for its line signaling algorithms. In
robbed bit signaling, the signaling bits are contained within the DS0s of a T1. Depending on the
framing format being used on the T1, there are either 2 (A/B SF framing) or 4 (A/B/C/D ESF
framing) signaling bits per timeslot. There are numerous line signaling algorithms defined for T1
CAS. Register signaling is performed via MF or DTMF signals sent in stages.
CAS MFC R2 signaling operates over E1. Line signaling information is contained in a dedicated
timeslot (timeslot 16). Four signaling bits (A/B/C/D) for each timeslot are packed into successive
frames in timeslot 16 (2 DS0s per sample). A line signaling representation is defined that relates
the call state of the circuit to the values of the signaling bits. Register signaling is performed via a
compelled mechanism, where each forward signal is acknowledged via a backward signal. Signals
are transmitted via MFC R2 tones. Both the line signaling and register signaling utilized in MFC
R2 signaling is described in the sections below.
The International Telecommunications Union (ITU) defines the international standard for MFC
R2 protocol. This protocol is used between international gateways. Individual countries are
allowed to derive their own national version from the ITU protocol using a reduced number of
multi-frequency combinations so as not to interfere with the international working. Common
elements between the ITU international version and all national variants include line signaling and
the tones used to transmit the MFC R2 signals. The differences between the ITU and national
variants lie in the number of MFC R2 signals recognized and the meaning assigned to the MFC R2
signals.
Line Signaling
Although four signaling bits are defined, the digital version of MFC R2 signaling uses just two of
the signaling bits in each direction of transmission per timeslot. These signaling bits are referred to
as af and bf for the forward direction and ab and bb for the backward direction.
• The af bit identifies the operating condition of the outgoing switching system and reflects the
condition of the calling subscribers line.
• The bf indicates a failure in the forward direction to the incoming switching equipment.
• The ab bit indicates the condition of the called subscribers line.
• The bb bit indicates the idle/seized state of the incoming switching equipment.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Services Managing the GSX
Table 6–15 illustrates the defined states for these signaling bits.
Signaling Bits
Forward Backward
Channel State af bf ab bb
Idle 1 0 1 0
Seized 0 0 1 0
Seizure Acknowledge 0 0 1 1
Answered 0 0 0 1
Clear Back 0 0 1 1
Clear Forward 1 0 0 1
or
1 1
Blocked 1 0 1 1
The other forward line signaling bits (cf, df) and backward line signaling bits (cb, db) are set to
default values as per the ITU recommendations. This default value is c = 0, d = 1 in both
directions. You may configure these bits (see "CAS Service" on page 3–1092).
Register Signaling
Each MFC R2 signal is comprised of a multi-frequency combination that is transmitted over the
voice band channel. There are 15 possible forward signals and 15 possible backward signals.
Table 6–16 lists the multi-frequency combinations that comprise these fifteen forward and
backward MFC R2 signals.
Frequencies in Hertz
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX CAS Services
The signal transfer in MFC R2 is different from the MFC R1 protocol. The MFC R2 protocol uses
what is called a compelled sequence. In a compelled sequence the first forward signal is
transmitted. When the receiving register detects the signal, a backward signal is transmitted in
response. When the forward register detects the backward signal it stops transmitting the forward
signal. When the receiving register recognizes the end of the forward signal it stops transmitting
the backward signal. When the forward register detects the end of the backward signal it proceeds
with the next R2 signal. The MFC R2 protocols also define the concept of a pulsed signal. A
pulsed signal is defined as the sending of a multi-frequency combination tone in the backwards
direction for a fixed duration of time (150 milliseconds ± 50 milliseconds). Pulsed signals are sent
when the incoming exchange has information for or needs information from the outgoing
exchange at a time when the outgoing exchange is not sending a forward signal. Pulse signals are
often used to request the calling party category, in congestion situations, or to signify address
complete after the last digit acknowledgement.
Higher level call processing controls the actual flow of information (for example, called number,
calling number, call category, rating category, and called party line status). The incoming
exchange controls the flow of information via the backward signal which it sends to acknowledge
the forward signal. For example, the outgoing register initiates the transfer by sending the first
digit of the called number. The incoming register typically acknowledges the digit and requests
that the next digit be sent. At any time the incoming register can request different information such
as calling party number, calling party category, rating category, etc. and can then switch back to
receiving the remainder of the called party number.
In order to facilitate the exchange of this varying information, the CAS MFC R2 signals are
defined in several groups. The ITU defines 2 forward groups (groups I and II) and 2 backward
groups (groups A and B). Mexico defines a third group in each direction (group III/forward and
group C/backward). The Mexico R2 variant defines a dual role for the group II forward signals. A
II6 signal provides the billing/rating category and a II3 signal defines the calling party category.
The meaning of a group II signal is based on the backward signal which requested it. The A-6
signal requests a II6 signal and an A-3 signal requests a II3 signal. The tables given in the
following sections define the national variant.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Services Managing the GSX
The CAS MFC R2 protocol implementations employ 2 different mechanisms for call
establishment:
• Link by Link - the complete sequence of digits is sent between outgoing and incoming
registers before the call proceeds to the next exchange. This is currently how the CAS MFC
R2 processing works in the GSX.
• End to End - the incoming register looks at only the minimum number of digits required to
route the call to the next switch. At which point, it routes the call, acknowledges the last digit
and requests re-transmission from the originating exchange of the required information for the
next exchange in the sequence. It then detaches the R2 register and cuts the call through. At
this point, the intermediate exchange is no longer involved with the CAS MFC R2 register
signaling, only the outgoing exchange and the next exchange in the series is involved. This
process can occur several times before the call reaches the terminating exchange.
Group II - calling party category and billing/charge category (II3 and II6)
NOTE
Signals marked with a meaning of “Reserved” are defined, but not yet used.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX CAS Services
NOTE
The GSX will ignore group 1 signals 11 - 14. These signals will be omitted from any
routing request issued to the softswitch and will not appear in the CDR.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Services Managing the GSX
NOTE
The GSX will only support the following group II6 signals: 1, 2, 3, 5, 6, 7 and 9. All
other received group II6 signals will be mapped to signal 2.
NOTE
The GSX will only support signals 1, 2, 4, 5, 6 and 8 from group II3. All other
received group II3 signals will be mapped to signal 2.
Full operator functionality, such as bridging of calls, is not provided in this release.
Test line support will be limited to the currently supported functionality. See "Test
Call" on page 3–1213 for details on supported test line functionality.
The Group I operator signal (digit 1), test call signal (digit 5) and the maintenance
call signal (digit 6) will be passed through from ingress to egress calls.
Appropriate mappings will take place in interworking scenarios.
NOTE
The GSX will ignore group III signals 11 - 14. These signals will be omitted from
any routing request issued to the softswitch and will not appear in the CDR.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX CAS Services
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Services Managing the GSX
NOTE
The GSX will only support the following group B signals: 1, 2, 4 and 5. All other
received group B signals will be mapped to signal 1.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX CAS Services
Example Profiles
A set of SSPs, SCPs, and collection profiles are displayed below to illustrate structures used to
carry out CAS MFC R2 calls, using the Mexico R2 signaling variant. These profiles provide an
example for handling an ingress call with a local or long distance number being dialed. Calls to an
operator of special service requiring only a 2-3 digit called party number are not handled by these
structures.
The following SSP (ingressMexV1) is the main signal sequence profile. This SSP assumes an
ideal exchange: 6 digits of called party, followed by charge category, up to 11 digits of calling
party terminated with an end of digits signal, up to 12 additional called party digits terminated with
an end of digits signal (or 12 digits received), and finally the calling party category digit. (See the
CAS COLLECTIONPROFILEs, below, for the derivation of these field lengths.) If the called
party remainder collection fails then a specialized SCP is invoked. Otherwise, in the event of a
failure a general failure SCP is invoked. The dialing of the subscriber status is delayed until the
call is routed and the status is obtained from the far end switch or an error is encountered (such as
no route to destination).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Services Managing the GSX
The five CAS COLLECTIONPROFILEs used in the main signal sequence profile are:
Name: calledPartyInitMexV1
Type: MFCR2
CollectId: CALLEDPARTY
MinDigits: 6
MaxDigits: 6
FirstDigit Timer: 8000
InterDigit Timer: 8000
Field Timer: 0
Term Digit: NONE
Restart Digit:
Reinput Digit:
Report Digits: 0
FirstDigit Quiet: DISABLED
Announce Prompt: 0
Tone Prompt:
Append Digits: DISABLED
Ack Signal 1: 1
Ack Signal 2: 6
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX CAS Services
Name: chargeCategoryMexV1
Type: MFCR2
CollectId: CHARGECATEGORY
MinDigits: 1
MaxDigits: 1
FirstDigit Timer: 8000
InterDigit Timer: 0
Field Timer: 0
Term Digit: NONE
Restart Digit:
Reinput Digit:
Report Digits: 0
FirstDigit Quiet: DISABLED
Announce Prompt: 0
Tone Prompt:
Append Digits: DISABLED
Ack Signal 1: 1
Ack Signal 2: 1
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Services Managing the GSX
Name: callingPartyMexV1
Type: MFCR2
CollectId: CALLINGPARTY
MinDigits: 0
MaxDigits: 11
FirstDigit Timer: 8000
InterDigit Timer: 8000
Field Timer: 0
Term Digit: R2SIGNAL15
Restart Digit:
Reinput Digit:
Report Digits: 0
FirstDigit Quiet: DISABLED
Announce Prompt: 0
Tone Prompt:
Append Digits: ENABLED
Ack Signal 1: 1
Ack Signal 2: 1
4. calledPartyRemMexV1 (Remainder of the called party number)
Node: TPUBS Date: 2003/09/30 20:05:57 GMT
Zone: GMTMINUS05-EASTERN-US
Name: calledPartyRemMexV1
Type: MFCR2
CollectId: CALLEDPARTY
MinDigits: 1
MaxDigits: 12
FirstDigit Timer: 8000
InterDigit Timer: 2000
Field Timer: 0
Term Digit: R2SIGNAL15
Restart Digit:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX CAS Services
Reinput Digit:
Report Digits: 0
FirstDigit Quiet: DISABLED
Announce Prompt: 0
Tone Prompt:
Append Digits: ENABLED
Ack Signal 1: 1
Ack Signal 2: 3
5. callCategoryMexV1 (Call category)
Node: TPUBS Date: 2003/09/30 20:11:33 GMT
Zone: GMTMINUS05-EASTERN-US
Name: callCategoryMexV1
Type: MFCR2
CollectId: CALLINGPARTYCATEGORY
MinDigits: 1
MaxDigits: 1
FirstDigit Timer: 8000
InterDigit Timer: 0
Field Timer: 0
Term Digit: NONE
Restart Digit:
Reinput Digit:
Report Digits: 0
FirstDigit Quiet: DISABLED
Announce Prompt: 0
Tone Prompt:
Append Digits: DISABLED
Ack Signal 1: 0
Ack Signal 2: 0
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Services Managing the GSX
The two ingress signal condition profiles for handling errors encountered during the main signal
sequence profile are:
SSP inMexV1A3Pulse is invoked when an inter-digit timeout occurs during the collection of the
remainder of the called party. A backwards tone cannot be sent because the A-1 (next-digit) signal
has already been sent. Thus the A-3 (request call category) signal is sent via a pulsed MF tone.
This SSP, displayed below, then completes the sequence in the same fashion as the main signal
SSP, shown at the beginning of this section.
Node: TPUBS Date: 2003/09/30 21:29:27 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX CAS Services
Finally, SSP inMexV1A4Fail is invoked when all other collection failures occur. The disconnect
reason for the call is set to 111 (PROTOCOL ERROR UNSPECIFIED). The subscriber status is
then sent as a backwards R2 signal. Because a disconnect reason is established for the call, the
subscriber status takes on a signal obtained from disconnect reason mapping. In this case, the
backwards congestion signal will be sent. Once the signal is sent, disconnect treatment is initiated.
This SSP summary is:
Node: TPUBS Date: 2003/09/30 21:56:48 GMT
Zone: GMTMINUS05-EASTERN-US
CAS loop start (LS) and ground start (GS) signaling is supported for the foreign exchange office
(FXO) and foreign exchange station (FXS) variants. FXO line signaling is network to user. FXS
line signaling is user to network. These variants are supported on T1 super frame and extended
super frame formats. Loop start and ground start register signaling supports DTMF and MF,
although MF is not typically used with these signaling types.
State A B C D
LCF (Idle) 0 1 0 1
RLCF (Answer) 0 1 0 0
Ringing 0 0 0 0
LCFO (Idle/Disconnect) 1 1 1 1
State A B C D
LO (on-hook) 0 1 0 1
LC (off-hook) 1 1 1 1
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Services Managing the GSX
A loop start FXS-to-FXO call is originated on the FXS side by transmitting ABCD=1111 (off-
hook). There is no acknowledgement from the FXO side other than an optional dial tone. The FXS
side transmits its address information (DTMF). Call progress information is provided to the FXS
side via in band tones/announcements. Optionally, FXO line side answer supervision can be
provided to the FXS switch by transmitting answer or ABCD=0100. However, the answer (RLCF)
signal may not be supported by some switching equipment. Call termination is provided by the
FXS side transmitting ABCD=0101 (on-hook).
PBX or
C hannel
Bank G SX
(F X S ) G S X S ig n a lin g S ta te
(F X O )
Receiv e Transmit
A B C D A B C D
Id le 0 1 0 1 0 1 0 1
L C (O ff-h o o k ) 1 1 1 1 0 1 0 1
D ia l- T o n e
C a lle d P a r t y # ( D T M F )
Optional
R L C F (A n s w e r) 1 1 1 1 0 1 0 0
PBX or
Channel
Bank GSX
(F X S ) G S X S ig n a lin g S ta te
(F X O )
Receive Transmit
A B C D A B C D
C onnect 1 1 1 1 0 1 0 1
L O (O n -h o o k ) 0 1 0 1 0 1 0 1
I d le 0 1 0 1 0 1 0 1
A loop start FXO-to-FXS call is originated on the FXO side by transmitting ABCD=0000 (ring).
The FXO side transitions the signaling bits back to ABCD=0101 after approximately 2 seconds
and back to ABCD=0000 after approximately 4 seconds. These ring cycles repeat until the call is
answered. This processing simulates the physical ringing state of an analog phone. The FXS side
answers the call by transmitting ABCD=1111 (off-hook). The FXO side transitions to
ABCD=0101 when the call is answered. Typically, address information is not sent in an FXO-to-
FXS call. Call termination is provided by the FXO side transmitting ABCD=1111 (LCFO) for a
timed duration (typically between 600 and 1000 milliseconds). Not all FXO equipment is capable
of generating the signal. Similarly, not all FXS equipment is capable of detecting the signal.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX CAS Services
PBX or
Channel
Bank GSX
(F X S ) G S X S ig n a lin g S ta te
(F X O )
Receive Transmit
A B C D A B C D
I d le 0 1 0 1 0 1 0 1
R in g O n
0 1 0 1 0 0 0 0
R in g O f f
0 1 0 1 0 1 0 1
L C (O ff-h o o k ) 1 1 1 1 0 1 0 1
C a lle d P a r t y # ( D T M F )
( O p t io n a l)
PBX or
Channel
Bank GSX
(F X S ) G S X S ig n a lin g S t a t e
(F X O )
Receive Transmit
A B C D A B C D
C onnect 1 1 1 1 0 1 0 1
L C F O ( D is c - S ta r t) 1 1 1 1 1 1 1 1
L C F ( D is c - E n d ) 1 1 1 1 0 1 0 1
L O (O n -h o o k ) 0 1 0 1 0 1 0 1
Id le
State A B C D
LCF (Tip ground) 0 1 0 1
RLCF (Answer) 0 1 0 0
LCFO (Idle/Disconnect) 1 1 1 1
Ring (Disconnect) 0 0 0 0
State A B C D
LO (on-hook) 0 1 0 1
LC (off-hook) 1 1 1 1
RG (Ring Ground) 0 0 0 0
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Services Managing the GSX
A ground start FXS-to-FXO call is originated on the FXS side by transmitting ABCD=0000 (ring
ground). The FXO side acknowledges this by transmitting ABCD=0101 (tip ground) and provides
an optional dial tone. In turn, the FXS side sends ABCD=1111 (off-hook) and transmits its address
information. Call progress information is provided to the FXS side via in band tones/
announcements. Optionally, FXO line side answer supervision can be provided to the FXS switch
by transmitting answer or ABCD=0100. However, the answer (RLCF) signal may not be
supported by some switching equipment. Call termination is provided by the FXS side
transmitting AB=01 (on-hook).
PBX or
Channel
Bank GSX
(F X S ) G S X S ig n a lin g S ta te
(F X O )
Receive Transmit
A B C D A B C D
Id le 0 1 0 1 1 1 1 1
R G (R in g G ro u n d ) 0 0 0 0 1 1 1 1
L C F (T ip G ro u n d )
0 0 0 0 0 1 0 1
L C (O ff-h o o k)
1 1 1 1 0 1 0 1
C a lle d P a rty # (D T M F )
Optional
R L C F (A n s w e r) 1 1 1 1 0 1 0 0
PBX or
Channel
Bank GSX
(F X S ) G S X S ig n a lin g S ta te
(F X O )
Receive Transmit
A B C D A B C D
C onnect 1 1 1 1 0 1 0 1
L O (O n -h o o k ) 0 1 0 1 0 1 0 1
L C F O ( I d le ) 0 1 0 1 1 1 1 1
Id le
A ground start FXO-to-FXS call is originated on the FXO side by transmitting ABCD=0000
(ring). The FXO side transitions the signaling bits to ABCD=0101 after approximately 2 seconds
and back to ABCD=0000 after approximately 4 seconds. These ring cycles repeat until the call is
answered. This processing simulates the physical ringing state of an analog phone. The FXS side
answers the call by transmitting ABCD=1111 (off-hook). The FXO side transitions to
ABCD=0101 when the call is answered. Typically, address information is not sent in an FXO-to-
FXS call. Call termination is provided by the FXO side transmitting AB=11 (LCFO).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX CAS Services
PBX or
Channel
Bank GSX G S X S ig n a lin g S ta t e
(F X S ) (F X O ) Receive Transmit
A B C D A B C D
Id le 0 1 0 1 1 1 1 1
R in g O n 0 1 0 1 0 0 0 0
R in g O f f 0 1 0 1 0 1 0 1
L C (O ff - h o o k ) 1 1 1 1 0 1 0 1
C a lle d P a r ty # ( D T M F )
( O p tio n a l)
P B X or
C hannel
B ank G S X
(F X S ) G S X S ig n a lin g S ta te
(F X O )
R e c e i v e T r a n s m i t
A B C D A B C D
C onnect 1 1 1 1 0 1 0 1
LC F O ( Id le ) 1 1 1 1 1 1 1 1
LO (O n -h o o k ) 0 1 0 1 1 1 1 1
I d le
Call Processing
The sections below call your attention to certain call processing features that may be invoked when
using CAS loop start and ground start signaling.
Digit Collection/Generation
Loop start and ground start signaling typically use DTMF tones for digit collection and generation.
The GSX also supports MF tone collection/generation for loop start and ground start.
Typically digits are not sent for FXO-to-FXS calls, however the GSX does not impose this
restriction. You may collect digits on the FXS side and generate digits on the FXO side.
Answer Supervision
Although answer supervision may be provided to the loop start FXS side, not all network
equipment will support this feature. Both signal transmission from the FXO side and signal
reception on the FXS side may be configured through the CLI.
You may configure line side answer supervision on T1s that use ESF framing. You may not
configure this facility on T1s that use D4 framing.
For switches that do not support line side answer supervision, you must utilize timed answer
supervision, an existing GSX feature, to declare a call stable and perform cut thru operations.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CAS Services Managing the GSX
Disconnect Supervision
Although disconnect supervision may be provided to the loop start FXS side, not all network
equipment will support this feature. Both signal transmission from the FXO side and signal
reception on the FXS side may be configured through the CLI.
When the LCFO/disconnect signal cannot be utilized, the Permanent Signal Condition (PSC)
capability of CAS service should be utilized to force the FXS side to release the call. This
capability allows tones/announcements to be played to the user. This is an existing capability. See
PSC_SSP under "CAS Service" on page 3–1092.
Channels will remain in an in-use/releasing state until the appropriate on-hook/idle signal is
received.
Glare
Glare (or simultaneous seizure of each end of a line for different purposes) cannot be detected on
loop start FXO egress calls.
Glare on loop start FXS egress calls is declared when a ring signal is received after sending the LC
(off-hook) signal.
Glare on ground start FXO egress calls is declared when a RG (ring ground) signal is received
when sending the ring signal.
Glare on ground start FXS egress calls is declared when a ring signal is received after sending the
RG (ring ground) signal.
Glare handling (Yield vs. Proceed) within the GSX is configurable. The default configuration
allows the FXO side to proceed and the FXS side to yield.
Hook-flash Transfer
The hook-flash transfer feature is supported on loop start / ground start FXO egress calls. This
feature is typically used for calls terminating from the GSX to voice mail systems. The voice mail
system collects a new called party number, sends a hook-flash to the GSX and then sends the new
called party number to the GSX. The GSX then re-routes the call.
Suspend/Resume
Suspend/Resume processing as required by GR-317 is supported on loop start / ground start FXO
services.
Channel Maintenance
CAS service provides a configurable maintenance busy flag. (See MAINTBUSY under "CAS
Service" on page 3–1092). The follow AB bit signals are sent when this flag is enabled and a loop
start or ground start channel is put out of service.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX CAS Services
Transmit
Channel Type A B C D
Loop Start FXS 1 1 1 1
Loop Start FXO 0 1 0 1
Ground Start FXS 1 1 1 1
Ground Start FXO 0 1 0 1
• Loop start FXO off-hook signal (LC ABCD=1111) received on an idle 1 way outbound
channel.
• Loop start FXS answer signal (RLCF ABCD=0100) received on an idle channel. The receipt
of the ring signal (Ring ABCD=0000) on a 1 way outbound channel is also considered a
remote maintenance event. However, the GSX will not declare remote maintenance in this
case. Ringing will occur in on/off cycles, so it may cause an oscillation of the remote
maintenance condition.
• Ground start FXO off-hook signal (LC ABCD=1111) received on an idle channel or ring
ground signal (RG ABCD=0000) received on an idle 1 way outbound channel.
• Ground start FXS answer signal (RLCF ABCD=0100) received on an idle channel.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Two-Stage Calls Managing the GSX
Two-Stage Calls
You may direct the GSX to execute two-stage (compound) calls through call processing scripts
that originate in the Sonus SoftSwitch. You initiate this sequence by passing a call processing
script to the GSX. The individual Sonus Information Building Blocks (SIBBs) in this script
instruct the GSX to take a series of actions that may involve DTMF collection to capture the called
party number, authorization of billing number, playing announcements, and others. These actions
require certain GSX based services described in the previous chapter, such as DTMF tones (see
"Tone Processing" on page 3–1183 and "Announcements" on page 6–88). However, control over
these services is provided by the Sonus SoftSwitch rather than GSX configuration commands.
The call processing scripts that control two-stage calls are developed under the Service Profile
Editor. This tool is one component of the Sonus SoftSwitch software package. See the PSX Policy
Server Provisioning Guide for the details of assembling SIBBs into these scripts to perform this
function.
For the remainder of this discussion, an example two-stage call processing script is proposed and
the resulting GSX behavior is examined. The example SIBBs are shown in flowchart format in
Figure 6–28, Two-Stage Call Processing SIBBs on page 6–138. This flowchart depicts a
simplified set processing points for a two-stage call.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Two-Stage Calls
Play
Announcement
Collect Digits
Trigger Request
Compare Two
Parameters
PIN_VALID
Place an Outgoing
PIN_INVALID
Call
In this scenario, an incoming call is forwarded to the Sonus SoftSwitch. The Sonus SoftSwitch
retrieves the previously saved call processing script shown above and transmits it to the GSX,
using DIAMETER protocol. (This script might process a credit card calling sequence.) The GSX
is directed to play an announcement (which may ask the caller for an authorization code), collect a
string of digits (using the GSX DTMF tone processing facility), trigger a request back to the Sonus
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Two-Stage Calls Managing the GSX
SoftSwitch (to authenticate the digit string that was collected), and compare two variables to
choose a subsequent processing path. Depending on the result of the compare, the GSX would
either place or skip the outgoing call. The script is terminated when either the call is finished or the
call is skipped. In the successful pathway through this scenario, two calls are performed:
The first call is also referred to as a “terminated call”. The second is a “stage 2 tandem call”.
An exchange of information occurs between the GSX and the PSX as the two-stage call processing
script is processed by the GSX. Table 6–28 summarizes the GSX actions that take place as each
SIBB is processed:
Separate accounting records will be generated for each call of a two-stage call. These records use a
Call Group ID to associate these records across a GSX node. See "Accounting Records" on
page 7–8. Call statistics such as call counts will be generated for each call separately.
Refer to the PSX Policy Server Provisioning Guide for a comprehensive summary of enhanced
services that may be deployed through call processing scripts.
NOTE
The GSX software limits the number of origination attempts for either stage of a
two-stage call to 10.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX GSX Call Rerouting Policy
Rerouting (or “Crankback”) of unsuccessful network call attempts is performed at the ingress GSX
when the Release/Disconnect from egress signaling matches a reason code in the Call Crankback
Profile, default, as described in "Call Crankback Profile" on page 3–1171.
Rerouting is performed for all possible PSTN-IP-IP-PSTN, PSTN-PSTN, SIP, and H.323 calls.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
GSX Call Rerouting Policy Managing the GSX
NOTE
Sonus codes 129 (CHANNEL COLLISION BACKOFF) and 134 (CONTINUITY CHECK
FAILED, BACKOFF) do not cause the call to be rerouted. These codes cause the
call to be retried, once, using the same route. If the retry results in the same Sonus
codes (129 or 134) then the call is released with Sonus Code 135, and thus may be
subjected to rerouting at the ingress GSX.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX GSX Call Rerouting Policy
Rerouting Behavior
When a call is successfully rerouted, the reason code that caused the reroute is not preserved by the
GSX. The reroute cause code (from the above table) is not propagated to the preceding switch or
stored in the accounting record.
If the call is successfully rerouted and established, then eventually the calling (or called) party will
hang up and the call will be disconnected normally. The reason code for that final normal
successful release is the reason code that will be stored in the accounting records.
If the call is routed to an egress GSX (PSTN-IP-IP-PSTN), then unsuccessful route attempts may
be captured in the accounting records on the egress GSX.
NOTE
Unsuccessful route attempts caused by no available circuits on the destination
trunk on the egress GSX or the egress GSX being suspended (due, for example, to
a module failure) are not recorded in the egress GSX accounting records.
If the call is not successfully rerouted after it is initially released with one of the above reroute
cause codes, then the reason code that triggered the final call release is propagated to the preceding
switch by the ingress GSX and stored in the accounting record of the ingress GSX (and, in PSTN-
IP-IP-PSTN call scenarios, also stored in the accounting record of the egress GSX).
NOTE
If the call is not successfully rerouted because there are no circuits available on
any of the remaining routes, then reason code 34 (NO CIRCUIT AVAILABLE) is
returned instead of the reason code that triggered the final reroute attempt.
The sections below elaborate, with regard to the ingress and the egress GSX.
Ingress GSX
When any route attempt is released with a reason code that is not in the above table, then that code
will be stored in the (“Call Disconnect Reason” field of the STOP or ATTEMPT) accounting
record and also propagated to the preceding switch (after a possible mapping to a value supported
by that switch’s signaling type). This applies to each reroute attempt, including the last one.
Successfully rerouted calls follow this behavior.
Each time a route attempt is released with a reason code from the above table, the next route is
attempted. If the last available route is released with one of the above reason codes, then that
(normally re-routable) reason code is stored in the accounting record and propagated to the
preceding switch.
In those cases where a Sonus reason code is mapped to one of the Q.931 codes, then the Q.931
code is propagated to the preceding switch, but the Sonus code is placed into the accounting
record.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
GSX Call Rerouting Policy Managing the GSX
For instance, in a PSTN-IP-IP-PSTN call scenario, if the call was attempted on the last available
route and then released with Sonus code 135 (COLLISION REATTEMPT EXHAUSTED), then
Sonus code 135 is placed into the “Call Disconnect Reason” field of the ATTEMPT accounting
record. As well, Sonus code 135 is mapped to Q.931 code 41 (TEMPORARY FAILURE) and
code 41 is propagated to the preceding switch. (This value is also written to the “Call Disconnect
Reason Transmitted to Ingress” field of the ATTEMPT accounting record.)
Egress GSX
In a PSTN-IP-IP-PSTN call scenario, a call may be released from the network to the egress GSX
with a reason code in the above table. The egress GSX will not attempt to reroute the call because
rerouting is performed only by the ingress GSX. The egress GSX will write an ATTEMPT
accounting record containing that code in both the “Call Disconnect Reason” and “Call Disconnect
Reason Transmitted to Ingress” fields. Then it will pass that code back to the ingress GSX. The
ingress GSX, upon recognizing the re-routable reason code, will attempt to reroute the call,
without writing any accounting record or propagating the reason code to the preceding switch.
This creates the possibility of a call that generates accounting records in one GSX that do not
match the accounting records generated by the call in another GSX.
For instance, consider a call for which the ingress GSX receives two routes in the PSX policy
response:
• GSX2, TrunkGroup1
• GSX2, TrunkGroup2
The ingress GSX signals the egress GSX with an Initial Address Message (IAM) directed to the
first route. If the egress GSX sees the call attempt released with a reason code of 42
(SWITCHINGEQUIP CONGESTION), it writes an ATTEMPT accounting record that contains
code 42 in the “Call Disconnect Reason” and “Call Disconnect Reason Transmitted to Ingress”
fields. Then it passes that code back to the ingress GSX. The ingress GSX, upon recognizing
reason code 42, reattempts the call using the next (and in this case last) available route. The ingress
GSX does not write any accounting records at this time. Assume the next route goes to the same
egress GSX. This time the egress GSX sees the call released with a reason code of 44
(REQUESTED CIRCUIT NOT AVAILABLE). It writes another ATTEMPT accounting record,
this time with code 44 in both the “Call Disconnect Reason” and “Call Disconnect Reason
Transmitted to Ingress” fields. It then passes that code back to the ingress GSX. The ingress GSX
recognizes reason code 44 as a re-routable cause code. However, since this is the last route, reason
code 44 is written to the “Call Disconnect Reason” and the “Call Disconnect Reason Transmitted
to Ingress” fields. This code is then propagated to the preceding switch in the network. In this
instance the egress GSX contains two ATTEMPT accounting records for the call with differing
reason codes, while the ingress GSX contains only the latter of those ATTEMPT records.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX GSX Call Rerouting Policy
The circumstances below cause a call to be released with reason code 34 (NO CIRCUIT
AVAILABLE) propagated to the preceding switch in the network.
• PSTN-PSTN - The ingress GSX attempts to initially route the call, and receives 10 routes in
the PSX policy response. But none of the routes presented by the PSX has any available
circuits.
The ingress GSX propagates reason code 34 to the preceding switch. The ingress GSX writes
an ATTEMPT accounting record that contains code 34 in the “Call Disconnect Reason” and
“Call Disconnect Reason Transmitted to Ingress” fields.
• PSTN-IP-IP-PSTN - The ingress GSX attempts to initially route the call, and receives two
routes in the PSX policy response. These routes are “GSX2, TrunkGroup1” and “GSX2,
TrunkGroup2”. The ingress GSX signals GSX2 with an Initial Address Message (IAM)
directed to the first route. GSX2 looks at TrunkGroup1 and finds no circuits available. GSX2
releases the call with reason code 130 (INSUFFICIENT RESOURCES) to the ingress GSX,
without writing an accounting record. The ingress GSX does not write an accounting record
but instead reroutes the call, using the second route. GSX2 recognizes the next IAM signaled
by the ingress GSX, directed to the second route, looks at TrunkGroup2, and finds no circuits
available. GSX2 releases the call with reason code 130 to the ingress GSX without writing an
accounting record. The ingress GSX recognizes that the last route has been tried.
The ingress GSX writes an ATTEMPT accounting record that contains reason code 130 in the
“Call Disconnect Reason” field. Next, the ingress GSX maps reason code 130 to Q.931 code
34, and writes code 34 to the “Call Disconnect Reason Transmitted to Ingress” field of the
ATTEMPT record. Then the ingress GSX propagates code 34 to the preceding switch. No
accounting records are written by GSX2.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
GSX Call Rerouting Policy Managing the GSX
The GSX is able to re-query the PSX for additional routes. Each PSX routing label may include up
to 200 routes. However, each time a GSX makes a PSX policy request for call routes, a “sublist” of
at most 10 routes from that routing label is returned. Those routes are tried sequentially, as
described previously in the examples in "Rerouting Behavior" on page 6–142. Each successive
sublist is presented to the GSX by its next request for call routes. These individual policy
exchanges between the GSX and PSX are part of the internal interworking between these Sonus
products. You may not influence this behavior externally (except that you must provision more
than 10 routes per route label in the PSX to initiate it).
The PSX policy response to the policy request for call routes indicates whether “additional routes
remain”. If there are remaining routes, then the GSX will request them upon exhausting the
previous group of 10. When the last route from the routing label is present in the PSX policy
response, the response will indicate that “no additional routes remain”, informing the GSX
software that the routes in this response are the last remaining routes on which to try this call. For
any call:
• All the routes that will be tried come from a single PSX routing label.
• No more than 200 routes may ever be tried, because that is the maximum number of routes per
routing label.
The route prioritization type assigned to the routing label is used by the PSX to create multiple
“sublists” of 10 routes. These priorities are sequential, proportion, or round robin. Each time a
sublist is presented to the GSX, the call is attempted on each successive route in the sublist and on
each successive sublist until the call terminates in one of the following manners:
NOTE
In all of the multiple route call scenarios discussed in "Rerouting Behavior" on
page 6–142, those routes may viewed as members of the last sublist returned by
the PSX.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX SIP DTMF Detection/Insertion Handling
PSTN
SIP
Application
Server
IP
PSTN SIP Signaling Channel
Phone
IP Media Stream
GSX
Media Server/
IAD/SIP
Phone
SIP Call Signaling Packets without DTMF INFO messages
G.711 G.72X
G.711 / RFC2833 (with DTMF Digits Removed) G.72X / RFC2833 (with DTMF Digits Removed)
G.711 / (with DTMF Digits Removed) G.72X / (with DTMF Digits Removed)
Figure 6–29 depicts the IP “pipes” used by the SIP software in the GSX:
• The SIP Signaling Channel used to exchange call signaling packets with a SIP Application
Server (AS).
• The IP Media Stream used to exchange call data with a SIP Media Server (MS), Integrated
Access Device (IAD), or SIP phone.
The network that is depicted supports SIP calls between the SIP MS/IAD/phone and a PSTN
Phone.
The SIP Application Server manages the SIP MS/IAD/phone through the IP cloud, shown by the
dotted line in Figure 6–29. This interaction is logically removed from the SIP GSX software, and
hence is not annotated in the examples that follow.
Audio call data from the PSTN may be encoded according to any of the algorithms below for
delivery via the IP Media Stream:
• G.711
• G.711 with Silence Suppression
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SIP DTMF Detection/Insertion Handling Managing the GSX
• G.723.1
• G.723.1A
• G.726
• G.729A
• G.729A+B
• iLBC
• iLBC with Silence Suppression
G.711 is the default encoding algorithm for all call data. G.711 with Silence Suppression adds an
optimization to G.711 for conveyance of silence. G.723.1, G.723.1A, G.726, G.729A, G.729A+B,
iLBC, and iLBCSS audio encoding reduce the IP bandwidth that is needed to maintain a call,
relative to the PSTN bandwidth required. For this reason, each of these audio encoding techniques
is referred to as an “audio compression” algorithm. All are combined under the key G.72X in
Figure 6–29. Any of these algorithms may be substituted whenever the term “audio compression”
is used in the discussion that follows.
DTMF tones (digits) may be present in any call. Three methods of DTMF digit delivery are
available for SIP calls:
• Leaving these audio tones embedded and unaltered in the IP Media Stream, the default
convention for all of the above mentioned encoding algorithms
• Isolating the tones and designating them explicitly within the IP Media Stream
• Isolating the tones, then designating and delivering them explicitly on the SIP Signaling
Channel instead of the IP Media Stream
The IP Media Stream in the figure above uses the Realtime Transport Protocol (RTP) to deliver
call data, for all audio compression algorithms.
Method 1, above, results in no manipulation of RTP packets and relies on the SIP MS/IAD/phone
to detect DTMF in this audio data and act on it appropriately.
Method 2, above, depends on the RFC2833 mechanism, used under the RTP protocol. This
standard mechanism isolates and explicitly delivers DTMF information through the RTP stream,
by using different packet payload types. The DTMF packets are delivered to the same address as
the RTP packets. This scheme relies on the SIP MS/IAD/phone to recognize the RFC2833
mechanism and act appropriately.
Method 3, above, depends on SIP INFO messages exchanged between the GSX and the SIP
Application Server on the SIP Signaling Channel to deliver DTMF information. The SIP AS must
subsequently deliver this information to the SIP MS/IAD/phone.
The legend in Figure 6–29 on page 6–146 represents DTMF delivery schemes used for SIP call
and signaling data:
• G.711, as mentioned, represents a G.711 audio packet stream that contains uncompressed
DTMF information that is encoded in the IP Media Stream along with all other audio data.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX SIP DTMF Detection/Insertion Handling
• G.711/RFC2833 represents a G.711 audio packet stream that contains DTMF information that
is placed into the RTP stream using the RFC2833 mechanism. In this case, the underlying
DTMF audio also remains embedded in the audio RTP packets.
• G.711/RFC2833 (with DTMF Digits Removed) represents a G.711 audio packet stream that
contains DTMF that is placed into the RTP stream using the RFC2833 mechanism, as above,
but further manipulates the RTP stream by removing these tones from the audio RTP packets.
• G.711/ (with DTMF Digits Removed) represents a G.711 audio packet stream that has all
DTMF removed. The DTMF is delivered through DTMF INFO messages that are conveyed
on the SIP Signaling Channel. The RFC2833 mechanism is not present in this delivery
scheme.
• G.72X represents an audio compression packet stream that contains compressed DTMF
information that is encoded in the IP Media Stream along with all other (compressed) audio
data.
• G.72X/RFC2833 represents an audio compression packet stream that contains DTMF
information that is placed into the RTP stream using the RFC2833 mechanism. In this case,
the underlying DTMF audio also remains embedded in the audio RTP packets.
• G.72X/RFC2833 (with DTMF Digits Removed) represents an audio compression packet
stream that contains DTMF that is placed into the RTP stream using the RFC2833 mechanism,
as above, but further manipulates the RTP stream by removing these tones from the audio RTP
packets.
• G.72X/ (with DTMF Digits Removed) represents an audio compression packet stream that has
all DTMF removed. The DTMF is delivered through DTMF INFO messages that are
conveyed on the SIP Signaling Channel. The RFC2833 mechanism is not present in this
delivery scheme.
• SIP Call Signaling Packets without DTMF INFO Messages are used to exchange signaling
information for SIP calls. In this case, these packets do not contain any DTMF information.
These packets are conveyed on the SIP Signaling Channel.
• SIP Call Signaling Packets with DTMF INFO Messages are use to exchange all signaling
information for SIP calls, including DTMF information. DTMF digits are delivered via SIP
INFO messages. These packets are conveyed on the SIP Signaling Channel.
The Packet Service Profile is central to DTMF digit delivery in SIP calls. Various parameter
settings in this object direct the SIP GSX software to carry out these delivery schemes. For call
flows from PSTN to IP, this profile originates in the PSX before being passed to the GSX and is
configured on a per-call basis. Call flows from IP to PSTN are directed by the default Packet
Service Profile, originating in the GSX. The default Packet Service Profile cannot easily be
customized for individual calls.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SIP DTMF Detection/Insertion Handling Managing the GSX
DTMF Relay
DTMF Relay is the practice of explicitly passing DTMF tones between the GSX and the SIP
components, including the AS, MS, IAD, and phone. When DTMF Relay is in effect, DTMF tones
are isolated and explicitly exchanged between the GSX and SIP devices. When DTMF Relay is
not in effect, DTMF tones are embedded in the audio packet stream, but not otherwise indicated.
When audio compression is in effect, DTMF digits may be difficult to detect in the audio stream.
DTMF Relay is controlled by the DTMF RELAY parameter in the CODEC portion of the Packet
Service Profile. This parameter specifies the type of DTMF Relay to use to deliver DTMF
information when DTMF digits are detected in the data stream. It may take one of four values:
• none - Do not use any kind of DTMF Relay under any circumstances. DTMF remains
embedded in the audio stream regardless of the CODEC in use.
• longDigit - This applies to SIP calls when long digit (# or ##) recognition is enabled on the
appropriate CNS. When the long digit is detected, use SIP INFO messages to notify the SIP
signaling peer on the SIP signaling channel.
• outOfBand - Deliver DTMF digits on the SIP signaling channel, using SIP INFO messages.
• rfc2833 - Deliver DTMF digits within the RTP stream by using the RFC2833 mechanism.
Once they are directed to be explicitly exchanged, DTMF tones may be delivered “in band” or
“out of band”.
In Band DTMF
For all CODECs, you may, but need not, direct DTMF digit delivery through the RFC2833
mechanism. Under this mechanism, the DTMF packets are delivered within the RTP stream, using
unique payload types.
In band DTMF Relay is specified by setting the DTMF RELAY parameter described above to
rfc2833.
Because RFC2833 may not be supported on a particular MS, IAD, or SIP phone, an out of band
alternative for delivering DTMF must be provided.
Out of band DTMF is the practice of passing DTMF digits on the SIP Signaling Channel via the
SIP INFO message type.
Out of band DTMF is specified by setting the DTMF RELAY parameter described above to
outOfBand or longDigit. When you set this parameter to one of these values, you direct DTMF
digit delivery on the SIP Signaling Channel.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX SIP DTMF Detection/Insertion Handling
Remove Digits
DTMF Relay may be further qualified by the DTMF REMOVE DIGITS parameter in the CODEC
portion of the Packet Service Profile. This parameter is meaningful only when DTMF RELAY is not
none. When you direct DTMF digits to be explicitly inserted in band or out of band, via a DTMF
RELAY value of longDigit, outOfBand, or rfc2833, then the DTMF REMOVE DIGITS
parameter allows you to concurrently remove DTMF from the audio stream for that call. If you
specify the default value of enabled, the DTMF digits that are encoded into the audio stream for
that device are removed. If you specify the value disabled, the encoded DTMF digits remain in
the audio packet stream.
Hardware Prerequisites
DTMF Relay requires GSX processing resources in excess of those on the CNS module that are
supporting the SIP call. These resources are available on these GSX server modules:
In the case of the CNS25, the SIP call may or may not be supported by the server module. Note
that as you add the above server modules to your GSX, you improve the probabilities of
successfully executing SIP calls that require audio compression and/or DTMF Relay. Note also,
that any arbitrary SIP call could be dropped because of lack of processing resources, regardless of
the number of CNS or SPS server modules present in your GSX.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SIP DTMF Detection/Insertion Handling Managing the GSX
This section is the first of several descriptions of different DTMF delivery scenarios. Each
scenario includes the Packet Service Profile parameter values that you must set to achieve the
delivery scheme. Each description uses a particular rendition of Figure 6–29. Call flows from IP
to PSTN, which require the use of the default Packet Service Profile, are described.
PSTN
SIP
Application
Server
IP
PSTN SIP Signaling Channel
Phone
IP Media Stream
GSX
Media Server/
IAD/SIP
Phone
SIP Call Signaling Packets without DTMF INFO messages
G.711 G.72X
G.711 / RFC2833 (with DTMF Digits Removed) G.72X / RFC2833 (with DTMF Digits Removed)
G.711 / (with DTMF Digits Removed) G.72X / (with DTMF Digits Removed)
Figure 6–30 illustrates the IP streams for SIP calls when the Packet Service Profile CODEC is G711
or G711SS and DTMF RELAY is none. The SIP Signaling Channel is active, but never carries
DTMF tones. DTMF is embedded in the audio packets of the G.711 IP Media Stream. No CNS or
SPS audio compression resources are necessary to support this scenario.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX SIP DTMF Detection/Insertion Handling
The default Packet Service Profile shown below provides this SIP IP environment.
SHOW PACKET SERVICE PROFILE default ADMIN
Node: TPUBS Date: 2002/09/03 15:36:47 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SIP DTMF Detection/Insertion Handling Managing the GSX
PSTN
SIP
Application
Server
IP
PSTN SIP Signaling Channel
Phone
IP Media Stream
GSX
Media Server/
IAD/SIP
Phone
SIP Call Signaling Packets without DTMF INFO messages
G.711 G.72X
G.711 / RFC2833 (with DTMF Digits Removed) G.72X / RFC2833 (with DTMF Digits Removed)
G.711 / (with DTMF Digits Removed) G.72X / (with DTMF Digits Removed)
Figure 6–31 illustrates the IP streams for SIP calls when CODEC is G711 or G711SS, DTMF RELAY
is rfc2833, and DTMF REMOVE DIGITS is disabled. This establishes in band DTMF Relay
using the RFC2833 mechanism. Thus, although the SIP Signaling channel is active, it does not
carry DTMF tones. At least one CNS or SPS server module must be present in the GSX to provide
processing resources for DTMF Relay, even under G.711 encoding.
The default Packet Service Profile shown below provides this SIP IP environment.
SHOW PACKET SERVICE PROFILE default ADMIN
Node: TPUBS Date: 2002/09/03 15:36:47 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX SIP DTMF Detection/Insertion Handling
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SIP DTMF Detection/Insertion Handling Managing the GSX
PSTN
SIP
Application
Server
IP
PSTN SIP Signaling Channel
Phone
IP Media Stream
GSX
Media Server/
IAD/SIP
Phone
SIP Call Signaling Packets without DTMF INFO messages
G.711 G.72X
G.711 / RFC2833 (with DTMF Digits Removed) G.72X / RFC2833 (with DTMF Digits Removed)
G.711 / (with DTMF Digits Removed) G.72X / (with DTMF Digits Removed)
Figure 6–32 illustrates the IP streams for SIP calls when CODEC is G711 or G711SS, DTMF RELAY
is rfc2833, and DTMF REMOVE DIGITS is enabled. This establishes in band DTMF Relay using
the RFC2833 mechanism. Thus, although the SIP Signaling channel is active, it does not carry
DTMF tones. Additionally, the DTMF tones are removed from the audio packets in the IP Media
Stream. At least one CNS or SPS server module must be present in the GSX to provide processing
resources for DTMF Relay, even under G.711 encoding.
The default Packet Service Profile shown below provides this SIP IP environment.
% SHOW PACKET SERVICE PROFILE default ADMIN
Node: TPUBS Date: 2002/09/03 15:36:47 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX SIP DTMF Detection/Insertion Handling
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SIP DTMF Detection/Insertion Handling Managing the GSX
FIGURE 6–33 G.711with DTMF RELAY, Out of Band, with DIGITS REMOVED
PSTN
SIP
Application
Server
IP
PSTN SIP Signaling Channel
Phone
IP Media Stream
GSX
Media Server/
IAD/SIP
Phone
SIP Call Signaling Packets without DTMF INFO messages
G.711 G.72X
G.711 / RFC2833 (with DTMF Digits Removed) G.72X / RFC2833 (with DTMF Digits Removed)
G.711 / (with DTMF Digits Removed) G.72X / (with DTMF Digits Removed)
Figure 6–33 illustrates the IP streams for SIP calls when CODEC is G711 or G711SS, DTMF RELAY
is outOfBand or longDigit, and DTMF REMOVE DIGITS is enabled. This establishes out of
band DTMF Relay using SIP INFO message types to exchange DTMF digit information with the
SIP Application Server on the SIP Signaling Channel. Additionally, the DTMF tones are removed
from the audio packets in the IP Media Stream. At least one CNS or SPS server module must be
present in the GSX to provide processing resources for DTMF Relay, even under G.711 encoding.
The default Packet Service Profile shown below provides this SIP IP environment.
SHOW PACKET SERVICE PROFILE default ADMIN
Node: TPUBS Date: 2002/09/03 15:36:47 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX SIP DTMF Detection/Insertion Handling
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SIP DTMF Detection/Insertion Handling Managing the GSX
FIGURE 6–34 G.729A with DTMF RELAY, Out of Band, with DIGITS REMOVED
PSTN
SIP
Application
Server
IP
PSTN SIP Signaling Channel
Phone
IP Media Stream
GSX
Media Server/
IAD/SIP
Phone
SIP Call Signaling Packets without DTMF INFO messages
G.711 G.72X
G.711 / RFC2833 (with DTMF Digits Removed) G.72X / RFC2833 (with DTMF Digits Removed)
G.711 / (with DTMF Digits Removed) G.72X / (with DTMF Digits Removed)
Figure 6–34 illustrates the IP streams for SIP calls when CODEC is G729A, DTMF RELAY is
outOfBand or longDigit, and DTMF REMOVE DIGITS is enabled. This establishes out of band
DTMF Relay using SIP INFO message types to exchange DTMF digit information with the SIP
Application Server on the SIP Signaling Channel. At least one CNS or SPS server module must be
present in the GSX to provide processing resources for both the G.729A audio compression and
DTMF Relay.
The default Packet Service Profile shown below provides this SIP IP environment.
SHOW PACKET SERVICE PROFILE default ADMIN
Node: TPUBS Date: 2002/09/03 19:20:01 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX SIP DTMF Detection/Insertion Handling
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SIP DTMF Detection/Insertion Handling Managing the GSX
FIGURE 6–35 G.729A with DTMF RELAY, In Band, with DIGITS REMOVED
PSTN
SIP
Application
Server
IP
PSTN SIP Signaling Channel
Phone
IP Media Stream
GSX
Media Server/
IAD/SIP
Phone
SIP Call Signaling Packets without DTMF INFO messages
G.711 G.72X
G.711 / RFC2833 (with DTMF Digits Removed) G.72X / RFC2833 (with DTMF Digits Removed)
G.711 / (with DTMF Digits Removed) G.72X / (with DTMF Digits Removed)
Figure 6–35 illustrates the IP streams for SIP calls when CODEC is G729A, DTMF RELAY is
rfc2833, and DTMF REMOVE DIGITS is enabled. This establishes in band DTMF Relay using
the RFC2833 mechanism. In this case, the DTMF audio is removed from the packets in the IP
Media Stream. At least one CNS or SPS server module must be present in the GSX to provide
processing resources for both audio compression and DTMF Relay.
The default Packet Service Profile shown below provides this SIP IP environment.
SHOW PACKET SERVICE PROFILE default ADMIN
Node: TPUBS Date: 2002/09/03 19:20:01 GMT
Zone: GMTMINUS05-EASTERN-US
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX SIP DTMF Detection/Insertion Handling
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Alarm and Threshold Crossing Reporting Hierarchies Managing the GSX
This description summarizes a GSX software facility to limit the reporting of interface-related
(Layer 1) events. These are log file entries and SNMP traps that are generated by the occurrence of
an error or a state change on the Layer 1 interface. Frequently, when such an event occurs at a
particular layer of the interface, it propagates itself to other layers on the interface. This can result
in the reporting of numerous events that ultimately resolve themselves to a small number of
meaningful events.
• The SYS event log file is more streamlined, making it easier for a system engineer to
determine the root-cause problem.
• Bandwidth usage of the management IP network is reduced because fewer system events are
written to the NFS server and fewer SNMP traps are sent.
• Insight EMS is less likely to be throttled due to an excessive number of SNMP traps sent
within a short time period.
• GSX Sonic Bus traffic from CNS to MNS is reduced on the GSX9000.
• CPU utilization on MNS or GNS due to SNMP trap generation is reduced.
ST Frame
DS1 (x84)
HG (x336)
Virtual Tributary (x84)
VT AIS
Higher layers
(VT PTE)
Downstream
Upstream
Path (x3)
Path AIS (STS PTE)
Line
Line AIS (LTE)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Alarm and Threshold Crossing Reporting Hierarchies
The interface layering depicted in the figure applies to a VT-mapped SONET/SDH signal, such as
processed by the CNS71 module on the GSX. (The ST Frame is meaningful only in Japan mode.)
This figure depicts signal processing on the CNS71. In the sections that follow, the ALARM
REPORTING HIERARCHY CLI object applies to the CNS86, CNS85, CNS81, CNS80, CNS71,
CNS60, and CNS30 circuit processing modules through the OPTICAL INTERFACE and T3 CLI
objects. The TCA FILTER CLI object applies to the CNS modules through the OPTICAL
INTERFACE, T3, T1 and E1 CLI objects.
The following sections describe the consequences of unregulated reporting of events in each
category.
As an example of unregulated reporting of alarm state change events, assume that a CNS71
section-layer defect, such as loss of frame (LOF), is detected. As shown in Figure 6–36, the action
taken in response to a section-layer defect is to generate line AIS downstream to the LTE. The
LTE then generates path AIS downstream to the three STS PTEs, which in turn generate VT AIS
downstream to the 84 VT PTEs, which generate DS1 AIS downstream to the 84 DS1s. Without an
alarm reporting hierarchy, as each AIS defect at the higher layers integrates into an alarm, it will
be individually reported. The result is that for this single section-layer root-cause problem, 172
AIS alarms are reported (84 DS1 AIS + 84 VT AIS + 3 Path AIS + 1 Line AIS), along with the
single LOF alarm.
As an example of unregulated reporting of threshold crossing alerts, assume again that an LOF
defect occurs, as discussed above. The AIS defects cause all the near-end error counts at each
interface layer to increment. As the AIS defects persist, threshold crossing alerts will be generated
for each near-end error count at each layer. Depending on the particular parameter threshold
values the user has configured, the result could be the reporting of several thousand threshold
crossing alerts.
When the user changes the administrative or operational state of an optical interface, the respective
administrative or operational state of the 84 DS1s carried in the OPTICAL INTERFACE are
automatically changed to match the OPTICAL INTERFACE (or T3). The administrative or
operational state change of each individual DS1 is reported separately, along with the OPTICAL
INTERFACE, resulting in 85 state change events being reported.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Alarm and Threshold Crossing Reporting Hierarchies Managing the GSX
allow you to configure alarm state change reporting to report only the root-cause problem when an
alarm state change occurs. When ALARM REPORTING HIERARCHY is enabled, the root-cause
problem, only, is reported. When ALARM REPORTING HIERARCHY is disabled, the root-cause
problem and all propagated problems such as those described above, are reported.
The root-cause problem is defined as the lowest-layer problem that directly causes higher-layer
problems to be detected. This alarm reporting hierarchy conforms to GR-253-CORE, Issue 3,
Section 6.2.1.8.2. The Automatic Protection Switch (APS) feature poses special considerations for
determining the root-cause problem. For instance, a section or line layer alarm may or may not
result in Path, VT and DS1 AIS alarms. If a section or line alarm occurs and an APS switchover
occurs, the Path, VT, and DS1 layers do not go into AIS alarm. However, if an APS switchover
does not occur (because the APS Lockout or Protect command was issued), the Path, VT, and DS1
layers do go into AIS alarm. Thus, when a section or line layer alarm occurs, the resulting path
layer AIS alarms (if any) are always reported. Otherwise it would be unclear from looking at the
traps generated or log file entries whether or not a path layer alarm occurred due to the section/line
layer alarm. If a path layer alarm does occur, the resulting VT AIS and DS1 AIS alarms will not be
reported, since the path layer alarm is the root-cause of the VT and DS1 alarms.
Assuming that ALARM REPORTING HIERARCHY is enabled, if you use the example from "Alarm
State Change Reporting" on page 6–164, the section-layer LOF alarm is the root-cause problem,
because it directly causes AIS to be detected in all higher layers. Therefore, the LOF alarm would
be reported. If an APS switchover does not occur, causing the STS path layers to go into AIS
alarm, these would also be reported, while the VT and DS1 layer alarms would be not be reported.
The alarm status information for each layer, regardless of ALARM REPORTING HIERARCHY state, is
available via SNMP GET operations. Thus CLI alarm status SHOW screens will continue to indicate
the AIS alarms present at all the higher layers.
The ALARM REPORTING HIERARCHY is applicable only to near-end alarms (LOS, LOF, AIS, LOP,
UNEQ, PLM). It does not apply to far-end alarms (RFI). This is because far-end alarms, unlike
near-end alarms, do not necessarily cause an alarm to occur at lower layers. For example, a Line
RFI does not necessarily cause Path and VT RFI alarms.
The default state of the ALARM REPORTING HIERARCHY is enabled.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Alarm and Threshold Crossing Reporting Hierarchies
allow you to enable or disable the reporting of each particular threshold crossing alert on a specific
error-type parameter basis. The error types are CV-L, CV-S, ES-L, ES-S, SEFS-S, SES-L, SES-S,
UAS-L, CV-P, ES-P, SES-P, UAS-P, CV-V, CSS-P, ES-V, SES-V, UAS-V, SEFS-P, and SAS-P.
These filters may be applied to the Layer 1 interface associated with the CNS modules through the
appropriate CLI objects.
A threshold crossing alert that occurs at a lower-layer due to parity errors, does not necessarily
imply that a corresponding higher-layer threshold crossing alert will occur. This differs from alarm
state changes, where a lower-layer alarm log entry always implies that a higher-layer AIS alarm
will occur. This property lends itself to the ALARM REPORTING HIERARCHY described in the
previous section, but that hierarchy is not offered for threshold crossing alerts. Instead, each error-
type may be individually “filtered” (or enabled/disabled) for the reporting of threshold
crossing alerts.
NOTE
The relevant standards (GR-253-CORE, ANSI T1.231) require that performance
monitoring be performed independently at each interface layer, and that threshold
crossing alerts be independently sent for each and every parameter, at each and
every layer.
The default state of the threshold crossing alert filtering mechanism for every parameter is
disabled (not filtered). An operator is required to explicitly provision the GSX to enable filtering
of selected threshold crossing alerts. Control of the report filtering is accomplished via CLI
commands, and the current state of the filtering (enabled/disabled) is available via CLI show
screens. Threshold crossings that have occurred, but weren’t reported because of filtering, are also
viewable via CLI SHOW screens. The TCA FILTER applies to near-end and far-end alarms.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Alarm and Threshold Crossing Reporting Hierarchies Managing the GSX
NOTE
There are no CLI commands to configure administrative/operational state change
reporting. The sections that follow describe the GSX software policy for reporting
these changes.
All of these changes are always reported in the system event log. Each reported system event
consolidates the information on a T3 basis, if possible. The sections that follow describe the
circumstances under which these consolidations do and don’t take place.
This section describes the GSX event reporting behavior when the administrative or operational
state of an OPTICAL INTERFACE or T3 is configured at boot time via a Parameter Download. This
may happen in either of two ways:
• At boot time, Parameter Download is enabled, and a parameter file exists
• CLI commands are issued before the CNS has booted
The "normal" case is where the administrative and operational states of the underlying T3s and
T1s are identical to the corresponding states of the OPTICAL INTERFACE/T3. In this case, the
event reporting at boot time will be identical to that described in "State Changes via CLI
Commands" on page 6–168.
The "exception" case is when the administrative or operational state of one or more underlying
T3s/T1s is not the same as the corresponding state of the OPTICAL INTERFACE/T3. As an
example, consider an OPTICAL INTERFACE that is configured to administrative state enabled,
operational state inService. At this point all 84 underlying T1s are also enabled/inService.
Suppose that a user then configures T1 #1 to enabled/outOfService. Then the user reboots the
CNS module. Since T1 #1 operational state is not the same as the other 83 T1s, a single
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Alarm and Threshold Crossing Reporting Hierarchies
operational state change event indicating that all 84 T1s are inService cannot be reported,
because T1 #1 is outOfService. In this case, individual operational state change events will be
reported for each T1. Note that since the administrative states of all 84 T1s is the same (enabled),
a single administrative state change event indicating that all 84 T1s are enabled will be reported.
This section describes the GSX event reporting behavior when the administrative or operational
state of an OPTICAL INTERFACE or T3 is changed via CLI commands after the CNS module has
booted. These action is initiated either by running a CLI script, or issuing CLI commands via a
telnet session.
For all state changes except “operational state placed out-of-service with dryup”, a single
administrative or operational state change event indicating that all 84 (or 28) underlying T1s have
changed state will be reported when the administrative or operational state of an OPTICAL
INTERFACE/T3 is changed. In addition, the state change for the OPTICAL INTERFACE/T3 will
also be reported.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SIP Redirect Handling Managing the GSX
The GSX manages the process of trying “targets” to reach the destination of a SIP call. The targets
consist of (1) routes returned by the initial route lookup performed by the PES module, (2) explicit
destinations received in 300 redirect response messages, and (3) additional routes determined as a
result of re-querying the PSX PES if so indicated in a 300 redirect response. Re-querying will
occur where the IP address of the redirect Contact is the GSX that sent the INVITE.
Redirect processing controls are provisioned in the Signaling Profile associated with each SIP
Server virtual Trunk Group. These controls specify how 300 redirect messages associated with
INVITEs to that SIP Server virtual Trunk Group are handled. Redirects can be merged with
existing targets or used as replacements for previously determined targets (previous targets are
purged).
• GSX maintains two lists: routes and redirect contacts. The merger/purge process applies only
to redirect contacts, not the original routes.
• A PSX Signaling Profile drop-down allows the provisioner to configure either (1) no
redirection allowed, (2) multiple redirections per route, or (3) a single redirection per route.
• The GSX will process only the first 10 contacts in any single redirect received.
• The GSX will allow a maximum of 10 redirect attempts per route.
• If one of the redirects causes the GSX to re-query the PSX, all previously determined routes
and redirects are purged. A maximum of 10 such redirected re-queries of the PSX are allowed
per call.
• The PSX control flag which indicates to "skip crankback profile and always crankback" only
applies to processing 300 redirects, not the original routes.
• The GSX always uses its default crankback profile to determine whether or not to try the next
element in the route list. See "Call Crankback Profile" on page 3–1171.
• q-values associated with contacts in a redirect response are used to order the contacts in that
redirect. If a q-value is not present, it is equivalent to a q-value of 1. Contacts with the highest
q-value are tried first, however contacts received in subsequent 300 responses take priority
over previously received untried contacts.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Call Bridging Facilities
In some ISUP and ISDN environments, a call can be transferred from the original destination back
to the GSX for completion of the call to the transfer destination. This allows the occupying
resources on the original destination to be released. The original destination establishes a different
call to the final transfer destination, and then releases the calls back to the GSX, allowing the two
independent calls to be bridged together into a single call. This feature is designed for services
such as enhanced 411, where the call can be set up to the number provided from the directory.
Forwarding the call from the directory-assistance center is possible but would tie up all of its
trunks, whereas this feature allows the directory-assistance trunk to be re-used once the call is
bridged.
Figure 6–37 illustrates a typical scenario where the following two calls are bridged together:
GSX
Party A Party B (Operator)
GSX
Party A
Party C
Bridging causes the connection of the voice path from Party A to Party C. The other call legs to the
operator (Party B and Party B') are disconnected. Call Bridging is available through ISUP and
ISDN service.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Bridging Facilities Managing the GSX
The SS7 ISUP standard for this method of bridging is known as Release Link Trunking (RLT), or
“Facility Release to Pivot” per ANSI T1.666-2000. ISUP service groups must use REVISIONs
ansi1992, ansi1995, or ansiatt and must set RLT in the ISUP SIGNALING PROFILE to
supported. See "Egress Release Link Trunking (RLT) Feature Specific Data Field" on page 7–
118 and "Ingress Release Link Trunking (RLT) Feature Specific Data Field" on page 7–122 for
more detail on the accounting treatment of these calls.
ISDN PRI Two B Channel Transfer (TBCT), per GR 2865, is the counterpart to SS7 ISUP
Release Link Trunking, described in the previous section. This feature is available when the GSX
is configured on the network side of the ISDN switch. TBCT allows the bridging of two calls
where one call is in Established state and the other is in Alerting state. The first call (from Party A
to operator) must be in Established state; the 2nd call (from operator to Party C) may also be in
Established state but is allowed to be in Alerting state.
The command thread below is a provisioning example for the use of this feature. In this case, ISDN
SERVICE prixyz:
See "Two B-Channel Transfer Feature Specific Data Field" on page 7–122 for more detail on the
accounting treatment of these calls.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Call Bridging Facilities
Multiple Bridging Transfer allows a call which is already involved in a multiparty bridged call to
be subjected to another multiparty operation such as redirection or bridging.
Figure 6–38 illustrates a continuation of the example in Figure 6–37, where Party C is another
operator who places another call to Party D. This second operator performs a bridging operation to
bridge Party A to Party D, while both legs to the second operator drop out of the call. The end
result is a single voice path from Party A to Party D.
GSX
Party A
Party C (Operator)
GSX
Party A
Party D
Multiple bridging transfers are possible even when all call legs are on the same GSX (as shown in
Figure 6–38).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Bridging Facilities Managing the GSX
The GSX SIP Call Transfer feature uses REFER, an IETF SIP extension that provides the means
to build different types of transfer and third-party call control services. The SIP REFER method, as
defined by RFC 3261, indicates that the recipient should contact a third party using the contact
information provided in the request. This method can be used to enable a variety of applications,
including—but not limited to—SIP Call Transfer. The REFER method improved on the BYE/Also
concept by disassociating transfers from the processing of BYE. These changes facilitate recovery
of failed transfers and clarify state management in the participating entities.
The GSX acts as the transferee in basic transfer scenarios when the transfer target is exposed to the
transferee. Using the REFER method, the call transfer can be initiated by either the called (egress)
or calling (ingress) party.
Figure 6–39 illustrates SIP Call Transfer using REFER from the egress leg of the call. Figure 6–
40 illustrates SIP Call Transfer using REFER from the ingress leg.
GSX
Party A Party B
GSX
Party A Party B (On Hold)
Party C
The egress leg (Party B) requests to
be put on hold and the call is
referred to Party C.
GSX
Party A
Party C
After the call has been referred to
Party C, Party B disconnects.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Call Bridging Facilities
GSX
Party A Party B
The call starts as a normal tandem
two-party call.
GSX
Party A (On Hold) Party B
The ingress leg (Party A) requests
Party C
to be put on hold and the call is
referred to Party C.
GSX
Party B
After the call has been referred to
Party C Party C, Party A disconnects.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Mid-Call Digit Detection Managing the GSX
The GSX provides a DTMF digit detection service that detects DTMF tones within the voice
stream of a stable call without affecting or altering the voice quality of the call. GSX applications
such as SIP, MGCP, and the internal GSX scripting engine use this service to implement a number
of features. These applications contain digit maps that the GSX will compare to each digit it
detects in the audio stream of a call. When a digit map matches a notification, it is sent to the
application. Notifications are application-specific but can take the form of a SIP INFO message to
an external SIP server or it can be an internal notification to the GSX scripting engine.
The Mid-call digit detection functionality is provided by CNS25, CNS40, CNS45, CNS60,
CNS80, CNS81, CNS85, CNS86, CNS60, and CNS71 modules on the GSX9000 and by GNS
modules on GSX4000 series switches, and is supported by circuit-to-circuit, packet-to-circuit, and
transcoded packet-to-packet call types. CNS30, CNS10, and CNS25 cards continue to support
long pound/## detect. Long #/## detect is a primitive form of mid-call digit detection - to make use
of a digit map requires a CNS25, CNS40, CNS45, CNS60, CNS80, CNS81, CNS85, CNS86,
CNS60, or CNS71 module.
For information on configuring the SIP DTMF trigger, see "SIP DTMF Trigger Detection" on
page 3–1203.
Packet-to-Packet Pass-Through
Support for mid-call detection on packet-to-packet pass-through calls is provided on PNS40 and
MNS20 modules. This provides the GSX/NBS the ability to perform mid-call DTMF digit
detection as per RFC 2833, without hardware assistance on specific packet server modules or
access of a DSP resources on another module, e.g. an SPS module.
To enable this feature, you configure the NBS with two trigger profiles, INGRESS and EGRESS,
using the CONFIGURE DTMF TRIGGER <triggerprofile> ... command. Each profile has a
digit pattern associated with it. For packet-to-packet pass-through calls, the Ingress triggers are
used to detect RFC 2833 DTMF and out-of-band (OOB) digits sent to the Ingress peer (Calling
Party). Egress triggers are used to detect RFC 2833 and OOB digits sent to the Egress peer (Called
Party). RFC 2833 event detection is only supported when the RTP sampling rate is 8000Hz.
Wideband audio codecs (for example AMR-WB, G722.1) are not supported.
For information on configuring the SIP DTMF trigger, see "SIP DTMF Trigger Detection" on
page 3–1203.
NOTE
If you run two-stage calls that use Long Digit DTMF interrupts, the GSX does not
automatically terminate the egress leg but instead reports the DTMF interrupt event
to the script for appropriate event handling. If you do not modify the script to CPL
6.0 (or later), the previous functionality---where the GSX releases the called party
automatically and then reports the DTMF interrupt to the script---will be preserved.
If you open the script using SPE and modify and/or save it back to the PSX, then
you must ensure that the script is modified to release the called party on receipt of
Long Digit DTMF interrupt appropriately.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Mid-Call Digit Detection
This feature allows for DTMF tones to be detected and sent to the softswitch via MGCP NTFY
messages without interrupting the bearer audio media stream (providing mid-call non-intrusive
DTMF detection). Prior to this release tone detection caused a disconnection in the bearer path (i.e.
intrusive DTMF detection) and was generally used prior to call cut through. The following
sections describe how to setup mid call non-intrusive DTMF detection; the existing intrusive
DTMF detection capabilities remain unchanged.
The GSX will interpret any RQNT command containing an R: parameter requesting all DTMF
tone events with action "notify" as a request to enable non-intrusive DTMF detection. This
includes stand-alone RQNT commands as well as encapsulated RQNT commands. Specifically,
the R: parameter must be set as follows:
R:d/[abdcx#*L](n)
or
R:d/[abdcx#*](n)
The "L" event is optional. If omitted then long DTMF tones appear in the Observed Event
parameter with out the d/l prefix event. The RQNT which enables mid-call may also include an
instance of S: parameter containing a tone or announcement. The GSX will respond to the request
as follows:
• If the request is sent to a circuit provisioned on a CNS25, CNS60 or CNS71 module, then the
detection can be enabled using the DSP resource normally allocated for the call and the
request will be accepted (subject to normal CRCX command processing). All circuits on
CNS25, CNS60 and CNS71 modules possess this capability.
• If the request is sent to a circuit provisioned on a CNS10 or CNS30 module then the request
will be accepted (subject to normal CRCX command processing) if a conference bridge
resource can be allocated. The number of conference bridge resources supported on the
CNS10 and the CNS30 modules is limited.
• If mid-call non-intrusive DTMF detection cannot be performed then the CRCX+RQNT
request will be rejected with error status.
Any other instances of RQNT command which requests DTMF tone detection will continue to use
the existing functionality.
Other signals (tones or announcements) may be generated, or stopped, while non-intrusive DTMF
detection remains enabled.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Mid-Call Digit Detection Managing the GSX
Per the MGCP standards, long-duration tones, if the "long" tone event 'd/l' is included in the R:
parameters, will appear as two observed events in the "O:" parameter of the NTFY command. For
example:
O:d/l,d/#,d/l,d/0
indicates that a long "#" tone followed by long "0" tone have been detected.
NOTE
The R: parameter syntax R:d/all(n) is not usable here since this would also
enable detection of the timeout event T.
Mid-call non-intrusive DTMF detection is supported only on the audio media stream received
from the endpoint.
As DTMF tones are detected a NTFY command will be generated and sent for each DTMF tone
detected outside of MGCP "Quarantine" periods (i.e. detected while there is no prior outstanding
NTFY). DTMF tones detected during the Quarantine Period are accumulated as observed events;
on exit from the Quarantine Period then the next NTFY command will include all DTMF tones
which may have been detected (this is per normal MGCP protocol).
For example, the following command enables mid-call non-intrusive DTMF detection of all
DTMF tones with a NTFY sent for tones as they are detected, paced by the call agent in response
to each prior NTFY command:
CRCX 7349 9/7/1@DYNASTY MGCP 1.0
C:1
M:sendrecv
Z2: 9/6/1@DYNASTY
X: 1234
R:d/[abdcx#*](n)
Q:loop,process
NOTE
The setting Q:loop,process allows the GSX to send additional NTFY commands
as additional tones are detected after receiving a response to last NTFY sent
without requiring a new RQNT. This is strongly recommended as the protocol used
for mid-call non-intrusive DTMF detection.
Mid-call detection is suspended on receipt of any RQNT with empty R: parameter line. Mid-call
detection will be resumed on receipt of the R: which is used to enable mid-call as described above.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX IP Trunk Groups
IP Trunk Groups
IP trunk groups are used to carry calls between GSXs and to and from SIP servers and H.323
gateways within the packet network core. IP trunk groups are also used to carry calls to and from
IP devices at the network edge in packet peering scenarios. This enables carriers to manage and
control peering relationships in their packet network in the same way they manage and control
peering relationships in their circuit-switched network.
An IP trunk group is a collection of IP trunks serving one or more IP signaling peers. Carriers are
able to apply call admission controls for call traffic to and from IP signaling peers by defining the
maximum number of calls and/or the maximum allocated bandwidth per trunk group. During
provisioning, an IP trunk group is associated with an IP signaling peer group, a collection of IP
signaling peers.
NOTE
For egress calls, only a single signaling peer IP address is returned by the PSX in a
policy response, regardless of the number of members of the IP signaling peer
group. In this case, each of these individual peers is returned in a round-robin
fashion, per policy response. However, ingress calls over an IP trunk group may
identify more than one signaling peer. The IP addresses of these signaling peers
are specified in the Network Selector Table. See "Network Selector Table" on
page 3–558.
The provisioning model for IP trunk groups is similar to the one used for PSTN trunk groups. On
the PSX, an IP trunk group is associated with a signaling profile and an IP signaling profile, a
packet service profile, a numbering plan, and a feature control profile. On the GSX, an IP trunk
group is associated with a service group.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
IP Trunk Groups Managing the GSX
Figure 6–41 shows IP trunk groups for ingress call legs. In this example, ingress IP call legs are
associated with one of three ingress IP trunk groups: IP-A, IP-B, and IP-C. The IP trunk group
named IP-B is associated with all call legs from the IP signaling peer group. Call legs from other
ingress IP signaling peer groups are associated with trunk groups IP-A or IP-C.
GW-GW, SIP, or
H323 Signaling GSX
IP-A
IP-B TG PSTN
IP-C
IP Trunk
Group of Groups
Signaling Peers
The GSX selects ingress IP trunk groups based on the IP network address and signaling protocol of
the originating peer. The GSX maintains a mapping from IP network addresses to IP trunk groups
in an object called the IP Trunk Group Selection Table, which is similar to a router’s IP routing
table. It contains an IP Network Selector, which includes one or more IP network addresses
specifying a range of IP addresses in the network and an IP trunk group name. The GSX uses the
longest prefix match method for selecting an ingress IP trunk group, in which the longest, most
specific entry in the list of possible ingress IP trunk groups will be selected.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX IP Trunk Groups
Figure 6–42 shows IP trunk groups for egress call legs. In this example, egress IP call legs are
associated with one of three egress IP trunk groups: IP-A, IP-B, and IP-C. The IP trunk group
named IP-B is associated with all call legs to the IP signaling peer group. Call legs to other egress
IP signaling peer groups are associated with trunk groups IP-A or IP-C.
IP-A
PSTN TG IP-B
IP-C
IP Trunk Group of
Groups Signaling Peers
The GSX selects egress IP trunk groups based on either the trunk group name from the destination
route received in the policy response from the PSX (for delivery via SIP or H.323) or the IP
network address and signaling protocol of the destination peer (for calls routed between GSXs on
IP trunk groups within the network core). In the policy response, the PSX returns an IP signaling
profile, a signaling profile, an IP peer signaling address, the IP peer signaling protocol, and a
packet service profile. The peer signaling information needed by the GSX is provided by the PSX
in the route-specific information of the policy response. IP trunk group selection by name takes
precedence over selection by IP network address.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
IP Trunk Groups Managing the GSX
Figure 6–43 shows IP trunk groups in a packet-to-packet scenario. Packet-to-packet calls consist
of an ingress call leg over IP trunk group IP-A and an egress call leg over IP trunk group IP-B.
Each IP trunk group is associated with a distinct IP signaling peer group.
Group of Group of
Signaling Peers Signaling Peers
IP-A IP-B
IP Trunk IP Trunk
Group Group
There are two types of IP trunk groups on the GSX, as discussed below.
Non-routable IP trunk groups are used in the network core. These IP trunk groups control
processing of calls between GSXs, are provisioned on the GSX, and although they are not used for
routing, they can be provisioned on the PSX for assigning profiles.
The PSX uses routable IP trunk groups when providing call routing services for packet calls,
which can be in the network core or at the network edge in a packet peering scenario.
Figure 6–45 shows IP trunk groups in the network core and at the network edge in a packet
peering configuration. In this example, trunk group A is a PSTN trunk group, trunk groups B and
C are non-routable IP trunk groups in the network core, and trunk group D is a routable IP trunk
group at the network edge. The PSX routes calls directly from trunk group A to trunk group D by
instructing GSX 1 to initiate a call to trunk group D on GSX2. Calls are not explicitly routed
through trunk groups B and C.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX IP Trunk Groups
IP trunk groups can be used to control and manage packet voice traffic flowing within the core of a
carrier network.
Figure 6–44, "IP Trunk Groups in the Network Core" shows an example carrier network
consisting of four points of presence (POPs), each containing a cluster of GSXs. On each GSX in
the network, an IP trunk group is defined to every other POP in the network. For example, on
every GSX in POP A, three trunk groups would be defined: TG PopB, TG PopC, and TG PopD.
These IP trunk groups represent the traffic between POP A and each of the other POPs in the
network.
Pop A
Pop C
IP Network
Pop B
Pop D
Using this model, the carrier is able to understand how well the VoIP application is performing
through the IP network. The carrier can monitor traffic data reported by each of the IP trunk
groups and obtain a good understanding of quality measures of calls occurring between any two
POPs. Each IP trunk group reports performance data concerning call processing such as call
attempts/completions, bandwidth allocations/usage, and media quality measures such as packet
loss/jitter. Similarly, a failure within the IP network that affects traffic between two POPs will be
reported by the performance statistics of the respective IP trunk groups; this provides meaningful
information to the carrier for troubleshooting the network failure and for establishing temporary
corrective actions.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
IP Trunk Groups Managing the GSX
Performance data collected from each of the IP trunk groups within the network provide valuable
data for capacity planning processes. Along with capacity planning, IP trunk groups can also be
used to provide static assurances of engineered capacity by enforcing call and/or bandwidth limits
between any two POPs within the network. This model of capacity engineering is familiar to
carrier traffic engineers and would be a natural step in the evolution of a carrier’s network to
packet.
Figure 6–45 shows IP trunk groups in the network core and at the network edge in a packet
peering scenario. In this example, trunk group A is a PSTN trunk group, trunk groups B and C are
non-routable IP trunk groups in the network core, and trunk group D is a routable IP trunk group at
the network edge. The PSX routes calls directly from trunk group A to trunk group D by
instructing GSX 1 to initiate a call to trunk group D on GSX2. Calls are not explicitly routed
through trunk groups B and C.
FIGURE 6–45 IP Trunk Groups in the Network Core and at the Network Edge
PSTN IP Trunk
Trunk PSX Group At the
Group IP Trunk Network Edge
Groups
Carrier A
…A Sonus Solution… Carrier B
…Some Other Solution…
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX IP Trunk Groups
• Static Call Admission Controls—These controls enable carriers to either admit or reject calls
to manage the traffic to and from signaling peers over their associated IP trunk groups. The
controls are based on allocation of resources, the maximum number of calls allowed, and/or
the maximum allocated bandwidth.
Call and bandwidth limits are statically configured per IP trunk group, which is associated
with an IP signaling peer group. Note that the bandwidth limits are enforced for media only.
Bandwidth for signaling, management data, traffic data, CDRs, and logs is excluded. Static
call admission controls are provisioned on the GSX. For information, see "Trunk Groups" on
page 3–532.
• Traffic Monitoring—IP trunk groups provide a set of traffic statistics such as number of call
attempts, number of completions, and total number of call seconds on the IP trunk group. The
statistics available for IP trunk groups are the same as those available for PSTN trunk groups.
There are additional statistics for IP trunk groups for bandwidth usage, media performance,
and quality of service. For example, statistics on call failures specify whether a failure was due
to unavailable bandwidth as opposed to unavailable call resources.
• Traffic Controls—IP trunk groups can be managed by a set of traffic controls similar to those
available for PSTN trunk groups.
The traffic controls detected by the PSX and applied by the GSX include CANT (Cancel To),
CANF (Cancel From), SKIP, STR (Selective Trunk Reservation), IRR (Immediate
Rerouting), SIRR (Spray Immediate Rerouting), ORR (Overflow Rerouting), and SORR
(Spray Overflow Rerouting). These traffic controls apply to IP trunk groups at the network
edge.
The traffic controls detected and applied by the GSX include DRE (Directional Reservation
Equipment) and SILC (Selective Incoming Load Control). These traffic controls apply to IP
trunk groups at the network edge as well as those in the network core.
There are additional controls for IP-related events, such as packet outage detection (POD),
which monitors the receive RTP (real-time transport protocol) stream of calls on an IP trunk
group. When packet outage events are detected by the DSPs (digital signal processors) on the
GSX, the POD control limits new call admission into the network.
• Multi-Shelf Trunk Group Management—This feature enables IP trunk groups to span
multiple GSXs, allowing resources managed by a trunk group to be distributed across the
GSXs. This enables the resources managed by the static call admission controls (maximum
number of calls allowed and maximum allocated bandwidth) to be controlled centrally,
allowing for better network resource management.
• Hierarchical Resource Management—IP trunk groups can be arranged in a hierarchy to
enforce multiple call admission control policies for calls. For example, this feature can be used
in conjunction with the multi-shelf trunk group management feature to allow carriers to
manage the bandwidth for an access link to a network node as well as the bandwidth between
the node and other nodes in the network. For information, see "Trunk Groups" on page 3–532.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
IP Trunk Groups Managing the GSX
Source gateway routing (end-to-end routing) and IP trunk group routing (hop-by-hop routing) are
two options for routing SIP and H.323 calls. Source gateway routing is enabled on the PSX by
default.
Source gateway routing is a PSX feature in which the source gateway and associated trunk group
used for routing a call are not the gateway that sent the policy request and its associated trunk
group. Instead, the source gateway and associated trunk group that the PSX uses to route a call are
derived from information sent in the policy request about the gateway that originated the call.
For a SIP or H.323 ingress call to a GSX, the GSX passes the originating gateway address to the
PSX. The PSX determines the originating gateway from the originating gateway address and
assigns the associated SIP or H.323 trunk group to the call. The associated trunk group can either
be the default SIP or H.323 virtual trunk group or a provisioned virtual trunk group. The PSX uses
the originating gateway and its associated virtual trunk group as the source information for routing
the call.
For SIP calls, a SIP server may send a SIP INVITE message to the GSX with an Originating Trunk
Group (OTG) parameter that specifies the OTG on the originating SIP server. The GSX passes the
originating gateway address and the OTG parameter to the PSX. The PSX determines the
originating gateway from the originating gateway address and uses the originating gateway and the
trunk group specified in the OTG parameter as the source information for routing the call.
If source gateway routing is enabled (by clearing the Use IP Trunk Group Routing (Hop By Hop
Routing) For Ingress check box in the Flags section of the Trunk Group screen), the PSX ignores
any provisioned IP trunk groups and uses the originating gateway and its associated virtual trunk
group (or for SIP calls, the trunk group specified in the OTG parameter of the SIP INVITE
message, if included) as the source information for routing calls.
When IP trunk groups are provisioned on the PSX, an IP trunk group can be used as the source
trunk group for PSX route processing. To provision the PSX to use IP trunk group routing instead
of source gateway routing, on the Trunk Group screen, in the Flags section, select the Use IP
Trunk Group Routing (Hop By Hop Routing) For Ingress check box. The PSX will use the
gateway that sent the policy request and its associated IP trunk group as the source information for
routing calls.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX IP Trunk Groups
This section includes examples of IP trunk groups in a trunking gateway application, a SIP server
application, and a packet peering application.
Figure 6–46 shows an example of IP trunk groups used in a traditional trunking application. In this
example, the carrier uses the Sonus Gateway-to-Gateway (GW-GW) signaling protocol for
signaling between switches in the packet network core. The example shows a call between two
switches, GSX1 and GSX2, and shows IP trunk groups IPTG1 and IPTG2 in the network core.
Egress IP Ingress IP
Trunk Group Trunk Group
GSX1 GSX2
10.1.1.1 10.2.1.1
Carrier A
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
IP Trunk Groups Managing the GSX
Note that the route information specifies the destination switch by name and IP network
address and the destination trunk group, but does not contain any information about the IP
trunk groups in the network core.
4. When it receives the policy response from the PSX, GSX1 determines if the route is a local or
remote route. In this example, the route is a remote route to trunk group IPTG2 on GSX2.
GSX1 searches the IP Trunk Group Selection Table using the destination signaling address,
10.2.1.1, to select the egress IP trunk group with the most specific network address. In this
example, IP trunk group IPTG1 is selected.
5. GSX1 continues to process the call, implementing the features associated with IP trunk group
IPTG1. IPTG1 specifies a call admission control (CAC) call limit of 1,000 calls and a
bandwidth limit of 100 Megabytes per second. GSX1 enforces these limits, and if the call is
allowed, GSX1 sends a call setup message to GSX2.
6. GSX2 receives the call setup message from GSX1 and searches the IP Trunk Group Selection
Table using the signaling address of the originating GSX1, 10.1.1.1, to select the ingress IP
trunk group with the most specific network address. In this example, IP trunk group IPTG2 is
selected.
7. IPTG2 specifies a CAC call limit of 2,000 calls and a bandwidth limit of 200 Megabytes per
second. GSX2 enforces these limits, and if the call is allowed, GSX2 admits the call,
terminating the call on trunk group TG2.
Traffic measurements are collected for this call on all of the trunk groups: TG1, IPTG1, IPTG2,
and TG2, and all PSTN traffic controls apply to TG1 and TG2. IPTG1 enforces the DRE control.
IPTG2 enforces the DRE and SILC controls (of 80% and 20% respectively).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX IP Trunk Groups
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
IP Trunk Groups Managing the GSX
Egress IP
Trunk Group
Ingress PSTN
Trunk Group PSX
VTG
IPTG1
TG1 “Virtual Trunk Group”
SIP/SIP-T
SIP
GSX1 Server
10.1.1.1 10.2.1.1
Default * No No Limit
Limit
As depicted in Figure 6–47, a call from a GSX to a SIP server is set up as follows:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX IP Trunk Groups
An IP signaling profile specifying the SIP signaling attributes for the call is associated with the
SIP VTG.
4. When it receives the policy response from the PSX, GSX1 determines if the route is a local or
remote route. In this example, the route is a remote route to trunk group VTG on the SIP server
using SIP as the signaling protocol. GSX1 searches the IP Trunk Group Selection Table using
the destination signaling address, 10.2.1.1, to select the egress IP trunk group with the most
specific network address. In this example, IP trunk group IPTG1 is selected.
5. GSX1 continues to process the call, implementing the features associated with IP trunk group
IPTG1. IPTG1 specifies a call admission control (CAC) call limit of 1,000 calls and a
bandwidth limit of 100 Megabytes per second. GSX1 enforces these limits, and if the call is
allowed, GSX1 sends a SIP INVITE message to the SIP server.
Traffic measurements are collected for this call on all of the trunk groups: TG1 and IPTG1. TG1
enforces the DRE and SILC traffic controls, IPTG1 enforces the SILC control (of default values
75% and 25% respectively). IPTG1 is an IP trunk group in the network core, and only the DRE
control applies for egress calls from GSX1.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
IP Trunk Groups Managing the GSX
Ingress IP
Trunk Group
Egress PSTN
PSX Trunk Group
IPTG1 TG1
SIP/SIP-T
SIP GSX1
Server 10.1.1.1
10.2.1.1
Default * No No Limit
Limit
As depicted in Figure 6–48, a call to GSX from a SIP server is set up as follows:
1. The SIP server sends a SIP INVITE message to the PSX. The PSX responds with a 300
REDIRECT message, which redirects the call to the GSX.
2. The SIP server sends a SIP INVITE message to the SIP signaling port on the GSX.
3. Upon receipt of the SIP INVITE message, GSX1 searches the IP Trunk Group Selection Table
using the peer signaling address, 10.2.1.1, to select the ingress IP trunk group with the most
specific network address. In this example, IP trunk group IPTG1 is selected.
4. GSX1 continues to process the call, implementing the features associated with IP trunk group
IPTG1. IPTG1 specifies a call admission control (CAC) call limit of 1,000 calls and a
bandwidth limit of 100 Megabytes per second. GSX1 enforces these limits, and if the call is
allowed, GSX1 accepts the SIP INVITE message from the SIP server.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX IP Trunk Groups
5. GSX1 issues a policy request to the PSX, indicating IPTG1 as the ingress trunk group on the
GSX. The PSX may route the call using the GSX1/IPTG1 or SIP server/SIP as the ingress
source information for the call, depending whether source gateway routing or IP trunk group
routing has been provisioned on the PSX for IPTG1. For information, see the PSX Policy
Server Product Description.
Traffic measurements are collected for this call on all of the trunk groups: TG1 and IPTG1. TG1
enforces the DRE traffic control, and IPTG1 enforces DRE and SILC controls (of 80% and 20%
respectively).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
IP Trunk Groups Managing the GSX
Figure 6–49 shows an example of a packet peering application call from within Carrier A’s
network to a SIP server in Carrier B’s network. The figure shows a call from an ingress GSX to a
GSX acting as a Network Border Switch at the edge of Carrier A’s network, to a SIP server in
Carrier B’s network. Within Carrier A’s network core, Gateway-to-Gateway (GW-GW) signaling
protocol is used. Between Carrier A and Carrier B, SIP-I protocol is used. The figure shows the IP
trunk groups, IPTG1, IPTG2, and IPTG3, used in the call. In this example, IP trunk group routing
is used.
Carrier A
Egress IP
Trunk Group
TG IP # Calls BW … TG IP # Calls BW …
Name Network Allowed Name Network Allowed
Selector Selector
IPTG1 10.2.* 1000 100M …. IPTG2 10.1.* 2000 200M ….
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX IP Trunk Groups
4. When it receives the policy response from the PSX, GSX1 determines if the route is a local or
remote route. In this example, the route is a remote route to trunk group IPTG3 on GSX2.
GSX1 searches the IP Trunk Group Selection Table using the destination signaling address,
10.2.1.1, to select the egress IP trunk group with the most specific network address. In this
example, IP trunk group IPTG1 is selected.
5. GSX1 continues to process the call, implementing the features associated with IP trunk group
IPTG1. IPTG1 specifies a call admission control (CAC) call limit of 1,000 calls and a
bandwidth limit of 100 Megabytes per second. GSX1 enforces these limits, and if the call is
allowed, GSX1 sends a call setup message to GSX2.
6. GSX2 receives the call setup message from GSX1 and searches the IP Trunk Group Selection
Table using the signaling address of the originating GSX1, 10.1.1.1, to select the ingress IP
trunk group with the most specific network address. In this example, IP trunk group IPTG2 is
selected.
7. IPTG2 specifies a CAC call limit of 2,000 calls and a bandwidth limit of 200 Megabytes per
second. GSX2 enforces these limits, and if the call is allowed, GSX2 admits the call,
terminating the call on IP trunk group IPTG3.
Traffic measurements are collected for this call on all of the trunk groups: TG1, IPTG1, IPTG2,
and IPTG3. IPTG1 and IPTG2 are IP trunk groups in the network core (non-routable IP trunk
groups) and IPTG3 is an IP trunk group at the network edge of Carrier A’s network (a routable IP
trunk group). TG1 and IPTG2 enforce the DRE and SILC traffic controls and IPTG3 enforces all
applicable traffic controls.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
IP Trunk Groups Managing the GSX
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX IP Trunk Groups
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Configuring Local SS7 Links Managing the GSX
Integrated SS7 F link (fully-associated link) termination allows a GSX to serve as the physical
interface point connecting the GSX directly to the PSTN signaling network. Direct termination of
SS7 F links from the SS7 network is via T1/E1 interfaces on the GSX4000 and via E1s interfaces
on CNS25, CNS40, CNS45, CNS71, CNS81, and CNS86 modules.
F Links will generally be deployed when a large volume of traffic exists between two signaling
switching points (SSPs) (between the GSX and a PSTN switch), or when it is not feasible to
connect directly to a signal transfer point (STP).
NOTE
You can configure a maximum of:
-- 256 SS7 links on the GSX9000: one SS7 link per three E1s (20 SS7 Links per
CNS71/CNS81/CNS86 and four (4) per CNS25/CNS40/CNS45).
When you create an SS7 node, you define the protocol type used between the GSX9000 or
GSX4000 series switch and its signaling gateway using the SERVER PROTOCOL parameter. The
local option establishes that direct SS7 termination (no external Signaling Gateway) is used.
Configuration of SS7 links involves creating and configuring new objects for Message Transfer
Part 2 (MTP2) and Message Transfer Part 3 (MTP3) along with associating the MTP links with the
SS7 node object.
The following objects are used to configure, control, and display the status of MTP2 and MTP3
protocol layers:
MTP2 Objects
MTP3 Objects
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Configuring Local SS7 Links
Configuration Steps
For detailed information on command syntax and parameter for each of the SS7 objects in the
following procedure, see the section "SS7 Link Termination" on page 3–357 in Chapter 3, "CLI
Reference".
1. Create and enable an SS7 MTP2 link profile. This example uses the profile name
itu1.
% CREATE SS7 MTP2LINK PROFILE itu1
% CONFIGURE SS7 MTP2LINK PROFILE itu1 STATE ENABLE
2. Create and enable SS7 MTP2 links. This example uses the link names link1,
link2, link3, and link4.
% CREATE SS7 MTP2LINK link1
% CONFIGURE SS7 MTP2LINK link1 PROFILE itu1 ..
PORT port1-2 TIMESLOT 17
% CONFIGURE SS7 MTP2LINK link1 STATE ENABLE
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Configuring Local SS7 Links Managing the GSX
5. Create, configure, and enable the SS7 Node. Note the local option for the SERVER
PROTOCOL parameter. This example uses the SS7 Node name c7n3.
% CREATE SS7 NODE c7n3 PROTOCOL itu
% CONFIG SS7 NODE c7n3 POINTCODE SIZE 14 POINTCODE FORMAT 14
% CONFIG SS7 NODE c7n3 PC 3
% CONFIG SS7 NODE c7n3 SS7 MTP3 MGMT mtp3
% CONFIG SS7 NODE c7n3 SERVER PROTOCOL local
% CONFIG SS7 NODE c7n3 SERVICES isuponly
% CONFIG SS7 NODE c7n3 MODE inservice
% CONFIG SS7 NODE c7n3 CONNECT always
% CONFIG SS7 NODE c7n3 STATE enabled
6. Create SS7 Destination nodes. This example uses the Destination node names
c7n12 and c7n13.
% CREATE SS7 DESTINATION c7n12 TYPE adjacent ..
POINT CODE 12 SS7 NODE c7n3 SS7 MTP3 MGMT mtp3
% CREATE SS7 LINK ls1-2 TYPE f SLC 1 SS7 NODE c7n3 SS7 ..
DESTINATION c7n12 SS7 MTP2LINK link3
% CREATE SS7 LINK ls2-1 TYPE f SLC 0 SS7 NODE c7n3 SS7 ..
DESTINATION c7n13 SS7 MTP2LINK link2
% CREATE SS7 LINK ls2-2 TYPE f SLC 1 SS7 NODE c7n3 SS7 ..
DESTINATION c7n13 SS7 MTP2LINK link4
8. Create and activate SS7 Linksets between the source and destination nodes. This
example uses the linkset names ls1 and ls2.
% CREATE SS7 LINKSET ls1 SS7 NODE c7n3 SS7 DESTINATION c7n12
% CONFIG SS7 LINKSET ls1 ACTIVATION MODE normal
% CREATE SS7 LINKSET ls2 SS7 NODE c7n3 SS7 DESTINATION c7n13
% CONFIG SS7 LINKSET ls2 STATE activate
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Configuring Local SS7 Links
9. Create and enable SS7 Routes between source and destination nodes. This
example uses route names r1 and r2.
% CREATE SS7 ROUTE r1 TYPE direct PRIORITY 0 SS7 NODE c7n3 ..
SS7 DESTINATION c7n12 SS7 LINKSET ls1
The default setting for SS7 MTP2 Links Error Correction is BASIC (Basic Error Correction). This
method depends on a constant receipt of acknowledgements by the sending point code. In an
environment where there are long propagation delays with satellite links, you can set the error
correction method to PCR (Preventive Cyclic Retransmission). PCR does not wait for
acknowledgements; rather, if no new message signaling unit (MSUs) are available for
transmission, those available for retransmission are retransmitted cyclically.
To change the Error Correction Method to Preventive Cyclic Retransmission (PCR) for an SS7
MTP2 Link:
1. Deactivate the SS7 Link. This example uses the SS7 Link name link.:
% CONFIGURE SS7 LINK link ACTIVATION MODE DEACTIVATE
2. Disable the SS7 MTP2 Link. This example uses the SS7 MTP2LINK name link1.:
% CONFIGURE SS7 MTP2LINK link1 STATE DISABLED
3. Disable the SS7 MTP2 Profile. This example uses the SS7 Node name itu1.:
% CONFIGURE SS7 MTP2LINK PROFILE itu1 STATE DISABLED
4. Set the Error Correction Method to PCR:
% CONFIGURE SS7 MTP2LINK PROFILE itu1 ECM PCR
5. Re-enable the SS7 MTP2 Profile:
% CONFIGURE SS7 MTP2LINK PROFILE itu1 STATE ENABLED
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Configuring Local SS7 Links Managing the GSX
------------------------------------------------------------------
MTP2 Link Profile : itu1
Administrative State : ENABLED
Protocol Variant : ITU
Link Speed : HIGH
Bitrate (Kbps) : BITRATE64
Error Correctiom Method (ECM) : PCR
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Using the Disk Management Utility (DMU)
The Local Disk Management Utility (DMU) is an interactive command-line shell from which
manage the GSX local disk. Basic commands allow you to create, delete, and view the contents of
directories as well as navigate through the directory hierarchy. Copying files is supported for use
in software upgrade procedures (to copy script files from one software path directory to another).
Limited viewing capabilities for text files is also supported.
DMU Commands
Table 6–31 lists the DMU commands. Except for the chdev and lsdev commands, you can issue
all DMU commands listed while in the NVS Configuration subsystem and during run-time (i.e. via
the CLI).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the Disk Management Utility (DMU) Managing the GSX
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Using the Disk Management Utility (DMU)
The Disk Verify Utility (similar to a scandisk utility) is invoked using the verify command from
the DMU. The utility verifies the integrity of the file system and repairs fixable errors. After
starting the Disk Verify Utility, you may be prompted (depending on the options specified) to
choose from the following actions when a repairable error is encountered:
If any unrepairable errors are encountered, the Disk Verify Utility notifies you that the disk must
be reformatted, for which the format command must be used.
Whenever a GNS module boots, the Disk Verify Utility automatically runs. If the utility
encounters unrepairable errors, a format is automatically executed if the GNS boots as standby;
otherwise the GNS resets itself and allows the other GNS to boot.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Using the Disk Management Utility (DMU) Managing the GSX
See Table 6–31, DMU Commands, for usage. Note the following additional usage information:
• Use the -s switch if there is a problem with the disk, as this condition could produce a large
amount of errors.
• Use the -r switch to repair any fixable errors. However, if any errors were repaired, you must
rerun the Disk Verify Utility to check for other errors hidden by the first error. To repeatedly
run the utility until the disk is clean (or there are only unrepairable errors), use the -rl switch.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Circuit Test Packages
This section describes circuit test packages that may be utilized by a particular vendor (“Carrier
1”) for testing 64 Kb/second channels (DS0s) in STM-1 that interconnect GSXs with PSTN
switches owned by other carriers (designated hereafter by “Carrier 2”).
The sections below describe the vendor objective, the respective Sonus solutions, and how these
test packages are provisioned and used.
The Carrier 1 test objective is to verify the end-to-end connectivity of each circuit. Provisioning
these circuits into service/trunk groups may, but need not be a prerequisite for testing. Figure 6–50
shows how Carrier 1 performs circuit testing. Regardless of whether a trunk group with signaling
is in-service or out-of-service, the testing is carried out by direct voice path cut-through to the
channel under test, with no signaling sent or received.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Circuit Test Packages Managing the GSX
Switch at Switch at
Carrier 1 Carrier 2
POP POP
The PSTN switches used by Carrier 1 have a special telephone line appearance through which a
technician can dial up a voice path cut-through to any DS0 channel on the switch. The test line
appearance uses a special dial plan by which digits dialed on the phone designate the specific DS0
to be tested.
To perform the test, a Carrier 1 technician dials up a voice path to the DS0 on Carrier 1’s switch,
and a Carrier 2 technician dials up a voice path to the same DS0 on Carrier 2’s switch. If the two
technicians can talk, the test is successful. The two technicians then proceed to test the next DS0,
and so on. In the future, manual call initiation at either or both end points may be automated.
Sonus provides five circuit test packages to address this objective, as previously described:
• SENDTL
• CMT
• Outgoing Trunk Test
• Incoming Trunk Test
• PSX Configuration Test
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Circuit Test Packages
The Sonus SENDTL test package provides a facility that satisfies the Carrier 1 objective cited
above, subject to the following conditions:
PSX
Switch connects two-
way voice path to the
specific DS0 designated
by digits dialed on the
PSX routes test call to
test telephone.
proper egress GSX on
basis of calledpty #. DS0 1
DS0 to be tested is DS0 n
specified in callingpty #
GSX has a T1
assigned to special Special test
test TG that accepts telephone line
CAS signaling provided by switch
Channel bank
(MUX) with FXO
channel unit to serve
Carrier 1 & Carrier 2
the telephone set
technicians talk over
the DS0 under test
after each dials
connection to their
own end of that DS0.
As shown in Figure 6–51, one GSX at the Carrier 1 POP has a T1 attached to a channel bank
(MUX), and that T1 will be configured as an ingress trunk group for test calls. Although other
GSXs may be in the network, under this package the egress trunk groups that contain the test DS0s
must be on the same GSX as the ingress trunk group. A Foreign Exchange Office (FXO) channel
unit installed in the channel bank serves as a standard telephone set for test initiation. The FXO
unit provides loop current to the telephone set and recognizes on/off-hook from the telephone set.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Circuit Test Packages Managing the GSX
The SENDTL test package is triggered by the use of the TRUNK GROUP named SENDTL-something
on the PSX. The GSX must not use that name. On the GSX, SENDTL-anything is a reserved trunk
group name that is never used in normal operations.
CAUTION
Trunk Group names starting with the letters "SENDTL" are reserved for the
SENDTL feature. Do not configure a trunk group on the GSX that begins with those
letters. The virtual trunk group named "SENDTL" should be configured only on the
PSX.
Signaling is used to set up the call. All DS0s must be assigned to some (ISUP, CAS, or ISDN)
SERVICE group, and that service group must be enabled, prior to circuit testing.
Sonus recommends that you configure the test ingress T1 as a CAS trunk group to use the FXO
signaling that is available on the phone set and the channel bank. This approach is not necessary,
but it will be illustrated in the configuration examples in following sections.
The CAS profile needs to recognize a called party number terminated by delimiter # and followed
by eight digits of calling party number.
The called party number must be configured in the PSX prefix profile that is associated with the
ingress trunk group. This entity declares how to interpret the called party number.
The calling party number digits designate the egress circuit to be tested. This string has the format
aabbccdd, defined as follows:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Circuit Test Packages
NOTE
The called and calling party digits are passed to the PSX in a policy request just as
for a regular call. The PSX is provisioned so that the called number finds a special
egress test trunk group that always starts with the string "SENDTL", and this trunk
group is on the egress GSX that has the DS0 to be tested.
The trunk group can have additional characters, but must always start with
SENDTL. Examples: SENDTLgsx1, SENDTLgsx2, SENDTLtokyoGsx1, and so forth.
The PSX returns a policy response with the SENDTL trunk group, including called
and calling numbers, plus other call data. The GSX recognizes a SENDTL trunk
group as requiring special handling.
SENDTL appears to an egress GSX as a virtual trunk group (TG) that contains all
the DS0s of all the service groups existing on that GSX. For the SENDTL virtual TG,
hunting is not used to select a DS0. Instead, a DS0 is selected according to the
aabbcc digits of the calling party number (DS0, DS1, port/slot).
Selection of a DS0 results in a test call being set up over the selected DS0 using
the kind of signaling associated with the DS0's actual service group (ISUP, ISDN,
or CAS).
See "Configuring SENDTL and CMT Circuit Test Packages" on page 6–213 for the setup
procedures for this testing package.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Circuit Test Packages Managing the GSX
The capabilities of the CMT package allow testing of local DS0s accessed through a local test T1,
just as does the SENDTL package. In addition, the CMT package can be provisioned to test
connectivity between DS0 circuits on a remote GSX and a remote Carrier 2 switch. Both test
setups are depicted in Figure 6–52.
Channel bank
(MUX) with FXO CAS trunk group for
channel unit to serve initiating multiple test
the telephone set calls automatically,
concurrently
• Signaling may, but need not be, used to set up test calls.
• The test DS0s may, but need not be, provisioned to trunk groups/service groups.
• If the trunk group/service group is provisioned, the call will be successful even when the ISUP
circuit under test is “blocked”.
• The trunk and service groups may, but need not be, enabled when the tests are run.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Circuit Test Packages
On the GSX at the local POP, Carrier 1 can initiate tests manually via a telephone set on a channel
bank using called party and calling party digits to set up each test as described for SENDTL.
Sonus recommends that you configure the test ingress T1 as a CAS trunk group to use the FXO
signaling that is available on the phone set and the channel bank. This approach is not necessary,
but it will be illustrated in the configuration examples in following sections.
In addition to increased capabilities described above, this package differs from the SENDTL
package in provisioning requirements. Most provisioning takes place at the PSX.
PSX Provisioning
• Trunk Group Name - A name must be chosen for the ingress trunk group that will handle CMT
calls, but the name itself has no significance. Sonus recommends a descriptive name such as
“CMT_TRUNK”.
• Feature Control Profile Flag - This flag (FCP) must be enabled on the ingress trunk group that
handles the CMT call.
• Allow CMT Call Flag - This flag must be enabled in Feature Set 3.
• Process Called Party Number Flag - This flag must be enabled in Feature Set 1.
• Ingress Numbering Plan - A prefix profile must be enabled for this entity.
• Ingress Trunk Group - The Calling Party Category (CPC) for this entity must be “test call”.
• Prefix Profile (assigned to the above Ingress Numbering Plan) - Digit type “test” must be
enabled. The called party number must be configured in this profile, to describe how to
interpret this number. This string must match the pattern of the called number, which selects
the egress GSX.
• Route Label - A route label with the new trunk must be created.
• Standard Route - A standard route for the test digits that uses this route label must be created.
The calling party digits used in the prefix profile also differ from the SENDTL package. The CMT
calling party number takes the form xxffttppdd, where:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Circuit Test Packages Managing the GSX
GSX Provisioning
Unlike the SENDTL setup, the DS0s to be tested do not need to be enabled members of an enabled
GSX trunk/service group.
NOTE
Figure 6–52 shows the Sage and telephone set at a local POP able to also test
DS0s on a GSX in a remote POP. This capability will enable Carrier 1 operations
centers to remotely test DS0s anywhere throughout that carrier’s Sonus network.
If proper external equipment is available, both (SENDTL and CMT) test packages may perform
automated call-thru testing to tone generators and other test boxes on other switches. This
equipment must properly inject a Calling Party Number (CPN). Typically a test script is created
and invoked to process a list of CPNs.
Sage Instruments is one such external equipment provider. A Sage automatic test controller can
initiate up to 24 (or more) tests concurrently using the same test dial plan as described for manual
tests from a telephone set. Thus a Sage (or equivalent) can run automated tests on thousands of
DS0s per hour. This setup is shown in Figure 6–52, Circuit Tests Using Sonus CMT Package on
page 6–211, but it pertains as well to the SENDTL environment.
On the GSX, follow Step 1 through Step 8 for both SENDTL and CMT testing:
1. Configure the T1 for the special test trunk group that accepts CAS signaling:
% CONFIGURE T1 T1-1-3-1-1 SIGNALING robbedBit
2. Create a Circuit Service Profile (see "Circuit Service Profile" on page 6–215):
% CREATE CIRCUIT SERVICE PROFILE CAS_CSP
3. Create a Trunk Group (see "Trunk Group" on page 6–216):
% CREATE TRUNK GROUP test_TG
4. Create a CAS service group (see "CAS Service Group" on page 6–217):
% CREATE CAS SERVICE TR00_CAS
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Circuit Test Packages
5. Assign lsFxo Signaling and the previously created trunk group to the CAS service
group:
% CONFIGURE CAS SERVICE TR00_CAS SIGNALTYPE lsFxo TRUNK
GROUP test_TG
6. Assign the test T1 and the Circuit Service Profile to the above service group/trunk
group:
% CONFIGURE CAS CHANNEL SERVICE TR00_CAS PORT T1-1-3-1-1 ..
CHANNEL 1-24 CIRCUITPROFILE CAS_CSP
7. Create a Signal Sequence to collect the calling and called party numbers (see "CAS
Collection Profile" on page 6–217):
% CONFIGURE CAS SIGNALSEQ SSP ingressToneStart INDEX 1 ..
TOKEN COLLECTFIELD PARAM1 dnisDTMF SCPNAME collectErrors
% CONFIGURE CAS SIGNALSEQ SSP ingressToneStart INDEX 2 ..
TOKEN COLLECTFIELD PARAM1 aniDTMF SCPNAME collectErrors
% CONFIGURE CAS SIGNALSEQ SSP ingressToneStart INDEX 3 ..
TOKEN REPORT PARAM1 setupComp
8. Configure the DS0s to be tested into a service group (ISUP, ISDN, or CAS) and
trunk group, using the same logic as used above to create the test trunk group.
9. On the PSX, perform the previously cited PSX configuration, including the routing
tables. For SENDTL, see "SENDTL Sonus Circuit Test Package" on page 6–208.
For CMT, see "PSX Provisioning" on page 6–212.
10. Then to carry out a SENDTL test:
a. Off-hook the phone set.
b. Push the digits on the phone set, such as “102#06130801”
This selects egress GSX 02 as set up in the PSX configuration, DS0 6 on T1 span
13 on the CNS module in slot 8 of that GSX. That channel should be cut-through
and the caller on the far end should be audible.
End of Procedure
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Circuit Test Packages Managing the GSX
The sections below provide information on creating a Circuit Service Profile, Trunk Group, CAS
Service Group, CAS Collection Profile as required in the Step 2, Step 3, Step 2Step 2Step 2 Step 4,
and Step 7 of "Configuring SENDTL and CMT Circuit Test Packages" above.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Circuit Test Packages
Trunk Group
The TRUNK GROUP, test_TG, shown below, receives the off-hook signal:
% SHOW TRUNK GROUP test_TG ADMIN
Node: TPUBS Date: 2005/07/01 03:58:07 GMT
Zone: GMTPLUS09-TOKYO
This trunk group is bound to CAS SERVICE , TR00_CAS, as shown by the command below:
% SHOW TRUNK GROUP test_TG SERVICEGROUPS
Node: TPUBS Date: 2005/07/01 03:58:13 GMT
Zone: GMTPLUS09-TOKYO
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Circuit Test Packages Managing the GSX
The CAS SERVICE, TR00_CAS, shown below, is configured with Loop Start Foreign Exchange
Office (LSFXO), signaling. See "CAS Loop Start / Ground Start Signaling" on page 6–130 for the
call initiation sequence using this signaling type.
% SHOW CAS SERVICE TR00_CAS ADMIN
Node: TPUBS Date: 2005/07/01 03:59:23 GMT
Zone: GMTPLUS09-TOKYO
------------------------------------------------------------
Name: TR00_CAS
------------------------------------------------------------
Admin State: ENABLED Trunk Group: test_TG
Mode: INSERVICE Hunt Algorithm: BOTTOM2TOP
Cost: 50 Profile Name:
Signal Type: LSFXO Signal Variant: NONE
Switch Side: NETWORK CPTone Pkg:
Maint Busy: ENABLED Answer Timeout: 0
Auto Busy: 0 DTMF Profile:
Requires CPTone DISABLED Ingress SSP: CAS_INGRESS_SSP
Provides CPTone DISABLED Egress SSP: CAS_EGRESS_SSP
MGC Package: NONE PSC SSP:
DT Profile:
Crank Back Prof: 1
The CAS COLLECTIONPROFILE, dnisDTMF, shown below will collect the called party number
first, followed by the ANI. The Tone Prompt has been configured with dial which means it will
provide dial tone as prompt for collection of called party digits. The term digit, POUND, designates
the pound sign (“#”) as the terminator of the called party number. The first dialed digit is awaited
for up to six seconds (6000 milliseconds) and successive dialed digits are awaited for five seconds
(5000 milliseconds):
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Circuit Test Packages
Name: dnisDTMF
Type: DTMF
CollectId: DNIS
MinDigits: 3
MaxDigits: 11
FirstDigit Timer: 6000
InterDigit Timer: 5000
Field Timer: 20000
Term Digit: POUND
Restart Digit:
Reinput Digit:
Report Digits: 0
FirstDigit Quiet: DISABLED
Announce Prompt: 0
Tone Prompt: dial
Append Digits: DISABLED
Ack Signal 1: 1
Ack Signal 2: 1
The CAS COLLECTIONPROFILE, aniDTMF, shown below will collect the ANI. This CAS
collection profile is otherwise structured similarly to dnisDTMF, above.
% SHOW CAS COLLECTIONPROFILE aniDTMF ADMIN
Node: TPUBS Date: 2005/06/29 21:51:13 GMT
Zone: GMTMINUS05-EASTERN-US
Name: aniDTMF
Type: DTMF
CollectId: ANI
MinDigits: 8
MaxDigits: 10
FirstDigit Timer: 6000
InterDigit Timer: 5000
Field Timer: 20000
Term Digit: POUND
Restart Digit:
Reinput Digit:
Report Digits: 0
FirstDigit Quiet: DISABLED
Announce Prompt: 0
Tone Prompt:
Append Digits: DISABLED
Ack Signal 1: 1
Ack Signal 2: 1
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Circuit Test Packages Managing the GSX
The outgoing trunk test verifies PSTN trunk group and circuit connectivity without having to
provision any routing information on the PSX. Configuration of the CAS Signaling Profile
provides the basic information required for the GSX to initiate and route a call without having to
issue a policy request to the PSX. The required and optional information to perform this test is
listed below:
• Destination Gateway (optional) – specifies the destination gateway's signaling IP address and
port. When not provided, a call on a local trunk group is performed.
• Outgoing Trunk Group (required)
• Outgoing Circuit (required) - specifies the actual circuit (slot, port, channel, or CIC) within
the trunk group.
• Called Party Number (required)
• Called Party Nature of Address (optional) - Subscriber, National, International, or Network
Specific.
• Calling Party Number (optional)
• Calling Party Nature of Address (optional) - Subscriber, National, International, or Network
Specific.
• TMR - 3.1KHz audio, Speech, 64K restricted, or 64K unrestricted. The default is speech.
Note that this overrides the value specified in the circuit service profile for the CAS channel
originating the call. Also since a T1 CAS interface is initiating the call, a 64K unrestricted path
through the originating GSX is not possible. However, a 64K unrestricted path will be
established between the originating and terminating switches involved in the test.
• Calling Party Category (CPC) (optional) - Ordinary subscriber, Priority subscriber, Test, or
Pay phone.
• Originating carrier code (optional)
• Originating charge area (optional)
• ISUP Preferred (optional) - non-required or mandatory.
• ISDN Access (optional) - ISDN or non-ISDN.
The details of CAS configuration is defined in "Configuring Test Calls" on page 6–222. The
incoming CAS T1 may be configured for E&M, Loop Start, or Ground Start signaling.
NOTE
CAS E1/MFCR2 circuits are not supported.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Circuit Test Packages
The incoming trunk test verifies PSX routing and configuration. The test simulates an incoming
call on any previously provisioned trunk group. Configuration of the CAS Signaling Profile
provides the basic information required to simulate an incoming call on the incoming trunk groups
requiring verification. The required and optional information to perform this test is listed below:
The information is provisioned on an incoming CAS T1 circuit connected to a channel bank. The
test call is initiated by going offhook on a phone connected to the channel bank. The calling and
called address digits can also be entered via DTMF digits. Once the call is initiated, the PSX query
is performed, and the call then proceeds as any other outbound call from the GSX.
The details on how the CAS configuration is performed is defined in "Configuring Test Calls" on
page 6–222. The incoming CAS T1 may be configured for E&M, Loop Start, or Ground Start
signaling.
NOTE
CAS E1/MFCR2 circuits are not supported.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Circuit Test Packages Managing the GSX
The PSX Configuration Test builds on the Incoming Trunk Test by adding the ability to configure
the Incoming Gateway name. When the incoming gateway is specified, the existing Incoming
Trunk Group configuration specifies the Incoming Gateway and Incoming Trunk Group pair. This
allows the Policy Requests generated by the “Test Call” GSX to simulate policy requests coming
from a different GSX.
Once the Incoming Gateway name is configured and a CAS test call is initiated, the existing CAS
SSP Outgoing Gateway and Outgoing Trunk Group configuration will specify the route to be
selected from the list of routes returned by the PSX in the Policy Response: The first route with the
specified Outgoing Gateway and Outgoing Trunk Group will be selected regardless of the priority
of other routes in the Policy Response (i.e., the GSX will ignore all other routes in the route list.)
NOTE
If the Outgoing Gateway and Outgoing Trunk Group are not configured when this
feature is invoked, the test call will be routed using the standard call control
routing logic, selecting the highest priority route from the Policy Response.
When the GSX performing the Test Call sends a policy request to the PSX, the PSX will perform
the policy lookup as if the ingress call arrived on the specified Incoming Gateway and Incoming
Trunk Group. This functionality requires that the Incoming Gateway be registered with the PSX.
The required and optional information to perform this test is listed below:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Circuit Test Packages
• Outgoing Gateway (optional) – specifies the destination gateway's signaling IP address and
port. If no value is specified for the Outgoing Gateway IP address, the corresponding token’s
(TESTOUTGW) PARAM1 value is set to an empty string. If the Outgoing Gateway IP
Address is specified, but the port is not, the port number will default to 2569.
• Outgoing Trunk Group (optional) - if no value is specified, the corresponding token’s
(TESTOUTTG) PARAM1 value is set to an empty string.
Provisioning of the parameters required by Outgoing Trunk, Incoming Trunk, and PSX
Configuration tests is accomplished by utilizing the CAS signaling sequence profile (SSP)
mechanism. The following CAS Signaling Tokens are used for testing:
• testCGPN
• testCDPN
• testOUTGW
• testOUTTG
• testCIC
• testSLOT
• testCHAN
• testINTG
• testORIGCARRIER
• testORIGCHARGE
• testCPC
• testTMR
• testISUPPREF
• testISDNACCESS
• testINGW
For descriptions on these tokens, see Table 3–210 on page 3–1119, "CAS Signaling Tokens".
Note there are two ways to specify the outgoing circuit (CIC or slot/port/channel). Specifying a
CIC will take precedence over slot/port/channel. If a CIC is not specified then the slot, port, and
channel must all be specified for the call to correctly egress the specified channel. If an outgoing
circuit is not specified correctly, then a channel is hunted from the specified trunk group.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Circuit Test Packages Managing the GSX
An example script containing CAS SSPs for the following is provided as a TCL file located in
cli/sys/casTestCallSetup.tcl:
• outTestCic - Outbound test (DS0 specified by CIC, configured called party number)
• outTestDs0 - Outbound test (DS0 specified by slot/port/channel, configured called party
number)
• outTestCicCdDtmf - Outbound test (DS0 specified by CIC, called party number entered via
DTMF)
• outTestDs0CdDtmf - Outbound test (DS0 specified by slot/port/channel, called party
number entered via DTMF)
• inTest - Inbound test (configured called party number)
• inTestCdDtmf - Inbound test (DTMF supplied called party number)
The configuration will not be built into the GSX software. Your system administrator must source
the scripts on systems requiring the test call enhancements. Once the scripts are sourced, the test
CAS service/trunk group can be configured using the supplied SSPs.
Perform the following edits on the script file prior to sourcing on a GSX:
• Update the outTestDest variable to reflect a valid trunk group on the GSX.
set outTestDest { local SKYLARK-MABEL-SS78 1198 10 1 6 }
• Update the inTestTg variable to reflect a valid trunk group on the GSX.
set inTestTg SKYLARK-MABEL-SS78
The following shows an example SSP which would implement the outgoing test call type.
% SHOW CAS SIGNALSEQ SSP outTestCic SUMMARY
Node: SKYLARK Date: 2005/09/12 20:30:35 GMT
Zone: GMTMINUS05-EASTERN-US
CAS SSP: outTestCic
Index Pos Token Param1 Param2 SCP Name State
----- --- ------------ ---------------- ---------------- -------------- -------
1 0 TESTOUTGW 10.13.1.65 ENABLED
1 0 TESTOUTTG SS78 ENABLED
2 1 TESTCIC 1067 ENABLED
3 2 TESTCGPN 9786148300 subscriber ENABLED
4 3 TESTCDPN 9786148200 national ENABLED
5 4 TESTCPC test ENABLED
6 5 TESTTMR speech ENABLED
7 6 TESTORIGCARRIER 0288 ENABLED
8 7 TESTORIGCHARGE 12345 ENABLED
9 8 TESTISUPPREF 1 ENABLED
10 9 TESTISDNACCESS 1 ENABLED
11 10 REPORT setupComp ENABLED
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Circuit Test Packages
The test call SSPs provided must be configured with a CAS service/trunk group. This CAS service
must be separate from any other CAS service used for other test calls (such as circuit match test,
TL105, etc). Note, that a single T1 can be split into multiple CAS services. Each CAS service can
be configured with enough DS0s to perform the required test calls. For example, channels 1-4 can
be used for TL105, channels 5-8 for circuit match test and 9-12 for incoming/outgoing test calls.
To change a parameter in the CAS SSPs, you must first disable the signaling sequence, change the
PARAM1 or PARAM2 field, and then re-enable the signaling sequence. For example, the following
commands change the called party number for the outbound test:
% CONF CAS SIGNALSEQ SSP outTestCic INDEX 3 STATE DIS
% CONF CAS SIGNALSEQ SSP outTestCic INDEX 3 PARAM1 9786148299
% CONF CAS SIGNALSEQ SSP outTestCic INDEX 3 STATE ENAB
You must repeat this series of commands for every PARAM1 or PARAM2 field.
Simplified Method for Modifying CAS Signaling Sequence Profiles
To simplify this configuration, CLI function extensions are provided in the form of a TCL script
located in cli/sys/casTestCallProcs.tcl.
This script can either be sourced by your system administrator when the test calls need to be
performed, or they can be put into the cli/sys/sessinit.tcl script so they are available for
every CLI session.
The script contains three functions which will perform configuration operations on the CAS test
call SSPs.
• casOutTest – provides an easier method to update a CAS SSP for outgoing test calls
• casInTest – provides an easier method to update a CAS SSP for incoming test calls
• casPsxTest – provides an easier method to update a CAS SSP for PSX configuration test
calls.
The following are example uses of these functions:
% casOutTest SSP outTestCic GWIP 10.13.1.67 TG SS75
% casOutTest SSP outTestCic CGPN 9785551212 CDPN 9786148299
% casOutTest SSP outTestCic CIC 1078
These commands perform all of the necessary re-configuration of the CAS SSP called
outTestCic. You can enter the commands as a single command with all parameters on a single
line. Once you have completed entering the commands, you can perform a test call with the new
parameters.
NOTE
This enhanced CLI method is only available when logged in directly to a GSX CLI
session. It is not available via Sonus Insight EMS.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Circuit Test Packages Managing the GSX
You can specify the following parameters to the casOutTest function. Each parameter must have
an associated value. The permitted values for each parameter are defined in "Configuring Test
Calls" on page 6–222.
You can specify the following parameters to the casInTest function. Each parameter must have
an associated value. The permitted values for each parameter are defined in "Configuring Test
Calls" on page 6–222.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Circuit Test Packages
You can specify the following parameters to the casPsxTest function. Each parameter must have
an associated value. The permitted values for each parameter are defined in "Configuring Test
Calls" on page 6–222.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Circuit Test Packages Managing the GSX
Monitoring of the test call results is accomplished by the following existing functionality within
the GSX:
• Call Summary and Detail screens – provide the endpoints and resources involved in the call
as well as other status information.
• Service Group Specific CIC/Channel Status screens - provide the block and call status for
the endpoints involved in the call.
• Disconnect treatment - call progress tones and announcements can be provided to the
operations personnel initiating the test via the CAS interface. The tones and announcements
are provided after failed call attempts. See "Disconnect Treatment Profile" on page 3–1162
for details on how to configure disconnect treatment.
• Debug logs - failed test call attempts are logged to the system debug file at minor level. The
log indicates the status of the test call and reason for the call failure (if any). The logs are
logged at major level. See "Example Debug Logs" on page 6–227.
The following shows some example debug logs which will occur during typical test calls:
Successful call:
MAJOR .CASSG: *Test call GCID 0x90001: CAS port 1, chan 0, type
outgoing, OutTg: SKYLARK-MABEL-SS78, CIC: 1198
MAJOR .CASSG: *Test call GCID 0x90001: PARAMS: CdPn: 7793211024, CdNoa
2, CgPn: 7793210000, CgNoa 2 OrigCarrier: 0288, OrigCharge: 12345
MAJOR .CASSG: *Test call GCID 0x90001: PARAMS: TMR: 0x0, CPC: 13, ISUP
Link Signal: 2, ISDN Access: 1
MAJOR .CASSG: *Test call GCID 0x90001: Received event ACM/Alert
MAJOR .CASSG: *Test call GCID 0x90001: Received event ANM/Connect
Abandoned call:
MAJOR .CASSG: *Test call GCID 0x90002: CAS port 1, chan 0, type
outgoing, OutTg: SKYLARK-MABEL-SS78, CIC: 1198
MAJOR .CASSG: *Test call GCID 0x90002: PARAMS: CdPn: 7793211024, CdNoa
2, CgPn: 7793210000, CgNoa 2 OrigCarrier: 0288, OrigCharge: 12345
MAJOR .CASSG: *Test call GCID 0x90002: PARAMS: TMR: 0x0, CPC: 13, ISUP
Link Signal: 2, ISDN Access: 1
MAJOR .CASSG: *Test call GCID 0x90002: Received event ACM/Alert
MAJOR .CASSG: *Test call GCID 0x90002: Failed due to Abandoned Call
(calling party disconnect)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Circuit Test Packages
CIC in use:
MAJOR .CASSG: *Test call GCID 0x90005: CAS port 1, chan 0, type
outgoing, OutTg: SKYLARK-MABEL-SS78, CIC: 1193
MAJOR .CASSG: *Test call GCID 0x90005: PARAMS: CdPn: 7793211024, CdNoa
2, CgPn: 7793210000, CgNoa 2 OrigCarrier: 0288, OrigCharge: 12345
MAJOR .CASSG: *Test call GCID 0x90005: PARAMS: TMR: 0x0, CPC: 13, ISUP
Link Signal: 2, ISDN Access: 1
MAJOR .CASSG: *Test call GCID 0x90005: Failed due to Unexpected event
EV_DISC_REQ/Disconnect Reason(34) CPC_DISC_NO_CIRCUIT_AVAILABLE
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CNS71, CNS81, and CNS86 Path Testing Overview Managing the GSX
The CNS71, CNS81, and CNS86 Path Generation and Monitoring facility provides a tool to
perform path continuity testing at the VC11 and VC3 layers for Japan payload mapping.
The CONFIGURE OPTICAL INTERFACE parameters that comprise this facility provide two test
patterns as well as generated bit errors in the range 10-2 to 10-7. The test patterns are:
• PN15 - 215-1
You can observe the processing of these patterns on the interface through the MONITOR and SHOW
.. STATUS commands.
You must configure the PAYLOAD MAPPING parameter of the OPTICAL INTERFACE under test to
stFrame or the commands below will be rejected by the CLI with an error message.
To test the VC11 layer, you direct the test pattern to a Virtual Tributary (VT) in the range 1-84. To
test the VC3 layer, you direct the test pattern to a PATH in the range 1-3.
NOTE
The CNA70 adapter must use both CPIM71A circuit pluggable interface modules to
use this feature. The commands described below will be rejected by the CLI with
an error message if they are directed to a CNA70 with either one or two CPIM71s
present. (CPIM71s may be present in the system, but they cannot be the test
target.)
CLI Interface
An overview of the command interface to this facility is presented below. The example commands
that illustrate these features use Virtual Tributary 1 on the CNS71/CNA70 pair in slot 5. (By
substituting PATH for VT in the commands that follow, you would test PATH 1 in the VC3 layer.)
To run path generation and monitoring, the VC11 must first be unequipped, which may be
accomplished by:
% CONFIGURE OPTICAL INTERFACE optical-1-5-1 VT 1 STATE UNEQUIPPED
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX CNS71, CNS81, and CNS86 Path Testing Overview
------------------------------------------------------
Shelf: 1 Slot: 5 Port: 1 IfIndex: 13
------------------------------------------------------
Virtual Tributary 1 Configuration
------------------------------------------------------
STS1: 1 VTG: 1 VT: 1
------------------------------------------------------
Equipped State: UNEQUIPPED
VT Type: VT1.5/VC11
RDI Mode: NORMAL
Trace State: DISABLED
Transmit Trace Msg:
Expected Trace Msg:
Send Test Pattern: PN15
Monitor Test Pattern: PN15
Test Pattern Bit Error Rate: 10E-2
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
CNS71, CNS81, and CNS86 Path Testing Overview Managing the GSX
To reset the error counts that are displayed in the SHOW .. STATUS screens:
% CONFIGURE OPTICAL INTERFACE optical-1-5-1 VT 1 TESTPATTERN RESET ..
ERRORCOUNT
% CONFIGURE OPTICAL INTERFACE optical-1-5-1 PATH 1 TESTPATTERN RESET ..
ERRORCOUNT
The (TESTPATTERN) SEND, MONITOR, ERRORINJECT, and RESET commands, as well as the
SHOW command, must be directed to one and only one VT or PATH at a time. You cannot SEND to
one VT/PATH and MONITOR another. As well, the same pattern must be used on the VT/PATH.
For example, you cannot SEND PN15 and MONITOR PN15INVERT on a VT/PATH.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX CNS71, CNS81, and CNS86 Path Testing Overview
7. Display the status on the VT/PATH under test. The Test Pattern Error
Count should be nonzero. The Test Pattern Error Count should increment
on subsequent display status commands. The Test Pattern BER should match
the rate that was used to inject errors.
8. Send TESTPATTERN NONE on VT/PATH under test.
9. Monitor TESTPATTERN NONE on VT/PATH under test.
10. Choose a subsequent VT/PATH to test and repeat Step 3 through Step 9.
End of Procedure
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SIP P-Charging Vector Header Support Managing the GSX
In this release, the GSX, functioning as the NBS, supports P-Charging Vector headers as defined
in SIP RFC 3455. The P-Charging-Vector is a collection of charging information, including a
globally unique charging identifier, the ICID value, that allows carriers to charge for access and
services in a network by correlating charging records generated for an IP multimedia session by
the various network entities involved in the session.
• icid-value (IMS charging identity value) – a value generated by the NBS containing the
Universally Unique Identifier (UUID), as specified in RFC 4122.
• icid-generated-at – the IP address of the proxy's local Transport Service Access Point (TSAP)
(the SIP signaling address of the node that generated the ICID).
• ioi (inter-operator identifier) – used to correlate originating and terminating charging records
between different operators. This field is not generated by the NBS, however it will be relayed
if received in a request or response message.
When the P-Charging-Vector Header check box is selected in the IP Signaling Profile screen of the
PSX Manager, the NBS transparently copies the P-Charging-Vector header from the ingress
message to the egress message. When the check box is cleared, the NBS does not copy the header.
P-Charging-Vector header transparency is supported in INVITE, REGISTER, SUBSCRIBE,
OPTIONS, NOTIFY, REFER, INFO messages, and relayed 4xx, 5xx and 6xx responses.
When the Create P-Charging-Vector check box is selected in the IP Signaling Profile screen of the
PSX Manager, the NBS creates a new P-Charging-Vector header in the outgoing message. When
cleared, the NBS does not create a new P-Charging-Vector header. Creating P-Charging-Vector
headers is supported in INVITE, REGISTER, SUBSCRIBE, OPTIONS, and NOTIFY messages.
CDR Processing
The NBS saves the P-Charging Vector header with the icid-value and icid-generated-at values to
the CDR in ingress and egress protocol specific variants fields. P-Charging Vector headers
received or created in INVITE messages are saved to the CDR; P-Charging Vector header register
requests are not saved to the CDR.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX SIP Path and Service-Route Header Support
In this release, the GSX (functioning as the NBS) supports SIP Path and Service-Route headers.
The NBS functions as a Back-to-Back User Agent (B2BUA) when processing Path and Service-
route headers in REGISTER messages. The NBS also functions as a B2BUA when using
information derived from Path and Service-Route headers received in 200-class responses to
REGISTER requests in outgoing INVITE messages. A B2BUA performs hop-by-hop routing
rather than end-to-end routing. Each component of the network will only store the information of
its nearest neighbor or next hop. For the purpose of Path and Service-Route headers this means
only storing a single instance of each of those headers.
In order for Path and Service-Route headers to be properly processed on the NBS, the appropriate
provisioning of ingress and egress IP trunk groups in the IP Signaling Profile screen of the PSX
Manager must be completed.
When the NBS receives a REGISTER request from the SIP endpoint, it sends a policy request to
the PSX for the next-hop route to the SIP Registrar. Before it forwards the REGISTER request, the
NBS creates a Path header containing its own signaling IP address and port number and includes
the Path header in the outgoing REGISTER request. The Contact header of forwarded REGISTER
requests to the SIP Registrar contain a dir_device (direction=device) parameter, which is used by
the NBS to determine the next-hop direction of future INVITE requests.
When the NBS receives a 200-class response to a REGISTER request from the SIP Registrar, the
NBS does not include the Path header when it sends the response to the SIP endpoint.
When the NBS receives a 200-class response to a REGISTER request from the SIP Registrar, it
stores the received Service-Route header value, but it does not include a Service-Route header
when it sends the response to the SIP endpoint.
SIP INVITE requests from the SIP Registrar include a dir_device parameter in the Request-URI
and the NBS checks for the presence of the dir_device parameter when it processes INVITE
Request-URIs. Support for the dir_device parameter is needed to determine the direction of a call
when hop-by-hop routing is used.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SIP Path and Service-Route Header Support Managing the GSX
When the NBS receives an INVITE request that does not contain a dir_device parameter in the
Request-URI, it determines that the request was sent by a SIP endpoint. The NBS converts the
Service-Route header saved from the 200-class response to the REGISTER request for the SIP
endpoint into a Route header and includes the Route header in the outgoing INVITE request to the
SIP Registrar.
When the NBS receives an INVITE request that contains a dir_device parameter in the Request-
URI, it determines that the request was sent by the SIP Registrar. The NBS does not include the
Route header in the outgoing INVITE request to the SIP endpoint.
Two parameters, ROUTESET and REGISTRATION REQUIRED are utilized with the SIP
SERVICE object to support Path and Service-Route header processing.
• Stored - use the Stored Path or Service-Route information stored in the Registration Control
Block (RCB) for routing.
• Received - use the received Route Set for routing
• Disabled (default) - use the current PSX-based routing.
Set the parameter in the SIP service group connected to the SIP endpoint and connected to the SIP
Registrar to STORED.
The REGISTRATION REQUIRED parameter indicates whether the IP TRUNK GROUP to which
the SIP SERVICE group belongs requires registration between endpoints:
Set this parameter in the SIP service group connected to the IAD to ENABLED.
The REGISTRAR SUPPORTS CONTACT PARAMETER is used with the SIP SIGNALING
CONTROLS object to enable support of parameters in the Contact header:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX SIP Path and Service-Route Header Support
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Support for Government Emergency Telecomunications Service (GETS) and Wireless Priority Service (WPS) Managing the GSX
The functions described in this section are necessary to support the High Probability of
Completion (HPC) network capability intended to provide enhanced probability of call completion
to authorized Government Emergency Telecommunication Service (GETS) and Wireless Priority
Service (WPS) users during time of network stress and/or congestion.
NOTE
The use of the GETS Software is restricted in the U.S. and U.S. TERRITORIES to
NS/EP users authorized by the Office of the Manager, National Communications
System (OMNCS). See "GETS Software" on page xxviii.
The High Probability of Completion (HPC) features comprise a set of network capabilities applied
during call setup that provide authorized Government Emergency Telecommunications Service
(GETS) users enhanced call completion during times of network stress and/or congestion. An HPC
call is recognized based on the code point in the Calling Party's Category (CPC) parameter of the
incoming Initial Address Message (IAM). For ANSI, the CPC parameter is NS/EP (National
Security/Emergency Preparedness); for ITU, the CPC parameter is IEPS (International
Emergency Preference Scheme).
An HPC call can also be recognized by the analysis of the dialed or signaled digits from the Called
Party Number parameter. The GSX enables HPC-identified calls to receive additional network
treatment to further increase the probability of call completion.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX High Probability of Completion (HPC) Features
• For HPC calls that egress a GSX using SS7 or SIP-T signaling:
- Recording of the NS/EP value in the outgoing IAM’s CPC.
- Outgoing IAMs sent with an SS7 MTP value of 1 (instead of 0). Non-HPC calls are normally
set up using IAM with MTP = 0. However, for any SS7/SIP-T incoming call, if the MTP is
one or greater, that MTP is preserved and passed to the outgoing SS7/SIP-T signaling.
• For recognized HPC calls processed while a Sonus network element is in overload machine
congestion level 1 or 2 (MC1 or MC2), acceptance of HPC calls or rejection of non-HPC calls.
Note that for purposes of GSX congestions levels, only calls with a CPC values of NS/EP are
recognized as HPC calls. All other calls, including those that dial recognized Government
Emergency numbers, will be treated as non-HPC calls.
• Reserving of trunks for HPC calls using directional reservation equipment (DRE) control on a
per-trunk-group basis. The trunks reserved for HPC calls can be used by HPC calls in either
direction (inbound or outbound).
Office-wide Call Queuing (OWCQ) is intended to minimize the administration that a service
provider would be required to perform to make trunk queuing available to all desired trunk groups.
When a call attempts to seize an idle resource (i.e., trunk or IP bandwidth) in a trunk group (TDM,
or IP, respectively) to which it has been routed and no resource is found in any trunk group, the
call is queued if it is recognized as an HPC call, and waits for the needed resource to become
available.
An HPC call that has failed to get resources in the first pass is not blocked, but instead given the
second chance to search through the same route set for available resources. For each route in the
second pass search, the HPC call is queued on that route (trunk group). If no resources are
available, an announcement is played. If the queue is full, or no resources are available after the
queue timer expires, the call overflows to the next route in the set. If no idle resources are found in
any trunk group in the second pass, the call is blocked and given the final handling treatment.
OWCQ is also intended to allow an identified HPC call to receive a higher probability of
completing to the terminating station, e.g., PBX.
For a complete list of commands and parameters used for office-wide call queuing, see the
sections "High Probability of Completion Shelf" on page 3–122 and "High Probability of
Completion (HPC) Trunk Group Profile" on page 3–126. The HIGH PROBABILITY OF
COMPLETION parameters under the TRUNK GROUP object (see "Trunk Groups" on page 3–532)
provide a method for linking an HPC trunk group profile to a trunk group.
Current and Interval HPC performance statistics can be retrieved using the SHOW HIGH
PROBABILITY OF COMPLETION ... commands listed in the section, "High Probability of
Completion Shelf" on page 3–122.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
High Probability of Completion (HPC) Features Managing the GSX
The Resource-Priority header (RPH) can be used for marking SIP calls as priority calls. For
ingress SIP calls, if the INVITE message contains this header with particular namespace values,
and the SIP service group configuration indicates that RPH is enabled, then the call is accepted and
treated as a High Probability of Completion (HPC) call.
In the reverse direction, if the Calling Party Category (CPC) of an egress call is National Security/
Emergency Preparedness (NSEP) and the SIP service group configuration indicates that RPH is
enabled, then the egress INVITE includes this header with the appropriate namespace value.
You use the SIP SERVICE RESOURCE PRIORITY HEADER PROFILE configuration object to
determine which treatment to give to the Resource Priority Header for a SIP Service group. Use
the CONFIGURE SIP SERVICE sipservice RESOURCE PRIORITY HEADER PROFILE
rphprofile command to bind an RPH profile to a SIP Service group. See "SIP Service" on
page 3–437 and "SIP Service Resource Priority Header Profile" on page 3–479for more
information.
Various parameters in the following configuration objects are also used for configuring the SIP
RPH functionality:
In addition you can display current and interval SIP Resource Priority Header (RPH) statistics. See
the section, "SIP Resource Priority Header (RPH) Statistics" on page 3–484.
You can set the Type Of Service (TOS) value on the PSX in the packet service profiles to indicate
the required TOS for any type of call. When the PSX determines a call to be an HPC call, it
includes a configurable TOS byte value in the returned packet service profiles.This ensures that
the voice packets of HPC calls have differentiated service markers.
You can provision base and preferred packet service profiles for HPC calls as well as for normal
calls using two screens in the PSX Manager, Packet Service Profile ID Group and Preferred Packet
Service Profile ID Group, and then group them using the ID Group screens.
For information on provisioning support for TOS values, see the “Provisioning Packet Service
Profiles” section of Chapter 2 of the PSX Policy Server Provisioning Guide for this release.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX High Probability of Completion (HPC) Features
• The CAUSEMAP CPC_TO_SIP PROFILE supports mapping of received Q.850 cause code
values to transmitted SIP error messages.
• The CAUSEMAP SIP_TO_CPC PROFILE supports mapping of received SIP error messages
(without Reason Header Q.850 or MIME encapsulated cause code values) to Q.850 cause
code values.
Sonus systems use an extended range of configurable internal cause codes from 128-255. While
these cause codes are never externally visible, the actions taken because of them are. See "Sample
CAUSEMAP Configuration" on page 3–496 for information on configuring CAUSEMAP
Profiles.
A SIP INVITE containing an RPH header and an ISUP-MIME with a calling party category (CPC)
parameter may provide conflicting information on HPC treatment. If an RPH contains a valid ETS
or CPC value of NS/EP, the call should be treated as HPC, but the CPC may indicate some other
value (such as a specific language operator). To configure which information to use on a per-
service-group basis, use the following command:
% CONFIGURE SIP SERVICE RESOURCE PRIORITY HEADER PROFILE <rphprofile>..
ETS ETSCPCPRECEDENCE [CPC|ETS|HPC]
A SIP INVITE containing an RPH header with WPS and an ISUP-MIME that has a precedence
(MLPP) parameter may provide conflicting information. To control the GSX behavior when it
receives conflicting WPS (RPH) and MLPP (ISUP-MIME) values on a per-service-group basis,
use the following command:
% CONFIGURE SIP SERVICE RESOURCE PRIORITY HEADER PROFILE <rphprofile>..
ETS WPSMLPPPRECEDENCE <CPC|ETS|HPC>
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
High Probability of Completion (HPC) Features Managing the GSX
Precedence Value
For more information, see "High Probability of Completion (HPC) Trunk Group Profile" on
page 3–126.
Reject Non-ETS
When a call is rejected because of the conditions associated with the enabled SIP Service RPH
Profile parameter REJECTNOTETSDN, the SIP response is a 403 (Forbidden) with two reason
header fields:
The response will not contain an RPH with ETS. These values are configured in the applicable
CAUSEMAP CPC_TO_SIP PROFILE. See "Sample CAUSEMAP Configuration" on page 3–496
for more information.
When any route attempt for a call returns 486 (Busy Here) the call will receive final treatment.
High Probability of Completion entails marking signaling and media packets to receive priority
handling by network elements. This includes IP (layer 3) setting of DSCP values in the TOS
header byte and Ethernet (layer 2) setting of COS values in a tag header. The GSX outputs are
configurable for different markings on HPC and non-HPC calls, driven by a call’s HPC status,
independent of any input markings. SIP over UDP signaling receives DSCP or COS marking on
output. By proper configuration, in overload situations with 10 times normal incoming signaling
traffic, the GSX can provide normal levels of service to HPC calls up to where they constitute 10%
of GSX capacity. Limits can optionally be imposed on specified peer IP signaling addresses
concerning the ingress HPC call rate and the number of simultaneous HPC calls.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX High Probability of Completion (HPC) Features
Class of Service
You can set the Class of Service (COS) value to be set in the IEEE 802.1D User Priority field of
media packets transmitted on a call leg that uses a specific Packet Service Profile using the Packet
Service Profile in the PSX Manager and the following command on the GSX:
% CONFIGURE PACKET SERVICE PROFILE <psp> COS <cosvalue>
This only has an effect if the network interface supports 802.1Q tagged Ethernet frames.
The HIGH PROBABILITY OF COMPLETION LIMIT configuration object creates and configures
SIP peers that are subject to limits on HPC calls. A peer will be recognized by the IP address it
uses for signaling to or from the GSX. Because the same IP address can appear in multiple disjoint
networks, the peer is identified by a combination of its IP address and associated signaling Zone.
For more information, see "High Probability of Completion Limit" on page 3–130.
Differentiated Services
Setting the IP OUTPUT FILTER allows the GSX to select egress signaling packets for DSCP
marking. The DIFFSERV MARK command is used to identify the particular DSCP value to set for
those selected signaling packets. Although there is no special configuration required in the context
of HPC calls, if a DIFFSERV MARK is configured for an IP OUTPUT FILTER that matches a
transmitted packet, its value will overwrite any HPC or non-HPC Diffserv Code Point (DSCP)
value that is configured.
You can define Diffserv Code Point (DSCP) and Class of Service (COS) parameters for SIP-over-
UDP signaling, for both HPC and non-HPC calls, on a per-shelf basis using these commands:
% CONFIGURE HIGH PROBABILITY OF COMPLETION SHELF 1 UDP SIGNALING ..
[HPC|NONHPC] DSCP <dscpvalue>
% CONFIGURE HIGH PROBABILITY OF COMPLETION SHELF 1 UDP SIGNALING ..
[HPC|NONHPC] COS <cosvalue>
For more information, see "High Probability of Completion Shelf" on page 3–122.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Monitoring Managing the GSX
Call Monitoring
The GSX provides the ability to monitor stable simple tandem voice call content by setting up a 3-
way conference with the target call, with the monitor endpoint leg in listen-only mode receiving a
mix of media from both the endpoints.
For more information on call monitoring, including command syntax and parameter definitions,
see "Call Monitor Endpoint and Monitor Target" on page 3–1179.
The procedures for configuring a call monitoring session, as well as initiating and terminating call
monitoring are as follows.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Call Monitoring
4. Create and configure a monitor target based on the information gathered in Step 3:
% CREATE MONITOR TARGET targetname
If you are using a GCID,
% CONFIGURE MONITOR TARGET targetname GCID gcid#
If you are using a Shelf/Slot/Port/Channel:
% CONFIGURE MONITOR TARGET targetname PORTNAME port ..
CHANNEL channel
If you are using an ISUP Service Group and CIC,
% CONFIGURE MONITOR TARGET targetname CIC cic ..
ISUP SERVICE GROUP isupsvcgroup
5. Enable the monitor target to initiate the call monitoring session:
% CONFIGURE MONITOR TARGET targetname STATE enabled
The monitor endpoint rings and you are bridged into the call.
6. After completing the call monitoring, disable the monitor target:
% CONFIGURE MONITOR TARGET targetname STATE disable
If the target endpoint is a SIP phone, use the following command to delete the call
monitoring session:
% DELETE MONITOR TARGET targetname
End of Procedure
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SIP over TCP Managing the GSX
SIP signaling can be transported over UDP, TCP, or TLS/TCP. This section describes support for
SIP over TCP.
When the GSX/NBS wants to send a SIP message to a peer it must select a transport. When it
receives a SIP message from a peer, it must determine if the transport the message was received
over is acceptable. These decisions may be based on various factors including local policy,
message length, URI scheme (e.g. sip: or sips:) in SIP requests, transport information received
from PSX or DNS, and perhaps others.
Ingress SIP transport type acceptance is typically configured on a Signaling Zone basis with
specific parameters configurable on a SIP Service basis; Egress SIP transport type is typically
configured via the Egress IP signaling profile in the PSX, or on a SIP Service basis, or may be
determined by a DNS NAPTR (Name Authority Pointer) query; see "SIP Transport Type" on
page 3–438 for more information. The chosen transport type remains stable for the duration of the
call, and cannot be changed mid-dialog for calls to/from registered endpoints (registrant calls).
Connection Reuse
For Access, connections are on a per-subscriber-registration basis. The NBS keeps track of
subscriber-initiated TCP "flow" beginning with when the endpoint registers, and uses it to forward
any requests to the subscriber. The connection stays up as long as the subscriber is registered with
NBS. A connection is deleted when the flow cannot reach the subscriber (e.g. a broken TCP
connection), or it is replaced by a newer one via successful modification, or when the registration
is deleted.
For peering, and for PSTN-IP gateway usage, there are typically two connections, one for each
direction. Connections to the peers are maintained and reused for all requests to the peer,
independent of calls. The NBS can accept multiple connections from the same remote peer.
TCP connections are not maintained upon MNS card or PNS40 switchover. However, as (per
RFC3261) connections are independent from calls, stable SIP calls that do not have transactions
outstanding at the time of switchover should not be affected by loss of connection.
Keepalive
By default, TCP connections carrying SIP signaling are kept alive using the existing SIP
registration refresh mechanism, and specified via the SIP Service Group “Registration Expires”
keepalive timeout value. When the “Force Fast Refresh” flag is enabled, the GSX/NBS uses the
SIP Service Group parameters “NAT keepalive timeout for TCP” and “NAT keepalive timeout for
UDP” to set the refresh rate for registrations established over TCP (or TLS/TCP) or over UDP
respectively. Refer to "SIP Service" on page 3–437 for more information.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX SIP over TCP
Billing
The transports used in sending/receiving initial INVITE data on each SIP call leg are recorded in
the applicable call accounting records (START, STOP, ATTEMPT, and INTERMEDIATE).
These appear in the Ingress/Egress Protocol Variant Specific Data Fields, respectively, in sub-field
33 of the SIP-specific variant, as UDP, TCP, or TLS-TCP.
Provisioning
On a signaling zone basis, CONFIGURE ZONE TRANSPORT_PROTOCOLS lets you specify the
allowed Ingress transport protocol(s) for the SIP signaling zone. Refer to "Zone" on page 3–511
for more information.
On a signaling zone basis, CONFIGURE ZONE TCP_TIMEOUT sets the maximum time (in seconds)
allowed for the GSX/NBS to establish an outbound TCP connection. Refer to "Zone" on page 3–
511 for more information.
You can specify a first, second, and third preference for SIP transport type by using CONFIGURE
SIP SERVICE <> TRANSPORT [1ST,2ND,3RD]_PREFERENCE. Refer to "SIP Service" on
page 3–437 for more information.
Use CONFIGURE SIP SERVICE <> TCP RETRANSMIT INTERVAL to specify the retry time (in
seconds) for SIP over TCP after an unacknowledged message such as request, final response, or
reliable provisional response (due to TCP connection failure or SIP/application layer not
responding) is sent, until the retry sending of the message using a different flow or to a different
destination. Refer to "SIP Service" on page 3–437 for more information.
Use CONFIGURE SIP SERVICE <> REGISTRATION EXPIRES to specify the timeout for the
default SIP registration keepalive mechanism. Use CONFIGURE SIP SERVICE <> FAST
REFRESH to enable the protocol-specific timeouts for registrations established over TCP or UDP
connections as set by CONFIGURE SIP SERVICE <> NATOVERTCP and CONFIGURE SIP
SERVICE <> NATOVERUDP, respectively. Refer to "SIP Service" on page 3–437 for more
information.
You can enable or disable redirection of inbound SIP calls landing on MNS20 card by using
CONFIGURE SIP SERVICE <> CALL REDIRECTION. Refer to "SIP Service" on page 3–437 for
more information.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Secure RTP/RTCP Managing the GSX
Secure RTP/RTCP
Secure real-time transport protocol (Secure RTP) is an IETF cryptographic protocol used to
provide secure communications over an untrusted network. It provides encryption, message
authentication, and integrity for RTP media streams over packet call legs. The GSX supports
Secure RTP and its associated secure real-time transport control protocol (Secure RTCP) per
RFC3711.
Secure RTP on the GSX/NBS is available using SIP signaling over UDP, TCP, and TLS
(Transport Layer Security) protocol, and is signaled by specifying Secure RTP transport in an SDP
(Session Description Protocol) media (m=) line. The GSX uses the RFC4568 Security
Descriptions ("sdescriptions") standard for negotiating the use of Secure RTP. TLS over TCP is
recommended for SIP transport when negotiating Secure RTP, because it protects the integrity and
confidentiality of the SRTP keys which would otherwise be exposed.
The use of Secure RTP on one call leg is independent of its use on other legs of the same call, and
is negotiated for each packet leg. Secure RTP may be used outside or inside the network, for
packet-to-packet and circuit-to-packet calls. All Secure RTP calls are routed through the GSX. The
GSX does not support negotiation of a secure direct media stream between two endpoints.
Provisioning
Use of Secure RTP is typically provisioned via the PSX on a Packet Service Profile basis; separate
packet service profiles may be applied to Ingress and Egress packet signaling. Refer to the section,
“Secure RTP/RTCP” in Chapter 3, “Call Processing,” of PSX Product Description for more
information.
You can also set the following Secure RTP related parameters in the GSX default packet service
profile via the GSX command line interface; see "Packet Service Profile" on page 3–690 for
details:
• Use of Secure RTP for calls using a specified packet service profile.
• Whether calls being negotiated for a specified packet service profile can fall back to regular
RTP if the crypto attribute offer/answer fails or if all Secure RTP sessions are in use.
• The crypto suite(s) that Secure RTP can use.
• Whether encrypted Secure RTP, encrypted Secure RTCP, and/or authenticated Secure RTP
are not to be used with the specified crypto suite. The GSX, by default, uses all of these.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Secure RTP/RTCP
Crypto Suites
Crypto suites are used to negotiate cryptographic algorithms when establishing unicast media
streams involving Secure RTP/RTCP. In its policy response, the PSX returns a prioritized list of
supported crypto suites and optional session parameters for three crypto suite profiles (Ingress,
Egress inter-gateway per route, and Egress IP trunk group per route) based on the associated
packet service profiles provisioned for the call. The GSX/NBS includes these crypto suites and
optional session parameters in one or more crypto attributes (a=crypto) of SDP offers and answers.
Each crypto attribute describes a cryptographic suite, key parameters, and any optional session
parameters. The most preferred crypto suite is listed first.
The GSX/NBS supports the following call scenarios involving Secure RTP.
ISUP SIP
PSTN
SRTP
GSX/NBS SIP UA
(SBC, IAD)
Figure 6–54 shows Secure RTP on the ingress and egress call legs in a packet-to-packet scenario.
Variations on this scenario include using Secure RTP on the inside or outside network only.
SIP SIP
SRTP SRTP
SIP UA GSX/NBS SIP UA
(Gateway, SBC) (SBC, IAD)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Secure RTP/RTCP Managing the GSX
Figure 6–55 shows a Secure RTP call scenario involving a SIP proxy. The GSX/NBS makes the
Secure RTP keying material visible to the SIP proxy via security description key negotiation.
SIP
Proxy
SIP SIP
SRTP
GSX/NBS SIP UA
(SBC, IAD)
NOTE
Secure RTP/RTCP is not available on IAD-to-IAD call legs via the GSX/NBS direct
media feature.
A SIP call signals and negotiates cryptographic parameters for the media stream via the SDP m=
line Crypto attribute. These parameters are mostly grouped into a "crypto-suite" field that
describes the encryption and authentication algorithms for transport. The GSX/NBS supports the
crypto-suite "aes-cm-128-hmac-sha1-80." Secure RTP is requested by the presence of RTP/SAVP
or RTP/SAVPF in the m= line.
The appropriate crypto suite profile may also include valid combinations of the following session
parameters:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Secure RTP/RTCP
On Ingress SIP calls, the GSX/NBS receives an SDP offer that may include one or more crypto
suite attributes defining the crypto suites being offered for the ingress call leg. When the GSX/
NBS sends a policy request to the PSX, the PSX policy response includes an ingress crypto suite
profile, an egress inter-gateway crypto suite profile (per route), and an egress IP trunk group
crypto suite profile (per route).
The GSX/NBS uses the returned ingress crypto suite profile to generate an SDP answer for the
ingress call leg by attempting to match the crypto suite(s) and any associated session parameters in
the offer with the crypto suite(s) and any associated session parameters in the crypto suite profile.
Based on the results, the GSX/NBS does one of the following:
• Accepts the media stream by including in the SDP answer one of the offered crypto suites (the
most preferred crypto suite that the GSX/NBS can support) and any associated session
parameters.
• Rejects the offered media stream by releasing the call if crypto attribute negotiation fails. Calls
are rejected if no available crypto suite is offered, or if the SDP flags for unencrypted_srtp,
unencrypted_srtcp, and unauthenticated_srtp are different than the values in the Crypto Suite
table of the packet service profile.
• If Allow Fallback is enabled for the ingress call leg and crypto attribute negotiation fails, the
GSX/NBS accepts the offered media stream using standard RTP/RTCP. In this case, the GSX/
NBS does not include a crypto suite in the SDP answer.
The GSX/NBS uses the security settings in the Egress inter-gateway crypto suite profile, or the
Egress IP trunk group crypto suite profile, to generate an SDP offer to the egress endpoint for the
egress call leg, regardless of the offered or negotiated settings in the Ingress leg. Secure RTP
negotiations for the Egress leg are conducted similarly to the Ingress leg described above.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SIP Over Transport Layer Security Protocol Managing the GSX
The GSX/NBS supports the exchange of SIP signaling over Transport Layer Security (TLS). TLS
is an IETF protocol for securing communications across an untrusted network. Normally, SIP
packets travel in plain text over TCP or UDP connections; Secure SIP is a security measure that
uses TLS, the successor to the Secure Sockets Layer (SSL) protocol. TLS operates just above the
transport layer (Layer 4) and provides peer authentication, confidentiality, and message integrity.
The GSX/NBS supports TLS version 1.0 with server-only authentication (in which only the server
is authenticated at the TLS layer) and mutual authentication (in which both the TLS client and
server are authenticated at the TLS layer). TLS is an effective countermeasure to a number of
threats including theft of service, disruption of service, compromise of confidentiality, and
compromise of service integrity.
In the SIP context, TLS may be applied (or not) independently on each hop between SIP devices.
SIP transport type selection is typically configured via the IP signaling profile in the PSX, It may
also be provisioned on the GSX SIP Service group or identified via a DNS lookup. For more
information, see "SIP Transport Type" on page 3–438.
Configuration Summary
Adding a TLS protection-level policy involves configuring the following parameters using the
TLS PROFILE object:
• TLS Roles - which TLS role(s) the GSX/NBS may act in (server or both client and server)
• Server and Client Certificates - pointers to local or remote server and client certificates,
created using the PKI SECURITY configuration object. For more information, see "Security
Public Key Infrastructure (PKI) Certificates" on page 3–38.
• TLS Client Authentication - whether TLS client authentication shall be performed when the
GSX/NBS is acting as a TLS server.
• Cipher Suites - which of the implemented cipher suites are permitted and in what order of
preference.
• Timers - handshake, authorization, and session resumption timers.
For more information on command syntax and parameter definitions, see "Transport Layer
Security Profile" on page 3–500.
The ZONE configuration object specifies the configured TLS PROFILE (CONFIGURE ZONE zone
TLS_PROFILE tlsprofile) to control TLS behavior for all SIP Signaling Ports in the zone. If
no TLS profile is specified, the default TLS profile, defaultTlsProfile, is used.
In addition, you must set the transport protocols parameter in the ZONE object to allow SIP over
TLS over TCP (CONFIGURE ZONE zone TRANSPORT_PROTOCOLS sip-tls-tcp).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX SIP Over Transport Layer Security Protocol
SIP over TLS on the GSX/NBS can be used in several scenarios. Table 6–32 describes each of
these scenarios, the TLS role (server or client/server), and the authentication requirements.
Usage TLS
Scenario Usage Description Role Authentication Requirements
Residential Between a subscriber SIP Server Server-only authentication.
Access User Agent (UA) and a GSX/
This is intended for use in conjunction
NBS.
with authenticated SIP registration. A
peer is blocked from using any
services until a successful SIP
registration is performed. A separate
registrar is deployed to challenge and
authenticate the registration; this may
be a Sonus ASX or other device. The
registrar should be configured to
require authentication on the
registration; however the GSX/NBS
does not check or enforce this. You
can disable this requirement using the
CONFIGURE TLS PROFILE
<profile> CLIENT_
AUTHENTICATION true command.
Enterprise Between an enterprise PBX Server Mutual TLS authentication
Access and a GSX/NBS.
Inter-Carrier Between a SIP proxy or Back- Client or Mutual TLS authentication
Peering to-Back User Agent (B2BUA) Server
belonging to another
administrative domain and a
GSX/NBS.
Intra-Carrier Between a GSX/NBS and a Client or Mutual TLS authentication
Peering SIP proxy and a B2BUA Server
belonging to the same
administrative domain.
Deployments may involve two or more of the above scenarios simultaneously and involve
different transports (SIP over TLS over TCP, SIP over TCP, or SIP over UDP) simultaneously,
including on separate legs of the same signaling path.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SIP Over Transport Layer Security Protocol Managing the GSX
The GSX/NBS and its peer devices use X.509 digital certificates to authenticate themselves for
TLS. Local certificates (attesting to the identity of the GSX/NBS) and remote Certificate
Authority (CA) certificates may be installed on the GSX/NBS in a common area where they are
available to TLS. Client or Server Certificates are initially configured using the SECURITY PKI
configuration object and then specified in the TLS PROFILE.
Client Role - When the GSX/NBS acts in the TLS client role, the CONFIGURE TLS PROFILE
<profile> CLIENT_CERTIFICATE <clientcertname> command specifies a certificate that
is presented to the server by default. When the server requests our certificate and this optional
parameter is not configured, or if the certificate specified does not satisfy the certificate request
sent by the server, then any certificate indicated here is not used and the system attempts to find
another local certificate that does satisfy the server's request.
Server Role - When the GSX/NBS acts in the TLS server role, the CONFIGURE TLS PROFILE
<profile> SERVER_CERTIFICATE <servercertname> command specifies a certificate that
is presented to peers. If this parameter is not set, the GSX/NBS cannot establish TLS connections
in the server role.
The Client and Server Certificates are created using the SECURITY PKI configuration object. For
more information on creating Client and Server Certificates, see "Security Public Key
Infrastructure (PKI) Certificates" on page 3–38.
When the GSX/NBS acts in either the TLS server or client role, the peer may present a certificate.
There is no immediate check by the GSX/NBS on the identity presented and assuming the
certificate is otherwise valid, it is accepted.
The GSX/NBS accepts incoming TLS connections from any client able to authenticate itself; there
is no authorization check at the TLS level. However, TLS access control may be imposed through
the use of IP Input Filters, trust anchors (CAs) that only issue credentials to restricted groups of
authorized peers, or (for access clients) through the registrar-based application layer authentication
mechanism.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX SIP Over Transport Layer Security Protocol
Cipher Suites
Cipher suites define a set of ciphers (algorithms used for encrypting data), which allows selection
of an appropriate level of security. When an TLS connection is established, the client and server
exchange information about which cipher suites they have in common. Three cipher suites are
supported:
• TLA-RSA-WITH-3DES-EDE-CBC-SHA
• TLS-RSA-WITH-AES-128-CBC-SHA
• TLS-RSA-WITH-NULL-SHA - used for troubleshooting or for use in crypto-restricted
jurisdictions.
Confidentiality
Authentication Mechanism Cipher and Mode Integrity Cipher
TLA-RSA-WITH-3DES-EDE-CBC-SHA
RSA 3DES-EDE-CBC SHA-1
TLS-RSA-WITH-AES-128-CBC-SHA
RSA AES-128-CBC SHA-1
TLS-RSA-WITH-NULL-SHA
RSA NULL SHA-1
Terms used in this table:
RSA - Authentication based on X.509 certificates using RSA public/private key pairs
3DES-EDE - Data Encryption Standard applied three times with Encrypt Decrypt Encrypt
AES-128 - Advanced Encryption Standard (128-bit key length)
CBC - Cipher Block Chaining
SHA - Secure Hash algorithm
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
SIP Over Transport Layer Security Protocol Managing the GSX
TLS Timers
• High Level Authentication Timer - In an access scenario where a client does not
authenticate itself within TLS, a higher-layer authentication timer specifies the time in which
the client must complete authentication in a higher-level protocol after the TLS connection is
established. In this case the higher layer authentication is typically SIP-based HTTP digest
authentication between the peer and a SIP registrar such as the Sonus ASX. Use the
CONFIGURE TLS PROFILE <tlsprofile> HIGH_LEVEL_AUTH_TIMER <timervalue>
command to configure this timer.
• Handshake Timer - This timer makes sure the TLS handshaking completes in a timely
manner. The timer starts when the TCP connection is established. Use the CONFIGURE TLS
PROFILE <tlsprofile> HANDSHAKE_TIMER <timervalue> command to configure this
timer.
• Session Resumption Timer - TLS allows multiple connections to be created within one TLS
session and the resumption of a session after a TLS connection is closed or after a server card
failover, without incurring the full handshake cost, except when the space must be reclaimed
for a new session. The TLS resumption timer specifies the TLS session resumption period for
which cached sessions are retained (in seconds). Use the CONFIGURE TLS PROFILE
<tlsprofile> RESUME_TIMER <timervalue> command to configure this timer.
The following commands show status and statistical information for TLS sessions and their
associated TLS connections on the given SIP signaling port. Status information includes IP
addresses and TCP port numbers, negotiated session parameters, session start time, remaining
resumption time (if applicable), client and server roles, client authentication or not, negotiated
session parameters, current connection information, session ID, etc.
• The SHOW SIP SIGNALING PORT sig-port TLS SESSION STATUS command gives
summary information about all current TLS sessions (and associated TLS connections)
associated with a given SIP Signaling Port.
• The SHOW SIP SIGNALING PORT sig-port PEER remoteIPaddr TLS SESSION
STATUS command shows all available status information about the current TLS session(s)
(and associated TLS connections) associated with a given SIP Signaling Port and a given
remote IP address.
• The SHOW SIP SIGNALING PORT sig-port PEER remoteIPaddr TLS SESSION
STATISTICS commands show per-session and per-connection statistics for the specified
session(s).
• THe SHOW SIP SIGNALING PORT sig-port TLS STATISITCS commands give statistics
information about the TLS connections on the specified SIP signaling port.
For a full list of TLS statistics and status commands, see "SIP Signaling Port" on page 3–416.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX ISUP-to-SIP Interworking
ISUP-to-SIP Interworking
The following SIP and UK ISUP interworking capabilities are compliant with TSG/SPEC/017,
Interworking between SIP and UK ISUP, and ITU-T Q.1912.5, Interworking between SIP and Bearer
Independent Call Control Protocol or ISDN User Part (which is based on TSG/SPEC/017). These
capabilities include the following. For more information on SIP SERVICE CLI commands and
parameter descriptions, see "SIP Service" on page 3–437.
If a REL is received with cause value 34 “No circuit/channel available,” then if the location in the
cause parameter is set to “user,” SIP sends a 600 “Busy Everywhere” message, otherwise SIP
should send a 486 “Busy Here” message. Also, cause value 34 is mapped based on the CCBS
indicator in the diagnostics (Q1912 requirement). The UK mapping for cause 34 must have the
SIP SERVICE GROUP VARIANT TYPE set to UK, otherwise the GSX will attempt to map it based
on the Q1912 requirement and the value “34” must not be in the cause mapping table.
The location fields for cause values which should not be “BI” are hard-coded to their required
value if the SIP SERVICE GROUP parameter VARIANT TYPE is set to UK.
NOTE
This is not related to location in REL, but is related to Table 40. In order to map
from a SIP response to the ISUP Cause Value 24 “Call Rejected due to ACR
supplementary service,” the CPC cause value in the table must be configured as
32 (rather than the Q.850 value of 24).
This command specifies the factor value used to interwork the SIP Max Forwards Header and the
ISUP Hop counter parameter:
This command specifies the default value for the Max Forwards Header.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP-to-SIP Interworking Managing the GSX
(Q1912.5 6.1.3.3)
The satellite indicator in the Nature of Connection indicators is defaulted to “One satellite circuit
in connection” according to Q1912.5 and the 3GPP spec. (TS 29 163 V7.4.0).
(Q1912.5 5.4.2.1.1)
If the SIP SERVICE GROUP VARIANT TYPE is Q1912.5 or UK, and the value in the SIP header
is different from that in the ISUP MIME, the header value takes precedence. For the UK, the
exception to this is that if any CLI parameters are present in the IAM (i.e. Calling Party Number,
Generic Number, or Presentation Number) then they will take precedence over the SIP headers.
In ISUP the Call Hold supplementary service uses the Call Progress message with the Generic
Notification Indicator parameter. This service is also available in SIP and is defined in RFC 3264.
In SIP an INVITE or an UPDATE message is used with an updated SDP. A control in the PSX IP
Signaling Profile (Call Hold Interworking) is available so that this option is not supported by
default.
Therefore a Suspend message received with the suspend/resume indicator set to “ISDN subscriber
initiated” is treated like a CPG with “remote hold.” Terminal Portability can be interworked to
SIP-I, but for SIP it is mapped to the Call Hold flows. A control in the PSX IP Signaling Profile
(Terminal Portability Interworking) is used for this feature.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX ISUP-to-SIP Interworking
(TSG/SPEC/017 6.1.1)
If the VARIANT TYPE in the SIP SERVICE GROUP is set to UK, then the call is rejected if there is
no SDP in the INVITE.
When interworking with SIP-I, if after the application of the rules in clause 6.1.3.6 and any other
processing procedures, if the address within the Calling Party Number is not the same as that in the
Calling Party number received in the ISUP MIME, the Access Transport Calling Party sub-address
parameter is deleted. The VARIANT TYPE in the SIP SERVICE GROUP must be set to Q1912.
When interworking with SIP-I, if after the application of the rules in clause 6.1.3.6 and any other
processing procedures, the address within the Called Party Number is not the same as that in the
Called Party number received in the ISUP MIME, the Access Transport Called Party sub-address
parameter should be deleted. The VARIANT TYPE in the SIP SERVICE GROUP must be set to
Q1912.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
ISUP-to-SIP Interworking Managing the GSX
ISUP encapsulation is used to interwork the ECT service, however, procedures described in
Q732.7 under the sub clause “Interactions with Other Networks” are used for SIP-only. When
interworking to a protocol that does not support the Loop Prevention Procedure, when a Loop
Prevention (request) message with Call transfer reference parameter is received, a Loop
Prevention (response) message, with indication “insufficient information” and identical Call
transfer reference parameter is sent.
Overlap Dialing
To support SIP-to-ISUP overlap dialing, use the following SIP SERVICE GROUP commands.
This command specifies the minimum number of digits that must be received before sending a
routing request to the PSX, if Overlap Addressing is supported:
CONFIGURE SIP SERVICE <sipsvc> OVERLAP MINDIGITS <mindigits>
This command specifies the Time in seconds between receiving a 484 Address Incomplete
message if there are no outstanding INVITE transactions and the receipt of fresh address
information:
CONFIGURE SIP SERVICE <sipsvc> OVERLAP TOIW3 <timervalue>
Early Progress Message Timer – this timer is used to send an early progress message if no
backwards message is received. This command specifies the time in seconds between sending an
INVITE and receiving a backward message when Overlap Addressing is supported:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Support for Video Calls
The GSX operating as an NBS can be configured to support video calls. A video stream can be
established at call setup time in conjunction with an audio stream or can be added to an existing
audio call. Video streams can be supported in either pass-through or direct media modes but are
supported only for SIP-to-SIP calls.
Video calls are supported only on PNS40 modules on the GSX9000 and GNS15 modules on the
GSX4000. The number of video calls supported on PNS40 and GNS15 modules depends on the
available NIF and IP trunk group bandwidth and maximum call limit per server type.
The audio and video streams of a video call may have same or different remote IP addresses but
should have different IP port numbers. A video call must ingress and egress on the same server
module. The video stream of a call can be bidirectional or unidirectional and its direction can be
changed after a call is established. Secure RTP is not supported on video streams.
Network Address and Port Translation (NAPT) processing is supported on the video RTP stream
of a video call. The NBS supports direct media between end points behind the same NAPT
module, provided the SIP SERVICE groups for all such endpoints have the same MEDIA ZONE.
For more information about Direct Media, see the section "Direct Media" on page 3–439.
Video call support is provisioned in the GSX and PSX Packet Service Profiles. For details on the
command syntax of the GSX PACKET SERVICE PROFILE, see "Packet Service Profile" on
page 3–690. For details on the PSX Packet Service Profile, see Appendix A of the PSX
Provisioning Guide.
Audio Codecs
The following audio codecs are configured in the Packet Service Profile. Video calls and audio
only calls can use these audio codecs in pass-through or direct media mode only (that is, special
DSP treatments and transcoding are not applicable to the calls using these audio codecs).
• G.722
• G.722.1
• G.728
• AMR-WB (G.722.2)
- Bandwidth Efficient
- Octet Aligned
- CRC
- CRC-Interleaving
- CRC-Robustsort
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Support for Video Calls Managing the GSX
- CRC-Interleaving-Robustsort
- Interleaving
- Robustsort
- Interleaving-Robustsort
If the NBS is configured to allow any of the above mentioned audio codecs (in the Packet Service
Profile), it passes the received SDP from ingress to egress call legs. Otherwise, the NBS
suppresses the SDP from any subsequent offer/answer exchange.
Silence Suppression rates are applicable to G.722, G.722.1, G.728, and AMR-WB codecs. The
Silence Factor configured in the Packet Service Profile reduces bandwidth allocated by the IP
trunk group and NIF.
Video Codecs
The following video codecs are supported. A video call can use any of these video codecs in
conjunction with any of the audio codecs supported by the GSX (the codecs mentioned in the
“Audio Codecs” section above as well as any of the other supported audio codecs, such as G.711,
G.723, G.726, G.729, and ILBC), in pass-through or direct media mode only.
• H.261
• H.263
• H.263-1998 (H.263v2)
• H.263-2000 (H.263v3)
• H.264
If the Packet Service Profile allows video, the NBS passes the above mentioned codecs in the SDP
from ingress to egress call legs. Otherwise, the NBS suppresses the codecs in the SDP from any
subsequent offer/answer exchange. Unsupported video codecs are filtered and not propagated in
the egress offer.
The following parameters configured in the Packet Service Profile enable (or disable) video and
control the bandwidth allocated by the IP trunk group and NIF for a video call:
• Maximum Video Bandwidth - This parameter specifies the maximum bandwidth for the
video stream in kilobits per second. The video stream will be policed at the rate specified by
this parameter. This value must include all codec specific header and payload data as well as
any non-codec header data including RTP, UDP, IP, Ethernet, or MAC. For video to be
allowed in a call, this parameter must have a non-zero value in both egress and ingress Packet
Service Profiles.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Support for Video Calls
• Video Bandwidth Reduction Factor - This parameter specifies the percentage that the
configured MAXIMUM VIDEO BANDWIDTH should be reduced to determine the IP
bandwidth that should be allocated from the IP trunk group and NIF to a video call.
• Video Failure Audio Only - This parameter specifies whether a video call should continue as
an audio only call when video cannot be established for any reason. If this field is enabled in
either egress or ingress Packet Service Profiles, the audio stream of a call continues using
normal negotiation process. If this field is disabled in both egress and ingress Packet Service
Profiles, the call is rejected.
The following are a few error conditions under which a video call continues as an audio only
call, if the VIDEO FAILURE AUDIO ONLY parameter is enabled in egress or ingress Packet
Service Profiles:
- Video requested, but not allowed by the Packet Service Profile
- Video requested, but egress leg is routed off card
- Ingress video bandwidth and resources are not available at the start of a call
- Egress video bandwidth and resources are not available at the start of a call
The bandwidth allocated for a video call is calculated using the following formula:
Allocated Video Bandwidth =
Maximum Video Bandwidth - (Video Bandwidth Reduction Factor X Maximum
Video Bandwidth)
NOTE
Since the NBS uses the aforementioned parameters to control the bandwidth
for a video call instead of the parameters specified in the SDP, it is important
that you set proper values for these parameters. Setting lower values for the
video parameters will result in discarded video frames and setting higher
values will result in under utilization of IP bandwidth.
• On the ingress side, bandwidth is allocated when the call arrives on the NBS.
• On the egress side, bandwidth is allocated after the GSX receives a policy response from the
PSX.
In both cases, the bandwidth allocated for the audio stream depends on the audio codec used by the
audio RTP stream. Any unused bandwidth is released after the endpoints negotiate an audio codec.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Support for Video Calls Managing the GSX
Bandwidth and resources for the video stream of a video call are allocated in the following
manner:
Since egress and ingress Packet Service Profiles may have different video bandwidth settings, the
higher of the two bandwidth values is used for bandwidth reservation and policing.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Managing the GSX Support for Video Calls
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
CHAPTER 7 Call Accounting
Overview
The chapter provides information on the Call Accounting Manager (CAM), along with accounting
files and records. Topics include:
Accounting Files
Although call accounting is thereby a special form of event logging, it is presented here in its own
context. See "Event Monitoring" on page 6–40 for a discussion of non-accounting event logging.
The Call Accounting Manager (CAM) running on every GSX logs system accounting data to the
event log files. In the case of NFS (DSI Level 0)-based logging, those files are in the form of
ASCII data. Accounting files can also be streamed directly to the DataStream Integrator (DSI) in
the form of binary CAM (BCAM) information.
For NFS/DSI-based logging, the accounting files are saved in the <BASEDIR>/evlog/
<NODEID>/ACT subdirectory of the GSX system tree on the NFS (DSI Level 0) server (see
Figure 6–15 on page 6–91).
Stream-Based Logging
The LOG SERVER object is used to create and configure a link to the DSI and initiate log
streaming. (see the section "Log Server" on page 3–96 for more information).
Selectable CDRs
When using Stream-based logging to the DSI (instead of NFS/DSI-based logging), the selectable
CDR feature allows you to select only the CDR fields necessary to your application and
deployment. Each field is assigned a unique identifying number. The field numbers for each CDR
field are listed in Table 7–3 in the "Accounting Records Summary" on page 7–9. The
provisioning for the Selectable CDR feature is provided on the DSI Stream Server.The GSX only
generates CDR records selected by the configuration data defined at the DSI Stream Server. For
more information on using the Selectable CDR feature, see the Sonus DSI Administration and
Maintenance Guide.
The SHOW ACCOUNTING SELECTABLE CDR POPULATION .. commands allows you to display
which CDR fields you have selected for each record type (START, STOP, ATTEMPT, or
INTERMEDIATE). These SHOW commands list CDR record type, field number, and whether that
field number is selected or deselected.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting Files Call Accounting
File Name
The file names for accounting log files differ depending on which event logging method is used.
For NFS (DSI Level 0)-based event logging, the accounting file name format is as follows:
SXXXXXX.ACT
Where,
Thus a file named 100003A.ACT designates an accounting file for shelf 1, sequence number 58.
For stream-based event logging to the DSI, the file name format is as follows:
GSXNodeName.XXXXXXXXXX.BCAM
Where,
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Accounting Accounting Files
File Size
For NFS (DSI Level 0)-based logging, the size of each accounting file is established by the
FILESIZE parameter of the acct Event Log object (see "Event Log" on page 3–90). By default
this size is 32768K bytes.
Each accounting record is queued in MNS (MNS10, MNS11, or MNS20) server module memory
on the GSX9000 or the GNS module memory on a GSX4000 series switch until either of two
circumstances forces it to be written:
• The number of queued records matches the value of the QUEUE parameter of the acct object
(by default this parameter is 10).
• A one-second timer expires.
Whenever a file is filled to the FILESIZE limit with accounting records, a new file is created and
named using the above scheme.
For NFS (DSI Level 0)-based logging, the number of coexisting accounting files is established by
the NUMFILES parameter of the acct Event Log object. By default this number is 512. This means
that, in a default configuration, a maximum of 512 accounting files may be created.
Accounting files are never intentionally deleted by the CAM. To avoid running out of disk space
or suspending accounting because the NUMFILES limit is reached, you must process and delete
these files in timely fashion.
As the number of files begins to approach the NUMFILES limit, critical SYS events are written to
system event log announcing this impending condition. Traps are also generated and delivered to
enabled users. These announcements are made when NUMFILES is 50%, 75%, and 90% full
respectively. An example of this event/trap entry is:
The number of log files in the directory BOOT/evlog/0030000070/ACT has reached 50 percent of
the configured maximum (256/512). Please process and remove files!
If the number of accounting files should reach the NUMFILES limit, the logging of accounting
records to the GSX System Tree will cease and call accounting will be effectively shut down. If
this should happen, a system event entry announcing this condition is issued every 10 minutes
until the condition is cleared. An example of this event entry is:
The number of log files in the directory BOOT/evlog/0030000070/ACT has now reached the
configured maximum (256/256)! Automatic shutdown has occurred! Please process and remove
files!
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting Files Call Accounting
The file NEXTACTn (n = shelf number) is maintained by the CAM in the /ACT subdirectory for
incrementing the sequence number in order to name the next accounting file that is created. The
content of this file is the six ASCII digits of the next sequence number to use to name the next
accounting file. Each time a new accounting file is opened, the sequence number file is updated to
reflect the sequence number to be used when creating the next file name. This file allows the
accounting file names to remain uniquely and incrementally named even if the GSX is rebooted.
NOTE
The hexadecimal digits A, B, C, D, E, and F of any sequence number are always
represented in upper case in these filenames.
CAUTION
To guarantee that this naming strategy is not violated, do not alter or remove the
NEXTACTn file.
The examples in Table 7–1 below illustrate the CAM strategies for creating, naming, and
maintaining the accounting log files.
NOTE
Zero existing .ACT files with no existing NEXTACT1 file represents the initial system
boot scenario. However, if NEXTACT1 is removed for any reason and the GSX is
rebooted, then this scenario is also applicable regardless of the number of .ACT
files present. Notice that in this situation, an existing version of 1000001.ACT
would be lost (because it is recreated).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Accounting Accounting Files
File Header
Every event log file, including accounting logs, begins with a file header. This 128 character string
is terminated by a carriage return. Table 7–2 shows the layout of this string.
“SonusNetworks,Inc.00000000FF600000430000000000000060V07.01.00000000000000000000
0000000000000ACT2006061116444900000000000000”
(The old and new file version fields are highlighted in this example.)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting Files Call Accounting
File Footer
The one line footer, below, is appended to each log file, including accounting logs, when it is
closed under controlled conditions.
DDMMYYYY HHMMSS: File administratively closed.
Controlled conditions include CLI commands (CONFIGURE EVENT LOG ACCT ROLLFILE..) and
automatic rollovers when maximum file size is reached. When an uncontrolled closure occurs,
such as an MNS or GNS switchover or NFS (DSI Level 0) failure, then this footer may not be
present.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Accounting Accounting Records
Accounting Records
The CAM generates one of seven types of accounting records corresponding to specific events in
the life of a call:
Each of the Accounting Records have multiple fields which are saved in a comma-delimited
format. These fields are summarized and described in detail in the following sections.
Timestamps
All timestamps in the accounting record fields are in GMT. Each accounting record contains a
field that cites the time zone in which the GSX node is configured. Billing application programs
can use this field in conjunction with the timestamps in GMT to convert those timestamps into
local time.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting Records Summary Call Accounting
Table 7–3 describes each field in the START, STOP, ATTEMPT, and INTERMEDIATE records
by location within the record, field length, and field type.
In addition, a Streaming Field ID number is identified for each field. These field ID numbers are
used with the Selectable CDR feature with stream-based logging to a DSI.
NOTE
Table 7–3 only contains columns for call specific record types START, STOP,
ATTEMPT, and INTERMEDIATE. Three additional record types, REBOOT,
SWITCHOVER, and SW_CHANGE signify system level events. Field information for
the these system level record types is found in Table 7–4.
Streaming
ASCII Accounting Accounting
INTERMEDIATE
Max Length in ASCII
Streaming Field ID
ATTEMPT
START
Characters
STOP
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Accounting Accounting Records Summary
Streaming
ASCII Accounting Accounting
INTERMEDIATE
Max Length in ASCII
Streaming Field ID
ATTEMPT
START
Characters
STOP
Field Name Type Record Number GMI Type
"Start Date Field" 10 mm/dd/yyyy 6 6 6 6 6 DATE
(GSX GMT)
Note: This field is combined with
the Start Time Field when stream-
based CDR logging is used.
"Start Time Field" 10 hh:mm:ss.d 7 7 7 7 6 DATE
(GSX GMT)
Note: This field is combined with
the Start Date Field when using
stream-based CDR logging.
"Time Elapsed from Receipt of 10 Decimal 8 8 8 8 7 ULONG
Setup Message to Policy Server/
Sonus SoftSwitch Response
Field"
"Time Elapsed from Receipt of 10 Decimal 9 9 9 8 ULONG
Setup Message to Receipt of
Alerting/ProcProg Field"
"Time Elapsed from Receipt of 10 Decimal 10 10 9 9 ULONG
Setup Message to Service (TIME TICK)
Established"
"Intermediate Date Field" 10 mm/dd/yyyy 10 10 DATE
(GSX GMT)
Note: This field is combined with
the Intermediate Time Field when
stream-based CDR logging is
used.
"Intermediate Time Field" 10 hh:mm:ss.d 11 10 DATE
(GSX GMT)
Note: This field is combined with
the Intermediate Date Field when
stream-based CDR logging is
used.
"Disconnect Date Field" 10 mm/dd/yyyy 11 105 11 DATE
(GSX GMT)
Note: This field is combined with
the Disconnect Time Field when
using stream-based CDR logging
is used.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting Records Summary Call Accounting
Streaming
ASCII Accounting Accounting
INTERMEDIATE
Max Length in ASCII
Streaming Field ID
ATTEMPT
START
Characters
STOP
Field Name Type Record Number GMI Type
"Disconnect Time Field" 10 hh:mm:ss.d 12 10 11 DATE
(GSX GMT)
Note: This field is combined with
the Disconnect Date Field when
stream-based CDR logging is
used.
"Time Elapsed from Receipt of 10 Decimal 13 11 12 ULONG
Disconnect to Completion of Call (TIME TICK)
Field"
"Call Service Duration Field" 10 Decimal 14 12 13 ULONG
(TIME TICK)
"Call Disconnect Reason Field" 3 Decimal 15 12 14 UCHAR
"Service Delivered Field" 22 Characters 11 16 13 13 15 UCHAR
"Call Direction Field" 12 Characters 12 17 14 14 16 UCHAR
"Service Provider Field" 23 Characters 13 18 15 15 17 STRING
"Transit Network Selection Code 5 Characters 14 19 16 16 18 STRING
Field"
"Calling Number Field" 30 Characters 15 20 17 17 19 STRING
"Called Number Field" 30 Characters 16 21 18 18 20 STRING
"Extra Called Address Digits 30 Characters 17 22 19 19 21 STRING
Field"
"Number of Called Num 1 Decimal 18 23 20 20 22 UCHAR
Translations Done by This Node
Field"
"Called Number Before 30 Characters 19 24 21 21 23 STRING
Translation #1 Field"
"Translation Type 1 Field" 1 Decimal 20 25 22 22 24 UCHAR
"Called Number Before 30 Characters 21 26 23 23 25 STRING
Translation #2 Field"
"Translation Type 2 Field" 1 Decimal 22 27 24 24 26 UCHAR
"Billing Number Field" 30 Characters 23 28 25 25 27 STRING
"Route Label Field" 23 Characters 24 29 26 26 28 STRING
"Route Attempt Number Field" 5 Decimal 25 30 27 27 29 USHORT
"Route Selected Field" 51 Characters 26 31 28 28 30 STRING
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Accounting Accounting Records Summary
Streaming
ASCII Accounting Accounting
INTERMEDIATE
Max Length in ASCII
Streaming Field ID
ATTEMPT
START
Characters
STOP
Field Name Type Record Number GMI Type
"Egress Local Signaling IP 15 Dotted 27 32 29 29 31 IPAddressV4
Address Field" Decimal
"Egress Remote Signaling IP 15 Dotted 28 33 30 30 32 STRING
Address Field" Decimal
"Ingress Trunk Group Name 23 Characters 29 34 31 31 33 IPAddressV4
Field"
"Ingress PSTN Circuit End Point 38 Characters 30 35 32 32 34 STRING
Field"
"Ingress IP Circuit End Point 43 Characters 31 36 33 33 35 STRING
Field"
"Egress PSTN Circuit End Point 38 Characters 32 37 34 34 36 STRING
Field"
"Egress IP Circuit End Point 43 Characters 33 38 35 35 37 STRING
Field"
"Ingress Number of Audio Bytes 20 Decimal 39 38 ULONG64
Sent Field"
"Ingress Number of Audio 20 Decimal 40 39 ULONG64
Packets Sent Field"
"Ingress Number of Audio Bytes 20 Decimal 41 40 ULONG64
Received Field"
"Ingress Number of Audio 20 Decimal 42 41 ULONG64
Packets Received Field"
"Originating Line Information 3 Decimal 34 43 36 54 42 UCHAR
(OLIP) Field"
"Jurisdiction Information 15 Characters 35 44 37 55 43 STRING
Parameter Field"
"Carrier Code Field" 5 Characters 36 45 38 36 44 STRING
"Call Group ID Field" 10 32-Bit 37 46 39 37 45 ULONG
Hexidecimal
"Script Log Data Field" 95 Characters 47 40 46 STRING
"Time Elapsed from Receipt of 10 Decimal 38 48 41 95 47 ULONG
Setup Message to Receipt of Exit (TIME TICK)
Message Field" on page 7–59
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting Records Summary Call Accounting
Streaming
ASCII Accounting Accounting
INTERMEDIATE
Max Length in ASCII
Streaming Field ID
ATTEMPT
START
Characters
STOP
Field Name Type Record Number GMI Type
"Time Elapsed from Receipt of 10 Decimal 39 49 42 96 48 ULONG
Setup Message to Generation of (TIME TICK)
Exit Message Field"
"Calling Party Nature of Address 3 Decimal 40 50 43 56 49 UCHAR
Field"
"Called Party Nature of Address 3 Decimal 41 51 44 57 50 UCHAR
Field"
"Ingress Protocol Variant Specific 814 Characters 42 52 45 38 51 STRING
Data Field"
"Ingress Signaling Type Field" 2 Decimal 43 53 46 39 52 UCHAR
"Egress Signaling Type Field" 2 Decimal 44 54 47 40 53 UCHAR
"Ingress Far End Switch Type 1 Decimal 45 55 48 41 54 UCHAR
Field"
"Egress Far End Switch Type 1 Decimal 46 56 49 42 55 UCHAR
Field"
"Carrier Code of the Carrier That 5 Characters 47 57 50 43 56 STRING
Owns the Far End of the Ingress
Trunk Group Field"
"Carrier Code of the Carrier That 5 Characters 48 58 51 44 57 STRING
Owns the Far End of the Egress
Trunk Group Field"
"Calling Party Category Field" 4 8 Bit 49 59 52 45 58 UCHAR
Hexadecimal
"Dialed Number Field" 30 Characters 50 60 53 46 59 STRING
"Carrier Selection Information 1 Decimal 51 61 54 47 60 UCHAR
Field"
"Called Number Numbering Plan 2 Decimal 52 62 55 48 61 UCHAR
Field"
"Generic Address Parameter 30 Characters 53 63 56 49 62 STRING
Field"
"Disconnect Initiator Field" 1 Decimal 64 57 63 UCHAR
"Ingress Number of Packets 10 Decimal 65 64 ULONG
Recorded as Lost Field"
"Ingress Interarrival Packet Jitter 5 Decimal 66 65 USHORT
Field"
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Accounting Accounting Records Summary
Streaming
ASCII Accounting Accounting
INTERMEDIATE
Max Length in ASCII
Streaming Field ID
ATTEMPT
START
Characters
STOP
Field Name Type Record Number GMI Type
"Ingress Last Measurement for 5 Decimal 67 66 USHORT
Latency Field"
"Egress Trunk Group Name Field" 23 Characters 54 68 58 50 67 STRING
"Egress Protocol Variant Specific 814 Characters 55 69 59 51 68 STRING
Data Field"
"Incoming Calling Number Field" 30 Characters 56 70 60 52 69 STRING
"Intermediate Record Reason 1 Decimal 53 70 UCHAR
Field"
"AMA Call Type Field" 3 Characters 57 71 61 58 71 STRING
"Message Billing Index (MBI) 3 Characters 58 72 62 59 72 STRING
Field"
"Originating LATA Field" 3 Characters 59 73 63 60 73 STRING
"Route Index Used Field" 2 Decimal 60 74 64 74 UCHAR
"Calling Party Number 1 Decimal 61 75 65 61 75 UCHAR
Presentation Restriction Field"
"Incoming ISUP Charge Number 30 Characters 62 76 66 62 76 STRING
Field"
"Incoming ISUP Charge Number 3 Decimal 63 77 67 63 77 UCHAR
NOA Field"
"Dialed Number NOA Field" 3 Decimal 64 78 68 64 78 UCHAR
"Ingress Codec Type Field" 6 String 79 69 79 STRING
"Egress Codec Type Field" 6 String 80 70 80 STRING
"Ingress RTP Packetization Time 3 Decimal 81 71 81 UCHAR
Field"
"GSX Call ID Field" 10 32 Bit 65 82 72 65 82 ULONG
Hexadecimal
"Terminated with Script Field" 1 Boolean 73 83 BOOLEAN
"Originator Echo Cancellation 1 Decimal 83 74 84 BOOLEAN
Field"
"Terminator Echo Cancellation 1 Decimal 84 75 85 BOOLEAN
Field"
"Charge Flag Field" 1 Decimal 66 85 76 66 86 UCHAR
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting Records Summary Call Accounting
Streaming
ASCII Accounting Accounting
INTERMEDIATE
Max Length in ASCII
Streaming Field ID
ATTEMPT
START
Characters
STOP
Field Name Type Record Number GMI Type
"AMA Service Logic Identification 9 Characters 67 86 77 67 87 STRING
Field"
"AMA BAF Module Field" 256 Characters 68 87 78 68 88 STRING
"AMA Set Hex AB Indication 1 Boolean 69 88 79 69 89 BOOLEAN
Field"
"Service Feature ID Field" 3 Characters 70 89 80 70 90 STRING
"FE Parameter Field" 22 Hexadecimal 71 90 81 71 91 BINARY
(10 bytes) STRING
"Satellite Indicator Field" 1 Decimal 72 91 82 72 92 BOOLEAN
"PSX Billing Information Field" 256 Hexadecimal 73 92 83 73 93 BINARY
(128 bytes) STRING
"Originating TDM Trunk Group 1 Decimal 74 93 84 74 94 UCHAR
Type Field"
"Terminating TDM Trunk Group 1 Decimal 75 94 85 75 95 UCHAR
Type Field"
"Ingress Trunk Member Number 5 Decimal 76 95 86 76 96 USHORT
Field"
"Egress Trunk Group ID Field" 12 Decimal 77 96 87 77 97 STRING
"Egress Switch ID Field" 8 Decimal 78 97 88 78 98 STRING
"Active Call Ingress Local ATM 0 Reserved 79 98 89 79 N/A N/A
Address Field"
"Active Call Ingress Remote ATM 0 Reserved 80 99 90 80 N/A N/A
Address Field"
"Active Call Egress Local ATM 0 Reserved 81 100 91 81 N/A N/A
Address Field"
"Active Call Egress Remote ATM 0 Reserved 82 101 92 82 N/A N/A
Address Field"
"Policy Response Call Type Field" 4 Decimal 83 102 93 83 99 USHORT
"Outgoing Route Identification 5 Decimal 84 103 94 84 100 USHORT
Field"
"Outgoing Message Identification 1 Decimal 85 104 95 85 101 USHORT
Field"
"Incoming Route Identification 5 Decimal 86 105 96 86 102 USHORT
Field"
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Accounting Accounting Records Summary
Streaming
ASCII Accounting Accounting
INTERMEDIATE
Max Length in ASCII
Streaming Field ID
ATTEMPT
START
Characters
STOP
Field Name Type Record Number GMI Type
"Calling Name Field" 25 Characters 87 106 97 87 103 STRING
"Calling Name Type Field" 1 Decimal 88 107 98 88 104 UCHAR
"Incoming Calling Party 2 Decimal 89 108 99 89 105 UCHAR
Numbering Plan Field"
"Outgoing Calling Party 2 Decimal 90 109 100 90 106 UCHAR
Numbering Plan Field"
"Calling Party Business Group ID 10 Decimal 91 110 101 91 107 ULONG
Field"
"Called Party Business Group ID 10 Decimal 92 111 102 92 108 ULONG
Field"
"Calling Party Public Presence 30 Characters 93 112 103 93 109 STRING
Directory Number Field"
"Elapsed Time from Receipt of 10 Decimal 94 113 104 94 110 ULONG
Setup Message to Last Call (10 millisecond (TIME TICK)
Routing Attempt Field" ticks)
"Billing Number NOA Field" 3 Decimal 95 114 106 97 111 UCHAR
"Incoming Calling Number NOA 3 Decimal 96 115 107 98 112 UCHAR
Field"
"Egress Trunk Member Number 5 Decimal 97 116 108 99 113 USHORT
Field"
"Selected Route Type Field" 1 Decimal 98 117 109 100 114 UCHAR
"Telcordia Long Duration Record 1 Decimal 118 101 115 UCHAR
Type Field"
"Time Elapsed from Previous 10 Decimal 119 102 116 ULONG
Record Field" (10 millisecond (TIME TICK)
ticks)
"Cumulative Route Index Field" 5 Decimal 99 120 110 117 USHORT
"Call Disconnect Reason 3 Decimal 121 111 118 UCHAR
Transmitted to Ingress Field"
"Call Disconnect Reason 3 Decimal 122 112 119 UCHAR
Transmitted to Egress Field"
"ISDN PRI Calling Party 30 Characters 100 123 113 103 120 STRING
Subaddress Field"
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting Records Summary Call Accounting
Streaming
ASCII Accounting Accounting
INTERMEDIATE
Max Length in ASCII
Streaming Field ID
ATTEMPT
START
Characters
STOP
Field Name Type Record Number GMI Type
"Outgoing Trunk Group Number 6 Decimal 101 124 114 104 121 STRING
in EXM Field"
"Ingress Local Signaling IP 15 Dotted 102 125 115 105 122 IpAddressV4
Address Field" Decimal
"Ingress Remote Signaling IP 15 Dotted 103 126 116 106 123 IpAddressV4
Address Field" Decimal
"Record Sequence Number Field" 5 Decimal 104 127 117 107 124 USHORT
"Transmission Medium 3 Decimal 105 128 118 108 125 UCHAR
Requirement (TMR) Field" on
page 7–115
"Information Transfer Rate (ITR) 2 Decimal 106 129 119 109 126 UCHAR
Field"
"User Service Information (USI) 2 Decimal 107 130 120 110 127 UCHAR
User Information Layer 1 Field"
"Unrecognized Raw ISUP Calling 3 Decimal 108 131 121 111 128 UCHAR
Party Category Field"
"Egress Release Link Trunking 598 Characters 109 132 122 112 129 STRING
(RLT) Feature Specific Data Field"
"Two B-Channel Transfer Feature 72 Characters 110 133 123 113 130 STRING
Specific Data Field"
"Calling Party Business Unit 10 Decimal 111 134 124 114 131 ULONG
Field"
"Called Party Business Unit Field" 10 Decimal 112 135 125 115 132 ULONG
"Redirect Feature Specific Data 123 Characters 113 136 126 116 133 STRING
Field"
"Ingress Release Link Trunking 598 Characters 114 137 127 117 134 STRING
(RLT) Feature Specific Data Field"
"PSX Index Field" 2 Decimal 115 138 128 118 135 UCHAR
"PSX Congestion Level Field" 1 Decimal 116 139 129 119 136 UCHAR
"PSX Processing Time Field" 5 Decimal 117 140 130 120 137 USHORT
"Script Name Field" 23 Characters 118 141 131 121 138 STRING
"Ingress External Accounting 128 Characters 119 142 132 122 139 STRING
Data Field"
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Accounting Accounting Records Summary
Streaming
ASCII Accounting Accounting
INTERMEDIATE
Max Length in ASCII
Streaming Field ID
ATTEMPT
START
Characters
STOP
Field Name Type Record Number GMI Type
"Egress External Accounting Data 128 Characters 120 143 133 123 140 STRING
Field"
"Egress RTP Packetization Time 3 Decimal 144 134 141 UCHAR
Field"
"Egress Number of Audio Bytes 20 Decimal 145 142 ULONG64
Sent Field"
"Egress Number of Audio Packets 20 Decimal 146 143 ULONG64
Sent Field"
"Egress Number of Audio Bytes 20 Decimal 147 144 ULONG64
Received Field"
"Egress Number of Audio Packets 20 Decimal 148 145 ULONG64
Received Field"
"Egress Number of Packets 10 Decimal 149 146 ULONG
Recorded as Lost Field"
"Egress Interarrival Packet Jitter 5 Decimal 150 147 USHORT
Field"
"Egress Last Measurement for 5 Decimal 151 148 ULONG
Latency Field"
"Ingress Maximum Packet Outage 10 Decimal 152 149 ULONG
Field"
"Egress Maximum Packet Outage 10 Decimal 153 150 ULONG
Field"
"Ingress Packet Playout Buffer 16 Hexadecimal 154 151 BINARY
Quality Field" STRING
"Egress Packet Playout Buffer 16 Hexadecimal 155 152 BINARY
Quality Field" STRING
"Call Supervision Type Field" 1 Decimal 121 156 135 124 153 UCHAR
"Ingress SIP Refer & Replaces 70 Characters 122 157 136 125 154 STRING
Feature Specific Data Field"
"Egress SIP Refer & Replaces 70 Characters 123 158 137 126 155 STRING
Feature Specific Data Field"
"Network Transfer Feature 54 Characters 124 159 138 127 156 STRING
Specific Data Field"
"Call Condition Field" 2 Decimal 125 160 139 128 157 UCHAR
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting Records Summary Call Accounting
Streaming
ASCII Accounting Accounting
INTERMEDIATE
Max Length in ASCII
Streaming Field ID
ATTEMPT
START
Characters
STOP
Field Name Type Record Number GMI Type
"Toll Indicator Field" 2 Decimal 126 161 140 129 158 UCHAR
"Generic Number Number Field" 30 Characters 127 162 141 130 159 STRING
"Generic Number Presentation 1 Decimal 128 163 142 131 160 UCHAR
Restriction Indicator Field"
"Generic Number Numbering 2 Decimal 129 164 143 132 161 UCHAR
Plan Field"
"Generic Number Nature of 3 Decimal 130 165 144 133 162 UCHAR
Address Field"
"Generic Number Type Field" 2 Decimal 131 166 145 134 163 UCHAR
"Final ATTEMPT Indicator Field" 1 Decimal 146 164 BOOLEAN
"Originating Trunk Type Field" 2 Hexadecimal 132 167 147 135 165 UCHAR
"Terminating Trunk Type Field" 2 Hexadecimal 133 168 148 136 166 UCHAR
"Remote GSX Billing Indicator 1 Decimal 169 149 167 BOOLEAN
Field"
"Extra Disconnect Reason Field" 4 Decimal 150 168 USHORT
"VPN Calling Private Presence 30 Characters 134 170 151 137 169 STRING
Number Field"
"VPN Calling Public Presence 30 Characters 135 171 152 138 170 STRING
Number Field"
"External Furnish Charging Info 800 Hexadecimal 136 172 153 139 171 BINARY
Field" STRING
"Ingress Policing Discards Field" 20 Decimal 173 172 ULONG64
"Egress Policing Discards Field" 20 Decimal 174 173 ULONG64
"Announcement ID Field" 5 Decimal 137 175 154 140 174 USHORT
"Source Information Field" 2 Decimal 138 176 155 141 175 UCHAR
"Network ID Field" 5 Decimal 139 177 156 142 176 USHORT
"Partition ID Field" 4 Decimal 140 178 157 143 177 USHORT
"NCOS Field" 5 Decimal 141 179 158 144 178 USHORT
"Ingress SRTP Field" 7 Characters 180 179 STRING
"Egress SRTP Field" 7 Characters 181 180 STRING
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Accounting Accounting Records Summary
Streaming
ASCII Accounting Accounting
INTERMEDIATE
Max Length in ASCII
Streaming Field ID
ATTEMPT
START
Characters
STOP
Field Name Type Record Number GMI Type
"ISDN Access Indicator from the 1 Decimal 142 182 159 145 181 UCHAR
Forward Call Indicator Field"
"Call Disconnect Location Field" 2 Decimal 183 160 182 UCHAR
"Call Disconnect Location 2 Decimal 184 161 183 UCHAR
Transmitted to Ingress Field"
"Call Disconnect Location 2 Decimal 185 162 184 UCHAR
Transmitted to Egress Field"
"Network Call Reference - Call 8 Decimal 143 186 163 146 185 ULONG
Identity Field"
"Network Call Reference - 5 Decimal 144 187 164 147 186 USHORT
Signaling Point Code Field"
"Ingress ISUP MIME Protocol 814 Characters 145 188 165 148 187 STRING
Variant Specific Data Field"
"Egress ISUP MIME Protocol 814 Characters 146 189 166 149 188 STRING
Variant Specific Data Field"
"Modem Tone Type Field" 1 Decimal 190 189 UCHAR
"Modem Tone Signal Level Field" 2 Decimal 191 190 UCHAR
"Video Codec Data Field" 152 Characters 147 192 167 150 191 STRING
"Video Codec Statistics Field" 512 Characters 193 192 STRING
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting Records Summary Call Accounting
Table 7–4 describes each field in the REBOOT, SWITCHOVER, and SW_CHANGE records by
location within the record, field length, and field type. In addition, a Streaming Field ID number is
identified for each field. These field ID numbers are used with the Selectable CDR feature with
stream-based logging to a DSI.
Streaming
ASCII Accounting Accounting
SWITCHOVER
SW_CHANGE
Max Length in ASCII
Streaming Field ID
REBOOT
Characters
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Accounting Accounting Record Field Descriptions
The record fields are described in detail in this section. Most of these fields are propagated to more
than one record type. See "Accounting Records Summary" on page 7–9 to view the chronological
arrangement of the fields of any one of these record types.
START Field
STOP Field
ATTEMPT Field
INTERMEDIATE Field
REBOOT Field
SWITCHOVER Field
SW_CHANGE Field
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting Record Field Descriptions Call Accounting
If parameter loading is turned on (see "Non-Volatile Storage (NVS) Parameters" on page 3–62),
then the previously configured node name will appear in the REBOOT and SWITCHOVER
records.
If parameter loading is turned off, or the Node Name object has never been configured (see "Node
Name" on page 3–14), then this value will be “None” in the REBOOT and SWITCHOVER
records.
Accounting ID Field
This field occurs in each record. This identifier, combined with the Gateway Name field, uniquely
identifies the call accounting information on a network basis for an extended period of time. This
field is depicted in Figure 7–1.
NOTE
The Boot Count is incremented every time the shelf reboots or an MNS or GNS
switchover is performed.
In the REBOOT record, this is the accounting ID of the first call attempted on this GSX.
Start time in system ticks - the timestamp of when Setup Request was received (Decimal number 0
- 4294967295).
• "GMT-12:00-Eniuetok"
• "GMT-11:00-Midway Island"
• "GMT-10:00-Hawaii"
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Accounting Accounting Record Field Descriptions
• "GMT-09:00-Alaska"
• "GMT-08:00-Alaska-DST" (DST - Daylight Savings Time)
• "GMT-08:00-Pacific(US)"
• "GMT-07:00-Pacific-DST"
• "GMT-07:00-Arizona"
• "GMT-07:00-Mountain"
• "GMT-06:00-Mountain-DST"
• "GMT-06:00-Central"
• "GMT-05:00-Central-DST"
• "GMT-06:00-Mexico"
• "GMT-06:00-Saskatchewan"
• "GMT-05:00-Bojota"
• "GMT-05:00-Eastern"
• "GMT-04:00-Eastern-DST"
• "GMT-05:00-Indiana"
• "GMT-04:00-Atlantic(Can)" Note: “Can” is short for “Canada”
• "GMT-03:00-Atlantic-DST"
• "GMT-04:00-Caracas"
• "GMT-03:00-Buenos Aires"
• "GMT-02:00-Mid Atlantic"
• "GMT-01:00-Azores"
• "GMT"
• "GMT+01:00-Berlin"
• "GMT+02:00-Athens"
• "GMT+03:00-Moscow"
• "GMT+03:30-Tehran"
• "GMT+04:00-Abu Dhabi"
• "GMT+04:30-Kabul"
• "GMT+05:00-Islamabad"
• "GMT+05:30-New Delhi"
• "GMT+06:00-Dhaka"
• "GMT+07:00-Bangkok"
• "GMT+08:00-Beijing"
• "GMT+09:00-Tokyo"
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting Record Field Descriptions Call Accounting
• "GMT+09:30-Adelaide"
• "GMT+10:00-Guam"
• "GMT+11:00-Magadan"
• "GMT+12:00-Fiji"
• "Time Zone Not Set"
Start Date (mm/dd/yyyy) - GMT datestamp when Setup Request was received. This value is
provided by NTP.
In the REBOOT record, this is the date that the GSX was last booted.
NOTE
This field is combined with the Start Time Field when stream-based CDR logging is
used.
Start Time (hh:mm:ss.d) (d=deci-seconds) - GMT timestamp when Setup Request was received,
for example 16:20:38.6. This value is provided by NTP.
In the REBOOT record, this is the time that the GSX was last booted.
NOTE
This field is combined with the Start Date Field when stream-based CDR logging is
used.
The GSX Old Software Version represents the GSX software that was running before the Live
Software Upgrade occurred. This is a 14-character string containing the following format:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Accounting Accounting Record Field Descriptions
For example, GSX Software Version 6.03.02, Build 1, produces the string:
“V06.03.02 R001”
The GSX New Software Version represents the GSX software that is running after the Live
Software Upgrade. This is a 14-character string containing the following format:
For example, GSX Software Version 6.03.05, Build 1, produces the string:
“V06.03.05 R001”
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting Record Field Descriptions Call Accounting
The sequence number of this record relative to other records in the file. This number starts at zero
and increments by one each time a new record is written. The software maintains only one
sequence regardless of the record type. When the sequence number reaches its maximum, 65535,
it wraps to zero and begins incrementing again (65534, 65535, 0, 1, 2...). The incrementing
continues through file rollovers. A sequence number of zero occurs only on a reboot (MNS or
GNS switchover), or a natural wraparound. (A natural wraparound sequence is 65534, 65535, 0, 1,
2 and so on.)
This field is intended to help reconcile billing records after events which may result in lost
accounting records, such as an NFS (DSI Level 0) timeout or an MNS or GNS switchover.
Time Elapsed from Receipt of Setup Message to the first Policy Server/Sonus SoftSwitch
Response in 10 millisecond Ticks (Decimal number 0 - 4294967295).
Time Elapsed from Receipt of Setup Message to Service Established (Receipt of Answer and
Completion of Cut-through) in 10 millisecond Ticks (Decimal number 0 - 4294967295).
NOTE
This field is combined with the Intermediate Time Field when stream-based CDR
logging is used.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Accounting Accounting Record Field Descriptions
NOTE
This field is combined with the Intermediate Date Field when stream-based CDR
logging is used.
Disconnect Date (mm/dd/yyyy) - GMT date stamp when Disconnect Request was received.
The Disconnect Date field is not set by reading NTP time. Instead, the disconnect date stamp is
calculated by adding the elapsed time between the Setup and Disconnect Messages to the Start
date stamp. This indirect method ensures the difference between the Start and Disconnect Dates
reflects the true duration of the call, even if the NTP server adjusted time of day during the call.
See “Disconnect Time Field” below for an explanation and example of this method.
NOTE
This field is combined with the Disconnect Time Field when stream-based CDR
logging is used.
Disconnect Time (hh:mm:ss.d) (d=deci-seconds) - GMT time stamp when Disconnect Request
was received, for example 16:20:38.6.
The Disconnect Time field is not set by reading NTP time. Instead, the disconnect time stamp is
calculated by adding the elapsed time between the Setup and Disconnect Messages to the Start
time stamp. This indirect method ensures the difference between the Start and Disconnect Times
reflects the true duration of the call, even if the NTP server adjusted time of day during the call.
For example: assume a Setup Message is received at 01:00:00.0 GMT (NTP Time). Then over the
next hour the NTP server rolls back NTP time by one minute. Also after exactly one hour (360000
ten-millisecond ticks) a Disconnect message is received, terminating the call. The new NTP time
when this disconnect is received would be 01:59:00.0 GMT (but would have been 02:00:00.0
GMT if NTP adjustment did not occur). In reality the caller spent 60 minutes on the phone, not 59.
Because of the indirect disconnect time calculation described above, the GSX will log disconnect
time as 02:00:00.0 GMT. To recap: the disconnect time is based on the NTP start time plus elapsed
time to disconnect, not the NTP disconnect time.
The elapsed time between the Setup and Disconnect Messages can be calculated by adding the
"Time Elapsed from Receipt of Setup Message to Service Established" and "Call Service
Duration" fields. The latter field measures time elapsed from service established to receipt of
disconnect message.
NOTE
This field is combined with the Disconnect Date Field when stream-based CDR
logging is used.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting Record Field Descriptions Call Accounting
Time Elapsed from Disconnect receipt to Call Termination completion in 10 millisecond ticks
(Decimal number 0 - 4294967295).
Call Service Duration in 10 millisecond ticks. This count is initiated when the answer message is
received and continues to increment until one leg of the call is released (Decimal number 0 -
4294967295).
The Call Termination Reason Codes shown below are taken from the Q.931 Standard for all codes
less than 128.
Codes equal to or greater than 128 are Sonus Reason Codes. The Sonus Reason Codes will never
be contained in messages sent to the PSTN, but will instead be mapped to an appropriate Q.931
Standard code. The Sonus Reason Codes will appear in the system event logs to give specific
information about the call failure. These codes could expand in the future.
NOTE
CAS SSP configuration (see "CAS Signaling Sequence" on page 3–1116 and
following) allows the administrator to specify the disconnect reason codes to be
used when errors are encountered during CAS call establishment. Therefore, any
of the error codes below could be returned from a CAS call.
If the GSX receives a call release or call disconnect with a cause value that is not listed in Table 7–
7, then that value is mapped to one of the 7 Mapped To cause values listed in Table 7–8, "Mapping
by Cause Code Class". In all cases, the Mapped To value is determined by the Class of the returned
cause value as shown in the table.
For example, the unlisted cause value of 14 (PORTED NUMBER) belongs to Class 000 and hence
would be mapped to cause value 31 (NORMAL_UNSPECIFIED). The unlisted cause value of 52
(OUTGOING CALLS BARRED) belongs to Class 011 and hence would be mapped to cause
value 63 (SERVICE_OR_OPTION_NOT_AVAILABLE_UNSPECIFIED).
When a mapped Disconnect Code is sent to the preceding switch by the GSX, that Disconnect
Code is also placed in either the "Call Disconnect Reason Transmitted to Egress Field" or the "Call
Disconnect Reason Transmitted to Ingress Field".
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Accounting Accounting Record Field Descriptions
DEFINITION
ID (Added Explanation)
Q.931 Standard (0-127)
0 INVALID DISCONNECT REASON
1 UNALLOCATED NUMBER
(Because the GSX never generates this internally, this code originates at a switch that
is downstream from this GSX.)
2 NO ROUTE TO SPECIFIED NETWORK
3 NO ROUTE TO DESTINATION
[Sonus codes 138 and 139 are mapped to this ID. This mapping is performed before
the ISUP Release Message is sent out. The “underlying” Sonus code is placed into the
accounting record.]
(The GSX may release a call with this cause value if:
• No routes are configured on the PSX for this destination.
• The PSX loses connectivity to the Oracle DB server and hence is unable to perform
routing.)
4 SEND SPECIAL INFO TONE
5 MISDIALED TRUNK PREFIX
6 CHANNEL UNACCEPTABLE
7 CALL AWARDED
8 PREEMPTION
9 PREEMPTION - CIRCUIT RESERVED
16 NORMAL ROUTE CLEARING
17 USER BUSY
18 NO USER RESPONDING
(The GSX may release a call with this cause value if:
• The CAS SSP that is executed on an egress call does not have WAIT ANSWER
configured as the last step in the sequence. This token is typically configured to
await an off hook at the Far-End. In this case, this token is performed by default with
a 30 second timeout. If this timer expires then this code is returned.
• ISDN User Part (ISUP) for an Egress Call releases a call because of an Address
Complete Message (ACM) timeout from the SGX. In this case, the SGX forwards
Q.931 code 31 (NORMAL UNSPECIFIED) to the PSTN switch.
• In general, the GSX times out waiting for an ISUP ACM or ALERTING or CON
message after sending the Initial Address Message (IAM) SETUP)
19 NO ANSWER FROM USER
(The GSX may release a call with this cause value if ISUP for an egress call releases a
call because of an ANM timeout from the SGX. In this case, the SGX forwards Q.931
code 102 (RECOVERY ON TIMER EXPIRY) to the PSTN switch.)
20 SUBSCRIBER ABSENT
21 CALL REJECTED
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting Record Field Descriptions Call Accounting
DEFINITION
ID (Added Explanation)
22 NUMBER CHANGED
23 UNALLOCATED DESTINATION NUMBER
24 UNKNOWN BUSINESS GROUP
25 EXCHANGE ROUTING ERROR
26 MISROUTED CALL TO PORTED NUMBER
(The GSX may release a call with this cause value if:
• An LNP translation produces a subscriber that is in a state of transition
• An LNP translation produces a subscriber that is in a state of ported out
This could occur either when the PSX initiates the LNP query to the SCP database, or
when the PSX receives a policy request where the translation has been performed by
a downstream switch.)
27 DESTINATION OUT OF ORDER
28 INVALID NUMBER FORMAT
(The GSX may release a call with this cause value if the LNP translation is performed
by a downstream switch and the General Address Parameter digits sent to the PSX
are in an incorrect format, that is, either too many digits or the number type is
incorrect.)
29 FACILITY REJECTED
30 RESPONSE TO STATUS ENQUIRY
(ISUP specific and thus not applicable to ISDN, H323, or SIP calls.)
31 NORMAL UNSPECIFIED
[Sonus codes 129, 130, 133, 134, 135, 141, 143, 144, and 145 are mapped to this ID.
This mapping is performed before the ISUP Release Message is sent out. The
“underlying” Sonus code is placed into the accounting record.]
[ISUP codes 6, 7, 24, and 25 are mapped to this ID]
(The GSX may release a call with this cause value if:
• ISUP circuits were reset via a CLI command, causing all calls on those circuits to be
brought down.
• ISDN circuits were reset via a CLI command, causing all calls on those circuits to be
brought down.
• ISDN Channels were restarted by the Far-End switch, causing all calls on those
circuits to be brought down.
• CAS circuits were reset via a CLI command, causing all calls on those circuits to be
brought down.
• Any other CLI command, such as a command to take a T1 or CNS out of service,
was issued, causing all calls on those circuits to be brought down.
• An ISUP Continuity Test timed out.
• ISUP circuits were reset by the Far-End switch.
• Calls were cleared by the SGX because of protocol timeouts.)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Accounting Accounting Record Field Descriptions
DEFINITION
ID (Added Explanation)
34 NO CIRCUIT AVAILABLE
[Sonus codes 128, 140, and 142 are mapped to this ID. This mapping is performed
before the ISUP Release Message is sent out. The “underlying” Sonus code is placed
into the accounting record.]
(The GSX may release a call with this cause value if:
• The GSX attempts to initially route the call, but none of the routes has any available
circuits.
• The GSX attempts to reroute the call (“crankback”), but is out of routes or out of
routes with available circuits. An attempt to reroute a call may have various causes.
When this is the result of an attempted reroute, the cause value that triggered the
reroute is placed into the accounting record.
• A GSX software programming error occurred.)
38 NETWORK OUT OF ORDER
(The GSX may release a call with this cause value if:
• The Gateway-to-Gateway Signaling Link to the Far-End GSX was lost, either
because of network problems or of a CLI command. In either event, all calls to that
GSX are cleared with this disconnect reason.
• The Gateway-to-Gateway Signaling Link to the Far-End GSX went down and then
came back up. Afterwards, the GSXs audit all calls between them. Any mismatched
calls are brought down with this disconnect reason.)
39 PERM FM CONNECTION OOS
40 PERM FM CONNECTION OPERATIONAL
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting Record Field Descriptions Call Accounting
DEFINITION
ID (Added Explanation)
41 TEMPORARY FAILURE
[Sonus codes 131, 132, and 136 are mapped to this ID. This mapping is performed
before the ISUP Release Message is sent out. The “underlying” Sonus code is placed
into the accounting record.]
(The GSX may release a call with this cause value if:
• Communication between GSX and PSX is broken and Policy Requests from the
GSX to the PSX timeout.
• A Policy Request issued from the GSX to the PSX was rejected by the PSX because
of corrupted data in the packet - an indication of possible network problems.
• A GSX software programming error occurred.
• ISUP calls were brought down as a result of corrective action that was performed
following a Circuit Query with a Far-End PSTN Switch.
• Connectivity to the SS7 Gateway was lost and all active SS7 Calls in the GSX were
brought down.
• The GSX received a UCIC ISUP Message from a Far-End PSTN Switch that
contained a CIC of an active GSX call.
• Call admission on the GSX was suspended due to CNS Failure, MNS or GNS
switchover, MNS or GNS Standby Card Synchronization, no NTP time, or other
issues. All new call admission requests coming from other GSXs over Gateway-to-
Gateway Signaling are released back to the originating gateway with this code.
• A catastrophic failure such as a CNS failure or a PNS failure occurs on a GSX and
all affected calls are released. The GSX releases these calls back to the originating
gateway over the gateway-to-gateway signaling link with this code.
• The T8 Timer expires in ISUP. This timer would expire if the GSX doesn’t receive a
COT message from the previous switch within the T8 Timer duration, when the IAM
indicates that a COT is being performed.
In general when GSX is not getting responses from the PSX, it is indicative of IP
network congestion or PSX overload. Both are transient and should be resolved soon,
hence the use of this code to indicate a temporary failure situation.)
42 SWITCHINGEQUIP CONGESTION
43 ACCESS INFORMATION DISCARDED
(The GSX may release a call with this cause value if this code is returned before an
ANM/CONNECT message.)
44 REQUESTED CIRCUIT NOT AVAILABLE
45 ANSI PREEMPTION
46 PRECEDENCE CALL BLOCKED
47 RESOURCE UNAVAILABLE UNSPECIFIED
[ISUP codes 39, 40, and 45 are mapped to this ID.]
49 QUALITY OF SERVICE UNAVAILABLE
50 REQUESTED FACILITY NOT SUBSCRIBED
51 CALL TYPE INCOMPATIBLE WITH SEREVICE
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Accounting Accounting Record Field Descriptions
DEFINITION
ID (Added Explanation)
53 OUTGOING CALL BARRED CUG
54 CALL BLOCKED GROUP RESTRICTIONS
55 INCOMING CALL BARRED CUG
(The GSX may release a call with this cause value if this code is returned before an
ANM/CONNECT message. CUG is CLOSED USER GROUP.)
57 BEARER CAPABILITY NOT AUTHORIZED
58 BEARER CAPABILITY PRESENTLY NOT AVAILABLE
62 INCONSISTENT OUTGOING SUBSCRIBER CLASS
63 SERVICE OR OPTION NOT AVAILABLE UNSPECIFIED
[Sonus code 137 is mapped to this ID. This mapping is performed before the ISUP
Release Message is sent out. The “underlying” Sonus code is placed into the
accounting record.]
[ISUP codes 49, 51, and 54 are mapped to this ID.]
65 BEARER CAPABILITY NOT IMPLEMENTED
66 CHANNEL TYPE NOT IMPLEMENTED
69 REQUESTED FACILITY NOT IMPLEMENTED
70 ONLY RESTRICTED DIGITAL INFO BEARER CAPABILITY AVAILABLE
79 SERVICE OR OPTION NOT IMPLEMENTED UNSPECIFIED
[ISUP code 66 is mapped to this ID.]
81 INVALID CALL REFERENCE
82 CHANNEL DOES NOT EXIST
83 SUSPENDED CALL NO IDENTITY
84 CALL IDENTITY IN USE
85 NO CALL SUSPENDED
86 CALL IDENTITY CLEARED
87 NOT MEMBER OF CUG
(The GSX may release a call with this cause value if this code is returned before an
ANM/CONNECT message. CUG is CLOSED USER GROUP.)
88 INCOMPATIBLE DESTINATION
90 NON-EXISTENT CUG
91 INVALID NETWORK SELECTION
95 INVALID MESSAGE UNSPECIFIED
[ISUP codes 81, 82, 83, 84, 85, and 86 are mapped to this ID.]
96 MANDATORY INFORMATION ELEMENT MISSING
97 MESSAGE TYPE NON-EXISTENT OR NOT IMPLEMENTED
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting Record Field Descriptions Call Accounting
DEFINITION
ID (Added Explanation)
98 MSG TYPE NC NE OR NI
(NC is NOT COMPATIBLE. NE is NON EXISTING. NI is NOT IMPLEMENTED. This
code typically suggests an incompatibility in the network.)
99 IE NOT IMPLEMENTED
100 INVALID INFORMATION ELEMENT CONTENT
101 MSG NOT COMPATIBLE WITH STATE
102 RECOVERY ON TIMER EXPIRY
(The GSX may release a call with this cause value if the internal GSX Call
Establishment Timer expires. This interval is 5 Minutes.)
103 PARAMETER NOT IMPLEMENTED
110 UNRECOGNIZED PARAMETER
111 PROTOCOL ERROR UNSPECIFIED
[ISUP codes 96, 98, 100, and 101 are mapped to this ID.]
[nttfcc ISUP code 102 is mapped to this ID.]
(The GSX may release a call with this cause value if:
• The PSX could not find routes to a destination because they were filtered out due to
protocol conformance errors, according to the conventions cited in GR-317/394.
• A CAS Call Establishment error that is not configured to be handled in the SSP
occurs, causing CAS to release the call with this code.
• Another error in a CAS SSP/SCP configuration that is being used by a call causes
the call to be released with this code.)
127 INTERWORKING UNSPECIFIED
(The GSX may release a call with this cause value if:
• An incoming CAS call goes on-hook while being established and the SSP does not
have this event configured.
• An incoming CAS call goes on-hook after being established.
• An outgoing CAS call goes on-hook after being established.)
Sonus Extensions (above 127)
128 RESOURCES ALLOCATION FAILURE
[This Sonus code is mapped to Q.931 ID 34.]
(The GSX may release a call with this cause value if:
• No PSTN circuits are available to hunt.
• The DSP call resources are exhausted.
• Call admissions to the system have been suspended due to an event such as an
MNS or GNS switchover, CNS switchover, etc.
• The GSX memory resources are exhausted.)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Accounting Accounting Record Field Descriptions
DEFINITION
ID (Added Explanation)
129 CHANNEL COLLISION BACKOFF
[This Sonus code is mapped to Q.931 ID 31.]
(The GSX may release a call with this cause value if a call collision occurs on the
selected egress circuit, resulting in backoff and reattempt of the call.)
130 INSUFFICIENT DESTINATION RESOURCES
[This Sonus code is mapped to Q.931 ID 34.]
(The GSX may release a call with this cause value if insufficient resources are
available on the destination gateway and rerouting is invoked to reattempt the call via a
different route on the originating gateway.)
131 RESOURCE FAILURE
[This Sonus code is mapped to Q.931 ID 41.]
(The GSX may release a call with this cause value if a resource that was being used by
the call fails and is no longer available. Taking a span out of service could cause this
code.)
132 MODULE FAILURE
[This Sonus code is mapped to Q.931 ID 41.]
(The GSX may release a call with this cause value if a catastrophic failure causes bulk
teardown of all calls on the module, and those calls are disconnected. A module
failure, a module switchover, a span failure, an SGX that is temporarily placed into
“PAUSED” state while calls are active, a GSX-to-SGX IP network failure resulting in
loss of connectivity, etc. could cause this code.)
133 MEDIA GATEWAY SERVICE GROUP EGRESS DISCONNECT
[This Sonus code is mapped to Q.931 ID 31.]
(The GSX may release a call with this cause value if an egress disconnect is indicated
due to receipt of the MGCP DLCX message.)
134 CONTINUITY CHECK FAILED, BACKOFF
[This Sonus code is mapped to Q.931 ID 31.]
(The GSX may release a call with this cause value if a continuity check on an egress
circuit fails, resulting in backoff and reattempt of the call on a different circuit.)
135 COLLISION REATTEMPT EXHAUSTED
[This Sonus code is mapped to Q.931 ID 41.]
(The GSX may release a call with this cause value if two consecutive collisions occur
on the egress ISUP/ISDN/CAS circuit. For PSTN-PSTN calls, after one reattempt, or
two collisions, the call is released with this code. For PSTN-IP-IP-PSTN calls, the call
is reattempted using the next route in the list.)
136 CONTINUITY REATTEMPT EXHAUSTED
[This Sonus code is mapped to Q.931 ID 31.]
(The GSX may release a call with this cause value if two consecutive continuity tests
on the selected egress circuits fail. After one reattempt, the call is released with this
code.)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting Record Field Descriptions Call Accounting
DEFINITION
ID (Added Explanation)
137 NO ROUTE FOR BEARER CAPABILITY
[This Sonus code is mapped to Q.931 ID 63.]
(The GSX may release a call with this cause value if the PSX routing lookup fails
because no route with the Bearer Capability required for this call exists on the PSX.)
138 NO ROUTE SIGNALING
[This Sonus code is mapped to Q.931 ID 3.]
(The GSX may release a call with this cause value if the PSX routing lookup fails
because no route with the signaling required for this call exists on the PSX.)
139 NO ROUTE DIRECTION
[This Sonus code is mapped to Q.931 ID 3.]
(The GSX may release a call with this cause value if the PSX routing lookup fails
because no route with the direction required for this call exists on the PSX.)
140 CIRCUIT ENDPOINT RESOURCE ALLOCATION FAILURE
[This Sonus code is mapped to Q.931 ID 34.]
(The GSX may release a call with this cause value if the circuit is released after being
selected. Events such as a NIF being placed out of service or a port going into alarm
may cause this code.)
141 DISCONNECT WITH NEW DESTINATION
[This Sonus code is mapped to Q.931 ID 31.]
(The GSX may release a call with this cause value if the egress circuit is released while
the ingress call is rerouted to a new destination, or the call is transferred.)
142 AUTOMATIC CONGESTION CONTROL PROCEDURE
[This Sonus code is mapped to Q.931 ID 34.]
(The GSX may release a call with this cause value if Automatic Congestion Control
(ACC) is configured, insufficient resources are detected at the far end, and the call is
cancelled. When ACC is active, calls may be rerouted or cancelled, depending on:
• current congestion level
• Alternate Route versus Direct Route requirements
• Percentage of calls to be rerouted versus cancelled
This release code indicates that this call was cancelled, rather than rerouted.)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Accounting Accounting Record Field Descriptions
DEFINITION
ID (Added Explanation)
143 ACC ALTERNATE ROUTE
[This Sonus code is mapped to Q.931 ID 31.]
(The GSX may release a call with this cause value if Automatic Congestion Control
(ACC) is configured, insufficient resources are detected at the far end, and the call is
rerouted. When ACC is active, calls may be rerouted or cancelled, depending on:
• current congestion level
• Alternate Route versus Direct Route requirements
• Percentage of calls to be rerouted versus cancelled
This release code indicates that this call was rerouted, or reattempted on an alternate
route.)
144 PACKET LOSS EXCEEDS THRESHOLD
[This Sonus code is mapped to Q.931 ID 31.]
(The GSX may release a call with this cause value if RTCP disconnects the call
because the measured packet loss within a specified timeframe exceeds a configured
threshold. This timeframe, the RTCP Sender Report interval, and the threshold value
are specified in the PSX Packet Service Profile.)
145 NO RTP OR RTCP PACKETS
[This Sonus code is mapped to Q.931 ID 31.]
(The GSX may release a call with this cause value if RTCP disconnects the call
because no RTP or RTCP packets were received within the specified timeframe. This
timeframe is two RTCP Sender Report intervals, as specified in the PSX Packet
Service Profile. This absence of packets for this timeframe is “loss of RTP bearer
channel”.)
146 HOP COUNTER EXHAUSTED
(The GSX may release a call with this cause value if the call was terminated because
the ISUP hop counter was exhausted; not applicable to ISDN, H323, or SIP calls.)
147 CONVERSION FAILURE
(The GSX may release a call with this cause value because the Gateway to Gateway
Signaling protocol could not convert an MCS message.)
148 CPC_DISC_CONGESTION_REROUTE_NOT_PERMITTED
(The GSX may release calls that utilize the BT-IUP service with this cause value.)
149 CPC_DISC_GSX_INCOMPATIBLE_DESTINATION
(The GSX may release a call with this cause code if the GSX version running on the
destination Gateway is not compatible with the GSX version running on the originating
Gateway.)
150 CPC_DISC_NO_PSX_ROUTES
(The GSX may release a call with this cause code if a policy response from the PSX
that should contain routes is received with no routes.)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting Record Field Descriptions Call Accounting
DEFINITION
ID (Added Explanation)
151 CPC_DISC_SETUP_REQ_TIMER_EXPIRY
(The GSX may release a call with this cause code if there is a timer expiry on a setup
request, for example no response by the peer to a SIP INVITE message on the egress
call leg. This reason code is in the default crankback profile, and will cause crankback
on the next route returned by PSX for the destination.)
152 CPC_DISC_GW_CONGESTED
(The remote GSX may release a gateway-to-gateway call with this cause code to
indicate that gateway is congested. The local GSX will then skip any additional routes
in the route list for that call that go to the congested gateway.)
153 CPC_DISC_GLARE_OCCURRED
(The GSX may release a call with this cause code when GLARE prevents a call from
setting up. Hence this cause code will populate the Call Disconnect Reason Field in an
ATTEMPT record.)
154 CPC_DISC_NO_TERM_CIT_RCVD
(The GSX may release a call with this cause code if the “Terminating carrier
information” or “Terminating CA” parameter in SIP message is not received before
Answer state. Based on IP signaling control flag "Disconnect If Neither Terminating CA
Nor CIC Received.")
155 CPC_DISC_BUSY_EVERYWHERE
(The GSX may release a High Probability of Completion (HPC) call with this cause
code to indicate that all routes have failed.)
156 CPC_DISC_REASON_UNKNOWN_RESOURCE_PRIORITY
(The GSX may release a High Probability of Completion (HPC) call with this cause
code when a bad resource priority header (RPH) is recieved in a SIP message.)
157 CPC_DISC_REASON_BAD_EXTENSION
(The GSX may release a call with this cause code when the required SIP Extension is
not supported.)
158 CPC_DISC_REASON_QUEUE_TIMEOUT
(The GSX may release a queued High Probability of Completion (HPC) call with this
cause code if a queue timeout has occurred.)
159 CPC_DISC_REASON_FORBIDDEN
(The GSX may release a call with this cause code if High Probability of Completion
HPC treatment cannot be applied.)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Accounting Accounting Record Field Descriptions
Mapped to
Class of Mapped Cause
From Cause Code Code Definition of Mapped to Cause Code
000 31 NORMAL_UNSPECIFIED
Normal
001 31 NORMAL_UNSPECIFIED
Normal
010 47 RESOURCE_UNAVAILABLE_UNSPECIFIED
Resource Unavailable
011 63 SERVICE_OR_OPTION_NOT_AVAILABLE_U
NSPECIFIED
Service or Option not Available
100 79 SERVICE_OR_OPTION_NOT_IMPLEMENTED
_UNSPECIFIED
Service or Option Not
Implemented
101 95 INVALID_MESSAGE_UNSPECIFIED
Invalid Message
110 111 PROTOCOL_ERROR_UNSPECIFIED
Protocol Error
111 127 INTERWORKING_UNSPECIFIED
Interworking
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting Record Field Descriptions Call Accounting
Table 7–9, "ISUP Call Disconnect Code Mapping" provides a “single source” reference that, for
each ISUP Disconnect Code received, shows the mapped Disconnect Code that will be stored in
the CDR that is generated by the ISUP, ISDN, H.323, and SIP services respectively. This table
also shows the standard(s) that define a particular ISUP Disconnect Code. The examples that
follow Table 7–9 further illustrate the use of this table.
Disconnect Code
Stored in CDR when
Code Received
Disconnect Initiated
Disconnect
GR-317
Q.931
Q.850
H.323
ISDN
ISUP
SIP
Enumeration
0 CPC_INVALID_DISC_REASON 31 16 127 500
1 CPC_DISC_UNALLOCATED_NUMBER 3 3 3 1 1 1 404
2 CPC_DISC_NO_ROUTE_TO_SPECIFIED_TRANSIT_NE 3 2 2 2 404
TWORK
3 CPC_DISC_NO_ROUTE_TO_DESTINATION 3 3 3 3 3 3 404
4 CPC_DISC_SEND_SPECIAL_INFO_TONE 3 4 4 4 500
5 CPC_DISC_MISDIALED_TRUNK_PREFIX 3 5 5 5 500
6 (a) CPC_DISC_CHANNEL_UNACCEPTABLE 3 3 31 31 6 500
7 (a) CPC_DISC_CALL_AWARDED 3 31 31 7 500
8 CPC_DISC_PREEMPTION 3 8 8 8 500
9 CPC_DISC_PREEMPTION_CIRCUIT_RESERVED 3 9 9 9 500
14 CPC_DISC_NUMBER_PORTED (b) 14 31 14 500
16 CPC_DISC_NORMAL_CALL_CLEARING 3 3 3 16 16 16 (c)
17 CPC_DISC_USER_BUSY 3 3 3 17 17 17 486
18 CPC_DISC_NO_USER_RESPONDING 3 3 18 18 18 408
19 CPC_DISC_NO_ANSWER_FROM_USER 3 3 19 19 19 480
20 CPC_DISC_SUBSCRIBER_ABSENT 3 20 20 20 480
21 CPC_DISC_CALL_REJECTED 3 3 3 21 21 21 (d)
22 CPC_DISC_NUMBER_CHANGED 3 3 3 22 22 22 (e)
23 (f) CPC_DISC_UNALLOCATED_DEST_NUMBER 3 3 23 31 23 410
24 (f) CPC_DISC_UNKNOWN_BUSINESS_GROUP * 31 31 24 500
25 CPC_DISC_EXCHANGE_ROUTING_ERROR 3 25 31 25 500
26 CPC_DISC_MISROUTED_CALL_TO_PORTED_NUMBE 3 26 26 26 404
R
27 CPC_DISC_DESTINATION_OUT_OF_ORDER 3 3 3 27 27 27 502
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Accounting Accounting Record Field Descriptions
Disconnect Code
Stored in CDR when
Code Received
Disconnect Initiated
Disconnect
GR-317
Q.931
Q.850
H.323
ISDN
ISUP
SIP
Enumeration
28 CPC_DISC_INVALID_NUMBER_FORMAT 3 3 3 28 28 28 484
29 CPC_DISC_FACILITY_REJECTED 3 29 29 29 501
30 (g) CPC_DISC_RESPONSE_TO_STATUS_ENQUIRY 3 31 31 30 500
31 CPC_DISC_NORMAL_UNSPECIFIED 3 3 3 31 31 31 480
34 CPC_DISC_NO_CIRCUIT_AVAILABLE 3 3 3 34 34 34 503
38 CPC_DISC_NETWORK_OUT_OF_ORDER 3 3 38 38 38 503
39 CPC_DISC_PERM_FM_CONNECTION_OOS 3 47 47 39 500
40 CPC_DISC_PERM_FM_CONNECTION_OPERATIONAL 3 47 47 40 500
41 CPC_DISC_TEMPORARY_FAILURE 3 3 3 41 41 41 503
42 CPC_DISC_SWITCHINGEQUIP_CONGESTION 3 3 3 42 47 42 503
43 CPC_DISC_ACCESS_INFORMATION_DISCARDED 3 43 43 43 500
44 CPC_DISC_REQUESTED_CIRCUIT_NOT_AVAILABLE 3 3 44 44 44 500
45 (f) CPC_DISC_ANSI_PREEMPTION 47 47 45 500
46 CPC_DISC_PRECEDENCE_CALL_BLOCKED 3 46 46 46 500
47 CPC_DISC_RESOURCE_UNAVAILABLE_UNSPECIFIED 3 3 3 47 47 47 503
49 CPC_DISC_QUALITY_OF_SERVICE_UNAVAIL 3 3 63 63 49 500
50 CPC_DISC_REQUESTED_FACILITY_NOT_SUBSCRIBE 3 50 50 50 500
D
51 (f) CPC_DISC_CALL_TYPE_INCOMPATIBLE_WITH_SERVI 63 63 51 500
CE
53 CPC_DISC_OUTGOING_CALL_BARRED_CUG 3 53 53 53 500
54 CPC_DISC_CALL_BLOCKED_GROUP_RESTRICTIONS 63 63 54 500
55 CPC_DISC_INCOMING_CALL_BARRED_CUG 3 55 55 55 403
57 CPC_DISC_BEARER_CAP_NOT_AUTHORIZED 3 3 57 57 57 403
58 CPC_DISC_BEARER_CAP_PRESENTLY_NOT_AVAILA 3 3 58 58 58 503
BLE
62 CPC_DISC_INCONSISTENT_OUTGOING_SUBSCRIBE 3 62 62 62 500
R_CLASS
63 CPC_DISC_SERVICE_OR_OPTION_NOT_AVAILABLE_ 3 3 63 63 63 500
UNSPECIFIED
65 CPC_DISC_BEARER_CAP_NOT_IMPLEMENTED 3 3 65 65 65 488
66 CPC_DISC_CHANNEL_TYPE_NOT_IMPLEMENTED 3 3 79 79 66 500
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting Record Field Descriptions Call Accounting
Disconnect Code
Stored in CDR when
Code Received
Disconnect Initiated
Disconnect
GR-317
Q.931
Q.850
H.323
ISDN
ISUP
SIP
Enumeration
69 CPC_DISC_REQUESTED_FACILITY_NOT_IMPLEMENT 3 69 69 69 500
ED
70 CPC_DISC_ONLY_RESTRICTED_DIGITAL_INFO_BEAR 3 70 70 70 488
ER_CAP_AVAIL
79 CPC_DISC_SERVICE_OR_OPTION_NOT_IMPLEMENT 3 3 79 79 501
ED_UNSPECIFIED
81 CPC_DISC_INVALID_CALL_REFERENCE 3 3 95 95 81 500
82 CPC_DISC_CHANNEL_DOES_NOT_EXIST 3 3 95 95 82 500
83 CPC_DISC_SUSPENDED_CALL_NO_INDENTITY 3 95 95 83 500
84 CPC_DISC_CALL_IDENTITY_IN_USE 3 95 95 84 500
85 CPC_DISC_NO_CALL_SUSPENDED 3 95 95 85 500
86 CPC_DISC_CALL_IDENTITY_CLEARED 3 95 95 86 500
87 CPC_DISC_NOT_MEMBER_OF_CUG 3 87 87 87 403
88 CPC_DISC_INCOMPATIBLE_DESTINATION 3 3 3 88 88 88 503
90 CPC_DISC_NON_EXISTENT_CUG 3 90 90 90 500
91 CPC_DISC_INVALID_TRANSIT_NETWORK_SELECTIO 3 3 91 91 91 500
N
95 CPC_DISC_INVALID_MESSAGE_UNSPECIFIED 3 3 3 95 95 95 500
96 CPC_DISC_MANDATORY_INFORMATION_ELEMENT_ 3 3 111 96 96 500
MISSING
97 CPC_DISC_MSG_TYPE_NON_EXISTENT_OR_NOT_IM 3 3 3 97 97 97 500
PLEMENTED
98 CPC_DISC_MSG_TYPE_NC_NE_OR_NI 3 3 111 111 98 500
99 CPC_DISC_IE_NOT_IMPLEMENTED 3 3 3 99 99 99 500
100 CPC_DISC_INVALID_INFORMATION_ELEMENT_CONT 3 3 111 100 100 500
ENT
101 CPC_DISC_MSG_NOT_COMPATIBLE_WITH_STATE 3 3 111 111 101 500
102 CPC_DISC_RECOVERY_ON_TIMER_EXPIRY 3 3 3 102 102 102 504
103 CPC_DISC_PARAMETER_NOT_IMPLEMENTED 3 3 103 103 103 500
110 CPC_DISC_UNRECOGNIZED_PARAMETER 3 110 110 110 500
111 CPC_DISC_PROTOCOL_ERROR_UNSPECIFIED 3 3 3 111 111 111 500
127 CPC_DISC_INTERWORKING_UNSPECIFIED 3 3 3 127 127 127 500
Sonus Extensions
128 CPC_DISC_RES_AL_FAIL 47 34 47 488
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Accounting Accounting Record Field Descriptions
Disconnect Code
Stored in CDR when
Code Received
Disconnect Initiated
Disconnect
GR-317
Q.931
Q.850
H.323
ISDN
ISUP
SIP
Enumeration
129 (h) CPC_DISC_CHAN_COLL_BACKOFF 31 16 47 500
130 CPC_DISC_INSUFF_DEST_RESOURCES 31 16 47 500
131 CPC_DISC_RESOURCE_FAILURE 41 47 47 500
132 CPC_DISC_MODULE_FAILURE 41 16 41 500
133 CPC_DISC_MGSG_EGRESS_DISC 31 16 31 500
134 CPC_DISC_CHAN_COT_FAIL_BACKOFF 31 16 47 500
135 CPC_DISC_COLL_REATTEMPT_EXHASTD 41 41 47 500
136 CPC_DISC_COT_REATTEMPT_EXHASTD 31 16 47 500
137 CPC_DISC_NO_ROUTE_BEARER_CAP 63 63 31 500
138 CPC_DISC_NO_ROUTE_SIGNALING 3 3 31 500
139 CPC_DISC_NO_ROUTE_DIRECTION 3 3 31 500
140 CPC_DISC_CEP_RES_AL_FAIL 34 16 47 500
141 CPC_DISC_WITH_NEW_DESTINATION 31 16 31 500
142 CPC_DISC_ACC_PROCEDURE 34 16 47 500
143 CPC_DISC_ACC_ALT_ROUTE 31 16 47 500
144 CPC_DISC_PACKET_LOSS_EXCEEDES_THRESHOLD 31 16 41 500
145 CPC_DISC_NO_RTP_OR_RTCP_PACKETS 31 16 41 500
146 CPC_DISC_HOP_COUNTER_EXHAUSTED 25 16 31 500
147 CPC_DISC_CONVERSION_FAILURE 31 16 127 500
148 CPC_DISC_CONGESTION_REROUTE_NOT_PERMITT 34 16 127 500
ED
149 CPC_DISC_GSX_INCOMPATIBLE_DESTINATION 3 3 3 404
150 CPC_DISC_NO_PSX_ROUTE 3 3 3 404
151 CPC_DISC_SETUP_REQ_TIMER_EXPIRY 102 102 504
152 CPC_DISC_GW_CONGESTED 42 42 503
153 CPC_DISC_GLARE_OCCURRED 16 127 500
154 CPC_DISC_NO_TERM_CIT_RCVD 16 127 500
155 CPC_DISC_BUSY_EVERYWHERE 16 127 600
156 CPC_DISC_REASON_UNKNOWN_RESOURCE_ 16 127 417
PRIORITY
157 CPC_DISC_REASON_BAD_EXTENSION 16 127 420
158 CPC_DISC_REASON_QUEUE_TIMEOUT 16 127 408
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting Record Field Descriptions Call Accounting
Disconnect Code
Stored in CDR when
Code Received
Disconnect Initiated
Disconnect
GR-317
Q.931
Q.850
H.323
ISDN
ISUP
SIP
Enumeration
159 CPC_DISC_REASON_FORBIDDEN 16 127 403
160 (Reserved for future use)
161 CPC_DISC_REASON_QUEUEING_IMPOSSIBLE 34 34 34 503
Notes:
(a) Disconnect code 6 and 7 are used by certain ISUP variants with the coding standard of CCITT
(b) Disconnect code 14 (DISCONNECT NUMBER PORTED) is a non-standard code for all Sonus service
groups. When this code is received by the GSX software, the Call Disconnect Reason field of the STOP or
ATTEMPT Call Data Record (CDR) is set to the received code of 14 by the ISUP and H.323 service
handlers. ISDN service groups set the field to 31 (NORMAL UNSPECIFIED). The SIP signaling service
does not recognize this code, and hence sets the field to 500 (SERVER INTERNAL ERROR).
(d) 403 if the cause location is “network”; 603 if the cause location is “user.
(e) Disconnect code 22 (NUMBER CHANGED) is a Q.850 standard code. When this code is received by the
GSX software, the Call Disconnect Reason field of the ATTEMPT CDR is set to the received code of 22
by ISUP, ISDN, and H.323 service handlers. The SIP signaling service looks for information in the
diagnostic field about a new number where the called party may be reachable. If this information is found,
it is added to the Contact header of the SIP response and the Call Disconnect Reason field is set to 301
(MOVED PERMANENTLY); if this information is not present, the field is set to 410 (GONE).
(f) Disconnect codes 23, 24, 45, and 51 are used by ANSI variants with the coding standard NATIONAL.
(g) Disconnect code 30 (RESPONSE TO STATUS ENQUIRY) is a Q.850 standard code. When this code is
received by the GSX software, the Call Disconnect Reason field of the STOP or ATTEMPT CDR is set to
the received code of 30 by ISUP and H.323 service handlers. ISDN service groups set the field to 31
(NORMAL UNSPECIFIED). The SIP signaling service does not recognize this code, and hence sets the
field to 500.
(h) Disconnect code 129 (CHANNEL COLLISION BACKOFF) is a Sonus defined code. When this code is
received by the GSX software, the Call Disconnect Reason field of a STOP or ATTEMPT CDR is set to
31 (NORMAL UNSPECIFIED) by ISUP service groups. ISDN service groups set the field to code 16
(NORMAL CALL CLEARING). H.323 signaling service sets the field to code 47 (RESOURCE
UNAVAILABLE UNSPECIFIED). The SIP signaling service does not recognize this code, and hence sets
the field to 500.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Accounting Accounting Record Field Descriptions
In each of the above cases, the disconnect code that is returned to the preceding switch depends on
the type of GSX service handler as well as the type of preceding switch. The code that is returned
when the called party initiates the disconnect is stored in the "Call Disconnect Reason Transmitted
to Ingress Field" on page 7–113. The code that is returned when the calling party initiates the
disconnect is stored in the “Call Disconnect Reason Transmitted to Egress Field” on page 7-113.
When SIP rejection responses must be signaled to the PSTN, the mappings shown below in "SIP to
ISUP Disconnect Code Mappings" on page 7–46 are recommended by RFC 3398 and
implemented by Sonus. If the SIP rejection message contains an encapsulated REL message, then
the Cause Indicator (CAI) parameter in the generated REL will be set to the value of the CAI
parameter received in the encapsulated REL.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting Record Field Descriptions Call Accounting
Whenever a Reason Header is encountered in any SIP message (such as BYE, CANCEL, 4xx, or
5xx), the GSX will use the Reason Header cause value for the Disconnect Code. If the Reason
Header is absent from the message, the ISUP Multipurpose Internet Mail Extension (Mime) cause
value, if available, is used for the Disconnect Code. Otherwise stated, the GSX precedence for
deriving the Disconnect Code in SIP/ISUP interworking is:
1. Reason Header
2. ISUP Mime (if cause value is available)
This conforms to RFC 3398 recommendations. You may configure the PSX IP PROFILE object to
reverse this mapping behavior, thus conforming to the Q.1912.5 recommendation.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Accounting Accounting Record Field Descriptions
Service Delivered - VoIP/Circuit Switched Voice (up to 22 characters). For PSTN-to-PSTN calls,
such as ISUP-to-ISUP, ISUP-to-ISDN, ISUP-to-CAS calls, this field would be “Circuit Switched
Voice.” For calls that involve packetized voice, such as GSX gateway-to-gateway signaling,
H.323, and SIP, this field would be “VoIP.”
When an ATTEMPT record is generated by a blocking script, this field is set to UNKNOWN.
(Since the call was not established, the Service Delivered is undefined or UNKNOWN.)
When an ATTEMPT record is generated after the GSX was able to route the call, but a subsequent
switch disconnected the call before the call was established, this field is populated with a valid
value.
When a START, STOP, or INTERMEDIATE record is generated by a successfully established
call, this field is populated with a valid value.
NOTE
The format of this field is an enumeration when stream-based CDR logging is used.
The first stage of a two stage call is either PSTN-TO-TERM or IP-TO-TERM. The second stage of
a two stage call is either TERM-TO-PSTN or TERM-TO-IP.
This field conveys the signaling scenario for the call, including whether ingress is a PSTN
signaling/IP signaling, and whether egress is PSTN signaling/IP signaling. For example, a call that
has ingress signaling as ISUP and egress signaling as ISUP, Call Direction = "PSTN-TO-PSTN".
For a call that has ingress signaling as H.323, and egress signaling as ISDN, Call Direction = "IP-
TO-PSTN". For a call that has ingress signaling as CAS, and egress signaling as GSX gateway-to-
gateway protocol, Call Direction = "PSTN-TO-IP". A call that has ingress signaling as H.323, and
egress signaling as GSX gateway-to-gateway protocol shows Call Direction = “IP-TO-IP”.
When an ATTEMPT record is generated by a blocking script, this field is set to UNKNOWN.
(Since the call was not established, the Call Direction is undefined or UNKNOWN.)
When an ATTEMPT record is generated after the GSX was able to route the call, but a subsequent
switch disconnected the call before the call was established, this field is populated with a valid
value.
NOTE
The format of this field is an enumeration when stream-based CDR logging is used.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting Record Field Descriptions Call Accounting
Service Provider (up to 23 characters). This field is populated with the route partition ID that the
PSX used for routing the call.
Transit Network Selection Code (string up to 4 characters, for example 0288). This is the ISUP
signaling parameter called Transit Network Selection. It is populated using either the information
received in the IAM (if ingress signaling was ISUP), or information returned by the PSX in a
policy response. The PSX obtains information from configuration tables. If the ingress signaling
group and the PSX did not provide a value for this field, this field would be empty.
Calling Number. This is the Calling Number Address Digits, which are sent out on the egress
signaling side. It is the end result of any digit manipulations and address translation that might
have been performed by the PSX during the policy request processing on the calling number that
was received from ingress signaling.
Called Number. This is the Called Number Address Digits, which are sent out on the egress
signaling side. It is the end result of any digit manipulations and address translation that might
have been performed by the PSX during the policy request processing on the called number that
was received from ingress signaling.
Extra Called Address Digits (string that is not used in routing the call, received via Overlap
Address Messages such as SAM). This field is significant when the ingress signaling protocol
supports overlap addressing (for example, SAM messages in ISUP, INFO messages in ISDN).
This field would contain any digits obtained by the GSX after it had successfully routed the call
based on the digits collected so far (before the overlap address signaling message was received).
For example, if the GSX receives "978-321" in the IAM, we route the call using these digits, and
subsequently, we receive a SAM message with 1234, the accounting records would contain:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Accounting Accounting Record Field Descriptions
The fields,
carry information about TollFree/LNP translation that was performed by the PSX.
For example the called number received by the GSX in the incoming IAM is 1-800-123-1234.
The PSX performs toll-free translation, and the result is 617-123-1234. Subsequently, it performs
LNP translation, and the result is 781-123-1000.
In this case:
Called Number = 781-123-1000
Number of Called Num Translations Done by This Node = 2
Called Number Before Translation #1 = 1-800-123-1234
Translation Type 1 = 2
Called Number Before Translation #2 = 617-123-1234
Translation Type 2 = 1
In another example, if the called number in the incoming IAM was 617-123-1234, and the PSX
performs an LNP translation, the result is 781-123-1000. Then the accounting records would
contain:
Note that although the Called Number Before Translation #1 Field is the called number before any
address translations were performed, it also represents the called number after any digit
manipulations performed by the PSX. To see the called number received from ingress signaling,
and hence the called number before any digit manipulation is performed by the PSX, see "Dialed
Number Field" on page 7–65.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting Record Field Descriptions Call Accounting
This field will be populated in an ATTEMPT record in the absence of a PSX query response if the
preceding switch has performed the translation and the call is torn down before the PSX response
is received. The presence of the M bit in the received ISUP Initial Address Message (IAM)
External Furnish Charging Info (FCI) message indicates that the preceding switch has performed
the translation.
Called Number before translation #1. This field carries information about TollFree/LNP
translation that was performed by the PSX.
This field will be empty (“”) if no translations were performed. This occurs when the Translation
Type 1 field (see “Translation Type 1 Field” on page 7-51) is 0 (CPC_ADDR_TRANS_NONE).
This field will also be empty (“”), if all of the following conditions are true:
• The dialed number is ported, that is an LNP query was performed.
• The SCP response to the LNP query did not return an LRN, that is a translated number.
• The Translation Type 1 field is 1 (CPC_ADDR_TRANS_LNP), that is the LNP was the first
translation attempted by the PSX.
• The GSX configuration “ACCOUNTING POPULATE NON-PORTED LNP NUMBERS” is set to
false.
This field will be populated in an ATTEMPT record in the absence of a PSX query response if the
preceding switch has performed the translation and the call is torn down before the PSX response
is received. The presence of the M bit in the received ISUP Initial Address Message (IAM)
External Furnish Charging Info (FCI) message indicates that the preceding switch has performed
the translation.
Translation Type 1. This field carries information about the translation that was performed by the
PSX:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Accounting Accounting Record Field Descriptions
Called Number before translation #2. This field carries information about TollFree/LNP
translation that was performed by the PSX.
This field will be empty (“”) if less than two translations were performed. This occurs when the
Translation Type 2 field (see “Translation Type 2 Field” on page 7-52) is 0
(CPC_ADDR_TRANS_NONE).
This field will also be empty (“”), if all of the following conditions are true:
Translation Type 2. This field carries information about the translation that was performed by the
PSX:
• 0 - CPC_ADDR_TRANS_NONE (No Translation Performed)
• 1 - CPC_ADDR_TRANS_LNP (Local Number Portability)
• 2 - CPC_ADDR_TRANS_TOLLFREE (8xx Numbers)
• 3 - CPC_ADDR_TRANS_PRIVATE
This field is a string of up to 30 characters. The record is populated using the following
precedence:
See the relevant table in “Nature of Address Enumeration Values” on page 7-166.
This record is a string of up to 23 characters. The content of this record depends upon the type of
call route that is returned from the PSX:
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting Record Field Descriptions Call Accounting
• If a normal route is returned, this field contains the ROUTING_LABEL pointed to by the
route record. The Overflow and Fallback labels are not present.
• If an SCP produced route made up of Gateway Name and Trunkgroup ID (as provisioned on
the PSX) is returned, this field will be empty (“”).
• If an SCP produced route made up of Switch ID and Trunkgroup ID (as provisioned on the
PSX) is returned, this field will contain the route label corresponding to the first Switch ID/
Trunkgroup.
Route Selected - Gateway Name (up to 27 characters):TG Name (up to 23 characters). If Gateway
Name is unknown, Gateway IP Address will be displayed, in dotted decimal format.
For packet based egress trunk groups, the IP address used for egress signaling on the local GSX, in
dotted decimal format, for example 128.1.22.233 (up to 15 characters). (The local GSX would
generate this accounting record; the device at the far end of the packet network is the remote
address.)
If the egress trunk group is circuit based, this field is empty (“”).
NOTE
When stream-based CDR logging is used, this field is in the form of an unsigned
integer.
For packet based egress trunk groups, the IP address used for egress signaling on the far end of the
packet network, in dotted decimal format, for example 128.1.22.233 (up to 15 characters). (The
local GSX would generate this accounting record; the device at the far end of the packet network is
the remote address.) The device at this address may be another GSX gateway, and H.323 device,
or a SIP device.
If the egress trunk group is circuit based, this field is empty (“”).
NOTE
When stream-based CDR logging is used, this field is in the form of an unsigned
integer.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Accounting Accounting Record Field Descriptions
Ingress Trunk Name (Applicable for PSTN-IP, PSTN-PSTN, IP-PSTN, and IP-IP Calls) (up to 23
characters).
The origination gateway will log the name of the external trunk group which exists between the
ingress network and the origination gateway in this field. The destination gateway will log the
name of the internal IP trunk group which exists between the origination gateway and destination
gateway in this field.
Figure 7–2 illustrates a typical call that originates on GSX1 and terminates on GSX2. The ingress
leg of the call is PSTN-TG1. The egress leg of the call is PSTN-TG2. Table 7–11 shows the
contents of the Ingress Trunk Group Name, Egress Trunk Group Name, and Route Selected fields
on GSX1 and GSX2, for CDRs that are generated by this call.
PSTN-TG2
PSTN-TG1 IP-TG1 IP-TG2
GSX1 GSX2
Egress Trunk Group Name. Applicable for IP-PSTN, PSTN-PSTN, PSTN-IP, and IP-IP calls.
(String up to 23 characters.)
The origination gateway will log the name of the internal IP trunk group which exists between the
destination gateway and the origination gateway in this field. The destination gateway will log the
name of the external trunk group which exists between the destination gateway and the egress
network in this field.
Figure 7–2, above, illustrates a typical call that originates on GSX1 and terminates on GSX2. The
ingress leg of the call is PSTN-TG1. The egress leg of the call is PSTN-TG2. The table above that
figure shows the contents of the Ingress Trunk Group Name, Egress Trunk Group Name, and
Route Selected fields on GSX1 and GSX2, for CDRs that are generated by this call.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting Record Field Descriptions Call Accounting
Ingress PSTN Circuit End Point - Shelf (1-6):Slot (1-16):Port (1-84):DS0 (1-32):CIC (1-
65535):Local Point Code (32 bit HEX format): Remote Point Code (32 bit HEX format)
(Applicable only for PSTN-IP and PSTN-PSTN Calls).
The Port range of 1-84 applies to calls that are assigned to a CNS60 or CNS71 module. 1-28 are
the T1 circuits on the first T3, 29-56 are the T1 circuits on the second T3, and 57-84 are the T1
circuits on the third T3.
Ingress IP Circuit End Point - Local IP Address: Port (0-65535)/Remote IP Address: Port (0-
65535) (Applicable only for IP-PSTN Calls) (IP address in dotted decimal format, for example
128.1.22.233 (up to 15 characters)).
Egress PSTN Circuit End Point - Shelf (1-6):Slot (1-16):Port (1-84):DS0 (1-32):CIC (1-
65535):Local Point Code (32 bit HEX format): Remote Point Code (32 bit HEX format)
(Applicable only for IP-PSTN and PSTN-PSTN Calls).
The Port range of 1-84 applies to calls that are assigned to a CNS60 or CNS71 module. 1-28 are
the T1 circuits on the first T3, 29-56 are the T1 circuits on the second T3, and 57-84 are the T1
circuits on the third T3.
Egress IP Circuit End Point - Local IP Address: Port (0-65535)/Remote IP Address: Port (0-
65535) (Applicable only for PSTN-IP Calls) (IP address in dotted decimal format, for example
128.1.22.233 (up to 15 characters)).
NOTE
The Remote IP Address and Port number may not be available in certain call
attempt situations that are captured in ATTEMPT records. Examples include when
the remote gateway has no available routes, or when address information is not
contained in a backwards release message. In these situations the IP Address and
Port will be displayed as "0.0.0.0:0". The remote data will always be available for
completed calls (that is, START, INTERMEDIATE and STOP records).
Number of Audio Bytes Sent as recorded by the ingress DSP (decimal representation of a 64 bit
number, that is 1 - 1.844674407*1019).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Accounting Accounting Record Field Descriptions
Number of Audio Bytes Sent as recorded by the egress DSP (decimal representation of a 64 bit
number, that is 1 - 1.844674407*1019).
Number of Audio Packets Sent as recorded by the ingress DSP (decimal representation of a 64 bit
number, that is 1 - 1.844674407*1019).
Number of Audio Packets Sent as recorded by the egress DSP (decimal representation of a 64 bit
number, that is 1 - 1.844674407*1019).
Number of Audio Bytes Received as recorded by the ingress DSP (decimal representation of a 64
bit number, that is 1 - 1.844674407*1019).
Number of Audio Bytes Received as recorded by the egress DSP (decimal representation of a 64
bit number, that is 1 - 1.844674407*1019).
Number of Audio Packets Received as recorded by the ingress DSP (decimal representation of a
64 bit number, that is 1 - 1.844674407*1019).
Number of Audio Packets Received as recorded by the egress DSP (decimal representation of a 64
bit number, that is 1 - 1.844674407*1019).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting Record Field Descriptions Call Accounting
Originating Line Information (OLIP), also known as info digits. A decimal value.
Names Value
OLI_POTS 0
OLI_ONI 1
OLI_ANI_FAILURE 2
OLI_HOTEL 6
OLI_SPECIAL_OPERATOR 7
OLI_RSTRCTD 8
OLI_TEST1 10
OLI_AIOD 20
OLI_IDENTIFIED 23
OLI_TOLLFREE (Non Pay phone originated 800 call) 24
If the “Reset OLIP” switch is set in the PSX Signaling Profile and a tollfree
translation occurs, then this code may be placed into this field.
OLI_PAYPHONE_TOLLFREE 25
(Pay phone originated 800 call). If the “Reset OLIP” switch is set in the PSX
Signaling Profile and a tollfree translation occurs, then this code may be placed
into this field.
OLI_COIN 27
OLI_INMATE 29
OLI_TELCO_OPERATOR 34
OLI_OUTWATS 52
OLI_TRS 60
OLI_CELLULAR_TYPE1 61
OLI_CELLULAR_TYPE2 62
OLI_CELLULAR_ROAMING 63
OLI_PRIVATE_PAYSTATION 70
OLI_RSTRCTD_COINLESS 78
OLI_PRIVATE_VIRTUAL_NW 93
OLI_PINK_PUBLIC_PHONE (Japan only) 94
OLI_PINK_OTHER_PHONE (Japan only) 95
Reserved 96-255
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Accounting Accounting Record Field Descriptions
Carrier Code (up to 5 characters). This is the carrier identification code (for example 0288) of the
carrier used for carrying the call on the egress trunk. This is provided by the ingress signaling
group from the appropriate parameters in its signaling protocol. For example, ISUP obtains it from
the Carrier Identification Code parameter in an IAM message, or it may be provided by the PSX in
a policy response. If the ingress signaling group and the PSX do not provide a value for this field,
this field will be empty.
Call Group ID (up to 32 bits of hexadecimal data). This is an internal identifier bound to each call
used by the GSX to group calls that are associated to each other. Multiple calls (with different
Global Call IDs) involved in transfer and redirection scenarios will have the same Call Group ID.
Example:
“0x0000002F”
Script Log Data (A string that contains data logged by a Sonus CPL script that was executed for
the call).
Multiple variables may be logged within this field, with each variable data separated from the next
variable by a configurable separator. The default value for the separator is slash (/). The data for
each script variable includes the variable ID and the variable value, with a “:” as the separator. For
example, the data string:
12:9786928999/108:12345
indicates data for two variables, variable ID - 12, and variable ID - 108. The value of variable 12 is
9786928999, and the value of variable 108 is 12345.
This field is applicable only if a Sonus CPL script was executed for the call. The sub-fields within
this field are all variables associated with the CPL script, and are a concatenation of the variables
requested by the script to be logged. This field is populated only if a CPL script was executed for
the call, and the script requested logging of script variables via the LOG SIBB in the script.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting Record Field Descriptions Call Accounting
Time Elapsed from Receipt of Setup Message to Receipt of Exit Message (EXM) in 10 ms Ticks
(Decimal number 0 - 4294967295).
Time Elapsed from Receipt of Setup Message to Generation of Exit Message (EXM) in 10 ms
Ticks (Decimal number 0 - 4294967295).
See the relevant table in "Nature of Address Enumeration Values" on page 7–166.
Ingress service group Protocol Variant Specific Data. String with delimiters “”. Whenever any
ingress service group has Protocol Variant Specific Data to log, this data is logged to this field.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Accounting Accounting Record Field Descriptions
NOTE
During a Live Software Update (LSWU), ingress and egress Protocol Variant
Specific Data may be logged interchangeably to either this field or to the Egress
Protocol Variant Specific Data field. This indeterminate behavior will persist until
after the LSWU is complete, as indicated by the SW_CHANGE record.
Carrier Code of the Carrier That Owns the Far End of the Ingress Trunk
Group Field
This field content depends upon whether or not the PSX is supporting a JAPAN variant.
If the JAPAN variant is being supported, then this field is the “Own Carrier ID” that is provisioned
against the ingress trunk group. This is a string of up to 5 characters such as “0288”.
If a Non-JAPAN variant is being supported, then this field is the Carrier Code of the carrier that
owns the Far End of the ingress trunk group. This is a string of up to 5 characters.
Figure 7–3, Trunk Ownership Fields in START/STOP Records on page 7–61 illustrates a typical
PSTN-to-PSTN network in which the local GSX is writing accounting records to its NFS (DSI
Level 0) file system. This figure depicts the Carrier Identification Codes that are contained in the
Carrier Code of the Carrier that Owns the Far End of the Ingress/Egress Trunk Group fields.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting Record Field Descriptions Call Accounting
NOTE
This depiction applies to all PSTN-to-PSTN networks except Japan.
End Office PSTN Switch Local GSX (writing CDRs) IP Cloud Far End GSX End Office PSTN Switch
Local GSX (writing CDRs)
Egress Trunk
Ingress Trunk
Carrier Code of the Carrier That Owns the Far End of the Egress Trunk
Group Field
This field content depends upon whether or not the PSX is supporting a JAPAN variant.
This field is a string of up to 5 characters. The field is populated using the following precedence:
1. If a Non-JAPAN PSX variant is being supported, and the SCP returns digits within the
AMADigitsDialedWC, and if the Context Identifier Digits within the AMADigitsDialedWC
are “003”, then these (SCP returned) digits are placed in the record.
2. If a Non-JAPAN PSX variant is being supported and the above conditions are not true, then
the Carrier Code of the Carrier that owns the Far End of the egress trunk group is placed in the
record. See Figure 7–3, “Trunk Ownership Fields in START/STOP Records” for more
explanation about this Carrier Code.
3. If a JAPAN PSX variant is being supported, then the “Own Carrier ID” that is provisioned
against the egress trunk group is placed in this record.
In all cases, a string of up to 5 characters is placed in this record (for example “0288”).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Accounting Accounting Record Field Descriptions
Calling Party Category. Hex Value between 0x00 and 0xff. All letters are lower case and leading
zeros are always displayed. The length is always 4 characters, two for the “0x” and two more for
the CPC value.
CDR ISUP
Value Variant Calling Party Description
0x00 All CPC_CALLING_PARTY_CATEGORY_UNKNOWN
0x01 All CPC_CALLING_PARTY_CATEGORY_FRENCH_LANG_OPERATOR
0x02 All CPC_CALLING_PARTY_CATEGORY_ENGLISH_LANG_OPERATOR
0x03 All CPC_CALLING_PARTY_CATEGORY_GERMAN_LANG_OPERATOR
0x04 All CPC_CALLING_PARTY_CATEGORY_RUSSIAN_LANG_OPERATOR
0x05 All CPC_CALLING_PARTY_CATEGORY_SPANISH_LANG_OPERATOR
0x06 All CPC_CALLING_PARTY_CATEGORY_OPERATOR_AVAILABLE1
0x07 All CPC_CALLING_PARTY_CATEGORY_OPERATOR_AVAILABLE2
0x08 All CPC_CALLING_PARTY_CATEGORY_OPERATOR_AVAILABLE3
0x09 Italy CPC_CALLING_PARTY_CATEGORY_NATIONAL_NETWORK_OPER
ATOR_SERVICE
0x0a All CPC_CALLING_PARTY_CATEGORY_ORD_SUBSCRIBER
0x0b All CPC_CALLING_PARTY_CATEGORY_SUBSCRIBER_WITH_PRIORI
TY
0x0c All CPC_CALLING_PARTY_CATEGORY_DATA_CALL_VOICE_BAND_D
ATA
0x0d All CPC_CALLING_PARTY_CATEGORY_TEST_CALL
0x0e All CPC_CALLING_PARTY_CATEGORY_SPARE
0x0f All CPC_CALLING_PARTY_CATEGORY_PAY_PHONE
0x10 All CPC_CALLING_PARTY_CATEGORY_CCITT_SPARE1
0x11 Singapore CPC_CALLING_PARTY_CATEGORY_INTERCEPT _OPERATOR
0x12 Singapore CPC_CALLING_PARTY_CATEGORY_PRIVATE_METERING
0x13 Singapore CPC_CALLING_PARTY_CATEGORY_PBX
0x14 Singapore CPC_CALLING_PARTY_CATEGORY_PBX_WITH_PRIORITY
0x15 Singapore CPC_CALLING_PARTY_CATEGORY_CITY_WIDE_CENTREX_SUB
0x16 Singapore CPC_CALLING_PARTY_CATEGORY_BASIC_BUSINESS_GROUP_S
UB
0x17 Singapore CPC_CALLING_PARTY_CATEGORY_PABX_WITH_PRIVATE_METE
RING
0x18 Singapore CPC_CALLING_PARTY_CATEGORY_HOTEL_SUBSCRIBER
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting Record Field Descriptions Call Accounting
CDR ISUP
Value Variant Calling Party Description
0x19 Singapore CPC_CALLING_PARTY_CATEGORY_HOTEL_SUB_WITH_PRI_MET
ERING
0x1a Denmark CPC_CALLING_PARTY_CATEGORY_DENMARKIC_249
0x1b Denmark CPC_CALLING_PARTY_CATEGORY_DENMARKIC_254
0x1c All CPC_CALLING_PARTY_CATEGORY_IUP_ORD_SUB_RESIDENTIA
L
0x1d All CPC_CALLING_PARTY_CATEGORY_IUP_ORD_SUB_BUSINESS
0x1e All CPC_CALLING_PARTY_CATEGORY_IUP_ADMIN_DIV_ORD
0x1f All CPC_CALLING_PARTY_CATEGORY_IUP_ADMIN_DIV_PAYPHONE
0x20 All CPC_CALLING_PARTY_CATEGORY_IUP_ISDN_RESIDENTIAL
0x21 All CPC_CALLING_PARTY_CATEGORY_IUP_ISDN_BUSINESS
0x22 All CPC_CALLING_PARTY_CATEGORY_IUP_PAYPHONE_PUBLIC
0x23 All CPC_CALLING_PARTY_CATEGORY_IUP_PAYPHONE_RENT_RESI
DENTIAL
0x24 All CPC_CALLING_PARTY_CATEGORY_IUP_PAYPHONE_RENT_BUSI
NESS
0x25 All CPC_CALLING_PARTY_CATEGORY_IUP_SERVICE_LINE
0x26 All CPC_CALLING_PARTY_CATEGORY_IUP_CENTREX
0x27 All CPC_CALLING_PARTY_CATEGORY_IUP_OSS_OPERATOR
0x28 All CPC_CALLING_PARTY_CATEGORY_IUP_AMC_OP_NND_IND
0x29 All CPC_CALLING_PARTY_CATEGORY_IUP_AMC_OP_NND
0x2a All CPC_CALLING_PARTY_CATEGORY_IUP_DPNSS
0x2b All CPC_CALLING_PARTY_CATEGORY_IUP_RSVD_ITU_LANG1
0x2c All CPC_CALLING_PARTY_CATEGORY_IUP_RSVD_ITU_LANG2
0x2d All CPC_CALLING_PARTY_CATEGORY_IUP_RSVD_ITU_LANG3
0x2e All CPC_CALLING_PARTY_CATEGORY_SPECIAL_LINE_2
0x2f All CPC_CALLING_PARTY_CATEGORY_SLOW_ORDINARY
0x30 All CPC_CALLING_PARTY_CATEGORY_TELETASA
0x31 All CPC_CALLING_PARTY_CATEGORY_MOBILE
0x32 All CPC_CALLING_PARTY_CATEGORY_VIRTUAL_PRIVATE_NETWOR
K
0x33 All CPC_CALLING_PARTY_CATEGORY_SPECIAL_LINE_1
0x34 All CPC_CALLING_PARTY_CATEGORY_NATIONAL_OP_INT_CAP
0x35 All CPC_CALLING_PARTY_CATEGORY_IMMEDIATE_CHG_RATE_SE
RV
0x36 China CPC_CALLING_PARTY_CATEGORY_ORD_FREE_LS_LS
0x37 China CPC_CALLING_PARTY_CATEGORY_ORD_PERIODIC_LS_LS
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Accounting Accounting Record Field Descriptions
CDR ISUP
Value Variant Calling Party Description
0x38 China CPC_CALLING_PARTY_CATEGORY_ORD_METERING_LS_LS
0x39 China CPC_CALLING_PARTY_CATEGORY_ORD_PRINTER_LS_LS
0x3a China CPC_CALLING_PARTY_CATEGORY_PRIORITY_FREE_LS_TS
0x3b China CPC_CALLING_PARTY_CATEGORY_PRIORITY_PERIODIC_LS_TS
0x3c China CPC_CALLING_PARTY_CATEGORY_ORD_SUB_LS_LS
0x3d China CPC_CALLING_PARTY_CATEGORY_MESSAGE_IN_MAILBOX
0x3e China CPC_CALLING_PARTY_CATEGORY_CANCEL_MESSAGE
0x3f India CPC_CALLING_PARTY_CATEGORY_OP_WITH_TRUNK_OFFER
0x40 India CPC_CALLING_PARTY_CATEGORY_OP_WITHOUT_TRUNK_OFFE
R
0x41 India CPC_CALLING_PARTY_CATEGORY_CCB_SUBSCRIBER
0x42 India CPC_CALLING_PARTY_CATEGORY_SUB_WITH_HOME_METER
0x43 India CPC_CALLING_PARTY_CATEGORY_LINE_TEST_DESK
0x44 Argentina CPC_CALLING_PARTY_CATEGORY_NON_INT_NATIONAL_OP
0x45 Argentina CPC_CALLING_PARTY_CATEGORY_PREPAID_PHONE
0x46 Argentina CPC_CALLING_PARTY_CATEGORY_PHONE_BOX
0x47 Argentina CPC_CALLING_PARTY_CATEGORY_SEMI_PUBLIC_PHONES
0x48 Brazil CPC_CALLING_PARTY_CATEGORY_SUBSCRIBER_SPECIAL_CRG
0x49 Brazil CPC_CALLING_PARTY_CATEGORY_NATIONAL_PUBLIC_TELEPH
ONE
0x4a Singapore CPC_CALLING_PARTY_CATEGORY_COIN_PHONE
0x4b All CPC_CALLING_PARTY_CATEGORY_CATEGORY_UNRECOGNIZE
D
0x4c ATT CPC_CALLING_PARTY_CATEGORY_ACI_TELECONFERENCE
ANSI
0x4d ATT CPC_CALLING_PARTY_CATEGORY_TELECONFERENCE
ANSI
0xdf All CPC_CALLING_PARTY_CATEGORY_CCITT_SPARE2
0xe0 All CPC_CALLING_PARTY_CATEGORY_EMERG_SERV_CALL_IN_PR
OG
0xe1 All CPC_CALLING_PARTY_CATEGORY_HIGH_PRIORITY_CALL_INDIC
ATION
0xe2 All CPC_CALLING_PARTY_CATEGORY_NSEP_CALL
0xe3 All CPC_CALLING_PARTY_CATEGORY_ANSI_SPARE1
0xef All CPC_CALLING_PARTY_CATEGORY_ANSI_SPARE2
0xf0 All CPC_CALLING_PARTY_CATEGORY_NETWORK_SPECIFIC1
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting Record Field Descriptions Call Accounting
CDR ISUP
Value Variant Calling Party Description
0xfa All CPC_CALLING_PARTY_CATEGORY_ADMIN_DIV_PAYPHONE_PRI
ORITY
0xfb All CPC_CALLING_PARTY_CATEGORY_ADMIN_DIV_ORD_PRIORITY
0xfe All CPC_CALLING_PARTY_CATEGORY_NETWORK_SPECIFIC2
Dialed Number. On the ingress GSX this is the actual dialed number that was contained in the
incoming setup message (IAM). These are the called number digits received by the GSX from the
ingress signaling group, before any digit manipulation or address translations are performed by the
PSX.
On the egress GSX, this is the called number from the Gateway-to-Gateway signaling message. In
this case, this number will contain digit manipulations performed by the ingress PSX.
Carrier Selection Information (decimal value). This is the ISUP Carrier Selection Information
parameter, which may be populated either by the ingress ISUP SG or by the PSX in a policy
response. If neither the ingress ISUP SG or PSX supplies this field, it takes a value of 0.
Table 7–14 lists the valid decimal values.
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Accounting Accounting Record Field Descriptions
Called Number Numbering Plan (decimal value). It indicates the numbering plan type used for the
called number representation. It could be one of ISDN/DATA/TELEX/PRIVATE. The numbering
plan for the called number is provided by the ingress signaling group (based on parameters
obtained in its signaling messages, or using defaults appropriate to the protocol type), or provided
by the PSX in the PSX in the policy response (if it provides a called number in the policy
response).
The Numbering Plan Indicator (NPI) range includes ISUP Reserve/Spare values. The block of
ISUP NPI enumerations (0 to 7) is appended to the existing Sonus enumerations of 0-7. The
combined NPI valid decimal value range is shown in Table 7–15.
NPI values in the record which are less than 8 should be interpreted as Sonus NPIs. Values greater
than 7 are ISUP (Spare/Reserve) NPIs, to be derived by subtracting 8 from the record value. For
example, a record value of 10 is an ISUP 2 NPI (10-8).
ISUP NPIs which map to a Sonus NPI are generated without any offset.
Generic Address Parameter. The original called number if LNP was performed by a switch
preceding the GSX. This field is applicable only if the ingress signaling group is ISUP, and if the
IAM indicates that LNP translation was performed by a switch preceding the GSX. In that case,
this field contains the contents of the ISUP Generic Address Parameter – GAP Digits (which
contains the called number before the LNP translation was done by the prior switch, as per ISUP
protocol).
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Accounting Record Field Descriptions Call Accounting
Disconnect Initiator. This field indicates the initiator of the call release as follows:
• 0 - INTERNAL
Released internally by the call control entity in the GSX, due either to some error in the
processing of the call or to a release initiated by a party on the peer call in a multiparty feature
such as ISDN Two B-Channel Transfer or SS7 Release Link Trunking.
• 1 - CALLING PARTY
Released by the ingress signaling group.
• 2 - CALLED PARTY
Released by the egress signaling group.
• 3 - INTERNAL EARLY
Released internally by GSX at early call attempt stage. Applies only to the ATTEMPT record.
• 4 - CALLING PARTY EARLY
Released by the calling party at an early call attempt stage. Applies only to the ATTEMPT
record.
(Decimal number in the range 0-4.)
EARLY disconnects occur before a PSX Policy Request is sent or a PSX Policy Response is
received. Some possible causes of early disconnect are incomplete setup message or a setup
message immediately followed by a disconnect from the calling party.
Number of packets recorded as a lost packet, as recorded by the ingress DSP. A decimal
representation of a 32 bit number. (Applicable to RTCP statistics for VoIP calls only.)
Number of packets recorded as a lost packet, as recorded by the egress DSP. A decimal
representation of a 32 bit number. (Applicable to RTCP statistics for VoIP calls only.)
Maximum interarrival Packet Jitter time in milliseconds, as recorded by the ingress DSP. A
decimal representation of a 16 bit number, hence must be in the range 0-65535. (Applicable to
RTCP statistics for VoIP calls only.)
© 2007 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
GSX9000/4000 Open Services Switch Operations Guide
Call Accounting Accounting Record Field Descriptions
Maximum interarrival Packet Jitter time in milliseconds, as recorded by the egress DSP. A decimal
representation of a 16 bit number, hence must be in the range 0-65535. (Applicable to RTCP
statistics for VoIP calls only.)
The last measurement for latency in milliseconds, as recorded by the ingress DSP. A decimal
representation of a 16 bit number, hence must be in the range 0-65535. (Applicable to RTCP
statistics for VoIP calls only.)
The last measurement for latency in milliseconds, as recorded by the egress DSP. A decimal
representation of a 16 bit number, hence must be in the range 0-65535. (Applicable to RTCP
statistics for VoIP calls only.)
Egress service group Protocol Variant Specific Data. String with delimiters “”. Whenever any
egress service group has Protocol Variant Specific Data to log, this data is logged to this field