550-00224 GSX 4.1 Operations Guide 2

SONUS TECHNICAL PUBLISHING
GSX9000
Open Services Switch
Operations Guide
Sonus Part Number: Document Version: Software Version:
550-00224 2 V04.01
Copyright
Copyright 1999 - 2003 Sonus Networks, Inc. All rights reserved. Printed in the U.S.A. This publication may be used, copied, or distributed only in accordance with the terms of the license agreement. Any other use, reproduction or distribution may occur only upon Sonus prior written consent.
Disclaimer and Restrictions

The material in this publication is for information only and is subject to change without notice. This material does not constitute a commitment on the part of Sonus Networks, Inc. This material is provided AS IS, with all faults, and without any warranties whatsoever, express or implied, including, but not limited, warranties of merchantability, performance, or fitness for a particular purpose. While reasonable efforts have been made in the preparation of this publication to assure its accuracy, Sonus Networks, Inc. assumes no liability resulting from technical or editorial errors or omissions, or for any damages whatsoever (including, but not limited to, incidental, special or consequential damages) resulting from the furnishing, performance, or use of the information contained herein. Sonus Networks, Inc. reserves the right to revise this publication, and to make changes on the content hereof without notice. The information in this document may be used by customers solely for the use and understanding of Sonus Networks products and solutions. This document is not meant to define an interface between Sonus products and any third party hardware or software. Sonus reserves the right to change the design and implementation used for any of the tables, screens, field names, etc. to enhance its products as it sees fit.
Trademarks
Sonus, Open Services Architecture, Insignus, Sonus Insight, and GSX9000 are trademarks of Sonus Networks, Inc. Open Services Partner Alliance and SonusCARE are service marks of Sonus Networks. The Telecom Corridor is a registered trademark of the Richardson Chamber of Commerce. All other trademarks, service marks, registered trademarks, or registered service marks may be the property of their respective owners. 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.
FCC Compliance
This equipment has been tested and found to comply with the limits for a Class A digital device, pursuant to Part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference when the equipment is operated in a commercial environment. This equipment generates, uses, and can radiate radio frequency energy and, if not installed and used in accordance with the instruction manual, may cause harmful interference to radio communications. Operation of this equipment in a residential area is likely to cause harmful interference in which case the user will be required to correct the interference at the users own expense.
GR-1089-CORE
The GSX9000 Open Services Switch is suitable for connection to intrabuilding or nonexposed wiring or cabling only.
TCL
The TCL software is copyrighted by the Regents of the University of California, Sun Microsystems, Inc., and other parties. The following terms apply to all files associated with the software unless explicitly disclaimed in individual files. The authors hereby grant permission to use, copy, modify, distribute, and license this software and its documentation for any purpose, provided that existing copyright notices are retained in all copies and that this notice is included verbatim in any distributions. No written agreement, license, or royalty fee is required for any of the authorized uses. Modifications to this software may be copyrighted by their authors and need not follow the licensing terms described here, provided that the new terms are clearly indicated on the first page of each file where they apply. IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION, OR ANY DERIVATIVES THEREOF, EVEN IF THE AUTHORS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. GOVERNMENT USE: If you are acquiring this software on behalf of the U.S. government, the Government shall have only "Restricted Rights" in the software and related documentation as defined in the Federal Acquisition Regulations (FARs) in Clause 52.227.19 (c) (2). If you are acquiring the software on behalf of the Department of Defense, the software shall be classified as "Commercial Computer Software" and the Government shall have only "Restricted Rights" as defined in Clause 252.227-7013 (c) (1) of DFARs. Notwithstanding the foregoing, the authors grant the U.S. Government and others acting in its behalf permission to use and distribute the software in accordance with the terms specified in this license.
TABLE OF CONTENTS
TABLE OF CONTENTS
Chapter 1 Introduction
About This Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2 Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2 Text Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2 Network Components and Topology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3 Overall Network Topology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3 GSX9000 Open Services Switch Management Network Topology . . . . . . . . . . . . . 1-4 Network Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5 GSX9000 Open Services Switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5 Insignus Softswitch PSX Policy Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5 Insignus Softswitch SGX SS7 Gateway. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5 MGCP Soft Switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5 Sonus Insight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5 NFS and NTP Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6 DataStream Integrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6 Installation Sequence. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6 Using Insignus Softswitch Control Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7 Using an MGCP Soft Switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8 Related Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
Chapter 2 Using the CLI to Configure Objects

Management Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1 MIBs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2 Behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2 Administrative Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2 Operational Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2 Parameter Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2 Parameter File Loading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2 Accessing the CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3 Basic CLI Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3 Configuration Profiles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4 Supported Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4 Creating and Saving Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
GSX9000 Open Services Switch Operations Guide - 550-00224 - 2
2002 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
TABLE OF CONTENTS
Configuring the GSX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6 Required Configuration Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7 Common Configuration Steps in Both Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7 Step 1: Configure Node Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7 Step 2: Configure Network Interface (NIF) Objects . . . . . . . . . . . . . . . . . . . . . . 2-8 Step 3: Configure the T3 Circuits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9 Step 4: Configure the T1 Spans. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10 Where to Go for Step 5: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10 Completing Your Configuration Using the PSX . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11 Step 5: Configure the SS7 Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11 Step 6: Configure the Gateway Signaling Ports. . . . . . . . . . . . . . . . . . . . . . . . 2-12 Step 7: Configure the PSX Policy Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12 Step 8: Configure the PSTN Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13 Configuration Using the MGCP Soft Switch Model . . . . . . . . . . . . . . . . . . . . . . . . 2-16 Step 5: Configure the Session, Call Agent, and Connection . . . . . . . . . . . . . . 2-17 Step 6: Configure the Media Gateway Service and Circuits . . . . . . . . . . . . . . 2-19
Chapter 3 CLI Reference

CLI Scripting Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2 Sonus Management CLI Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2 Command Line Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3 Command Line Verbs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3 Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4 Administrative versus Operational States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5 Effecting Parameter Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6 CLI Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6 Confirming Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7 Interactive Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7 Scripted Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7 CLI Startup File Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8 Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8 Command Lines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8 Typographic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-9 Upper Versus Lower Case . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-9 Required Versus Optional Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-10 Activating the Configured Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-10 Object Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-10 Node. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-11
vi GSX9000 Open Services Switch Operations Guide - 550-00224 - 2
TABLE OF CONTENTS
User Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-11 User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13 Node Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-15 Slot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-16 Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-16 Server Flash . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-25 Software Upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-26 Redundancy Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-27 Redundancy Client. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-33 Non-Volatile Storage (NVS) Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-34 NFS Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-38 NTP Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-40 Management Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-42 Trap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-46 Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-48 Alarm Contacts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-49 Event Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-53 Event Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-57 Call Trace Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-63 Network Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-69 PNS10 Network Interface (Ethernet NIF) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-69 PNS20 Network Interface (IP over ATM NIF) . . . . . . . . . . . . . . . . . . . . . . . . . 3-75 PNS30 Network Interface (Gigabit Ethernet NIF) . . . . . . . . . . . . . . . . . . . . . . 3-80 MNS Network Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-85 Debug Network Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-89 Static Routes (IP Routing Table) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-91 Ethernet Switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-95 Link Failure Detection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-97 Open Shortest Path First (OSPF) Interface . . . . . . . . . . . . . . . . . . . . . . . . . . 3-100 Differentiated Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-109 Sonus PSX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-114 Sonus PSX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-115 SS7 Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-119 SS7 Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-119 SS7 Node Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-122
vii
TABLE OF CONTENTS
SS7 Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-131 Gateway to Gateway Signaling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-137 Gateway Signaling Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-138 Gateway Signaling Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-142 Gateway Signaling Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-142 H323 Signaling Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-144 SIP Signaling Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-150 SIP Signaling Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-156 Accounting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-158 Accounting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-159 Local Time Zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-162 Trunk Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-164 Carrier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-164 Trunk Group Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-165 Trunk Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-169 Simulated Facility Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-174 T1 Circuits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-180 T1 Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-180 T1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-186 T1 Channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-197 E1 Circuits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-201 E1 Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-201 E1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-205 E1 Channels. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-214 T3 Circuits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-218 T3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-218 System Timing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-225 System Timing Shelf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-225 System Timing MTA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-229 System Timing Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-231 System Timing Reference Clock Binding . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-233 Circuit Service Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-235 Circuit Service Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-235 Packet Service Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-241 Packet Service Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-241 Voice Packet Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-252 Packet Assembler Disassembler (PAD) Resources . . . . . . . . . . . . . . . . . . . 3-252 Echo Canceller Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-263 ISUP Service Group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-265
viii GSX9000 Open Services Switch Operations Guide - 550-00224 - 2
TABLE OF CONTENTS
ISUP Service Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-265 ISUP Signaling Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-273 ISUP INR INF Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-299 ISUP Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-304 ISUP Circuit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-315 ISDN Service Group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-323 ISDN Service Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-323 ISDN Switch Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-328 ISDN Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-333 ISDN Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-349 ISDN B-channel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-351 ISDN Call Support under MGCP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-359 IUA Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-360 IUA Application Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-362 IUA Application Server Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-364 IUA Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-365 IUA Association . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-368 IUA Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-369 IUA ISDN Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-370 MGCP Soft Switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-372 MGCP Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-373 MGCP Session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-374 MGCP Call Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-375 MGCP Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-376 MGCP Service Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-377 Media Gateway Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-378 Media Gateway Circuit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-382 Command Example - MGCP Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-389 Show Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-391 Show Announcements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-392 Call and Performance Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-394 Call Counts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-394 Performance Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-397 RTCP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-400 ATM Network Interfaces. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-404
ix
TABLE OF CONTENTS
SONET Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-405 ATM Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-416 ATM Traffic Descriptor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-419 ATM Permanent Virtual Connection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-420 ATM-Extension Virtual Connection Network Interface (NIF) . . . . . . . . . . . . . 3-423 ATM Operations and Maintenance (OAM) . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-428 ATM Transmission Convergence Sublayer . . . . . . . . . . . . . . . . . . . . . . . . . . 3-430 AAL5 Shelf Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-431 AAL5 Layer Shelf Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-432 Show IPOA NIF Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-433 Automatic Protection Switching (APS) Interface . . . . . . . . . . . . . . . . . . . . . . . . . 3-436 APS Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-436 APS Channel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-440 CAS Service Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-443 CAS Service Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-443 CAS Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-448 CAS Signaling Sequence Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-455 CAS Signaling Condition Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-456 CAS SignalSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-457 CAS SignalCond . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-463 CAS Channel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-467 CAS CollectionProfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-472 Call Disconnect Treatment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-478 Disconnect Treatment Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-478 Disconnect Signaling Sequence Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-480 Disconnect SignalSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-481 Tone Processing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-484 Tone Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-484 Tone Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-485 Digit Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-487 Tone Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-489 Tone Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-490 Manual Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-491 Static Call . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-491 Call GCID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-495 Test Call . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-495
Chapter 4 Managing the GSX

Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
x

TABLE OF CONTENTS
Configuring Timing for Circuit Network Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2 Timing Source Sequence Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3 Reference Clock Bindings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4 Timing Source Switchover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5 Revertive Switching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6 Daisy Chaining . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7 Access Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7 System Administrator Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8 User Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8 Read-only Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8 Adding Hardware Modules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8 CNS Redundancy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9 PNS10 Redundancy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9 PNS20 Redundancy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10 Layer 3 PNS Redundancy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10 Creating Layer 3 PNS/PNA Pairs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12 Creating and Enabling the Layer 3 Redundancy Group . . . . . . . . . . . . . . . . . . . . 4-12 Creating and Configuring the OSPF Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13 Creating Logical Bearer Addresses for Call Endpoints . . . . . . . . . . . . . . . . . . . . . 4-13 MNS Redundancy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15 Configuring NVS Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15 Configuring the Gateway Call Signal Port Interface. . . . . . . . . . . . . . . . . . . . . . . . 4-15 Configuring the SS7 Gateway for Redundant MNS1xs . . . . . . . . . . . . . . . . . . . . . 4-16 NFS Server Redundancy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16 Booting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17 Parameter File Loading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17 Manual Unmounting and Mounting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18 Reconfiguring NFS Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19 NFS Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19 NFS Server Full . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-20 NFS Server Quotas Exceeded. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-20 Performing Live Software Upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-20 Upgrade PSX and SGX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-23
xi
TABLE OF CONTENTS
Install New Software in New /<SOFTWPTH> in the GSX System Tree . . . . . . . . 4-23 Upgrade GSX9000 Firmware. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-25 Upgrade Modules through the CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-25 LSWU with Full Server Module Redundancy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-26 Synchronize All Redundancy Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-26 Perform LSWU CLI Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-27 LSWU with One or More Unprotected Server Modules . . . . . . . . . . . . . . . . . . . . . 4-32 LSWU Procedure with Unprotected Modules. . . . . . . . . . . . . . . . . . . . . . . . . . 4-33 Example LSWU with Unprotected SPS30 Modules . . . . . . . . . . . . . . . . . . . . . 4-34 Restoring the Previous GSX9000 Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-35 Event Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-35 File Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-35 File Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-36 Number of Coexisting Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-36 Sequence Number in File Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-36 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-38 Destination of Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-38 Event Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-38 Show Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-39 Network Configuration Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-40 GSX with Separate Routed Subnet per Interface . . . . . . . . . . . . . . . . . . . . . . . . . 4-40 GSX with Shared Routed Subnets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-43 GSX with Switched Interfaces to a Single Routed Subnet. . . . . . . . . . . . . . . . . . . 4-44 GSX with Switched Interfaces to Multiple Routed Subnet Links . . . . . . . . . . . . . . 4-44 GSXs Directly Connected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-45 GSX in ATM+IP Environments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-46 Reconfiguring a MNS Network Interface (MGMT NIF). . . . . . . . . . . . . . . . . . . . . . 4-47 OC-3 TDM Interface Subsystem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-48 OC-3 TDM Interface Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-48 Configuring the OC-3 TDM Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-49 Configuring the SONET Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-50 Configuring the APS Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-50 Configuring an SPS30 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-50 Using SNMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-51 Support Files for SNMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-51 marlinMib.sum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-51 marlinTraps.sum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-51 ovLoadMibs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-52
xii GSX9000 Open Services Switch Operations Guide - 550-00224 - 2
TABLE OF CONTENTS
sonusTrapd.conf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-52 Trap and MIB Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-52 Loading MIBs into a Network Management System . . . . . . . . . . . . . . . . . . . . . . . 4-58 Verifying ISUP Circuits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-62 Circuit Conformance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-62 Manual Continuity Check (COT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-64 Announcements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-67 Announcement Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-67 Creating Announcement Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-67 Validating Announcement Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-68 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-70 Sample Announcement Files Provided . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-71 Updating Announcements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-72 Exceeding Announcement Memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-72 Playing Announcements under Sonus SoftSwitch Control . . . . . . . . . . . . . . . . . . 4-73 MGCP Continuity Tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-73 ISDN Call Support Through the Sonus SoftSwitch . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-75 Adding an ISDN PRI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-75 Adding an ISDN NFAS Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-79 Adding a Euro-ISDN PRI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-83 Japan Call Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-85 PRI-PBX Functionality (w/Japan INS-1500 ISDN) . . . . . . . . . . . . . . . . . . . . . . . . . 4-86 Internet Offload Support (w/Japan INS-1500 ISDN) . . . . . . . . . . . . . . . . . . . . . . . 4-86 Pre-subscription functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-87 CAS Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-87 Ingress Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-87 Egress Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-87 CAS Ingress to CAS Egress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-88 Non-CAS Ingress to CAS Egress. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-88 CAS Ingress to Non-CAS Egress. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-88 Two Stage Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-89 Initiation of a Two Stage Call . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-89 GSX Processing of a Two Stage Call. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-91
xiii
TABLE OF CONTENTS
GSX Call Rerouting Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-92 SIP DTMF Detection/Insertion Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-94 Packet Service Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-96 DTMF Relay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-96 In Band DTMF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-96 Out of Band DTMF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-97 Remove Digits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-97 Hardware Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-97 G.711 without DTMF RELAY Scenario . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-97 G.711 with DTMF RELAY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-99 G.711 with DTMF Relay, with Digits Removed . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-101 G.729A with DTMF Relay, Out of Band . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-102 G.729A with DTMF Relay, Out of Band, with Digits Removed . . . . . . . . . . . . . . . 4-103
Chapter 5 Call Accounting

Accounting Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1 File Name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1 File Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1 Number of Coexisting Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2 Sequence Number in File Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2 File Header. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3 Accounting Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4 Timestamps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4 Accounting Records Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5 Accounting Record Field Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12 REBOOT Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12 START Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12 STOP Field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12 ATTEMPT Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12 INTERMEDIATE Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12 Gateway Name Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12 Accounting ID Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12 Start Time in System Ticks Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-13 Node Time Zone Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-13 Start Date Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-14 Start Time Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-14 Time Elapsed from Receipt of Setup Message to Policy Server/Sonus SoftSwitch Response Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-14
xiv GSX9000 Open Services Switch Operations Guide - 550-00224 - 2
TABLE OF CONTENTS
Time Elapsed from Receipt of Setup Message to Receipt of Alerting/ProcProg Field5-14 Time Elapsed from Receipt of Setup Message to Service Established . . . . . . . . . 5-15 Intermediate Date Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-15 Intermediate Time Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-15 Disconnect Date Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-15 Disconnect Time Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-15 Time Elapsed from Receipt of Disconnect to Completion of Call Field . . . . . . . . . 5-15 Call Service Duration Field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-15 Call Disconnect Reason Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-16 Service Delivered Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-25 Call Direction Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-25 Service Provider Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-25 Transit Network Selection Code Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-26 Calling Number Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-26 Called Number Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-26 Extra Called Address Digits Field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-26 Number of Called Num Translations Done by This Node Field . . . . . . . . . . . . . . . 5-26 Called Number Before Translation #1 Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-27 Translation Type 1 Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-27 Called Number Before Translation #2 Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-28 Translation Type 2 Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-28 Billing Number Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-28 Route Label Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-28 Route Attempt Number Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-29 Route Selected Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-29 Local Gateway Signaling IP Address Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-29 Remote Gateway Signaling IP Address Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-29 Ingress PSTN Trunk Name Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-29 Ingress PSTN Circuit End Point Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-29 Ingress IP Circuit End Point Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-29 Egress PSTN Circuit End Point Field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-29 Egress IP Circuit End Point Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-30 Number of Audio Bytes Sent Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-30
xv
TABLE OF CONTENTS
Number of Audio Packets Sent Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-30 Number of Audio Bytes Received Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-30 Number of Audio Packets Received Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-30 Originating Line Information (OLIP) Field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-30 Jurisdiction Information Parameter Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-31 Carrier Code Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-31 Call Group ID Field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-32 Script Log Data Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-32 Time Elapsed from Receipt of Setup Message to Receipt of Exit Message Field . 5-32 Time Elapsed from Receipt of Setup Message to Generation of Exit Message Field5-32 Calling Party Nature of Address Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-32 Called Party Nature of Address Field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-32 Protocol Variant Specific Data #1 Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-33 Ingress Signaling Type Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-33 Egress Signaling Type Field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-33 Ingress Far End Switch Type Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-33 Egress Far End Switch Type Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-33 Carrier Code of the Carrier That Owns the Far End of the Ingress Trunk Group Field5-33 Carrier Code of the Carrier That Owns the Far End of the Egress Trunk Group Field5-34 Calling Party Category Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-35 Dialed Number Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-37 Carrier Selection Information Field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-37 Called Number Numbering Plan Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-37 Generic Address Parameter Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-38 Disconnect Initiator Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-38 Number of Packets Recorded as Lost Field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-39 Interarrival Packet Jitter Field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-39 Last Measurement for Latency Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-39 Egress Trunk Group Name Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-39 Protocol Variant Specific Data #2 Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-39 Incoming Calling Number Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-39 Intermediate Record Reason Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-39 AMA Call Type Field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-40 Message Billing Index (MBI) Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-40 Originating LATA Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-40 Route Index Used Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-40 Calling Party Number Presentation Restriction Field . . . . . . . . . . . . . . . . . . . . . . . 5-40 Incoming ISUP Charge Number Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-40
xvi GSX9000 Open Services Switch Operations Guide - 550-00224 - 2
TABLE OF CONTENTS
Incoming ISUP Charge Number NOA Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-41 Dialed Number NOA Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-41 Ingress Codec Type Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-41 Egress Codec Type Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-41 RTP Packetization Time Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-41 GSX Call ID Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-41 Terminated with Script Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-41 Originator Echo Cancellation Field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-42 Terminator Echo Cancellation Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-42 Charge Flag Field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-42 AMA Service Logic Identification Field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-42 AMA BAF Module Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-43 AMA Set Hex AB Indication Field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-47 Service Feature ID Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-48 FE Parameter Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-50 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-52 Satellite Indicator Field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-52 PSX Billing Information Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-53 Billing Info Variant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-56 Tag, Length, and Tag Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-56 Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-60 Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-62 Originating TDM Trunk Group Type Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-62 Terminating TDM Trunk Group Type Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-63 Ingress Trunk Member Number Field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-63 Egress Trunk Group ID Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-63 Egress Switch ID Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-63 Active Call Ingress Local ATM Address Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-63 Active Call Ingress Remote ATM Address Field . . . . . . . . . . . . . . . . . . . . . . . . . . 5-64 Active Call Egress Local ATM Address Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-64 Active Call Egress Remote ATM Address Field . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-64 Policy Response Call Type Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-64 Outgoing Route Identification Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-65

xvii
TABLE OF CONTENTS
Outgoing Message Identification Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-65 Incoming Route Identification Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-66 Calling Name Field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-66 Calling Name Type Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-67 Incoming Calling Party Numbering Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-67 Outgoing Calling Party Numbering Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-68 Calling Party Business Group ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-68 Called Party Business Group ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-69 Calling Party Public Presence Directory Number. . . . . . . . . . . . . . . . . . . . . . . . . . 5-69 Elapsed Time from Receipt of Setup Message to Last Call Routing Attempt . . . . 5-69 Billing Number NOA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-69 Incoming Calling Number NOA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-70 Egress Trunk Member Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-70 Selected Route Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-70 Second Stage Accounting Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-71 Accounting Record Field Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-72 Nature of Address Enumeration Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-72 Japan ISUP Variant Sub-field Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-74 SIP Variant Sub-field Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-77 H.323 Signaling Sub-field Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-77 GSX Gateway to Gateway Signaling Sub-field Descriptions . . . . . . . . . . . . . . . . . 5-78 BT-IUP Variant Sub-field Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-78 Signaling Type Enumeration Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-81 Far End Switch Type Enumeration Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-81 Codec Type Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-81 TDM Trunk Group Type Enumeration Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-83
Chapter 6 Troubleshooting
Frequently Asked Questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1 Is the SS7 Gateway Interacting Properly with the GSX? . . . . . . . . . . . . . . . . . . . . . 6-1 Can you successfully ping the SS7 Gateway?. . . . . . . . . . . . . . . . . . . . . . . . . . 6-1 Is the Policy Server Interacting Properly with the GSX? . . . . . . . . . . . . . . . . . . . . . 6-1 Can you successfully ping the Policy Server? . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1 Solutions to Frequently Encountered Problems. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2 Unable to Log on to the MNS Firmware from Craft Port . . . . . . . . . . . . . . . . . . . . . 6-2 Use the Correct Passwords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2 Set Matching Baud Rates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2 Make Sure Youre Using the Right Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
xviii GSX9000 Open Services Switch Operations Guide - 550-00224 - 2
TABLE OF CONTENTS
Unable to Connect Successfully to a Router . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2 Configure 3Com Routers Properly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2 Configure Cisco Routers Properly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3 Manually Configure MNA10 Link Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3 Unable to Telnet to the GSX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5 Specify the Correct Management Ethernet Port . . . . . . . . . . . . . . . . . . . . . . . . 6-6 Make sure the CLI is Loaded and Initialized . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6 Cant Remember Admin Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6 Change the Password through Another User . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6 Remove All Saved Configurations and Reboot . . . . . . . . . . . . . . . . . . . . . . . . . 6-6 Return the MNS Module to the Factory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6 Replacing Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7 Reporting Problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7
CLI Facilities 1
Command Line Interface Inline Editing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-1 EMACS Edit Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-1 VI Edit Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-3 Special Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-4 Intra-line Movement Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-5 Inter-line Movement Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-5 Edit Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-6 Miscellaneous Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-7 Command Syntax Assistance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-7 <enter> Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-7 <tab> Key. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-7 Administrator Command Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-7 Shell Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-8 CLI Prompt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-8

xix
TABLE OF CONTENTS
xx

1-1
CHAPTER 1
Introduction
This chapter provides basic information about the network components and topology required for successful operation of the Sonus GSX9000 Open Services Switch and its associated infrastructure. If you have questions or comments about this manual, please address your feedback via e-mail to support@sonusnet.com, by phone to +1 (888) 391-3434, or by mail to: Sonus Networks, Inc. Attn. Technical Publishing 5 Carlisle Road Westford, MA 01886 USA
Version 4.01, Document Version 2
GSX9000 Open Services Switch Operations Guide
1-2
About This Manual
About This Manual

This section gives general information about the GSX9000 Open Services Switch Operations Guide as a whole, including a description of the intended audience, the text conventions used throughout the book, and a revision history of this document.
Intended Audience
This document is intended for use by network engineers responsible for provisioning, maintaining, and administering the GSX9000 Open Services Switch. Individuals in this position are assumed to 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 GSX9000 Open Services Switch and its configuration.
Text Conventions
For clarity, this document follows a set of text conventions outlined below:
Document names are shown in italic type. For example: GSX9000 Open Services Switch Operations Guide. Cross references to headings contain the text of the heading in quotation marks. For example: See Related Documents on page 1-9 for a list of related documents. References to tables and figures use the table number or figure number for the reference. For example: See Table 1-1 for the document revision history. Command line syntax text uses the Courier mono-spaced typeface. Keywords are upper-case and user-input parameters are in lower-case italic. Each command appears on a separate line from any descriptive text. For example: CREATE USER username
Command line examples may display actual parameter values. Parameter values are lower-case bold. For example: CREATE USER joe Notes, Cautions, and Warnings appear in italic typeface with an italic heading to the left of the text. Note indicates additional information. Caution indicates the possibility of data loss or corruption if instructions are not followed accurately. Warning indicates physical danger to the operator of the equipment if directions are not followed accurately.
Network Components and Topology
1-3

This section describes the network topology and required components of a packet network that includes a Sonus GSX9000 Open Services Switch.
Figure 1-1 on page 1-3 shows the overall network topology. Figure 1-2 on page 1-4 shows the GSX9000 management network topology. A component list outlines each elements function in the management network.
Overall Network Topology

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 GSX9000 Open Services Switch is a carrier-grade packet telephony gateway that provides all of the capabilities required for world-class telephony service on a packet backbone. As illustrated in Figure 1-1, the GSX9000 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 GSX9000 provides intraLATA (tandem) or inter-LATA (toll or long-distance) service. PBX-to-PSTN/PBX: A PBX can connect to the GSX9000 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 GSX9000 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.
RAS GSX
PSTN
IP
GSX
PSTN
PBX
H.323 GK/GW
IP Device
Application Server
FIGURE 1-1
Overall GSX9000 Open Services Switch Network Topology

1-4
Within this network diagram, the boxes labeled GSX actually include a number of GSX9000s and their associated management network. A diagram of this network and descriptions of its components appear in the next two sections.
GSX9000 Open Services Switch Management Network Topology

The diagram below illustrates the network topology required for successful operation of the GSX9000 Open Services Switch and its associated infrastructure.
Insignus Softswitch SGX SS7 Gateway
SS7
DSI
Sonus Insight
10/100M Ethernet Insignus Softswitch PSX Policy Server (H.323 GK)
NFS
NTP
T1
BITS or SETS Timing Source SONET/ Ethernet
GSX9000
H.323 GK/GW
PSTN
T3 E1
IP/ATM
GSX9000
Application Server
GSX9000
GSX9000
FIGURE 1-2
GSX9000 Open Services Switch Management Network Topology
This guide describes the provisioning commands and administrative procedures in the diagram above. Note A single Insignus Softswitch PSX Policy Server, Insignus Softswitch SGX SS7 Gateway, Sonus Insight, NFS, NTP server, DataStream Integrator (DSI), or BITS/SETS timing source may support multiple GSX9000s. In addition, you can configure multiple platforms for each of these management network functions to provide redundancy.
1-5
Network Components
The components of the GSX9000 Open Services Switch management network are described below.
GSX9000 Open Services Switch

The GSX9000 Open Services Switch provides connectivity between circuit-switched and packet environments for voice, data, and fax transmission. SONET and Ethernet interfaces are provided to the packet environment. A BITS or SETS timing source may be configured to provide circuit module timing. This book describes the configuration procedures for the GSX9000 Open Services Switch. The adding and replacing of components of the GSX9000 Open Services Switch is defined in the GSX9000 Open Services Switch Maintenance Guide. The hardware components and the general installation procedures for the GSX9000 Open Services Switch is described in the GSX9000 Open Services Switch Installation Guide.
Insignus Softswitch PSX Policy Server

The Insignus Softswitch PSX Policy Server provides a central database of service, routing, and call treatment information for one or more GSX9000 Open Services Switches. Software installation of the Insignus Softswitch PSX Policy Server is defined in the PSX Policy Server Installation Guide. Operation, including configuration, of the Insignus Softswitch PSX Policy Server is defined in the PSX Policy Server Provisioning Guide.
Insignus Softswitch SGX SS7 Gateway

The Insignus Softswitch SGX SS7 Gateway provides connectivity between one or more GSX9000s and the Signaling System 7 (SS7) network for circuit switched call routing and services. Software installation and maintenance operations for the Insignus Softswitch SGX SS7 Gateway are defined in the SGX SS7 Signaling Gateway Installation, Upgrade, and Operations Guide.
MGCP Soft Switch

An MGCP soft switch may replace the Insignus Softswitch PSX Policy Server and SGX SS7 Gateway elements of a GSX9000 network.
Sonus Insight
Sonus Insight provides a Network Operations Center (NOC) facility for administration of the GSX9000 network. Sonus Insight requires that the Insignus Softswitch control elements, rather than an MGCP soft switch, be deployed in the network. Installation and operation of this system is defined in the Sonus Insight Installation and User Guide.
1-6
Installation Sequence
NFS and NTP Servers

In order to operate properly, the network must include a Network File Server (NFS) and a Network Time Protocol (NTP) server. The NFS provides file services that include loading software configuration information to the GSX9000 at boot time, storing configuration information generated by the GSX9000 during its operation, storing call accounting records, and others. 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. Caution Calls will not be properly processed if an NTP server is absent from the GSX9000 operating environment.
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 4.0 supports generation of AMA standard billing streams from the GSX network element.
The task sequence required for successful installation and configuration of the system elements depends on the control mechanism used for your GSX network: Insignus SoftSwitch PSX/SGX or MGCP soft switch.
1-7
Using Insignus Softswitch Control Elements

The installation sequence for a network that uses Insignus Softswitch PSX Policy Server and SGX SS7 Gateway control is shown in the diagram below. This is a high level overview of this process. For upgrading previously installed software, refer to the Sonus System Software Upgrade Guide for the appropriate software release.
Perform Perform Site Site Survey Survey
Read and understand the Requirements 1
Collect all required Information
Build out infrastructure as necessary 3
Install Install Hardware Hardware
Install SGX SS7 Gateway 4
Install PSX Policy Server 5
Install GSX9000 6
Install NFS server (if necessary) 7
Install Insight server (if necessary) 8
Install Install Software Software
Install/ Configure Sonus Insight 9
Install/ Configure PSX Policy Server 10
Install/ Configure SGX SS7 Gateway (if necessary) 11
Install NFS server 12
Install NTP server (if necessary) 13
Load software into GSX System Tree 14
Configure NVS Parameters 15
Boot GSX 16
Configure Configure GSX GSX
Logon to GSX and access the CLI 17
Configure GSX Management Objects 18
Enable Configuration 19
Verify Installation 20
The information in this manual pertains to boxes 17-20 in this process.
1-8
Using an MGCP Soft Switch

The installation sequence for a network that uses MGCP soft switch control is shown in the diagram below.
Perform Perform Site Site Survey Survey
Read and understand the Requirements 1
Collect all required information
Build out infrastructure as necessary 3
Install Install Hardware Hardware
Install MGCP Soft Switch Platform 4
Install GSX9000 5
Install NFS server (if necessary)
Install Install Software Software
Install NFS server 7
Install NTP server (if necessary)
Install/ Configure MGCP Soft Switch 9
Load software into GSX System Tree 10
Configure NVS Parameters 11
Boot GSX 12
Configure Configure GSX GSX
Logon to GSX and access the CLI 13
Configure GSX Management Objects 14
Enable Configuration 15
Verify Installation 16
The information in this manual pertains to boxes 13-16 in this process.
Related Documents
1-9
Related Documents
See the current GSX9000 Open Services Switch Release Notes for a complete list of all technical user documentation from Sonus Networks.
1-10
Related Documents
2-1
CHAPTER 2
Using the CLI to Configure Objects
Before you can access the GSX9000 Command Line Interface (CLI), you must load, initialize, and boot the GSX software as discussed in the GSX9000 Installation Guide. After these steps are finished, you use the CLI to customize your GSX configuration. (Note that 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 Sonus Insight Installation and User Guide.) This chapter provides an overview of:
The management objects to be configured on the GSX9000 The CLI that you will use to configure them
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. Command details are presented in the next chapter, CLI Reference. The organization of this chapter is:
1. 2. 3. 4. 5.
Management Objects - what they are, how they behave, and how they are saved. Accessing the CLI - how to connect to it and interact with it. Basic CLI Commands - the types of CLI commands. Configuration Profiles - a facility that simplifies the configuration process. Configuring the GSX - A recommended approach to configuration, expanded with examples and diagrams.
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 GSX9000. 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.
2-2
Management Objects
MIBs
Sonus utilizes standard MIBs and supplements these through the Sonus Enterprise MIB.
Behavior
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 the next chapter, CLI Reference.
Administrative Values
The administrative value is the configured value of the object or the value of all of the objects 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 present in the GSX configuration (enabled, that is, active) or not present (disabled, or inactive). In general the objects administrative state needs to be disabled before it can be reconfigured or removed. It is essentially present or not present in the configuration according to this parameter setting.
Operational Values
This is typically the readiness of the enabled object. If ready or operational, it is available for immediate use according to its configured parameter settings. Occasionally it is necessary to make objects temporarily not ready, for example to reconfigure or perform maintenance on them. This change can only be enacted on an enabled object and is hence dependent on the administrative value of the object.
Parameter Files
The GSX software automatically saves all initial configuration information, and all subsequent configuration changes to the binary parameter file. The binary parameter file contains all the default values for all objects in the GSX. This set of default values functions like a set of default profiles for the GSX. For more information about profiles, see Creating and Saving Profiles on page 2-5. You can use the binary parameter file to restore a GSXs configuration during a boot. There is one binary parameter file for each GSX, and a backup of that file. The binary parameter file and the backup are both stored in the GSX System Tree (see Figure 4-17, GSX System Tree) on the NFS file system on both the primary and secondary NFS servers. This constitutes, in effect, the archive of the GSX configuration.
Parameter File Loading

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 MNS10 or MNS11 (hereafter MNS1x)on
GSX9000 Open Services Switch Operations Guide Version 4.01, Document Version 2
Accessing the CLI
2-3
the GSX is booted. These values will always be copied to the standby MNS1x. See Non-Volatile Storage (NVS) Parameters on page 3-34 for more information on parameter file loading.
Accessing the CLI

You can access the CLI in the following ways:
Using a telnet connection via the 100Base-T Ethernet interface on the GSXs Management Adaptor (MNA10) module. 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. Using the RS232 DCE interface located on the adapter module panel in the back of the GSX. This interface is used to connect to an external modem for remote field service operation. Use one of the above methods to connect to GSX firmware, preferably a telnet connection to the MNA10 Ethernet Port 1 IP address that you specified when you initialized the GSX firmware. Enter your UserID and password.
Perform the following steps to access the CLI:
The CLI will return 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. You submit script files with the Tool Command Language (TCL) source command. (TCL is discussed in the following section CLI Scripting Language.) For example if you have a file named sample.tcl in the GSX System Tree, /scripts subdirectory, you may submit it by invoking the command:
% SOURCE cli/scripts/sample.tcl
Output from this script file will be displayed on the console.
Basic CLI Commands

The CLI supports the following commands:
CREATE
The CREATE command allows you to define objects in the GSX. For example, the following command line defines an Integrated Services Digital Network User Part (ISUP) service for use by ISUP circuits:
CREATE ISUP SERVICE isupsg1
DELETE
The DELETE command allows you to remove objects from the GSX. For example, the following command line removes an ISUP service:
Version 4.01, Document Version 2 GSX9000 Open Services Switch Operations Guide
2-4
Configuration Profiles
DELETE ISUP SERVICE isupsg1
CONFIGURE
The CONFIGURE command allows you to define the characteristics of objects in the GSX. For example, the following command activates an ISUP service:
CONFIGURE ISUP SERVICE isupsg1 STATE enabled
SHOW
The SHOW command 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
The MONITOR command functions the same as SHOW but the screen displays continuously until you intervene by typing CTRL-C.
RESET
The RESET command is used to clear counter values. An example of the command syntax to reset the call counts on the CNS module in slot 5 is:
RESET CALL COUNT SHELF 1 SLOT 5
All GSX management objects have one or more parameters that define their characteristics. For example, a T1 interface has the following characteristics:
The line buildout, or length of T1 wire that must be driven The framing format The type of line coding The type of signaling The facilities data link protocol The value transmitted on the line when it is idle The available channels on the line
When you use the CREATE command to define a new instance of a GSX management object like an ISUP service, the GSX creates that object using any values you explicitly specify, and using the default values for all of the objects other characteristics. Chapter 3, CLI Reference lists the default values for all parameters.
Supported Profiles
The GSX also supports profiles for the following PSTN configuration objects:
Trunk groups T1 and E1spans CLI Users Packet services

2-5
Circuit services ISDN services MGCP services ISUP services
A profile allows you to define a specific set of characteristics different from the standard GSX defaults, for any of the above objects. 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:
CONFIGURE ISUP SERVICE isupsg1 PROFILE myisupprofile
creates an ISUP service called isupsg1 with the characteristics specified in the profile named myisupprofile. 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.
Creating and Saving Profiles

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. See the Table of Contents for pointers to the sections that explain how to create and configure each type of profile.
2-6
Configuring the GSX
Configuring the GSX

Sonus PSX6000 SoftSwitch Model MGCP Soft Switch Model
Configure Node Objects
Configure NIFs
ConfigureT3 Ports
Configure T1 Ports
Configure SS7 Gateway
Configure MGCP Soft Switch
Configure Signaling Ports
Configure Sonus SoftSwitch
Configure PSTN Interfaces
FIGURE 2-1
GSX Configuration Approaches
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 Insignus Softswitch PSX Policy Server and SGX SS7 Gateway (hereafter abbreviated PSX) MGCP soft switch
These two configurations are described in Network Components on page 1-5. They give rise to the two installation scenarios described in Installation Sequence on page 1-6, and to the two configuration models depicted in Figure 2-1, GSX Configuration Approaches above. The model in effect at your site will determine your configuration approach.
Configuring the GSX
2-7
Required Configuration Sequence

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 soft switch model, the MGCP soft switch manages interconnection to the SS7 network and call routing. By configuring the MGCP soft switch 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.
Common Configuration Steps in Both Models

Whether you use a PSX or an MGCP soft switch, 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. Each section below explains a major step in configuring a GSX. You must perform your configuration in the order in which these sections appear below.
Step 1: Configure Node Objects

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, 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
2-8
Configuring the GSX
parameters, and event logs. Formal explanations of each object and its command syntax are presented in Chapter 3, CLI Reference. Hardware modules do need to be explicitly configured and enabled on initial power up. Subsequently the NVS binary parameter file may be used to restore your configuration. The hardware modules are the modules that are actually plugged into each slot in your GSX. 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.
Configuring the NTP Server

You may configure up to 3 NTP (Network Time Protocol) servers. The primary NTP server is an Internet standard time server which sets and maintains UNIX system timeof-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-40). 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.
Configuring the GSX Name

Each GSX has a name that is used to refer to it. You specify the GSX name using the CONFIGURE NODE NAME command. For example, the command:
CONFIGURE NODE NAME gsxhfd
defines the name of the GSX as gsxhfd.
Step 2: Configure Network Interface (NIF) Objects

This step requires the definition and configuration of the five types of NIF objects:
1.
PNA NIF - an Ethernet or IP over ATM interface on a Packet Network Adapter (PNA) module. This interface is used for telephony traffic and may also be used for management traffic. MNA10 (Management) NIF - an Ethernet interface on a Management Network Adapter (MNA) module. This interface is used only for management traffic. Debug NIF - an Ethernet interface on any GSX9000 hardware server module. This interface is for the use of Sonus authorized personnel only for system debugging.
2. 3.
Configuring the GSX
2-9
4.
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 PNS10 Network Interface (Ethernet NIF) on page 369 and PNS20 Network Interface (IP over ATM NIF) on page 3-75 for more detail. MNA10 NIFs are always configured as a redundant pair so that the Management Network can be configured without bringing down the GSX. See MNS Network Interface on page 3-85 for more detail. The configuration of the subnets that connect to NIFs may vary. See Network Configuration Considerations on page 4-40 for more detail on this subject. If you are running the MGCP soft switch model, the Ethernet NIFs may be managed by either the soft switch or the GSX software. See Failure COT Sequence on page 4-67 for more detail on this subject. All NIFs must be configured with their IP address, and a subnet mask. For example, the commands:
CREATE SERVER SHELF 1 SLOT 3 HWTYPE PNS10 CONFIGURE NIF ENET-1-3-2 IPADDRESS 10.2.1.2 CONFIGURE NIF ENET-1-3-2 MASK 255.255.255.0
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.
Step 3: Configure the T3 Circuits

This step requires you to specify the T3 circuits, if any, that are connected to the GSX Circuit Network Adaptors (CNA30). 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:
Line buildout (default 0_100 ft.) Line coding (default B3ZS) Available T1 spans (default 1-28)
For details on these and other parameters, see T3 on page 3-218. 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)
2-10
Configuring the GSX
Facilities data link type Available channel number range (default 1-24)
For details on these and other T1 parameters, see T1 on page 3-186. 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.
Step 4: Configure the T1 Spans

This step requires you to name and specify the T1 links that are connected to the GSX Circuit Network Adapters (CNA10). One CNA10 accomodates twelve T1 spans. A single Telco-Type 50-pin connector on the CNA10 accomodates 12 T1 spans or circuits. You define each T1 circuit and automatically assign it a name when you add the CNS10 server module to the CLI using the CREATE SERVER SHELF .. CNS10 command, as shown below. (You may subsequently change the name.) You can specify T1 circuit 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 on page 3-186. 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. For example, the commands:
CREATE SERVER SHELF 1 SLOT 3 HWTYPE CNS10 CONFIGURE T1 T1-1-3-2 PROFILE MYT1PROFILE
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-180.
Where to Go for Step 5:

If you are configuring a GSX to run with the PSX, continue with the next section immediately below.
Configuring the GSX
2-11
If you are using an MGCP soft switch, skip to the section Configuration Using the MGCP Soft Switch Model, later in this chapter.
Completing Your Configuration Using the PSX

A PSX Policy Server may be configured to supply policy and routing information to the GSX9000. This configuration represents the standard Sonus model. In this configuration, the GSX uses the following external management systems to support its operation. See Figure 2-2, GSX Management Interfaces.
A Network Time Protocol (NTP) server to provide an accurate date and time. This server is common to both models. Its configuration was discussed in Configuring the NTP Server on page 2-8. 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 GSX9000, SGX, and PSX to interact as peers.
A-Links SS7 GWA ss7nya A-Links SS7 GWB ss7nyb
PSX6000 SoftSwitch
psdenver
NTP Server
ntpbos
ss7gwny Gateway Signaling Port
GSX
gsxhfd
FIGURE 2-2
GSX Management Interfaces
You must define the characteristics of each interface as part of the standard model GSX configuration.
Step 5: Configure the SS7 Gateway

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
2-12
Configuring the GSX
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. For example, the commands:
CREATE SS7 GATEWAY ss7gwny CONFIG SS7 GATEWAY ss7gwny PRIMARY HOSTNAME ss7nya .. IPADDRESS 168.24.53.1 CONFIG SS7 GATEWAY ss7gwny SECOND HOSTNAME ss7nyb .. IPADDRESS 168.24.53.5
Define the redundant SS7 Gateway illustrated in Figure 2-2.
Step 6: Configure the Gateway Signaling Ports

The Gateway Signaling Port is used for call control processing on the IP network. You may define up to 2 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 Service on page 3-142). For example, the commands:
CREATE GATEWAY SIGNALING PORT 1 CONFIG GATEWAY SIGNALING PORT 1 IPADDRESS 16.4.5.1
define Gateway Signaling Port 1 and provide its IP address.
Step 7: Configure the PSX Policy Server

You may configure up to 2 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 Sonus documents cited in Network Components and Topology on page 1-3 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-115). For example, the commands:
CREATE SONUS SOFTSWITCH sonuserv1 CONFIG SONUS SOFTSWITCH sonuserv1 IPADDR 128.124.55.8
define a PSX Policy Server named sonuserv1 and specify its IP address. The PSX sonuserv1 is given default values for the other configuration parameters.
Configuring the GSX
2-13
Step 8: Configure the PSTN Interfaces

The PSTN configuration process for a GSX consists of the following steps:
Configuring Circuit Service Profiles Configuring SS7 Nodes Configuring Carriers Configuring Trunk Groups Configuring ISUP Services Configuring ISUP Circuits
This section explains each of these steps. The relationships between these is illustrated in Figure 2-3, PSTN Configuration Relationships.
A-Links
ansi SS7 Stack
ss7gyny SS7 GW
SS7 GW : ss7gyny SS7 Node: ansiSig Trunk Group TG1 gsxhfd 1-4-6 ISUP Service S1
CIC 1144 DS0s DS1 Port DS0s DS1 Port
Trunk Group TG2 ISUP Service S2

CIC 201248
ISUP Service S3
CIC 300396 DS0s DS1 Port
ISUP Circuits
2 rt 1
rt 1
S lo
Por t2
rt 9 Po t 7, S lo rt 4 Po t 12 S lo 7 o rt ,P
Por t5
Por t6
Por t3
S lo
S lo
t 12 , Po
t 12 , Po
t 14
t 3,
t 6,
t 3,
t 3,
t 4,
t 5,
Po
Po
Slo
Slo
Slo
Slo
Slo
Slo
rt 3
rt 1
W est 5ESS 3-4-5
East DMS250 6-7-8
FIGURE 2-3
PSTN Configuration Relationships

2-14
Configuring the GSX
Configuring the SS7 Node

When you configure an SGX SS7 Gateway, you create in it 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-131. For example, the commands:
CREATE SS7 NODE ansisig CONFIG SS7 NODE ansisig PC 1-4-6 SS7 GATEWAY ss7gwny
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 Step 5: Configure the SS7 Gateway on page 2-11.
Configuring the Carrier

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
assigns the name ATT to the selection code 0288.
Configuring the Trunk Group

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, 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 Groups on page 3-164. For example, the commands:
CREATE TRUNK GROUP tg1 CONFIG TRUNK GROUP tg1 CARRIER att SS7 NODE ansisig
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.
Configuring the ISUP Service

Configuring the GSX
2-15
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, PSTN Configuration Relationships, there are three ISUP Services:
S1, defining the SS7 signaling characteristics used on TG1 between gsxhfd and West S2, defining the SS7 signaling characteristics used on TG1 between gsxhfd and East 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 CONFIG 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-304. For example, the following commands define the ISUP Services described above:
CREATE ISUP SERVICE s1 CONFIG ISUP SERVICE s1 TRUNK GROUP tg1 DPC 3-4-5 .. SWITCHTYPE 5ess CREATE ISUP SERVICE s2 CONFIG ISUP SERVICE s2 TRUNK GROUP tg1 DPC 6-7-8 .. SWITCHTYPE dms250 CREATE ISUP SERVICE s3 CONFIG 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.
Configuring the Circuit Service Profile

A Circuit Service Profile defines a set services to be used on a particular set of circuits. Circuit Service Profiles are used in defining ISUP Circuits, described below. Examples of the services that can be specified are:
Audio coding (G.711 a-law or -law) Whether echo cancellation is to be provided The number of samples to accumulate in a frame (a block of encoded audio) The number of frames to send in one IP packet The initial delay in the jitter buffer for smoothing arrival variations in received audio
For details on these and other Circuit Service Profile parameters, see Circuit Service Profile on page 3-235. 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 Sonus defaults.
2-16
Configuring the GSX
For example, the commands:

CREATE CIRCUIT SERVICE PROFILE mycktprofile CONFIGURE CIRCUIT SERVICE PROFILE mycktprofile .. FRAMES PER PACKET 2
define a Circuit Service Profile called mycktprofile and modify the frames-perpacket parameter of that profile to be 2.
Configuring the ISUP Circuit

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, 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-315. For example, the following commands:
CREATE ISUP CIRCUIT SERVICE s1 CIC 1-24 CONFIGURE ISUP CIRCUIT SERVICE s1 PORT T1-1-3-1 .. CHANNEL 1-24 SERVICEPROFILENAME mycktprofile
define CIC range 1-24 for a ISUP Circuit named s1 as corresponding to the channels on the T1 circuit T1-1-3-1.
Configuration Using the MGCP Soft Switch Model

The MGCP soft switch model allows you to configure a GSX to communicate with a soft switch that uses the Media Gateway Control Protocol (MGCP). In the MGCP model, an MGCP soft switch performs all call control functions, and directly controls one or more GSX9000 media gateways. With MGCP, the soft switch handles all call control functions and uses MGCP commands to:
Setup and tear down connections, which facilitate calls Request information about the GSX and events related to those connections Direct the GSX to implement various features in the form of signals on connections
Figure 2-4 shows a basic MGCP configuration. In this model, the Call Agent(s) may be part of any soft switch that supports MGCP.
Configuring the GSX
2-17
SoftSwitch
Call Agent 3 Call Agent 2 Call Agent 1
Call Control Call Media
IP
GSX9000 Media Gateway
FIGURE 2-4
Basic MGCP Configuration
A soft switch 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 soft switch vendor. Configuring the GSX9000 media gateway for the MGCP model requires defining management objects that allow the GSX9000 to be managed by the MGCP soft switch.
Step 5: Configure the Session, Call Agent, and Connection

NOTE: Before performing this configuration step, you must do Steps 1 through 4, described in Common Configuration Steps in Both Models on page 2-7. Step 5 below requires you to name and specify:
1. 2.
An MGCP Session, which represents one soft switch. One or more Call Agents, which can be bound to the session. The session object specifies the Call Agents that are authorized to control the GSX. Requests from all other call agents are ignored by the GSX. One or more MGCP Connections for each Call Agent. 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 Call Agent.
3.
Together these objects identify and configure an MGCP soft switch to control the GSX9000.
2-18
Configuring the GSX
Example of MGCP Configuration Sequence

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. CREATE MGCP SESSION mgcpsession CREATE MGCP CALL AGENT callAgent1 SESSION mgcpsession CREATE MGCP CONNECTION IPADDRESS 10.150.254.198 PORT 2727 CALL AGENT callAgent1 CONFIG MGCP CONNECTION IPADDRESS 10.150.254.198 PORT 2727 STATE enable CONFIG MGCP CALL AGENT callAgent1 STATE enable CONFIG MGCP SESSION mgcpsession MODE inservice CONFIG MGCP SESSION mgcpsession STATE enable
Name and Specify the MGCP Session

You must first name and specify the MGCP Session, as in the example below:
CREATE MGCP SESSION mgcpsession1 CONFIG MGCP SESSION mgcpsession1 MODE inservice CONFIG MGCP SESSION mgcpsession1 STATE enabled
This example shows the CLI commands you would use to create the MGCP Session mgcpsession1, type generic, assigned it to shelf 1 of the gsx node gsxn1, put it into service, and enable it. Note In setting up a GSX/MGCP soft switch configuration, you should create the MGCP Session first but leave it in a disabled state. Then create and configure all the other required MGCP 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 Command Example - MGCP Configuration on page 3-389.
Name and Specify the MGCP Call Agent

You must next name, bind, and specify the MGCP Call Agent (the soft switch) as in the example below:
CREATE MGCP CALL AGENT callagent1 .. SESSION mgcpsession1 CONFIGURE MGCP CALL AGENT callagent1 .. STATE enabled
In this example, the MGCP Call Agent callagent1 is created and bound to the MGCP Session mgcpsession1. The Call Agent is then enabled and put in service.
Define a Connection to Each Call Agent (Soft Switch)
Configuring the GSX
2-19
Next you must define at least one connection to the Call Agent, as in the example below:
CREATE MGCP CONNECTION IPADDRESS 10.1.1.1 .. PORT 2727 CALL AGENT callagent1 CONFIG 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 (soft switch) is then enabled and put into service.
Step 6: Configure the Media Gateway Service and Circuits

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, as in the example below:
CREATE MEDIA GATEWAY SERVICE mgcpsrv CONFIGURE MEDIA GATEWAY SERVICE mgcpsrv .. CONTROLLER mgcpsession1 TYPE mgcp CONFIGURE MEDIA GATEWAY SERVICE mgcpsrv STATE enabled CONFIG MEDIA GATEWAY SERVICE mgcpsrv MODE unblocked 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 mgcpsrv CONFIGURE MEDIA GATEWAY CIRCUIT PORT T1-1-3-1 .. CHANNEL 1-24 STATE enabled CONFIGURE MEDIA GATEWAY CIRCUIT PORT T1-1-3-1 .. CHANNEL 1-24 MODE unblocked
In this example, the service mgcpsrv 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).
2-20
Configuring the GSX
3-1
CHAPTER 3
CLI Reference
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. Some background is helpful to put the management objects and the CLI into context. This background precedes the object descriptions. The resulting chapter organization is:
CLI Scripting Language on page 3-2, a discussion of the shell command language that underlies the CLI. Sonus Management CLI Commands on page 3-2, an introduction to the basic verbs that the CLI uses to manipulate all management objects. Profiles on page 3-4, an introduction to the profile facility that eases the configuring process by applying configuration properties globally. Administrative versus Operational States on page 3-5, a discussion of the administrative and operational states of objects and the implications to these states when you need to change an objects configuration. Effecting Parameter Changes on page 3-6, a discussion of the different activations of a parameter change. CLI Scripts on page 3-6, a summary of the CLI scripting facility. Confirming Commands on page 3-7, a discussion of command confirmations. Conventions on page 3-8, the conventions, organization, and style by which the objects and their CLI commands are specified. Object Groups on page 3-10, the object-by-object command descriptions.
3-2
CLI Scripting Language

The CLI is derived from the Tool Command Language (TCL) shell. This structuring yields a flexible, easily extendable CLI. 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
Sonus Management CLI Commands

CLI command lines are structured as follows: <Verb> <Object> <Parameters> The action defined by the verb is performed on the object, using configuration values specified by the parameters. The five verbs are:
CREATE DELETE CONFIGURE SHOW MONITOR
Objects are the management objects which are the focus of this chapter. Each is listed and described later in this chapter. Parameters are values that are assigned to configuration variables that modify the object. The command line is formed by a series of strings. Each string is a keyword or a parameter. Keywords may be verbs, objects, and parameter names. A few simple examples will clarify these concepts and add meaning to the Conventions discussion that follows.
3-3
Command Line Structure

In the command line,
CREATE USER guest CREATE is the verb, USER is the object, and guest is a parameter. Keywords are CREATE and USER. In this example, the name guest is assigned to the object USER. guest thereafter becomes a named management object.
Note
The reserved keywords ALL, NONE, and SUMMARY may not be used to name a management object. The CLI will reject these names. In the command line,
CONFIGURE USER guest ACCESS readonly CONFIGURE is the verb, USER is the object, and guest and readonly are parameters. Keywords are CONFIGURE, USER, and ACCESS. USER and ACCESS are parameter name keywords.
Command Line Verbs

The five verbs (or commands) are:
CREATE - allows you to name and define an object. For example the following command line names a new GSX user: CREATE USER guest DELETE - allows you to delete an object. For example the following command removes the previously created user: DELETE USER guest CONFIGURE - allows you to further qualify the previously created object. For example the following command adds readonly access privileges and a text comment field to the previously created user: CONFIGURE USER guest ACCESS readonly COMMENT demo-account SHOW - allows you to view the current configuration and status of an object. For example the following command displays configuration information about the previously created user: SHOW USER guest ADMIN (The requested information will be displayed immediately below the command.) MONITOR - functions the same as SHOW but the screen displays continuously until you intervene by typing CTRL-C. This command allows you to observe the timing as well as the content of changes to shelf or module status.
3-4
Profiles
All management objects have one or more parameters that define their characteristics. For example, a T1 interface to the GSX has the following characteristics:
The line buildout, or length of T1 wire that must be driven The framing format The type of line coding The type of signaling The facilities data link protocol The value transmitted on the line when it is idle The available channels on the line
When you use the CREATE command to define a new instance of a GSX configuration object like a T1 interface, that object is created with default values for all of its characteristics. (Every default value for every parameter is listed in this chapter.) Unless you explicitly specify a value for a parameter that is not its default, the default values will be assigned. A profile allows you to define a specific set of characteristics different from the GSX defaults for an object. Then, when you define a new instance of this object, you can use that profile to implicitly set the non-default values. 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 on page 3-186). When you configure a specific T1 interface, T1-1-3-1, using the command:
CONFIGURE T1 T1-1-3-1 PROFILE myt1profile ...
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.
3-5
Administrative versus Operational States

The administrative state parameter is common to all objects. You may set it to enabled or disabled through the STATE keyword. In general, when an objects administrative state is enabled, it is activated with explicit or implicit settings (see Profiles on page 3-4) for all parameters. When the administrative state is disabled, or deactivated, you may change all other parameter settings for the object without effect. 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 objects administrative state is always enabled or disabled, its operational state may be in service, out of service, 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 objects presence or absence in the configuration. 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-40). 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 new 5 second interval will take effect immediately. 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.
3-6
Effecting Parameter Changes

When you change the value of a parameter, its new value becomes effective in one of three time frames:
1. 2.
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 Profiles on page 3-4). On enable - The set value is applied the next time the objects administrative state is enabled. If the parameter is changed while the objects administrative state is enabled, the current value remains effective until the objects administrative state is disabled and then enabled. Then and only then does the new value become effective. If the objects administrative state was disabled when the change took place, the new value is installed immediately but cannot become effected until the object is reenabled. Some parameters cannot be changed at all while the objects 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 objects administrative state is disabled.
3.
These conditions are listed for each individual object in the command descriptions that follow.
CLI Scripts
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 would 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. To apply this behavior to the CLI Startup Script File:
% source -f cli/sys/sysinit.tcl
3-7
Confirming Commands
Some commands require a confirmation by the operator that they are intended, before they take effect. For example, commands to change an objects 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:
1. 2. 3.
interactively from a user console in a script that was invoked from a user console from the default CLI Startup File sysinit.tcl when the GSX is booted
Each case is described below.
Interactive Commands
If you are typing commands interactively, you will be prompted to confirm the request by entering a lower case y or n. For example if you respond yes,
% CONFIGURE NIF enet-1-3-2 MODE outofservice .. CONFIGURE NIF enet-1-3-2 MODE ... Confirm (y/n):y
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
the command will be aborted.
Scripted Commands
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. For example, if you respond Yes,
% SOURCE myscript.tcl CONFIGURE NIF enet-1-3-2 MODE outofservice .. CONFIGURE NIF enet-1-3-2 MODE ... Confirm (y/n/Y/N):Y
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.
3-8
CLI Startup File Commands

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.
Conventions
The configuration commands for each management object are ordered as follows:
1. 2. 3.
Command Syntax - all valid commands and command permutations are listed. Parameter Table - each parameter is described in detail and its valid values are listed. Command Examples - typical command sequences for manipulating the object are listed.
Command Lines
A command line is comprised exclusively of keywords and parameters. Keywords are unvarying strings that may be abbreviated as long as they remain unique. For example,
CONFIGURE SERVER SHELF...
could be abbreviated to,

CONFIG SER SHEL...
Parameters are variables that may take numeric, string, or enumerated values. For example in the command line,
CREATE USER joe CREATE and USER are keywords, and joe is a parameter that takes a string value.
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. Enumerated values are sets of values. The parameter tables below precisely describe each parameter, its use, and the valid values that it may take. The command examples add context to the command syntax presentations.
3-9
Typographic
The following typographic and related conventions are used in this chapter.
Convention Indicates All command line keywords. All command line parameter names. All command line parameter values. The default value of a parameter. The command is continued on the next (indented) line. Additional continuations of the same command line are also indented but the continuation dots appear only on the first line. The CLI prompt character. You type the characters that follow the prompt character on a line. Subsequent lines without a prompt character represent output from the CLI. For parameters that take a string value, this range specifies the minimum and maximum string length. If the parameter doesnt take a string value, N/A is displayed. Example
UPPER CASE CONSTANT WIDTH lower case constant width italic lower case constant width bold underlined parameter values .. (a pair of dots)
CREATE USER CREATE USER username CREATE USER joe enabled

disabled
CONFIG USER joe .. ACCESS admin COMMENT nocomment
% (per cent character)
% SHOW USER SUMMARY

Node: None Date: ..
Field Length (in Parameter Tables)
username admin-state
1-23 N/A
Upper Versus Lower Case

Throughout this chapter, 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.
3-10
Required Versus Optional Parameters

The default value for every parameter is indicated in the description. Whenever you do not configure a parameter, it takes the default value. (If a profile is specified but the parameter isnt, 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.
Activating the Configured Object

The configuration parameters assigned to an object are not activated until the administrative state parameter is set to enabled. Accordingly, all parameters for an object are deactivated when the administrative state is set to disabled. In general, the administrative state parameter must be changed on a separate command line. That is, no other parameters should be changed in that command line. This rule is indicated in the command syntax sections by showing the administrative state configuration command separtely.
Object Groups
Management objects fall into the following categories:
Node Network Interfaces Sonus PSX SS7 Gateway Gateway to Gateway Signaling Accounting Trunk Groups T1 Circuits T3 Circuits E1 Circuits System Timing Circuit Service Group Packet Service Group ISUP Service Group ISDN Service Group Third Party Soft Switch Voice Packet Resources ATM Networking Interfaces Automatic Protection Switching (APS) Interface
User Profile
3-11
CAS Service Group Tone Processing Manual Calls
In the discussion that follows, the group and the object members are identified. Each object is then explained according to its operational function. For each relevant command for each object the command syntax, parameter table, and related examples are presented.
Node
Node
These objects configure the immediate GSX environment.
User Profile
This object creates a template for user accounts. User account objects that are configured with a profile will silently take every enabled parameter value specified in the profile unless explicitly overridden.
Command Syntax
CREATE USER PROFILE userprofilename CONFIGURE USER PROFILE userprofilename .. STATE admin-state CONFIGURE USER PROFILE userprofilename .. PASSWORD password ACCESS access-type COMMENT comment-text PROFILE .. STATE profile-state PASSWORD profile-state ACCESS profile-state COMMENT profile-state SHOW USER PROFILE userprofilename ADMIN SHOW USER PROFILE SUMMARY DELETE USER PROFILE userprofilename
3-12
User Profile
Command Parameters
TABLE 3 -1.
USER PROFILE Parameters

Field Length 1-15 4-16 Description The name of the profile that may be applied to a user account object. 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. The type of access available to the user account that applies this profile. readOnly - 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.
Parameter
userprofilename password
access-type
N/A
comment-text admin-state
1-31 N/A
An alphanumeric string that describes the user that applies this profile. The administrative state of the user that applies this profile: disabled - User account is not activated. enabled - User configuration is activated.
profilestate
N/A
The state of the corresponding keyword parameter in the user profile: disabled - Ignore the corresponding parameter value when the user profile is applied (and thus take either the explicit or default parameter value from the user account object). enabled - Use the corresponding parameter value when the profile is 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, and then create and enable the user account joe from the template:
% CREATE USER PROFILE demo % CONFIG USER PROFILE demo PASSWORD 1234 .. ACCESS readOnly PROFILE STATE disabled PASSWORD enabled ACCESS enabled COMMENT disabled % CONFIG USER PROFILE demo STATE enabled % CREATE USER joe
User
3-13
% CONFIGURE USER joe PROFILE NAME demo % CONFIGURE USER joe STATE enabled
To display configuration information about the user profile demo:

% SHOW USER PROFILE demo ADMIN
Node: TPUBS Date: 1999/12/15 16:28:20 Zone: demo ENABLED READONLY ****** None GMT
User User User User User
Profile Name: State: Access: Password: Comment:
State: State: State: State:
ENABLED ENABLED ENABLED DISABLED
User User
This object allows you to add user accounts to the GSX. 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. Caution If you change the Admin users 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.
Command Syntax
CREATE USER username CONFIGURE USER username .. PASSWORD password ACCESS access-type COMMENT comment-text PROFILE NAME profilename CONFIGURE USER username STATE admin-state SHOW USER username ADMIN SHOW USER SUMMARY DELETE USER username
3-14
User
Command Parameters
TABLE 3 -2.
USER Parameters
Field Length 1-23 4-16 Description An alphanumeric account-name that you may use to log on to the GSX. First character must be alpha. 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. The type of access available to this user. readOnly - 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.
Parameter username
password
access-type
N/A
comment-text profilename admin-state
1-31 N/A N/A
An alphanumeric string that describes this user. This comment is displayed by the SHOW command. The name of a user profile to use for default parameter values. The administrative state of the user: disabled - User account is not activated. enabled - User configuration is activated.
Command Example
To create and activate user joe with readOnly access rights:
% CREATE USER joe % CONFIG USER joe PASS 6871 ACCESS readOnly % CONFIG USER joe STATE enabled
To display configuration information about user joe:

% SHOW USER joe ADMIN
Node: TPUBS Date: 1999/12/15 16:41:16 Zone: State ENABLED Access READONLY GMT
Name joe
Profile
Comment None
To deactivate user joe and display configuration information:

% CONFIG USER joe STATE disabled % SHOW USER joe ADMIN
Node: TPUBS Date: 1999/12/15 16:47:09 Zone: State DISABLED Access READONLY GMT
Name joe
Profile
Comment None
Node Name
3-15
To delete user joe:

% DELETE USER joe
Node Name
This object names the GSX. When you use the CONFIG NODE RESTART command to reboot a GSX with redundant MNS10s or MNS11s (hereafter MNS1xs), you reset both MNS1xs. The MNS1x in slot one will be active after the command is carried out.
Command Syntax
CONFIGURE NODE ... NAME name LOCATION loc CONTACT contact CONFIGURE NODE RESTART CONFIGURE NODE SHELF shelfnumber RESTART SHOW NODE ADMIN
Command Parameters
TABLE 3 -3.
Node Name Parameters

Field Length 1-255 Description 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). The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. A text field that Sonus suggests using to specify the location of this GSX. Quotes are required around any string that contains space characters. 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.
Parameter
name
shelfnumber loc
N/A 1-255
contact
1-255
Command Example
To configure the node name:
% CONFIGURE NODE NAME atlantic LOCATION syslab
To display the administrative status of this node:

% SHOW NODE ADMIN
Node: TPUBS Date: 1999/06/10 22:37:58 GMT
3-16
Slot
Zone: GMTMINUS05-EASTERN-US Name: TPUBS Contact: Location: SYSLAB
To reboot the GSX:

% CONFIGURE NODE RESTART
or
% CONFIGURE NODE SHELF 1 RESTART
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-27. 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
CONFIGURE SLOT SHELF shelfnumber .. SLOT slotnumber RESET CONFIGURE SLOT SHELF shelfnumber .. SLOT slotnumber COREDUMP
Command Parameters
TABLE 3 -4.
SLOT Parameters
Field Length N/A N/A Description The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. The slot number occupied by the module. For MNS hardware modules, this number must be 1 or 2. For all other modules, this number must be 3-16.
Parameter shelfnumber slotnumber
Command Example
To reset the module in slot 5:
% CONFIGURE SLOT SHELF 1 SLOT 5 RESET
Server
The server object specifies which server modules are administratively configured to exist within this GSX node.
Server
3-17
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 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 unpaired circuit module sets, in addition to the paired circuit module sets (CNS30/CNA30 and CNS30/CNA03). The unpaired sets are:
SPS30 circuit module server OC-3 TDM subsystem
The SPS30 is specified by declaring ADAPTER none. 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 leftmost (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-436 for APS naming conventions. See the GSX9000 Open Services Switch Installation 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. The SHOW INVENTORY...SUMMARY command displays the type and state of every server and adapter module present in the specified shelf. Note The CREATE SERVER command is unnecessary for MNS1xs. These modules may be assigned only to slots 1 or 2 and hence are created by default in those locations. A server module is always in one of two administrative states:
enabled disabled
3-18
Server
The same module is always in one of two operational states:
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. The rules for changing operational states are:
From (operational state) inservice
Changing to (operational state) inservice outofservice (In order to set the operational state to outofservice, the server module's redundancy state must be disabled. For a redundant server, this means that the corresponding redundancy group must be disabled. For a redundancy client, this means that the client's state must be disabled within the redundancy group.) Affirm the prompt query. The module immediately goes to the operational state outofservice and it may be disabled. Once disabled, the server module may be removed from the GSX. At this time you could also delete the module and reconfigure the slot for another module.
outofservice
Make sure the (new) server module is installed in the GSX and is ready for general usage. Change administrative state to enabled. Change operational state to inservice.
Command Syntax
Note In the command below, defaults are inserted if ADAPTER and/or reduntype are omitted. See Command Parameters.
CREATE SERVER SHELF shelfnumber SLOT slotnumber .. HWTYPE svrtype ADAPTER adptype redun-type CREATE SERVER SHELF shelfnumber SLOT slotnumber ..
Server
3-19
HWTYPE svrtype ADAPTER adptype .. FUNCTION function redun-type CONFIGURE SERVER SHELF shelfnumber .. SLOT slotnumber STATE admin-state CONFIGURE SERVER SHELF shelfnumber .. SLOT slotnumber CORE DUMP cdump-state MODE oper-state SHOW SERVER SHELF shelfnumber .. SLOT slotnumber ADMIN SHOW SERVER SHELF shelfnumber .. SLOT slotnumber STATUS SHOW SERVER SHELF shelfnumber SUMMARY SHOW SHELF SHELF shelfnumber STATUS MONITOR SERVER SHELF shelfnumber ... SLOT slotnumber STATUS DELETE SERVER SHELF shelfnumber SLOT slotnumber SHOW INVENTORY SHELF shelfnumber .. SLOT slotnumber STATUS SHOW INVENTORY SHELF shelfnumber SUMMARY SHOW INVENTORY SHELF shelfnumber HARDWARE SHOW INVENTORY SHELF shelfnumber CONFLICT MONITOR INVENTORY SHELF shelfnumber .. SLOT slotnumber STATUS MONITOR INVENTORY SHELF shelfnumber SUMMARY SHOW ADAPTER SHELF shelfnumber .. SLOT slotnumber STATUS SHOW ADAPTER SHELF shelfnumber SUMMARY
3-20
Server
Command Parameters
TABLE 3 -5.
SERVER Parameters
Field Length N/A N/A Description The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. The slot number occupied by the module. For MNS/MNA and MTA hardware modules, this number must be 1 or 2. For all other modules, this number must be 3-16. 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. pns20 - The slot is occupied by an IP over ATM Packet Server Module/Adapter Module pair. pns30 - The slot is occupied by a 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. cns60 - The slot is occupied by a 3xT3 Circuit Server Module/Adapter Module pair.
svrtype
N/A
Server
3-21
TABLE 3 -5.
SERVER Parameters
Field Length N/A Description The type of adapter module that is being configured in the slot behind the previously specified server module: cna10 - Valid for a cns10 server module used as a redundancy client. cna01 - Valid for a cns10 server module used as a redundant module. cna20 - 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 - Valid for a cns25 server module used as a redundancy client. cna05 - Valid for a cns25 server module used as a redundant module. cna30 - 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. 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. pna10 - Valid for a pns10 server module used either as a redundancy client or as a redundant module. pna21 - Valid for a pns20 server module used either as a redundancy client or as a redundant module. pna30 - Valid for a pns30 server module used either as a redundancy client or as a redundant module. none - Valid for a CNS30 server module that will be used as an SPS30. The defaults shown above are inserted if the ADAPTER parameter is absent.
Parameter adptype
redun-type
N/A
The redundancy group function that the previously specified module set will perform: normal - 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.
3-22
Server
TABLE 3 -5.
SERVER Parameters
Field Length N/A Description 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 - Perform a core dump of the module, then reboot.
Parameter cdump-state
function
N/A
Specifies the Ethernet redundancy model that will be used when the HWTYPE is PNS10 or PNS30: enet - 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.
oper-state
N/A
The operational state of the server module in the GSX chassis: inservice - 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 - Not active, able to be removed or reconfigured. enabled - Active. Not configurable until taken outofservice and disabled.
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
To display the status of this module:

% SHOW SERVER SHELF 1 SLOT 6 STATUS
Node: TPUBS Date: 2001/05/22 20:16:48 GMT Zone: GMTMINUS05-EASTERN-US 1 6 CNS30 2 0 810-00420 7 8/11/2000 0060003563 V03.03.00 A009 V01.04.00 R000
Shelf: Slot: Hardware Type: Hardware Type Rev: EPLD Rev: Part Number: Part Number Rev: Manufacture Date: Serial Number: Software Version: Firmware Version:
Server
3-23
Redundancy Mode: ACTIVE Temperature: 28C Memory Utilization: 35% Total Memory Size: 0x3400000 Total Shared Memory Size: 0x2000000 Total Available Memory Size: 0x217afe8 Total Available Shared Memory Size: 0x400700 CPU Utilization: 18%
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
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

Node: TPUBS Date: 2001/05/22 20:22:52 GMT Zone: GMTMINUS05-EASTERN-US
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
To display the configuration of this module:

% SHOW SERVER SHELF 1 SLOT 7 ADMIN
3-24
Server
Shelf: Slot: Server HwType: Adapter HwType: State: Mode: Action: Redundancy Role: Server Function: Core Dump State:
1 7 CNS25 CNA25 ENABLED INSERVICE FORCE NORMAL E1 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

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 ------- Server ------Installed Configured CNS30 CNS30 CNS30 CNS30 ------- Adapter -----Installed Configured UNKNOWN CNA30 UNKNOWN CNA30
Shelf 1 1
Slot 14 15
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 ..
Server Flash
3-25
ADAPTER pna30 FUNCTION enetLayer3 normal % CONFIGURE SERVER SHELF 1 SLOT 10 STATE enabled
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 4-17, GSX System Tree). The file mns10b.bin will be written to MNS1xs, the file cns10b.bin will be written to CNS10s and so on. 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
CONFIGURE SERVER FLASH SHELF shelfnumber .. SLOT slotnumber UPGRADE NOW SHOW SERVER FLASH SHELF shelfnumber .. SLOT slotnumber STATUS MONITOR SERVER FLASH SHELF shelfnumber .. SLOT slotnumber STATUS
Command Parameters
TABLE 3 -6.
Module Flash Parameters

Field Length N/A N/A Description The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. The slot number occupied by the module. For MNS hardware modules, this number must be 1 or 2. For all other modules, this number must be 3-16.
Command Example
To update the boot PROM in the MNS1x module in slot 1 from the current GSX System Tree:
% CONFIGURE SERVER FLASH SHELF 1 SLOT 1 UPGRADE NOW
To display the status of the flash on this module:

% SHOW SERVER FLASH SHELF 1 SLOT 1 STATUS
3-26
Software Upgrade
Shelf: Slot: State: Last Status:
1 1 IDLE UNKNOWN
Software Upgrade LSWU

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 Performing Live Software Upgrades on page 4-20 for a comprehensive explanation and example of the use of this facility.
Command Syntax
CONFIGURE SOFTWARE UPGRADE SHELF shelf .. DIRECTORY directory CONFIGURE SOFTWARE UPGRADE SHELF shelf .. UNPROTECTED CONTROL upcntl CONFIGURE SOFTWARE UPGRADE SHELF shelf INITIALIZE CONFIGURE SOFTWARE UPGRADE SHELF shelf .. INITIALIZE OVERRIDE FEATURES CONFIGURE SOFTWARE UPGRADE SHELF shelf UPGRADE NOW CONFIGURE SOFTWARE UPGRADE SHELF shelf COMMIT DIRECTORY SHOW SOFTWARE UPGRADE SHELF shelf SLOT slot STATUS SHOW SOFTWARE UPGRADE SHELF shelf STATUS SHOW SOFTWARE UPGRADE SHELF shelf ADMIN SHOW SOFTWARE UPGRADE SHELF shelf SUMMARY MONITOR SOFTWARE UPGRADE SHELF shelf SUMMARY MONITOR SOFTWARE UPGRADE SHELF shelf STATUS
Redundancy Group
3-27
Command Parameters
TABLE 3 -7.
SOFTWARE UPGRADE Parameters

Field Length N/A N/A Description The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. The slot number occupied by the module. For MNS hardware modules, this number must be 1 or 2. For all other modules, this number must be 3-16. Specifies the handling of server modules that are In Service, but not protected by redundancy during a Live Software Upgrade. upgrade - 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.
Parameter shelf slot
upcntl
N/A
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 4-17 on page 4-70.
Command Example
See Performing Live Software Upgrades on page 4-20.
Redundancy Group
This object identifies two or more GSX9000 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 GSX9000 via the CREATE SERVER .. ADAPTER .. redundant command. See Server on page 3-16 for additional information. The default name of the redundancy group is modname-shn-sln or modname-shn, where modname is the full server module name, shn is the shelf number, and sln is the slot number. PNS20 redundancy groups use the first convention, and all others the second convention. For example, CNS30-1 identifies the CNS30 redundancy group that
3-28
Redundancy Group
is established by adding a redundant CNS30/CNA03 module set to shelf 1. PNS20-15 identifies the PNS20 redundancy group that is established by adding a redundant PNS20/PNA21 module set to slot 5 of shelf 1. This name (for example, CNS30-1) 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 is removed via the DELETE SERVER .. ADAPTER command. Two redundancy models are supported:
1. 2.
The 1:1 model in which a redundancy group is assigned a single redundancy client (server module). This model is used by MNS1xs and PNS20s. 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, PNS10, and PNS30 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. 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. The following events may cause a switchover:
1. 2. 3. 4. 5. 6. 7.
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. Client Reset - A redundancy client is reset either by pressing the front panel reset button or by issuing the CONFIGURE SLOT SHELF...RESET command. 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 MNA10 or a PNA10 by the link verification mechanism, see Static Routes (IP Routing Table) on page 3-91. CLI Switchover - A switchover is initiated by issuing one of the CONFIGURE REDUNDANCY GROUP...SWITCHOVER/REVERT commands.
8.
On a switchover, all relevant stable calls are preserved. (Relevance is dependent on the GSX server modules that are switching over; for MNS 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. CLI initiated switchovers from the above list may be one of two types as indicated by the keywords:
1.
SWITCHOVER
Redundancy Group
3-29
A switchover is carried out cooperatively or arbitrarily, as discussed in the options below. Switchovers may be used if a redundancy client is active for the redundancy group or if a redundant server module is active for a 1:1 redundancy group.
2.
REVERT
This switchover permits a previously failed client to return as the active module after it has recovered. This capability is useful because when the recovered client returns to standby as a result of a switchover, it protects the now active redundant module, but no other members of the redundancy group. After a revert, all redundancy clients are again protected. Revert may only be used if the redundant server module is active for any redundancy group. Each of these switchovers is further qualified by the keyword options:
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, described below, may be displayed via the SHOW REDUNDANCY GROUP .. STATUS command.
Status
Description The active and standby server modules are fully synchronized such that the standby is ready to take over if the active fails. 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.
ACTIVESYNCED ACTIVENOTSYNCED
The table below summarizes the conditions and consequences of switchovers using either redundancy model:
3-30
Redundancy Group
CLI Imposed Switchovers in 1:1 and N:1 Redundancy Model

CLI Command Normal Switchover Normal Switchover Forced Switchover Forced Switchover Revert Revert Revert Client State ACTIVESYNCED ACTIVENOTSYNCED ACTIVESYNCED ACTIVENOTSYNCED ACTIVESYNCED or ACTIVENOTSYNCED STANDBY STANDBY Redundant Slot State STANDBY Stable Calls Preserved
(Normal Switchover is not allowed unless the client is ACTIVESYNCED) STANDBY STANDBY Preserved Dropped
(Revert is not allowed unless the client state is STANDBY) ACTIVESYNCED ACTIVENOTSYNCED Preserved Dropped
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 (and MNS11s are assigned to redundancy group MNS11-1) which is created and enabled when the GSX is booted. The MNS1x in slot 2 is the redundant module and the MNS1x in slot 1 is the client in this group.
Command Syntax
CONFIGURE REDUNDANCY GROUP rgroupname .. FALLBACK REVERTIVE TIMEOUT timeout FALLBACK NONREVERTIVE AUTO DETECT autodetect HEALTHCHECK healthcheck CONFIGURE REDUNDANCY GROUP rgroupname NAME newrgname
Note
In the syntax that follows, CLIENT SLOT may be omitted for 1:1 redundancy groups and NORMAL may be omitted in all cases. All permutations are shown in the syntax.
CONFIGURE REDUNDANCY GROUP rgroupname .. SWITCHOVER NORMAL CONFIGURE REDUNDANCY GROUP rgroupname .. SWITCHOVER NORMAL CLIENT SLOT slotnumber CONFIGURE REDUNDANCY GROUP rgroupname .. SWITCHOVER CLIENT SLOT slotnumber CONFIGURE REDUNDANCY GROUP rgroupname .. SWITCHOVER FORCED CLIENT SLOT slotnumber CONFIGURE REDUNDANCY GROUP rgroupname .. SWITCHOVER FORCED CONFIGURE REDUNDANCY GROUP rgroupname REVERT
Redundancy Group
3-31
CONFIGURE REDUNDANCY GROUP rgroupname REVERT NORMAL CONFIGURE REDUNDANCY GROUP rgroupname REVERT FORCED CONFIGURE REDUNDANCY GROUP rgroupname .. STATE admin-state SHOW REDUNDANCY GROUP SUMMARY SHOW REDUNDANCY GROUP rgroupname STATUS SHOW REDUNDANCY GROUP rgroupname ADMIN
Command Parameters
TABLE 3 -8.
REDUNDANCY GROUP Parameters

Field Length 1-23 Description The automatically assigned (and possibly changed) name of this redundancy group. See the beginning of this section for the structure of the default name. The slot number occupied by the client or redundant server module. For MNS1x hardware modules, this number must be 1 or 2. For all other modules, this number must be 3-16. 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. 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 MNS1x redundancy group is automatically created and configured, regardless of this parameter setting.) disabled - all clients must be manually assigned to the redundancy group.
Parameter rgroupname
slotnumber
N/A
timeout
N/A
autodetect
N/A
healthcheck
N/A
Specifies whether the redundant server module will poll its clients to proactively discover failures: enabled - polling will be performed disabled - polling will not be performed.
3-32
Redundancy Group
TABLE 3 -8.
REDUNDANCY GROUP Parameters

Field Length 1-23 Description 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 GSX9000 software. The administrative state of the redundancy group: enabled - Synchronization and mirroring between the clients and the redundant module is active. disabled - 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).
Parameter newrgname
admin-state
N/A
Command Example
To direct an immediate switchover that uses the standby MNS11 module as the new active:
% CONFIG REDUNDANCY GROUP MNS11-1 SWITCHOVER NORMAL
To display the current status of the MNS11-1 redundancy group:

% SHOW REDUNDANCY GROUP MNS11-1 STATUS
-----------------------------------------------------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 Client Slot -------1 Client State ----------------ACTIVESYNCED
To display the current configuration of the MNS11-1 redundancy group:

% SHOW REDUNDANCY GROUP MNS11-1 ADMIN
-----------------------------------------------------REDUNDANCY GROUP CONFIGURATION -----------------------------------------------------Name: MNS11-1 Shelf: 1 Redundant Slot: 2
Redundancy Client
3-33
Hardware Type, Function: Fallback Control: Wait to Revert Time (Minutes): Auto Detect Control: Healthcheck Control: State: Client Slot -------1 Client State --------ENABLED
MNS11, MGMT NONREVERTIVE 5 DISABLED ENABLED ENABLED
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. In 1:1 redundancy models, only one redundancy client may be assigned per redundancy group. The 1:1 redundancy model is used by MNS1xs and PNS20s. 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 CNS, PNS10, and PNS30 modules. Normally, only like server modules may exist within a redundancy group. There is one exception: 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 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, MNS1xs are assigned to the redundancy groups MNS10-1 or MNS11-1, which are created and enabled when the GSX is booted. The MNS1x in slot 2 is the redundant module and the MNS1x in slot 1 is the redundancy client in this group.
Command Syntax
CREATE REDUNDANCY CLIENT GROUP rgroupname .. SLOT slotnumber CONFIGURE REDUNDANCY CLIENT GROUP rgroupname .. SLOT slotnumber STATE admin-state DELETE REDUNDANCY CLIENT GROUP rgroupname .. SLOT slotnumber
3-34
Non-Volatile Storage (NVS) Parameters
Command Parameters
TABLE 3 -9.
REDUNDANCY CLIENT Parameters

Field Length 1-23 Description The automatically assigned (and possibly changed) name of this redundancy group. See the beginning of this section for the structure of the default name. The slot number occupied by the client module. For MNS1x hardware modules, this number must be 1 or 2. For all other modules, this number must be 3-16. 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 - 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.
Parameter rgroupname
slotnumber
N/A
admin-state
N/A
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
To activate these clients:

% CONFIGURE REDUNDANCY CLIENT GROUP cns10-1 .. SLOT 4 STATE enabled % CONFIGURE REDUNDANCY CLIENT GROUP cns10-1 .. SLOT 5 STATE enabled % CONFIGURE REDUNDANCY GROUP cns10-1 STATE enabled
To delete the client in slot 4 from the redundancy group:

% CONFIGURE REDUNDANCY GROUP cns10-1 .. STATE disabled % CONFIGURE REDUNDANCY CLIENT GROUP cns10-1 .. SLOT 4 STATE disabled % DELETE REDUNDANCY CLIENT GROUP cns10-1 SLOT 4
Delete Redundancy Client - Confirm(y/n): y

% CONFIGURE REDUNDANCY GROUP cns10-1 STATE enabled

This object allows you to:
1.
Configure the Non-Volatile Storage parameters without accessing the GSX firmware,
3-35
2.
Modify the nodes Binary Parameter Mode, to control the loading of the binary parameter file when the GSX is booted.
On GSX9000s with redundant MNS1xs, SHOW and CONFIGURE commands to this object are performed by the active MNS1x. Any changes from these commands are copied to the standby MNS1x, keeping it synchronized with the active MNS1x.
Command Syntax
CONFIGURE NODE NVS SHELF shelfnumber .. PARAMETER MODE parameter-mode CORE DUMP LEVEL severity CORE DUMP STATE core-state CORE DUMP FILE LIMIT filelimit PASSWORD password CONFIGURE PARAM INCRPIF MAXFILES xincrpif SHOW NODE NVS SHELF shelfnumber ADMIN SHOW PARAMETER STATUS SHOW PARAMETER ADMIN MONITOR PARAMETER STATUS
3-36
Command Parameters
Note Sonus recommends that you do not configure the CORE DUMP parameter settings except as advised by authorized Sonus personnel.
TABLE 3 -10.
NVS Parameters
Field Length N/A N/A Description The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. 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. The status of Binary Parameter File loading on a reboot: 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. 2. 3.
Parameter shelfnumber filelimit
parametermode
N/A
file with .prm extension - first choice file with .bck extension - second choice 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 doesnt exist or cant 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.
3-37
TABLE 3 -10.
NVS Parameters
Field Length 1-23 Description NVS password. The NVS Password is necessary to
Parameter password
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 MNS1x module to Sonus to recover.
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. 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 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.
Command Example
To display administrative information about the NVS parameter values in this module:
% SHOW NODE NVS SHELF 1 ADMIN
Node: TPUBS Date: 2000/04/22 01:04:52 GMT Zone: GMTMINUS05-EASTERN-US 1 5 MASTER DISABLED NORMAL Parameter Mode: CLI Script File: Loadfile Primary: Loadfile Secondary: Core Dump File Limit: BINARYFILE sysinit.tcl mns10.bin mns10_sec.bin 6
Shelf: Boot Delay: Master Shelf State: Core Dump State: Core Dump Level:
Slot 1 IP Address Ethernet Port 1: 10.6.10.190 Ethernet Port 2: 10.6.10.191 Field Service Port: 10.5.10.96 Slot 2 Ethernet Port 1: Ethernet Port 2: IP Address 10.6.10.192 10.6.10.193
Subnet Mask 255.255.0.0 255.255.0.0 255.255.0.0 Subnet Mask 255.255.0.0 255.255.0.0
Default Gateway 0.0.0.0 0.0.0.0 10.5.254.250 Default Gateway 0.0.0.0 0.0.0.0
3-38
NFS Parameters
Field Service Port: 10.5.10.97
255.255.0.0
10.5.254.250
To display the configuration of GSX parameter files:

% SHOW PARAM ADMIN
Node: TPUBS Date: 2001/08/06 15:17:21 GMT Zone: GMTMINUS05-EASTERN-US 10
Max incremental PIFs:
Warning
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 MNS1x module to Sonus to recover.
NFS Parameters
This object allows you to configure the GSX file system that is provided by the redundant NFS servers. The WRITE-ENABLE keywords may be necessary after an NFS server exceeds a quota. Use this command to restore the GSX file system after freeing up disk space on the server.
Command Syntax
CONFIGURE NFS SHELF shelfnumber .. PRIMARY SERVER ipaddress SECONDARY SERVER ipaddress PRIMARY MOUNTPOINT mountpoint SECONDARY MOUNTPOINT mountpoint LOAD PATH loadpath UNIX USERID unixuid UNIX GROUPID unixgid CONFIGURE NFS SHELF shelfnumber SLOT slotnumber .. MOUNT PRIMARY CONFIGURE NFS SHELF shelfnumber SLOT slotnumber .. MOUNT SECONDARY CONFIGURE NFS SHELF shelfnumber SLOT slotnumber .. UNMOUNT STANDBY CONFIGURE NFS SHELF shelfnumber SLOT slotnumber .. WRITE-ENABLE PRIMARY CONFIGURE NFS SHELF shelfnumber SLOT slotnumber .. WRITE-ENABLE SECONDARY CONFIGURE NFS SHELF shelfnumber SLOT slotnumber .. TOGGLE ACTIVE SHOW NFS SHELF shelfnumber SLOT slotnumber STATUS SHOW NFS SHELF shelfnumber ADMIN
NFS Parameters
3-39
SHOW SNMP STATS
Command Parameters
TABLE 3 -11.
NFS Parameters
Field Length N/A N/A Description The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. The slot number occupied by the MNS module being accessed by this command. Because it is an MNS module, this value must be 1 or 2. The 32-bit IP address of the NFS server specified in dotted decimal form (for example 128.127.50.224). The NFS mount path. 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. The user ID of the UNIX login account the GSX uses for NFS file operations, default 1036. The group ID of the UNIX login account the GSX uses for NFS file operations, default 101. Specifies the maximum number of incremental PIF files saved per NFS 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.
ipaddress mountpoint loadpath
N/A 1-31 1-31
unixuid unixgid xincrpif
N/A N/A N/A
Command Example
To point NFS to a new GSX System Tree anchored at subdirectory testtree:
% CONFIGURE NFS SHELF 1 SLOT 1 LOAD PATH testtree
To display status information about the NFS servers:

% SHOW NFS SHELF 1 SLOT 1 STATUS
Node: TPUBS Date: 1999/12/14 16:11:14 GMT Zone: GMTMINUS05-EASTERN-US Active NFS Server: Standby NFS Server: Last Error: NONE NONE PRIMARY SECONDARY IP Address: 128.6.254.210 128.6.254.249 Mount Path: /SonusNFS /SonusNFS
Shelf: Slot:
1 1
NFS Server: Status: Primary MOUNTED Secondary MOUNTED
To display configuration information about the NFS servers:

% SHOW NFS SHELF 1 ADMIN
3-40
NTP Server
Zone: GMTMINUS05-EASTERN-US Shelf: UNIX User ID: NFS Server: Primary Secondary 1 1036 NFS Load Path: DEMON UNIX Group ID: 101 Mount Path: /SonusNFS /SonusNFS
IP Address: 128.6.254.210 128.6.254.249
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.
Command Syntax
CREATE NTP SERVER servername CONFIGURE NTP SERVER servername .. IPADDRESS ipaddress CLIENT client-type VERSION vnumber MINPOLL mnnumber MAXPOLL mxnumber CONFIGURE NTP SERVER servername STATE admin-state SHOW NTP SERVER servername ADMIN SHOW NTP SERVER servername STATUS SHOW NTP SERVER ALL ADMIN SHOW NTP SERVER ALL STATUS SHOW NTP TIME DELETE NTP SERVER servernumber
NTP Server
3-41
Command Parameters
TABLE 3 -12.
NTP Server Parameters

Field Length 1-23 N/A N/A Description A unique name that specifies which server is being addressed. The 32-bit IP address of the server specified in dotted decimal form (for example 128.127.50.224). The mode used by the server to provide time: poll - The client polls the server. broadcast - The server broadcasts to clients.
Parameter servername ipaddress client-type
vnumber mnnumber mxnumber admin-state
N/A N/A N/A N/A
The NTP version number that is supported by the client (GSX). Must be 1-3, default is 3. The minimum polling interval in seconds for the
poll client-type.. Range: 1-63, default: 3

The maximum polling interval in seconds for the
poll client-type. Range: 1-63, default: 10

The administrative state of the NTP server: disabled - Server is not activated. enabled - Server is activated.
Command Example
To create NTP server ntp1:
% CREATE NTP SERVER ntp1
To configure this server in broadcast mode and activate it:

% CONFIG NTP SERVER ntp1 IPADDRESS 128.1.1.2 % CONFIG NTP SERVER ntp1 VERSION 3 CLIENT broadcast % CONFIG NTP SERVER ntp1 STATE enabled
To display configuration information about all configured NTP servers:

% SHOW NTP SERVER ALL ADMIN
Node: None Date: 1999/05/05 14:56:34 Zone: GMTMINUS05-EASTERN-US
Server IpAddress Client Vers MinPoll MaxPoll State -------------------------------------------------ntp1 128.1.1.2 POLL 3 3 10 ENABLED
To display status information about all configured NTP servers:

% SHOW NTP SERVER ALL STATUS
Node: None Date: 1999/05/24 23:56:32 GMT Zone: GMTMINUS05-EASTERN-US
Server Shelf State Stratum Reference Time --------------------------------------------------NTP1 1 INSYNC 1 1999/05/24 23:54:01
To delete NTP server ntp1:

% DELETE NTP SERVER ntp1
3-42
Management Client
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. 2. 3.
SNMPv1 Trap SNMPv2 Trap 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 resend 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-53) but only a small subset of events generate an SNMP trap message. Table 4 -1, Sonus GSX Trap Names, lists all GSX traps and the full MIB name of the trap.
Command Syntax
CREATE MGMT CLIENT client IPADDRESS ipaddress CONFIGURE MGMT CLIENT client .. IPADDRESS ipaddress ACCESS access GET COMMUNITY gcommunity SET COMMUNITY scommunity TRAP COMMUNITY tcommunity TRAP STATE trap-state TRAP PORT trap-port ALL TRAPS trap-type INFORM TIMEOUT timeout INFORM RETRIES retries INFORM QUEUE queuesize CONFIGURE MGMT CLIENT client STATE admin-state SHOW MGMT CLIENT client ADMIN SHOW MGMT CLIENT SUMMARY DELETE MGMT CLIENT client
Management Client
3-43
Command Parameters
TABLE 3 -13.
Management Client Parameters

Field Length 1-23 N/A Description The name that you are assigning to this network management station (client). The 32-bit IP address of this network management station specified in dotted decimal form (for example 128.127.50.224). Default is 0x01010101. A second level of authentication that identifies access privileges for this management client. readOnly - Read only. readWrite - Read and write of all management objects except those restricted to admin access. admin - Full administrative privileges to all management objects.
Parameter client ipaddress
access
N/A
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. 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. 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. 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 occured from the GSX perspective. Must be 1-120, default is 5 (seconds). This parameter applies only to trap-type inform.. At least two digits must be entered, for example 05.
scommunity
1-23
tcommunity
1-23
timeout
N/A
3-44
Management Client
TABLE 3 -13.

Field Length N/A Description 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 totrap-type inform. Two digits must be entered, for example 05.
Parameter retries
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 totrap-type inform.
trap-state
N/A
A flag that allows this network management station to receive SNMP trap messages: disabled - 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 065535, default is 162.
Management Client
3-45
TABLE 3 -13.

Field Length N/A Description 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 - (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.
Parameter trap-type
admin-state
N/A
The administrative state of the network management station: disabled - 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.
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 Ip Address 128.1.1.1 128.1.1.2 Access ADMIN ADMIN State ENABLED ENABLED
Name GRANITE SLATE
3-46
Trap
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
To display the configuration of the management client slate:

% SHOW MGMT CLIENT slate ADMIN
Node: TPUBS Date: 2000/04/25 20:33:43 GMT Zone: GMTMINUS05-EASTERN-US slate ENABLED 10.6.254.249 ADMIN public private public ENABLED 162 TRAPV2 5 3 50
Name: State: IP Address: Access: Get Community: Set Community: Trap Community: Trap State: Trap Port: All Traps: Inform Timeout: Inform Retries: Inform Queue:
Trap
This object provides:
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 youre 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
CONFIGURE TRAP trap STATE admin-state SHOW TRAP trap ADMIN SHOW TRAP SUMMARY
Trap
3-47
Command Parameters
TABLE 3 -14.
Trap Parameters
Field Length 1-23 N/A Description The name of the trap. The administrative state of this trap: disabled - 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.
Parameter trap admin-state
Command Example
To display the trap table:
% SHOW TRAP SUMMARY
Name shelfPowerA48VdcNormal shelfPowerB48VdcNormal shelfPowerA48VdcFailure shelfPowerB48VdcFailure shelfFanTrayFailure shelfFanTrayOperational shelfFanTrayRemoved shelfFanTrayPresent shelfIntakeTempWarning serverTempWarning serverTempFailure serverInserted State ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED
...
To display the configuration of the Shelf Fan Tray Failure trap:

% SHOW TRAP shelfFanTrayFailure ADMIN
Node: None Date: 1999/06/16 21:39:34 GMT Zone: GMTMINUS05-EASTERN-US shelfFanTrayFailure sonusNodeShelfFanTrayFailureNotification 1.3.6.1.4.1.2879.2.1.1.2.0.5 SYSMGMT MAJOR ENABLED
Name: MIB Name: OID: Class: Level: State:
The fields in the above display are:
Name - name of the trap. MIB Name - full MIB name of this trap. OID - MIB Object Identifier of this trap. Class - classification of the event corresponding to this trap. See Event Log on page 3-53. Level - severity level of the event corresponding to this trap. See Event Log on page 3-53. State - the administrative state of this trap.
3-48
Notification
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
CREATE NOTIFICATION notification .. MGMT CLIENT client TRAP trap CONFIGURE NOTIFICATION notification .. MGMT CLIENT client TRAP trap TYPE trap-type SHOW NOTIFICATION notification ADMIN SHOW NOTIFICATION SUMMARY DELETE NOTIFICATION notification
Command Parameters
TABLE 3 -15.
Notification Parameters
Field Length 1-23 1-23 Description The name that you are assigning to this notification. 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-42). The name of the trap. This trap must be defined in the Trap table (see Trap on page 3-46). 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-42. none - Do not enable all traps for this management client.
Parameter notification client
trap trap-type
1-23 N/A
Command Example
To create a notification named example1 that assigns one trap, shelfFanTrayFailure, to the network management station slate:
Alarm Contacts
3-49
% 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 Mgmt Client Name SLATE Trap Name SHELFFANTRAYFAILURE
Name EXAMPLE1
To display configuration information about Notification Table example1:

% SHOW NOTIFICATION example1 ADMIN
Node: None Date: 1999/06/17 18:25:34 GMT Zone: GMTMINUS05-EASTERN-US
Name: EXAMPLE1 Mgmt Client Name: SLATE Trap Name: SHELFFANTRAYFAILURE Type: TRAPV2
Alarm Contacts
There are 5 outbound physical alarm relay contacts and 5 inbound current sensing contacts located on the MNA. The GSX Installation Guide contains additional hardware related details. The state of the outbound alarm contacts is maintained by both MNS modules. Outbound contacts are only set by the active MNS module. Inbound contact state information will be maintained on the active MNS module.
Outbound Alarm Contact

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:
1. 2. 3. 4. 5.
Loss of shelf power Critical trap alarm Major trap alarm Minor trap alarm User configured
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 contact 5 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, howVersion 4.01, Document Version 2 GSX9000 Open Services Switch Operations Guide
3-50
Alarm Contacts
ever, 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 14 may be reset to their default state via the CONFIGURE CONTACTS commands.
Inbound Alarm Contact

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.
Command Syntax
CONFIGURE CONTACTS OUT SHELF shelf-number .. RELAY relay-number STATE state VALUE value SENSE sense START_DELAY start_delay CONFIGURE CONTACTS OUT SHELF shelf-number .. RELAY relay-number CUTOFF SHOW CONTACTS OUT ALL ADMIN SHOW CONTACTS OUT ALL STATUS SHOW CONTACTS OUT SHELF shelf-number ADMIN SHOW CONTACTS OUT SHELF shelf-number STATUS SHOW CONTACTS IN ALL ADMIN SHOW CONTACTS IN SHELF shelf-number STATUS
Alarm Contacts
3-51
Command Parameters
TABLE 3 -16.
Contacts Parameters
Field Length N/A N/A N/A Description The shelf number in the GSX node configuration. Must be 1. The outbound contact number. Outbound alarm contacts 2-5 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.
Parameter shelf-number relay-number state
value
N/A
The following values are valid for alarm 5 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-5 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 contact 5 is permanently set to 0.
Restrictions:

Outbound Alarm Contact 5
CUTOFF can not be set on alarm contact 5. The value never changes based on trap events or other system events. The user is able to change its administrative state using the CONFIGURE CONTACTS command.
Manually setting or clearing an alarm contact is only valid for contact 5. The start delay for alarm contact 5 is permanently set to 0 and can not be modified.
CUTOFF, SENSE, and STATE do not apply to outbound alarm contact 1.
The inbound alarm contacts may not be configured with the CONFIGURE CONTACTS commands.
Command Example
Obtain current contact status.
% SHOW CONTACTS OUT SHELF 1 ADMIN
3-52
Alarm Contacts
Zone: GMTMINUS05-EASTERN-US Alarm-Out Contact SHELFPWR-1 CRITICAL-2 MAJOR-3 MINOR-4 USER-5 Operational State ENABLED ENABLED ENABLED ENABLED ENABLED Default Value CLEAR CLEAR CLEAR CLEAR CLEAR Start Delay (seconds) 120 120 120 120 0
Shelf 1 1 1 1 1
Sense NORMAL NORMAL NORMAL NORMAL NORMAL
% SHOW CONTACTS OUT SHELF 1 STATUS

Node: TPUBS Date: 2000/08/25 18:34:07 GMT Zone: GMTMINUS05-EASTERN-US Status CLEAR CLEAR CLEAR CLEAR CLEAR Start Delay FALSE FALSE FALSE FALSE FALSE
Shelf 1 1 1 1 1
Alarm-Out-Contact SHELFPWR-1 CRITICAL-2 MAJOR-3 MINOR-4 USER-5
% SHOW CONTACTS IN SHELF 1 STATUS

Shelf 1 1 1 1 1
Alarm-In Contact 1 2 3 4 5
Status OPEN CLOSED OPEN OPEN 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 Operational State ENABLED ENABLED ENABLED DISABLED Default Value CLEAR CLEAR CLEAR CLEAR Start Delay (seconds) 120 120 120 120
Shelf 1 1 1 1
Alarm-Out Contact SHELFPWR-1 CRITICAL-2 MAJOR-3 MINOR-4
Sense NORMAL INVERTED NORMAL NORMAL
Event Log
3-53
USER-5
ENABLED
CLEAR
NORMAL
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
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 4-35 for additional detail on this facility. Accounting commands are described separately. See Accounting on page 3-158. The ROLLFILE facility provides a means of closing the active log file and opening a new one with an incremented 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 4-36 for additional filename detail.
Command Syntax
CONFIGURE EVENT LOG event-type .. NUMFILES numfiles FILESIZE filesize QUEUE qmesgno SAVETO log-dest EVMEMSIZE membufsize LEVEL filter-level CONFIGURE EVENT LOG event-type STATE admin-state CONFIGURE EVENT LOG event-type ROLLFILE NOW CONFIGURE EVENT LOG event-type ROLLFILE STOP CONFIGURE EVENT LOG event-type ROLLFILE START HH hh MM mm INTERVAL HH hh MM mm TYPE type CONFIGURE EVENT LOG ALL NUMFILES numfiles FILESIZE filesize QUEUE qmesgno SAVETO log-dest EVMEMSIZE membufsize
3-54
Event Log
LEVEL filter-level CONFIGURE EVENT LOG ALL STATE admin-state SHOW EVENT LOG event-type ADMIN SHOW EVENT LOG event-type SHELF shelfnumber STATUS SHOW EVENT LOG ALL ADMIN SHOW EVENT LOG ALL STATUS SHOW EVENT MEMORY SHELF shelfnumber .. LOG event-type INDEX event-range SHOW EVENT MEMORY SHELF shelfnumber .. LOG event-type ALL SHOW EVENT MEMORY ALL
Event Log
3-55
Command Parameters
TABLE 3 -17.
Event Log Parameters

Field Length N/A Description 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.
Parameter event-type
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-512, default is 512 for accounting, 32 for all others. 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. The number of event messages to queue before writing to disk. Must be 1-128, 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. 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 - log data is written to disk and to the internal memory buffer.
filesize
N/A
qmesgno
N/A
log-dest
N/A
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.
3-56
Event Log
TABLE 3 -17.
Event Log Parameters

Field Length N/A Description 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.
Parameter filter-level
This parameter should always be set to major under normal operating conditions.
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 - Logging is activated. shelfnumber event-range N/A N/A The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. The set of log entries in MNS1x 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. 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. 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.
mm
N/A
type
N/A
Event Filter
3-57
Command Example
To capture system events of major and critical criticality:
% CONFIGURE EVENT LOG system SAVETO disk LEVEL major
To examine the administrative status of logs of all types:

% SHOW EVENT LOG ALL ADMIN
File File Mem Rollover File Size Msg Save Size Filter Admin Start Time Interva Type Cnt (KB) Queue To (KB) Level State mm-dd,HH:MM min. Type -----------------------------------------------------------------------------SYSTEM 10 2048 10 BOTH 16 MINOR ENABLED N/A DEBUG 32 2048 10 BOTH 16 MAJOR ENABLED 04-25,22:10 10 REPETITIVE TRACE 32 2048 10 MEMORY 16 MAJOR ENABLED N/A ACCT 10 32768 10 BOTH 16 MAJOR ENABLED N/A
To schedule debug log rollovers starting at 6:30 PM at intervals of 10 minutes:

% CONFIGURE EVENT LOG debug ROLLFILE .. START HH 18 HH 30 INTERVAL HH 0 MM 10 TYPE repetitive
To stop scheduled debug log rollovers:

% CONFIGURE EVENT LOG debug ROLLFILE STOP
To immediately force a debug log rollover:

% CONFIGURE EVENT LOG debug ROLLFILE NOW
To display the configuration of the debug log:

% SHOW EVENT LOG debug ADMIN
File File Mem Rollover File Size Msg Save Size Filter Admin Start Time Interva Type Cnt (KB) Queue To (KB) Level State mm-dd,HH:MM min. Type -----------------------------------------------------------------------------DEBUG 32 2048 10 BOTH 16 MAJOR ENABLED 04-25,22:10 10 REPETITIVE
To display the status of the debug log:

% SHOW EVENT LOG debug SHELF 1 STATUS
File/Mem File/Mem File/Mem Next Admin Current Recs KBytes Events Rollover Shelf Type State File Logged Logged Dropped (min.) -----------------------------------------------------------------------------1 DEBUG ENABLED 100000F.DBG 69 6 0 5 455 23 0
Event Filter
This object allows you to fine tune the log file by selecting only events that:
are associated with a specific software subsystem are of a specific criticality occurred on a specific GSX module.
3-58
Event Filter
See Event Filters on page 4-38 for additional detail on this subject.
Command Syntax
CONFIGURE EVENT FILTER SHELF shelfnumber .. SLOT slotnumber LOG event-type CLASS ALL LEVEL filter-level MODE filter-state CONFIGURE EVENT FILTER SHELF shelfnumber .. SLOT slotnumber LOG event-type CLASS class-name LEVEL filter-level MODE filter-state SHOW EVENT FILTER ALL ADMIN SHOW EVENT FILTER ALL STATUS SHOW EVENT FILTER SHELF shelfnumber .. SLOT slotrange LOG event-type CLASS class-name STATUS SHOW EVENT FILTER SHELF shelfnumber .. SLOT slotrange LOG event-type CLASS class-name ADMIN SHOW EVENT FILTER SHELF shelfnumber .. SLOT slotrange LOG event-type CLASS ALL STATUS SHOW EVENT FILTER SHELF shelfnumber .. SLOT slotrange LOG event-type CLASS ALL ADMIN SHOW EVENT FILTER SHELF shelfnumber .. SLOT slotrange ALL ADMIN SHOW EVENT FILTER SHELF shelfnumber ..
Event Filter
3-59
SLOT slotrange ALL STATUS
3-60
Event Filter
Command Parameters
TABLE 3 -18.
Event Filter Parameters

Field Length N/A N/A N/A Description The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. The slot number occupied by the module being configured for logging events. 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.
Parameter shelfnumber slotnumber event-type
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 - Filter is not activated. on - Filter is activated.
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
1,3,5,8,10,12,14,15, and 16.

Event Filter
3-61
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
3-62
Event Filter
To examine the status of all event logs:

% SHOW EVENT LOG ALL STATUS
Node: TPUBS Date: 1999/09/08 16:30:39 GMT Zone: GMTMINUS05-EASTERN-US File/Mem Recs Logged ---------9951 23644 100000F.DBG 14002 14002 0 147 RECOVERING 0 37833529 Current File ----------1000001.SYS File/Mem KBytes Logged -------1729 2692 1599 956 0 10 0 1842455 File/Mem Events Dropped ---------0 0 0 0 147 0 35300776 0
Admin Shelf Type State ----- ------ -------1 SYSTEM ENABLED 1 1 1 DEBUG TRACE ACCT ENABLED ENABLED ENABLED
In this report, the Current File field may contain:
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.
To examine the status of all event filters in the node:

% SHOW EVENT FILTER ALL STATUS
Node: TPUBS Date: 1999/09/08 19:35:41 GMT Zone: GMTMINUS05-EASTERN-US Event Class --------SYSMGMT CALLPROC RESMGMT DIRECTORY NETMGMT SIGNALING ROUTING SYSMGMT CALLPROC RESMGMT DIRECTORY NETMGMT SIGNALING ROUTING SYSMGMT CALLPROC RESMGMT DIRECTORY Events Filtered -------1 0 0 0 68 0 0 49 4251390 195341885 126117 0 116807830 22 0 0 0 0
Shelf ----1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 . . . . 1 1 1
Slot ---1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1
Type -----SYSTEM SYSTEM SYSTEM SYSTEM SYSTEM SYSTEM SYSTEM DEBUG DEBUG DEBUG DEBUG DEBUG DEBUG DEBUG TRACE TRACE TRACE TRACE
3 3 3
DEBUG DEBUG DEBUG
CALLPROC 100204003 RESMGMT 10545472 DIRECTORY 0
Call Trace Filter
3-63
1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1
3 3 3 3 3 3 3 3 3 3 4 4 4 4 4 4
DEBUG DEBUG DEBUG TRACE TRACE TRACE TRACE TRACE TRACE TRACE SYSTEM SYSTEM SYSTEM SYSTEM SYSTEM SYSTEM
NETMGMT SIGNALING ROUTING SYSMGMT CALLPROC RESMGMT DIRECTORY NETMGMT SIGNALING ROUTING SYSMGMT CALLPROC RESMGMT DIRECTORY NETMGMT SIGNALING
0 39564146 8 0 0 0 0 0 0 0 0 0 1 0 0 0
Call Trace Filter CallTrace

This object allows you to add call events to the system trace data event log. Calls may be selected by Called Party Number and/or Calling Party Number. Call events captured are:
Call attempt Lookup request sent Lookup request received Alerting received Cut-through received Call Answer received Cut-through complete Service established Disconnect Request received Call terminated Wait for more digits Extra digits received Circuit Network Server (CNS) reply Initiating new attempt Signal messages received or sent Completion of allocation of Ingress/Egress Circuit End Point (CEP) Reservation Completion of CNS Egress Allocation and Binding Egress call setup message Collision detected Route lookup failure Call blocked
The TRC event log LEVEL must be info for this facility to operate properly.
3-64
Call Trace Filter
Warning
You should not turn on the Call Trace Filter to trace all calls. Doing so could cause poor system performance, or resets. Use this mechanism to trace a specific type of call.
Command Syntax
CREATE CALL TRACE FILTER ctfilter CONFIGURE CALL TRACE FILTER ctfilter .. TYPE CALLEDANDCALLING CALLED cpartynum CALLING cpartynum CONFIGURE CALL TRACE FILTER ctfilter .. TYPE CALLEDONLY CALLED cpartynum CONFIGURE CALL TRACE FILTER ctfilter .. TYPE CALLINGONLY CALLING cpartynum CONFIGURE CALL TRACE FILTER ctfilter LEVEL level CONFIGURE CALL TRACE FILTER ctfilter .. STATE admin_state SHOW CALL TRACE FILTER ctfilter ADMIN SHOW CALL TRACE FILTER ALL ADMIN DELETE CALL TRACE FILTER ctfilter
Call Trace Filter
3-65
Command Parameters
TABLE 3 -19.
CALL TRACE FILTER Parameters

Field Length N/A Description The name of a call trace filter that will be applied to the system trace data log file. This filter may be created, configured, or deleted. The filter level or minimum severity that warrants the capture of this call data: level1 - trace everything level2 - trace everything but raw hex dumps level3 -trace only external message information (ISDN/ISUP/CAS etc.) and errors
Parameter ctfilter
level
N/A
admin-state
N/A
The administrative state of this filter: disabled - 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.
cpartynum
N/A
The Called or Calling Party Number. X or x means accept anything in that digit position. For example 617xxx1212. % means accept anything for the rest of the string. For example, 978% to trace all calls with a 978 prefix.
Command Example
To create, configure, and enable a call trace filter, filter508, to log all calls from exchange 435 to exchange 366 in the 508 area code:
% CREATE CALL TRACE FILTER filter508 % CONFIGURE CALL TRACE FILTER filter508 .. TYPE CALLEDANDCALLING CALLED 508366xxxx CALLING 508435xxxx % CONFIGURE CALL TRACE FILTER filter508 .. STATE enabled
To examine the configuration of this call trace filter:

% SHOW CALL TRACE FILTER filter508 ADMIN
Call Trace filter508 Configuration Index: Admin. State: Type: Called: Calling: Level:
1 ENABLED CALLEDCALLING 508366XXXX 508435XXXX LEVEL1
3-66
Call Trace Filter
Each trace log entry contains the standard Event Log header followed by CALL:, trace filter name, and GCID. The remainder of the entry varies depending on the call event type. The example below shows a level 1, level 2, and level 3 call trace for an ISDN call that is looped back. LEVEL 1
165 02232001 190659.00005:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0xFFFFFFFF: Incoming call, called number=2124567, calling number=1112222 189 02232001 190659.00012:1.08.Info .SG :CALL:FILTER=yabba GCID= 0x00070002: Allocation of inbound Circuit EndPoint (CEP) success, called= 2124567, calling=1112222 128 02232001 190659.00013:1.08.Info .CC :CALL:FILTER=yabba GCID= 0x00070002: Initiating call attempt 142 02232001 190659.00014:1.08.Info .CC :CALL:FILTER=yabba GCID= 0x00070002: Directory Services (DS) query request 155 02232001 190659.00017:1.01.Info .DS :CALL:FILTER=yabba GCID= 0x00070002: Softswitch frame sent POLICY_REQUEST to sustaining1 396 02232001 190659.00018:1.01.Info .DS :CALL:FILTER=yabba GCID= 0x00070002: Softswitch hex output sent (part 1) FE0900C800070002000000000000000100100009000000010000006C00000007001800090 00000010000000000000000000000000000000C00140009000000013A96B4D30000000C00 00000E001400090000000154475053544E340000000009001C00080000000100010131313 1323232320000010100000000000B00100009 284 02232001 190659.00019:1.01.Info .DS :CALL:FILTER=yabba GCID= 0x00070002: Softswitch hex output sent (part 2) 00000001FF00000000000008001C000900000001000101323132343536370000000000000 000000D0010000900000001000000000000002D00140009000000018000070002000000 179 02232001 190659.00020:1.01.Info .DS :CALL:FILTER=yabba GCID= 0x00070002: Softswitch frame received POLICY_RESPONSE status = SUCCESS from sustaining1 400 02232001 190659.00021:1.01.Info .DS :CALL:FILTER=yabba GCID= 0x00070002: Softswitch hex output received (part 1) FE09010C00070002000000000000000100100009000000010000006D00000003001000080 0000001000000000000000700180009000000010000000B00000000414C4C000000001300 5000080000000154414E44454D0000010000000100000000000B0000002C0000010100010 0020003000000000105000200030003000300 400 02232001 190659.00022:1.01.Info .DS :CALL:FILTER=yabba GCID= 0x00070002: Softswitch hex output received (part 2) 0300030000000000000000000000000102000301000000110014000800000001524F55544 5303100000000100030000800000001010554475053544E340000020A090A635601504945 52434500000000000000000000000000000014001400080000000144454641554C5400000 0000F0010000800000001313332000000002E 168 02232001 190659.00023:1.01.Info .DS :CALL:FILTER=yabba GCID= 0x00070002: Softswitch hex output received (part 3) 001000080000000105000000 221 02232001 190659.00024:1.08.Info .CC :CALL:FILTER=yabba GCID= 0x00070002: Directory Services (DS) query response success, num routes = 1, route1=10.99.86.1:TGPSTN4, route2=, route3=, route4= 133 02232001 190659.00029:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070002: Sent ISDN frame CALL_PROC_REQ 170 02232001 190659.00034:1.08.Info .CC :CALL:FILTER=yabba GCID= 0x00070002: Outbound (Egress) CNS resource reply received, trunk group name = 129 02232001 190659.00039:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070002: Sent ISDN frame SETUP_REQ 137 02232001 190659.00046:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070002: Received ISDN frame CALL_PROC_IND 190 02232001 190659.00050:1.08.Info .SG :CALL:FILTER=yabba GCID=
Call Trace Filter
3-67
0x00070002: Allocation of outbound Circuit EndPoint (CEP) success, called= 2124567, calling=1112222 154 02232001 190659.00054:1.08.Info .SG :CALL:FILTER=yabba GCID= 0x00070002: Binding of outbound Circuit EndPoint (CEP) success 136 02232001 190659.00055:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070002: Received ISDN frame ALERTING_IND 137 02232001 190659.00057:1.08.Info .CC :CALL:FILTER=yabba GCID= 0x00070002: Alert Received from called number 199 02232001 190659.00062:1.08.Info .CC :CALL:FILTER=yabba GCID= 0x00070002: Cut thru received. The call is internally activated, inbound and outbound resources are active 135 02232001 190659.00066:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070002: Received ISDN frame CONNECT_IND 118 02232001 190659.00068:1.08.Info .CC :CALL:FILTER=yabba GCID= 0x00070002: Call answered 132 02232001 190659.00072:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070002: Sent ISDN frame ALERTING_REQ 128 02232001 190659.00076:1.08.Info .CC :CALL:FILTER=yabba GCID= 0x00070002: Call service established 131 02232001 190659.00080:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070002: Sent ISDN frame CONNECT_REQ 133 02232001 190724.00008:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070002: Received ISDN frame CLEAR_IND 111 02232001 190724.00010:1.08.Info .SG :CALL:FILTER=yabba GCID= 0x00070002: Release 119 02232001 190724.00011:1.08.Info .CC :CALL:FILTER=yabba GCID= 0x00070002: Call disconnect 128 02232001 190724.00030:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070002: Sent ISDN frame DISC_REQ 129 02232001 190724.00032:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070002: Sent ISDN frame CLEAR_REQ 134 02232001 190724.00034:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070002: Received ISDN frame CLEAR_CONF 134 02232001 190724.00038:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070002: Received ISDN frame CLEAR_CONF 118 02232001 190724.00040:1.08.Info .CC :CALL:FILTER=yabba GCID= 0x00070002: Call terminate ========================================================================= ===========================================
LEVEL 2
165 02232001 190902.00005:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0xFFFFFFFF: Incoming call, called number=2124567, calling number=1112222 189 02232001 190902.00012:1.08.Info .SG :CALL:FILTER=yabba GCID= 0x00070003: Allocation of inbound Circuit EndPoint (CEP) success, called= 2124567, calling=1112222 128 02232001 190902.00013:1.08.Info .CC :CALL:FILTER=yabba GCID= 0x00070003: Initiating call attempt 142 02232001 190902.00014:1.08.Info .CC :CALL:FILTER=yabba GCID= 0x00070003: Directory Services (DS) query request 155 02232001 190902.00017:1.01.Info .DS :CALL:FILTER=yabba GCID= 0x00070003: Softswitch frame sent POLICY_REQUEST to sustaining1 179 02232001 190902.00018:1.01.Info .DS :CALL:FILTER=yabba GCID= 0x00070003: Softswitch frame received POLICY_RESPONSE status = SUCCESS from sustaining1 133 02232001 190902.00021:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070003: Sent ISDN frame CALL_PROC_REQ 221 02232001 190902.00022:1.08.Info .CC :CALL:FILTER=yabba GCID=
3-68
Call Trace Filter
0x00070003: Directory Services (DS) query response success, num routes = 1, route1=10.99.86.1:TGPSTN4, route2=, route3=, route4= 170 02232001 190902.00028:1.08.Info .CC :CALL:FILTER=yabba GCID= 0x00070003: Outbound (Egress) CNS resource reply received, trunk group name = 129 02232001 190902.00034:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070003: Sent ISDN frame SETUP_REQ 137 02232001 190903.00005:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070003: Received ISDN frame CALL_PROC_IND 190 02232001 190903.00006:1.08.Info .SG :CALL:FILTER=yabba GCID= 0x00070003: Allocation of outbound Circuit EndPoint (CEP) success, called= 2124567, calling=1112222 154 02232001 190903.00012:1.08.Info .SG :CALL:FILTER=yabba GCID= 0x00070003: Binding of outbound Circuit EndPoint (CEP) success 136 02232001 190903.00014:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070003: Received ISDN frame ALERTING_IND 137 02232001 190903.00015:1.08.Info .CC :CALL:FILTER=yabba GCID= 0x00070003: Alert Received from called number 199 02232001 190903.00019:1.08.Info .CC :CALL:FILTER=yabba GCID= 0x00070003: Cut thru received. The call is internally activated, inbound and outbound resources are active 135 02232001 190903.00023:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070003: Received ISDN frame CONNECT_IND 118 02232001 190903.00024:1.08.Info .CC :CALL:FILTER=yabba GCID= 0x00070003: Call answered 132 02232001 190903.00028:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070003: Sent ISDN frame ALERTING_REQ 128 02232001 190903.00031:1.08.Info .CC :CALL:FILTER=yabba GCID= 0x00070003: Call service established 131 02232001 190903.00035:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070003: Sent ISDN frame CONNECT_REQ 133 02232001 190923.00008:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070003: Received ISDN frame CLEAR_IND 111 02232001 190923.00009:1.08.Info .SG :CALL:FILTER=yabba GCID= 0x00070003: Release 119 02232001 190923.00010:1.08.Info .CC :CALL:FILTER=yabba GCID= 0x00070003: Call disconnect 128 02232001 190923.00029:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070003: Sent ISDN frame DISC_REQ 129 02232001 190923.00030:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070003: Sent ISDN frame CLEAR_REQ 134 02232001 190923.00031:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070003: Received ISDN frame CLEAR_CONF 134 02232001 190923.00034:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070003: Received ISDN frame CLEAR_CONF 118 02232001 190923.00035:1.08.Info .CC :CALL:FILTER=yabba GCID= 0x00070003: Call terminate ========================================================================= ======================================
LEVEL 3
165 02232001 191039.00005:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0xFFFFFFFF: Incoming call, called number=2124567, calling number=1112222 133 02232001 191039.00026:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070004: Sent ISDN frame CALL_PROC_REQ 129 02232001 191039.00027:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070004: Sent ISDN frame SETUP_REQ 137 02232001 191039.00032:1.08.Info .ISDN :CALL:FILTER=yabba GCID=
PNS10 Network Interface (Ethernet NIF)
3-69
0x00070004: Received ISDN frame CALL_PROC_IND 136 02232001 191039.00039:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070004: Received ISDN frame ALERTING_IND 135 02232001 191039.00046:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070004: Received ISDN frame CONNECT_IND 132 02232001 191039.00050:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070004: Sent ISDN frame ALERTING_REQ 131 02232001 191039.00056:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070004: Sent ISDN frame CONNECT_REQ 133 02232001 191051.00003:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070004: Received ISDN frame CLEAR_IND 119 02232001 191051.00004:1.08.Info .CC :CALL:FILTER=yabba GCID= 0x00070004: Call disconnect 128 02232001 191051.00015:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070004: Sent ISDN frame DISC_REQ 129 02232001 191051.00018:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070004: Sent ISDN frame CLEAR_REQ 134 02232001 191051.00021:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070004: Received ISDN frame CLEAR_CONF 134 02232001 191051.00028:1.08.Info .ISDN :CALL:FILTER=yabba GCID= 0x00070004: Received ISDN frame CLEAR_CONF 118 02232001 191051.00029:1.08.Info .CC :CALL:FILTER=yabba GCID= 0x00070004: Call terminate
Network Interfaces
NetworkInterfaces
These objects specify the IP interfaces that the GSX9000 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 an Ethernet port on the PNA10 adapter module and the core packet network. Four NIFs of TYPE ETHERNETCSMACD (Ethernet Carrier Sense Multiple Access with Collision Detection) are automatically created and named when a PNS10/PNA10 module set is added to the GSX9000 via the CREATE SERVER .. ADAPTER command. See Server on page 3-16 for additional information. The default name of the ETHERNETCSMACD NIF is ENET-shn-sln-ptn, where shn is the shelf number, sln is the slot number, and ptn 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. This name may be changed via the CONFIG 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. No additional ETHERNETCSMACD NIFs may be created nor may the automatically created (and possibly renamed) NIFs be directly deleted. These four NIFs are removed only when the PNS10/PNA10 module set is removed via the DELETE SERVER .. ADAPTER command. NIFs are always in one of two administrative states:
3-70
enabled disabled
NIFs are always in one of two operational states:
The default operational state is inservice, where the link is available for use. Changing the operational state to outofservice makes the Ethernet port available for test and maintenance. The rules for changing operational states are:
Changing to (operational state) inservice outofservice Affirm the prompt query. No new calls on this NIF 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 is in operational state outofservice and its administrative state may be disabled.
outofservice
Make sure the corresponding Ethernet port is ready for general usage. Change administrative state to enabled. Change operational state to inservice.
Command Syntax
CONFIGURE NIF nifname .. IPADDRESS nipaddress MASK subnet-mask NEXTHOP nhipaddress CLASS class DEVIATION deviation CONTINGENCY contingency CONFIGURE NIF nifname .. MODE oper-state ACTION teardownmode TIMEOUT teardowntime CONFIGURE NIF nifname NAME newnifname
3-71
CONFIGURE NIF nifname STATE admin-state SHOW NIF nifname ADMIN SHOW NIF SHELF shelf ADMIN SHOW NIF SHELF shelf SLOT slot ADMIN SHOW NIF SHELF shelf SLOT slot .. PORT pnsport ADMIN SHOW NIF ALL ADMIN SHOW NIF nifname STATUS SHOW NIF SHELF shelf STATUS SHOW NIF SHELF shelf SLOT slot STATUS SHOW NIF SHELF shelf SLOT slot PORT pnsport STATUS SHOW NIF ALL STATUS SHOW LOGICAL BEARER ADDRESS ALL ADMIN SHOW LOGICAL BEARER ADDRESS ALL STATUS
3-72
Command Parameters
TABLE 3 -20.
Ethernet NIF Parameters

Field Length 1-23 Description The automatically assigned (and possibly changed) name of this link. See the beginning of this section for the structure of the default name. The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. The slot number occupied by the PNA module you are configuring. Must be 3-16. The number of the Ethernet port on the PNA module that you are configuring. Must be 1-4. The 32-bit IP address of the PNA10 Ethernet port in dotted decimal form (for example 128.127.50.224). The percentage of overall NIF 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. 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 status for actual/expected bandwidths.
Parameter nifname
shelf slot pnsport nipaddress deviation
N/A N/A N/A N/A N/A
contingency
N/A
The percentage of the overall NIF bandwidth that is reserved for contingency. If actual bandwidth is greater than the expected bandwdith and less than the overall NIF bandwidth minus contingency amount, calls will still be accepted. Must be 0-100, default is 0. See the NIF status for actual/expected bandwidths.
3-73
TABLE 3 -20.

Field Length N/A Description 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. Do not configure this parameter if your GSX9000 contains both PNS10s and PNS20s. See Static Routes (IP Routing Table) on page 3-91 for further discussion of IP routing table considerations.
Parameter nhipaddress
class
N/A
The type of use to be made of the NIF resources: general - Available for the use of all GSX or Sonus PSX controlled calls. reserved - Dedicated to the use of vendor soft switches that control the allocation of the NIF resources. See MGCP Soft Switch on page 3372.
subnet-mask newnifname
N/A 1-23
The 32-bit subnet mask in dotted decimal form (for example 255.255.255.0) A new name for the PNA10 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 PNS10/PNA10 module set is configured via CREATE SERVER, if it is performed at all. The operational state of the NIF: INSERVICE - This state is set by default when admin-state is enabled. OUTOFSERVICE - Set this state before changing admin-state to disabled.
oper-state
N/A
teardownmode
N/A
The method by which calls are torn down when operational state goes to outofservice: dryup - calls remain active until the teardowntime interval expires. force - calls are dropped immediately.
3-74
TABLE 3 -20.

Field Length N/A Description 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. The administrative state of the NIF: disabled - 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.
Parameter teardowntime
admin-state
N/A
NIF Out-of-Service Reason Codes

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. The table below lists the NIF OOS reason codes.
TABLE 3 -21.
NIF Out-of-Service (OOS) Reason Codes

Integer Value 1 Description
OOS Reason Code N/A
Out of service condition is Not Applicable. Set when the NIF is inService or in dryUp state.
Valid for all PNS modules. The NIF is down due to operator-initiated command. Valid for all PNS modules. The NIF is down because the gateway is not responding to arp requests. Valid for all PNS modules. The NIF is down because the port has failed. (A port cannot be administratively taken out of service.) Valid for all PNS modules. The NIF is down because the server has failed or is out of service. Valid for all PNS modules.
admin gateway portDown
2 3 4
serverDown vcsDown
5 6
All the VCs (Virtual Connections) on this PNS20 NIF are out of service. Valid only for
PNS20 modules.
noVc srvrAbsent linkDown
7 8 9
No VC have been configured for the PNS20 NIF. Valid only for PNS20 modules.
The server module is not inserted in the chassis. Valid for all PNS modules. The link connectivity is lost. This applies only to redundancy. Not valid for PNS20, but valid for all other PNS modules.
PNS20 Network Interface (IP over ATM NIF)
3-75
Command Example
To display configuration information regarding all NIFs:
% SHOW NIF ALL ADMIN
Node: TPUBS Date: 2001/02/17 19:31:05 GMT Zone: GMTMINUS05-EASTERN-US mode action timeout -------IS DRYUP 60 IS DRYUP 60 IS DRYUP 60 IS DRYUP 60 address mask nexthop --------------10.7.1.101 255.255.0.0 10.7.1.1 10.7.1.102 255.255.0.0 10.7.1.2 10.7.1.103 255.255.0.0 10.7.1.3 10.7.1.104 255.255.0.0 10.7.1.4 deviatn conting ------0 0 0 0 0 0 0 0
loc
index class state ---- ---- ------------------------ ---------1-9 1 ENET-1-9-1 159 ETHERNETCSMACD GENERAL ENABLED 1-9 2 ENET-1-9-2 160 ETHERNETCSMACD GENERAL ENABLED 1-9 3 ENET-1-9-3 161 ETHERNETCSMACD GENERAL ENABLED 1-9 4 ENET-1-9-4 162 ETHERNETCSMACD GENERAL ENABLED
port name type
To display the current status of all NIFs:

% SHOW NIF ALL STATUS
Node: TPUBS Date: 2001/02/17 19:33:56 GMT Zone: GMTMINUS05-EASTERN-US index state #calls cur/max bw act bw oos reason bytes/sec deviatn ----- ---------- -------- ---------- ------159 IS 149 2064100 553755 N/A 12500000 0 160 IS 153 2055700 576044 N/A 12500000 0 161 IS 151 2066900 571690 N/A 12500000 0 162 IS 154 2060600 611821 N/A 12500000 0
loc
port name type ---- ---- -----------------------1-9 1 ENET-1-9-1 ETHERNETCSMACD 1-9 2 ENET-1-9-2 ETHERNETCSMACD 1-9 3 ENET-1-9-3 ETHERNETCSMACD 1-9 4 ENET-1-9-4 ETHERNETCSMACD

This object defines the Asynchronous Transfer Mode (ATM) packet interface for system call data. It assigns a name to a network interface between an OC-12c SONET port on the PNA21 adapter module and the core ATM network. One NIF of TYPE IPOVERATM is automatically created and named when a PNS20/PNA21 module set is added to the GSX9000 by the CREATE SERVER .. ADAPTER command. The default name of the IPOVERATM NIF is IPOA-shn-sln-ptn-ixn, where shn is the shelf number, sln is the slot number, ptn is the port number (always 1 on the PNA21), and ixn is the NIF index (always 1 for this automatically created NIF). For example, IPOA-1-5-1-1 identifies NIF 1 associated with the SONET port on the PNS20/PNA21 module combination residing in slot 5 on shelf 1. This NIF is created, only by the CREATE SERVER SHELF command, and deleted only by the DELETE SERVER SHELF command. This name may be changed via the CONFIG 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. Additional, uniquely named, IPOVERATM NIFs can be created/deleted by the CREATE/DELETE NIF commands shown in the command syntax. No additional automatically named IPOVERATM NIFs may be created. The IPOA-shn-sln-ptn-ixn NIF is
3-76
removed only when the PNS20/PNA21 module set is removed via the DELETE SERVER .. ADAPTER command. The TYPE parameter, ipoveratm, distinguishes this NIF from a PNA10/PNA30 Network Interface. The remainder of these NIF parameters, SHELF, SLOT, PORT, IPADDRESS, MASK, ACTION, TIMEOUT, MODE, CLASS, STATE, and NAME are identical to the corresponding PNA10/PNA30 NIF parameters. IP over ATM NIFs are always in one of two administrative states:
enabled disabled
IP over ATM NIFs are always in one of two operational states:
The default operational state is inservice, where the link is available for use. Changing the operational state to outofservice leaves the SONET port available for test and maintenance. Note The NIF cannot be placed out of service unless all ATM EXT VCs that use the NIF are out of service. The NIF cannot be disabled unless all ATM EXT VCs that use the NIF are disabled.
The rules for changing operational states are:
Changing to (operational state) inservice outofservice Affirm the prompt query. No new calls on this SONET NIF 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 SONET NIF is in operational state outofservice and its administrative state may be disabled. Once disabled, if this is not the automatically created SONET NIF, it may be deleted.
outofservice
Make sure the associated SONET port is ready for general usage. Change administrative state to enabled. Change operational state to inservice.
3-77
Command Syntax
CREATE NIF nifname SHELF shelfnumber .. SLOT slotnumber PORT pna21port TYPE ipoveratm CONFIGURE NIF nifname .. IPADDRESS nipaddress MASK subnet-mask NEXTHOP sipaddress CLASS class CONFIGURE NIF nifname .. MODE oper-state ACTION teardownmode CONFIGURE NIF nifname .. MODE oper-state ACTION teardownmode TIMEOUT teardowntime CONFIGURE NIF nifname STATE admin-state SHOW NIF nifname ADMIN SHOW NIF SHELF shelfnumber ADMIN SHOW NIF SHELF shelfnumber SLOT slotnumber ADMIN SHOW NIF SHELF shelfnumber SLOT slotnumber .. PORT pna21port ADMIN SHOW NIF ALL ADMIN DELETE NIF nifname
3-78
Command Parameters
TABLE 3 -22.
IP OVER ATM NIF Parameters

Field Length 1-23 Description An alphanumeric name assigned to this link. This name may be automatically generated as discussed at the beginning of this section, or user specified via the CREATE NIF command. The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. The slot number occupied by the PNS20/PNA21 module pair associated with the SONET port that you are configuring or displaying. Must be 3-16. The port number on the PNA21 adapter module that is the physical endpoint of the PVC that you are configuring or displaying. Must be 1 (on a PNA21). The 32-bit IP address of the PNA21 SONET port in dotted decimal form (for example 128.127.50.224). The 32-bit IP address of the GSX which is to be accessed via the PVC, in dotted decimal form (for example 128.127.50.224). The type of use to be made of the NIF resources: general - Available for the use of all GSX or Sonus PSX controlled calls. reserved - Dedicated to the use of vendor soft switches that control the allocation of the NIF resources. See MGCP Soft Switch on page 3372.
Parameter nifname
shelfnumber slotnumber
N/A N/A
pna21port
N/A
nipaddress sipaddress
N/A N/A
class
N/A
subnet-mask deviation
N/A N/A
The 32-bit subnet mask in dotted decimal form (for example 255.255.255.0) The percentage of overall NIF 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. 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 status for actual/expected bandwidths.
contingency
N/A
The percentage of the overall NIF bandwidth that is reserved for contigency. If actual bandwidth is greater than the expected bandwdith and less than the overall NIF bandwidth minus contingency amount, calls will still be accepted. Must be 0-100, default is 0. See the NIF status for actual/expected bandwidths.
3-79
TABLE 3 -22.
IP OVER ATM NIF Parameters

Field Length N/A Description The operational state of the NIF: INSERVICE - This state is set by default when admin-state is enabled. OUTOFSERVICE - Set this state before changing admin-state to disabled.
Parameter oper-state
teardownmode
N/A
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. The administrative state of the NIF: disabled - in this state the NIF is inactive. enabled - in this state the NIF is active.
admin-state
N/A

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 -21, NIF Out-of-Service (OOS) Reason Codes.
Command Example
To create a default IP over ATM NIF, IPOA-1-6-1-1, for the PNS20/PNA21 module combination in slot 6 of shelf 1:
% CREATE SERVER SHELF 1 SLOT 6 HWTYPE pns20 .. ADAPTER pna21 normal
To configure and enable the default IP over ATM NIF for the PNS20/PNA21 module combination in slot 6 of shelf 1:
% CONFIGURE NIF IPOA-1-6-1-1 .. IPADDRESS 128.7.1.217 MASK 255.255.0.0 NEXTHOP 128.7.254.25
To create and configure a second IP over ATM NIF for the PNS20/PNA21 module combination in slot 6 of shelf 1:
% CREATE NIF IPOA-1-6-1-2 SHELF 1 SLOT 6 PORT 1 .. TYPE ipoveratm % CONFIGURE NIF IPOA-1-6-1-2 .. IPADDRESS 128.7.1.18 MASK 255.255.0.0 NEXTHOP 128.7.254.33
3-80
PNS30 Network Interface (Gigabit Ethernet NIF)
To display the configuration of all GSX NIFs of all types:

Node: TPUBS Date: 2000/03/24 19:30:34 GMT Zone: GMTMINUS05-EASTERN-US index class state mode
loc port name type
address action mask timeout nexthop ---------------------------------------------------1-3 1 nif1 36 ENABLED 10.7.11.121 DRYUP ETHERNETCSMACD GENERAL IS 255.255.0.0 60 10.7.11.113 1-3 2 nif2 37 ENABLED 10.7.11.122 DRYUP ETHERNETCSMACD GENERAL IS 255.255.0.0 60 10.7.11.114 1-3 3 nif3 38 ENABLED 10.7.11.123 DRYUP ETHERNETCSMACD GENERAL IS 255.255.0.0 60 10.7.11.115 1-3 4 nif4 39 ENABLED 10.7.11.124 DRYUP ETHERNETCSMACD GENERAL IS 255.255.0.0 60 10.7.11.116 1-4 1 nif5 44 ENABLED 10.7.11.125 DRYUP IPOVERATM GENERAL IS 255.255.0.0 60 10.7.11.117 1-6 1 IPOA-1-6-1-1 54 DISABLED 0.0.0.0 DRYUP IPOVERATM GENERAL IS 255.255.0.0 60 0.0.0.0 1-6 1 nif10 55 DISABLED 0.0.0.0 DRYUP IPOVERATM GENERAL IS 255.255.0.0 60 0.0.0.0

This object defines the Gigabit Ethernet packet interface for system call data. It assigns a name to a link between the Gigabit Ethernet port on the PNA30 adapter module and the core packet network. One NIF of TYPE GIGABITETHERNET (Gigabit Ethernet) is automatically created and named when a PNS30/PNA30 module set is added to the GSX9000 via the CREATE SERVER .. ADAPTER command. See Server on page 3-16 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 PNA30 port number (always 1). For example, GENET-1-5-1 identifies the NIF on the PNA30 that resides behind the PNS30 in slot 5 of shelf 1. This name may be changed via the CONFIG 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. No additional GIGABITETHERNET NIFs may be created nor may the automatically created (and possibly renamed) NIF be directly deleted. This NIF is removed only when the PNS30/PNA30 module set is removed via the DELETE SERVER .. ADAPTER command. NIFs are always in one of two administrative states:
enabled disabled
NIFs are always in one of two operational states:
3-81
The default operational state is inservice, where the link is available for use. Changing the operational state to outofservice makes the Gigabit Ethernet port available for test and maintenance. The rules for changing operational states are:
Changing to (operational state) inservice outofservice Affirm the prompt query. No new calls on this NIF 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 is in operational state outofservice and its administrative state may be disabled.
outofservice
Make sure the corresponding Gigabit Ethernet port is ready for general usage. Change administrative state to enabled. Change operational state to inservice.
Command Syntax
CONFIGURE NIF nifname .. IPADDRESS nipaddress MASK subnet-mask NEXTHOP nhipaddress CLASS class DEVIATION deviation CONTINGENCY contingency CONFIGURE NIF nifname .. MODE oper-state ACTION teardownmode TIMEOUT teardowntime CONFIGURE NIF nifname NAME newnifname CONFIGURE NIF nifname STATE admin-state SHOW NIF nifname ADMIN SHOW NIF SHELF shelf ADMIN
3-82
SHOW NIF SHELF shelf SLOT slot ADMIN SHOW NIF SHELF shelf SLOT slot .. PORT pnsport ADMIN SHOW NIF ALL ADMIN SHOW NIF nifname STATUS SHOW NIF SHELF shelf STATUS SHOW NIF SHELF shelf SLOT slot STATUS SHOW NIF SHELF shelf SLOT slot PORT pnsport STATUS SHOW NIF ALL STATUS
3-83
Command Parameters
TABLE 3 -23.
GIGABIT ETHERNET NIF Parameters

Field Length 1-23 Description The automatically assigned (and possibly changed) name of this link. See the beginning of this section for the structure of the default name. The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. The slot number occupied by the PNA30 module you are configuring. Must be 3-16. The number of the Gigabit Ethernet port on the PNA30 module that you are configuring. Must be 1. The 32-bit IP address of the PNA30 Gigabit Ethernet port in dotted decimal form (for example 128.127.50.224). The percentage of overall NIF 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. 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 status for actual/expected bandwidths.
Parameter nifname
shelf slot pnsport nipaddress
N/A N/A N/A N/A
deviation
N/A
contingency
N/A
The percentage of the overall NIF bandwidth that is reserved for contigency. If actual bandwidth is greater than the expected bandwdith and less than the overall NIF bandwidth minus contingency amount, calls will still be accepted. Must be 0-100, default is 0. See the NIF status for actual/expected bandwidths.
3-84
TABLE 3 -23.

Field Length N/A Description 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. Do not configure this parameter if your GSX9000 contains both PNS30s and PNS20s. See Static Routes (IP Routing Table) on page 3-91 for further discussion of IP routing table considerations.
Parameter nhipaddress
class
N/A
The type of use to be made of the NIF resources: general - Available for the use of all GSX or Sonus PSX controlled calls. reserved - Dedicated to the use of vendor soft switches that control the allocation of the NIF resources. See MGCP Soft Switch on page 3372.
subnet-mask newnifname
N/A 1-23
The 32-bit subnet mask in dotted decimal form (for example 255.255.255.0) A new name for the PNA30 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/PNA30 module set is configured via CREATE SERVER, if it is performed at all. The operational state of the NIF: INSERVICE - This state is set by default when admin-state is enabled. OUTOFSERVICE - Set this state before changing admin-state to disabled.
oper-state
N/A
teardownmode
N/A
MNS Network Interface
3-85
TABLE 3 -23.

Field Length N/A Description 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. The administrative state of the NIF: disabled - 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.
Parameter teardowntime
admin-state
N/A

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 -21, NIF Out-of-Service (OOS) Reason Codes.
Command Example
To display configuration information regarding all NIFs:
Node: TPUBS Date: 2001/06/22 14:22:11 GMT Zone: GMTMINUS05-EASTERN-US mode action timeout -------IS DRYUP 60 address mask nexthop --------------10.7.1.34 255.255.255.252 0.0.0.0 deviatn conting ------0 0
loc
index class state ---- ---- ------------------------ ---------1-3 1 nif1 337 GIGABITETHERNET GENERAL ENABLED
port name type
The Ether MAC addr in the above display represents the active hardware MAC address for ETHERNETCSMACD and GIGABITETHERNET NIFs. To display the current status of all NIFs:
% SHOW NIF ALL STATUS
loc
port name index state #calls cur/max bw act bw type oos reason bytes/sec deviatn ---- ---- ------------------------ ----- ---------- -------- ---------- ------1-3 1 nif1 338 IS 0 1250000 0 GIGABITETHERNET N/A 125000000 0

This object defines the packet interface for system management data. It defines a link between an Ethernet port on the Management Network Adapter (MNA10) and a gateway (or router) to an adjacent subnetwork. Sonus recommends that you configure two Management NIFs, one active, one standby. Then when a configuration change to the MNS network interface is necessary, you can
3-86
disable the standby and change its IP address, mask, and/or nexthop. Subsequently you can reenable that port, change its mode from standby to active, and similarly reconfigure, if necessary, the previously active port. In this manner the Management Network can be reconfigured without shutting down the GSX. See GSX in ATM+IP Environments on page 4-46 for additional detail about this procedure. The LOGICAL MGMTIF object allows you to assign a single virtual management address to the MNS group. Thus the active port associated with the active MNS will have two IP addresses. If the active MNS port goes down, the virtual management address will shift to the next active MNS port. A Management NIF is always in one of two administrative states:
enabled disabled
A Management NIF is always in one of two operational states:
active standby
If one port is in active mode, the other is necessarily in standby. A change to ones operational state effects a corresponding change to the other. The rules for changing operational states are:
From (operational state) active
Changing to (operational state) active standby Make sure the administrative state of the other Management NIF is enabled. Change the operational state of this Management NIF to standby. (The other Management NIFs operational state will change to active.) Change the administrative state of this Management NIF to disabled, if you wish to change its configuration.
standby
Change the operational state of this Management NIF to active. (A Management NIF must be in administrative state enabled when changing the operational state to active.) (The other Management NIFs operational state will change to standby.)
The interface status of a Management NIF reflects the physical and administrative state of the interface as follows:
3-87
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 the interface is operational.
These states cannot be explicitly set. They are displayed by the SHOW MGMT NIF ... STATUS command.
Command Syntax
CONFIGURE MGMT NIF SHELF shelf SLOT slot PORT port .. IPADDRESS ipaddress MASK subnet-mask NEXTHOP nhipaddress MODE oper-state CONFIGURE MGMT NIF SHELF shelf SLOT slot PORT port .. STATE admin-state CONFIGURE LOGICAL MGMTIF SHELF shelf .. IPADDRESS lipaddress CONFIGURE LOGICAL MGMTIF SHELF shelf .. SECOND IPADDRESS lipaddress SHOW MGMT NIF SHELF shelf ADMIN SHOW MGMT NIF SHELF shelf STATUS SHOW MGMT NIF SHELF shelf SLOT slot ADMIN SHOW MGMT NIF SHELF shelf SLOT slot STATUS SHOW MGMT NIF ALL ADMIN SHOW MGMT NIF ALL STATUS
3-88
Command Parameters
TABLE 3 -24.
Management NIF Parameters

Field Length N/A N/A N/A N/A N/A Description The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. The slot number occupied by the MNA module you are configuring. Must be 1-2. The logical reference number to the Management NIF port. Must be 1-2. The 32-bit IP address of the Ethernet port in dotted decimal form (for example 128.127.50.224). 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 or PNS20 NIFs.
Parameter shelf slot port ipaddress nhipaddress
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 MNA10 port is configured for different IP subnets.
subnet-mask oper-state
N/A N/A
The 32-bit subnet mask in dotted decimal form (for example 255.255.255.0) The operational state of the NIF: active - Port is enabled and currently in use. standby - Port is not in use. In this state it may be disabled and reconfigured.
admin-state
N/A
The administrative state of the NIF: disabled - 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
To configure a Management NIF:
% CONFIGURE MGMT NIF SHELF 1 SLOT 1 PORT 1 .. IPADDRESS 128.2.3.4 MASK 255.0.0.0 NEXTHOP 128.11.12.13 MODE active STATE enabled
Debug Network Interface
3-89
To display configuration information about all Management NIFs:

% SHOW MGMT NIF ALL ADMIN
Node: TPUBS Date: 2001/02/22 01:03:44 GMT Zone: GMTMINUS05-EASTERN-US MTU Address Mask Nexthop LogicIP --------------10.21.10.162 255.255.0.0 10.21.254.235 0.0.0.0 10.21.10.163 255.255.0.0 10.21.254.235 0.0.0.0 10.21.10.164 255.255.0.0 10.21.254.235 0.0.0.0 10.21.10.165 255.255.0.0 10.21.254.235 0.0.0.0 Mode Admin Status
Shelf Slot Port Index Type
----- ---- ---- ----- -------------- ---1 1 1 3 ETHERNETCSMACD 1500
------- -------ACTIVE ENABLED
ETHERNETCSMACD 1500
STANDBY ENABLED
ETHERNETCSMACD 1500
ACTIVE
ENABLED
ETHERNETCSMACD 1500
STANDBY ENABLED
To configure a virtual management address of 128.6.7.8:

% CONFIGURE LOGICAL MGMTIF SHELF 1 IPADDRESS 128.6.7.8

Warning 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
CONFIGURE DEBUG NIF SHELF shelf SLOT slot .. IPADDRESS ipaddress MASK subnet-mask NEXTHOP nhipaddress CONFIGURE DEBUG NIF SHELF shelf SLOT slot .. STATE admin-state SHOW DEBUG NIF SHELF shelf ADMIN SHOW DEBUG NIF SHELF shelf STATUS SHOW DEBUG NIF SHELF shelf SLOT slot ADMIN SHOW DEBUG NIF SHELF shelf SLOT slot STATUS SHOW DEBUG NIF ALL ADMIN SHOW DEBUG NIF ALL STATUS
3-90
Command Parameters
TABLE 3 -25.
Debug NIF Parameters

Field Length N/A N/A N/A Description The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. The slot number occupied by the module you are configuring. Must be 1-16. The 32-bit IP address of the Ethernet port specified in dotted decimal form (for example 128.127.50.224). 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 or PNS20 NIFs.
Parameter shelf slot ipaddress
nhipaddress
N/A
subnet-mask admin-state
N/A N/A
The 32-bit subnet mask in dotted decimal form (for example 255.255.255.0) The administrative state of the NIF: disabled - 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
To configure a Debugger NIF:
% CONFIGURE DEBUG NIF SHELF 1 SLOT 1 .. IPADDRESS 128.5.1.120 MASK 255.255.0.0 NEXTHOP 128.5.254.250 % CONFIGURE DEBUG NIF SHELF 1 SLOT 1 .. STATE enabled
To display configuration information about all Debugger NIFs:

% SHOW DEBUG NIF ALL ADMIN
Node: TPUBS Date: 2000/04/13 15:15:57 GMT Zone: GMTMINUS05-EASTERN-US MTU Address Mask ---- --------------1500 10.5.10.96 255.255.0.0 1500 10.5.2.168 255.255.0.0 1500 10.5.2.145 255.0.0.0 Nexthop Admin Status --------------- ------10.5.254.250 ENABLED 10.5.254.250 10.5.254.230 ENABLED ENABLED
Shelf Slot Index Type ----- ---- ----- -------------1 1 1 ETHERNETCSMACD 1 1 4 15 42 41 ETHERNETCSMACD ETHERNETCSMACD
Static Routes (IP Routing Table)
3-91
Static Routes (IP Routing Table) StaticRoutes

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 CREATE, CONFIGURE, and DELETE SOCKET ACCESS commands allow port filtering. Packets that are destined for a UDP or TCP logical port are filtered if they are received on a configured interface, as follows:
CONFIGURE .. PERMIT adds entries to the permit table, while CONFIGURE .. (without PERMIT) adds entries to the deny table. When a packet is received, the permit table is first checked for an entry for the destination port in the packet. If that port and interface (IFINDEX) are in the permit table, then the packet is passed up to the application. If the port is in the permit table, but the interface is not, then the packet is dropped. If the destination port is not in the permit table, then the deny table is checked for an entry for that port. If that port and interface are in the deny table, the packet is dropped. If the port is in the deny table, but the interface is not, then the packet is passed up to the application. If there are no entries for the destination port in either the permit or deny tables, then the packet is passed up to the application. You may configure a maximum of 96 UDP or TCP port filters, but each of these 96 logical ports can be configured for multiple interfaces.
The SHOW IP NETSTAT commands display NIF statistics that have accumulated since the GSX was booted. 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
CREATE SOCKET ACCESS IFINDEX ifindex PORT port .. PROTOCOL protocol CONFIGURE IP ROUTE ADD NIF nifname .. IPADDRESS ipaddress MASK subnet-mask NEXTHOP nhipaddress CONFIGURE IP ROUTE ADD MGMT NIF SHELF shelf .. SLOT slot PORT port IPADDRESS ipaddress MASK subnet-mask NEXTHOP nhipaddress CONFIGURE IP ROUTE ADD DEBUG NIF SHELF shelf .. SLOT slot IPADDRESS ipaddress
3-92
MASK subnet-mask NEXTHOP nhipaddress CONFIGURE IP ROUTE ADD IFINDEX ifindex .. IPADDRESS ipaddress MASK subnet-mask NEXTHOP nhipaddress CONFIGURE IP ROUTE DELETE NIF nifname .. 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 CONFIGURE SOCKET ACCESS IFINDEX ifindex PORT lport .. PROTOCOL protocol CONFIGURE SOCKET ACCESS IFINDEX ifindex PORT lport .. PROTOCOL protocol PERMIT DELETE SOCKET ACCESS IFINDEX ifindex PORT lport .. PROTOCOL protocol SHOW IP NETSTAT ALL ROUTES ADMIN SHOW IP NETSTAT ALL ROUTES STATUS SHOW IP NETSTAT SHELF shelf ROUTES STATUS SHOW IP NETSTAT SHELF shelf SLOT slot ROUTES STATUS SHOW IP NETSTAT SHELF shelf IP COUNTERS SHOW IP NETSTAT SHELF shelf SLOT slot IP COUNTERS SHOW IP NETSTAT ALL IP COUNTERS SHOW IP NETSTAT SHELF shelf ICMP COUNTERS SHOW IP NETSTAT SHELF shelf SLOT slot ICMP COUNTERS SHOW IP NETSTAT ALL ICMP COUNTERS
3-93
SHOW IP NETSTAT SHELF shelf TCP COUNTERS SHOW IP NETSTAT SHELF shelf SLOT slot TCP COUNTERS SHOW IP NETSTAT ALL TCP COUNTERS SHOW IP NETSTAT SHELF shelf TCP CONNECTION STATUS SHOW IP NETSTAT SHELF shelf SLOT slot .. TCP CONNECTION STATUS SHOW IP NETSTAT ALL TCP CONNECTIONS STATUS SHOW IP NETSTAT SHELF shelf UDP COUNTERS SHOW IP NETSTAT SHELF shelf SLOT slot UDP COUNTERS SHOW IP NETSTAT ALL UDP COUNTERS SHOW IP NETSTAT SHELF shelf UDP LISTEN STATUS SHOW IP NETSTAT SHELF shelf SLOT slot .. UDP LISTEN STATUS SHOW IP NETSTAT ALL UDP LISTEN STATUS SHOW IP NETSTAT SHELF shelf ARP STATUS SHOW IP NETSTAT SHELF shelf SLOT slot ARP STATUS SHOW IP NETSTAT ALL ARP STATUS SHOW SOCKET ACCESS ENTRY PROTOCOL protocol ADMIN SHOW SOCKET ACCESS ENTRY PORT port ADMIN SHOW SOCKET ACCESS ENTRY ALL ADMIN SHOW SOCKET ACCESS ENTRY PROTOCOL protocol .. PORT port IFINDEX ifindex ADMIN SHOW SOCKET ACCESS ENTRY PROTOCOL protocol .. PORT port ADMIN
3-94
Command Parameters
TABLE 3 -26.
Static Route Parameters

Field Length 1-23 N/A Description The name of an existing PNS NIF. 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. 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. The 32-bit subnet mask in dotted decimal form (for example 255.255.255.0) The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. The slot number occupied by the MNS, CNS, or PNS module. Must be 1-16. The logical reference number to the Management NIF port. Must be 1 or 2. A non-zero, unsigned long index assigned to the port that defines the access permission. The logical port number. Must be 1-65535. The protocol used on the socket: tcp udp
Parameter nifname ipaddress
nhipaddress
N/A
subnet-mask shelf slot port ifindex lport protocol
N/A N/A N/A N/A N/A N/A N/A
Command Example
To add a gateway to the Management NIF:
% CONFIG IP ROUTE ADD MGMT NIF SHELF 1 SLOT 1 .. PORT 1 IPADDRESS 128.1.1.2 MASK 255.255.0.0 NEXTHOP 128.5.254.250
To display the status of the IP routing table for the Management NIFs:
% SHOW IP NETSTAT SHELF 1 SLOT 1 ROUTES STATUS
Node: TPUBS Date: 2000/04/13 19:05:03 GMT Zone: GMTMINUS05-EASTERN-US Destination --------------0.0.0.0 0.0.0.0 10.1.1.15 10.5.0.0 10.6.0.0 10.6.0.0 127.0.0.1 Mask --------------0.0.0.0 0.0.0.0 255.255.255.255 255.255.0.0 255.255.0.0 255.255.0.0 255.255.255.255 Nexthop --------------10.5.254.250 10.6.254.250 10.5.254.250 10.5.1.103 10.6.1.64 10.6.1.65 127.0.0.1 Index ----1 3 1 1 3 4 0
Shelf ----1 1 1 1 1 1 1
Slot ---1 1 1 1 1 1 1
Ethernet Switch
3-95
To display the status of the all IP routing tables for all NIFs (Management NIFs on the MNA10 in slot 1, PNS10 NIFs on the PNA10 in slot 3, and PNS20 NIFs on the PNA21 in slot 7):
% SHOW IP NETSTAT ALL ROUTES STATUS
Node: TPUBS Date: 2000/04/13 19:09:58 GMT Zone: GMTMINUS05-EASTERN-US Destination --------------0.0.0.0 0.0.0.0 10.1.1.15 10.5.0.0 10.6.0.0 10.6.0.0 127.0.0.1 0.0.0.0 10.5.0.0 127.0.0.1 0.0.0.0 10.5.0.0 127.0.0.1 Mask --------------0.0.0.0 0.0.0.0 255.255.255.255 255.255.0.0 255.255.0.0 255.255.0.0 255.255.255.255 0.0.0.0 255.255.0.0 255.255.255.255 0.0.0.0 255.255.0.0 255.255.255.255 Nexthop --------------10.5.254.250 10.6.254.250 10.5.254.250 10.5.1.103 10.6.1.64 10.6.1.65 127.0.0.1 10.5.254.250 10.5.1.27 127.0.0.1 10.5.254.250 10.5.1.129 127.0.0.1 Index ----1 3 1 1 3 4 0 63 63 0 62 62 0
Shelf ----1 1 1 1 1 1 1 1 1 1 1 1 1
Slot ---1 1 1 1 1 1 1 3 3 3 7 7 7
To display the configuration of the all IP routing tables for all NIFs:
% SHOW IP NETSTAT ALL ROUTES ADMIN
Node: TPUBS Date: 2000/04/13 19:36:44 GMT Zone: GMTMINUS05-EASTERN-US Mask --------------255.255.255.255 255.255.255.255 Nexthop --------------10.5.254.250 10.5.254.250 Index ----1 2
Destination --------------10.1.1.15 10.1.1.15
Ethernet Switch LinkFailureDetection

This object defines the IP address of the Ethernet switch that is connected to an MNA10, PNA10, or PNA30 Ethernet port. To achieve Ethernet link redundancy, Sonus recommends connecting all MNA and PNA ports, including the standby PNA, directly to Ethernet switches. 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 MNA10 or PNA10 port in this command. PNA30s 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
CONFIGURE SERVER ETHERNET SWITCH IPADDRESS ..
3-96
Ethernet Switch
SHELF shelf SLOT slot IPADDRESS ipaddress CONFIGURE SERVER ETHERNET SWITCH IPADDRESS .. SHELF shelf SLOT slot PORT phys_port IPADDRESS ipaddress SHOW SERVER ETHERNET SWITCH IPADDRESS SHELF shelf ADMIN SHOW SERVER ETHERNET SWITCH IPADDRESS SHELF shelf .. SLOT slot ADMIN SHOW SERVER ETHERNET SWITCH IPADDRESS ALL ADMIN
Command Parameters
TABLE 3 -27.
ETHERNET SWITCH Parameters

Field Length N/A Description 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. The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. The slot number occupied by the MNS, CNS, or PNS module. Must be 1-16. The physical port on either the PNA10 or the MNA10 on which to perform failure-stage link verification. Must be 1-2 for MNA10 links, must be 1-4 for PNA10 links. This parameter is omitted for PNA30 links, because only one physical port is available on the PNA30.
Parameter ipaddress
shelf slot phys_port
N/A N/A N/A
Command Example
To define the IP address of the Ethernet switch that is connected to the second physical port on the MNA10 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 IpAddress
Shelf
Slot
Port
Link Failure Detection
3-97
===== 1 1 1 1 1 1 1 1 1 1 1 1
==== 1 1 2 2 13 13 13 13 14 14 14 14
==== 1 2 1 2 1 2 3 4 1 2 3 4
========= 10.6.254.210 10.6.254.211 10.6.254.211 10.6.254.210 10.7.8.9 10.7.8.9 10.7.8.9 10.7.8.9 10.7.254.250 10.7.254.250 10.7.254.250 10.7.254.250

This object provides a link verification mechanism for PNA10, PNA30, and MNA10 ports. 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 an intermediate destination fails to reply within these established thresholds, 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. 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 the configured threshold. If the standby module has more failed ports, the switchover is not requested. To accomplish this switchover, a PNS10 or PNS30 redundancy group must be properly configured. See Redundancy Group on page 3-27. Note The NIF associated with the PNS that will be switched over to must be in service, or the switchover will not take place. This mechanism verifies MNA10 ports, and directs MNS10 (or MNS11) 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:
the NEXTHOP configured for the NIF the Ethernet switch IP address the first route that uses the NIF
3-98
(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 Verify Timer and 250 milliseconds for the 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 switchover, the virtual management address (see MNS Network Interface on page 3-85) will shift to the new active MNS port.
Command Syntax
CONFIGURE LINK FAILURE DECTECTION PARAMETER .. SHELF shelf SLOT slot THRESHOLDS thresholds VERIFY TIMER verifytimer REATTEMPT TIMER retimer RETRY COUNT retrycount SWITCHONLY LINKTEST solinktest STATE admin-state SHOW LINK FAILURE DETECTION PARAMETERS .. SHELF shelf ADMIN SHOW LINK FAILURE DETECTION PARAMETERS .. SHELF shelf SLOT slot ADMIN SHOW LINK FAILURE DETECTION PARAMETERS ALL ADMIN SHOW LINK FAILURE STATISTICS SHELF shelf STATISTICS SHOW LINK FAILURE STATISTICS SHELF shelf .. SLOT slot STATISTICS SHOW LINK FAILURE STATISTICS ALL STATISTICS SHOW LINK FAILURE STATISTICS IFINDEX ifindex .. DESTINATION ipaddress SHOW LINK FAILURE STATISTICS DESTINATION ALL SHOW IP NETSTAT SHELF shelf ICMP COUNTERS SHOW IP NETSTAT SHELF shelf SLOT slot ICMP COUNTERS SHOW IP NETSTAT ALL ICMP COUNTERS
3-99
Command Parameters
TABLE 3 -28.
LINK FAILURE DETECTION Parameters

Field Length N/A Description 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. The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. The slot number occupied by the MNS, CNS, or PNS module. Must be 1-16. The number of individual port or link failures that may be accepted before a switchover to the redundant PNS10 or MNS1x modules occurs. Must be 0100. A value of 0 means that a port or link failure will never cause a switchover. 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 when recovering from a link failure. Must be 0-60000, default is 500 (milliseconds). 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 060000, default is 250 (milliseconds). 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. Specifies whether the LINK FAILURE ICMP Echo Requests are sent to all the NIF destinations, or just the ETHERNET SWITCH address: enabled - send ICMP Echo Requests to the ETHERNET SWITCH only disabled - send ICMP Echo Requests to each NEXTHOP router or GSX port on the local Ethernet
Parameter ipaddress
shelf slot thresholds
N/A N/A N/A
verifytimer
N/A
retimer
N/A
retrycount
N/A
solinktest
N/A
admin-state
N/A
The administative state of link failure detection on the designated MNS1x or PNS10 module: enabled - turned on and active disabled - not in use
ifindex
N/A
A non-zero, unsigned long index assigned to the port that defines the access permission.
Command Example
To display the configuration of all link failure detection parameters:
% SHOW LINK FAILURE DETECTION PARAMETERS ALL ADMIN
3-100
Open Shortest Path First (OSPF) Interface
Shelf ===== 1 1 1 1
Slot ==== 1 2 3 4
State ======= DISABLE DISABLE DISABLE DISABLE
Threshold ========= 0 0 0 0
Retries ======= 2 2 2 2
Verify Timer ===== 500 500 500 500
Reattempt Timer ====== 250 250 250 250
Switch-only Link Test ========= ENABLED ENABLED ENABLED ENABLED
To display the link failure statistics:

% SHOW LINK FAILURE STATISTICS SHELF 1 STATISTICS
Node: TPUBS Date: 2001/02/17 21:05:24 GMT Zone: GMTMINUS05-EASTERN-US Active Port Failures ======== 0 Standby Port Failures ======== 0
Shelf ===== 1
Slot ==== 1
To enable link failure switchovers on the PNS redundancy group occupying slots 3, 4, and 5:
% CONFIGURE LINK FAILURE DETECTION PARAMETER .. SHELF 1 SLOT 3 STATE disabled % CONFIGURE LINK FAILURE DETECTION PARAMETER .. SHELF 1 SLOT 3 THRESHOLDS 1 % CONFIGURE LINK FAILURE DETECTION PARAMETER .. SHELF 1 SLOT 4 THRESHOLDS 1 % CONFIGURE LINK FAILURE DETECTION PARAMETER .. SHELF 1 SLOT 5 THRESHOLDS 1 % CONFIGURE LINK FAILURE DETECTION PARAMETER .. SHELF 1 SLOT 3 STATE enabled
Open Shortest Path First (OSPF) Interface OSPF

This object defines an OSPF instance to run in the GSX. OSPF is a standard intradomain 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 sub-
3-101
nets 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 lessor 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 4-10. For additional reference information on OSPF, see:
OSPF Version 2 (RFC 1583) OSPF - Anatomy of an Internet Routing Protocol (John Moy, 1998)
Command Syntax
CREATE OSPF SHELF shelf CONFIGURE OSPF SHELF shelf AREA area_id TYPE type CONFIGURE OSPF SHELF shelf AREA area_id TYPE type .. ROUTECALCTYPE routecalctype CONFIGURE OSPF SHELF shelf MODE mode CONFIGURE OSPF SHELF shelf STATE f_admin-state CREATE OSPF IF SHELF shelf IPADDRESS if_addr .. CONFIGURE OSPF IF SHELF shelf IPADDRESS if_addr .. HELLOINTERVAL hellointerval RETRANSMITINTERVAL rtxinterval DEADINTERVAL deadinterval CONFIGURE OSPF IF SHELF shelf IPADDRESS if_addr .. NBR neighbor_addr CONFIGURE OSPF IF SHELF shelf IPADDRESS if_addr .. STATE if_admin-state DELETE OSPF IF SHELF shelf IPADDRESS if_addr .. SHOW OSPF GENERAL ENTRY SHELF shelf SHOW OSPF GENERAL ALL SHOW OSPF IF ENTRY SHELF shelf IPADDRESS if_addr
3-102
SHOW OSPF IF ALL SHOW OSPF NBR ENTRY SHELF shelf IPADDRESS neighbor_addr SHOW OSPF NBR ALL SHOW OSPF LSDB ENTRY SHELF shelf AREAID area_id .. TYPE type LSID if_addr ROUTERID if_addr SHOW OSPF LSDB ALL CREATE LOGICAL BEARER ADDRESS lb_if_addr .. MASK subnet-mask SIZE size SHOW LOGICAL BEARER ADDRESS ALL ADMIN SHOW LOGICAL BEARER ADDRESS ALL STATUS DELETE LOGICAL BEARER ADDRESS lb_if_addr
3-103
Command Parameters
TABLE 3 -29.
OSPF Interface Parameters

Field Length N/A N/A Description The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. 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. Specifies the interfaces that the OSPF area will cover: MNS - only MNS IP interfaces. PNS - only PNS IP interfaces. COMMON - both MNS and PNS IP interfaces. Whenever an OSPF interface is created and configured, it is automatically included in the corresponding OSPF area or areas.
Parameter shelf area_id
type
N/A
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. 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. 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. 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). The number of seconds between the transmission of hello packets on the OSPF interface. Must be 165535, default is 10 (seconds). This must match the value configured in neighbor routers in order for adjacency to be established.
subnet-mask
N/A
size
N/A
neighbor_addr
N/A
hellointerval
N/A
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.
3-104
TABLE 3 -29.

Field Length N/A Description The number of seconds to wait before declaring a silent router down on the OSPF interface. Must be 02,147,483,647, default is 40 (seconds). This must match the value configured in neighbor routers in order for adjacency to be established.
Parameter deadinterval
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 - 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.
mode
N/A
This applies to ROUTECALCTYPE of spf and specifies whether those routes that are calculated are installed into the routing table: active - 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-91.
3-105
TABLE 3 -29.

Field Length N/A Description 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 - All parameter values associcated with this OSPF interface are active.
Parameter if_adminstate
f_admin-state
N/A
The administrative state of the OSPF process: disabled - 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.
OSPF Provisioning Overview

OSPF provisioning in the GSX is a two step process:
1. 2.
Create and configure the OSPF process. Configure and enable OSPF on each selected interface.
The discussion and example below provides additional detail about each of these steps. To create the OSPF process:
% CREATE OSPF SHELF 1
To configure the OSPF process: To complete this step, you must specify:
the OSPF area in which MNS interfaces will be configured the OSPF area in which PNS interfaces will be configured the OSPF route calculation type the OSPF mode
You may or may not specify:
An OSPF area is labeled by an AreaID in IP address format, for example 0.0.0.0. You must configure all MNS interfaces into one OSPF area; that is you may not place some MNS interfaces into one OSPF area and other MNS interfaces into another OSPF area. Likewise, you must configure all PNS interfaces into one OSPF area. You may place the MNS and PNS interfaces into separate OSPF areas or you may combine the MNS and PNS interfaces into one OSPF area, as demonstrated below. To configure PNS interfaces into OSPF area 0.0.0.1 and MNS interfaces into OSPF area 0.0.0.2:
% CONFIGURE OSPF SHELF 1 AREA 0.0.0.1 TYPE pns % CONFIGURE OSPF SHELF 1 AREA 0.0.0.2 TYPE mns
3-106
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
To configure and enable OSPF on individual interfaces: 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
3-107
Command Example
active MNS
10.1.1.1 10.1.1.2
Switch
LAN 10.1.0.0
standby MNS
10.1.1.3 10.1.1.4 10.1.2.1
active PNS
10.2.1.1 10.2.1.2 10.2.1.3 10.2.1.4 10.2.2.1
OSPF Router
Switch LAN 10.2.0.0 standby PNS
Area 0.0.0.1
FIGURE 3-1
Single OSPF Interface Area with Two Subnets
To configure an OSPF single area as depicted in Figure 3-1 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 ..
3-108
STATE enabled % CREATE OSPF IF SHELF 1 IPADDRESS 10.1.1.4 % CONFIGURE OSPF IF SHELF 1 IPADDRESS 10.1.1.4 .. STATE enabled % CREATE OSPF IF SHELF 1 IPADDRESS 10.2.1.1 % CONFIGURE OSPF IF SHELF 1 IPADDRESS 10.2.1.1 .. STATE enabled % CREATE OSPF IF SHELF 1 IPADDRESS 10.2.1.2 % CONFIGURE OSPF IF SHELF 1 IPADDRESS 10.2.1.2 .. STATE enabled % CREATE OSPF IF SHELF 1 IPADDRESS 10.2.1.3 % CONFIGURE OSPF IF SHELF 1 IPADDRESS 10.2.1.3 .. STATE enabled % CREATE OSPF IF SHELF 1 IPADDRESS 10.2.1.4 % CONFIGURE OSPF IF SHELF 1 IPADDRESS 10.2.1.4 .. STATE enabled % CONFIGURE OSPF SHELF 1 STATE enabled
To change the retransmit interval on Ethernet Port 10.2.1.4 to 8 seconds:

% CONFIGURE OSPF IF SHELF 1 IPADDRESS 10.2.1.4 .. STATE disabled % CONFIGURE OSPF IF SHELF 1 IPADDRESS 10.2.1.4 .. RETRANSMITINTERVAL 8 % CONFIGURE OSPF IF SHELF 1 IPADDRESS 10.2.1.4 .. STATE enabled % CONFIGURE OSPF SHELF 1 STATE enabled
To display configuration information about all OSPF areas:

% SHOW OSPF GENERAL ALL
--------------------------------------------------------------------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
To display configuration information about all OSPF interface states:

% SHOW OSPF IF ALL
shelf instance
IP address Mask Type Priority AreaId HelloInt DeadInt RxmtInt --------------------------------------------------------------------1 1 10.24.10.25 0.0.0.10 255.255.0.0 10 POINTTOPOINT 40 0 5
Differentiated Services
3-109
To display configuration information about the OSPF Link State Advertisement database of individual areas:
% SHOW OSPF LSDB ALL
area ID --------------0.0.0.0 0.0.0.1 0.0.0.1 0.0.0.1 0.0.0.1 0.0.0.1 0.0.0.1 0.0.0.1 0.0.0.1 0.0.0.10 0.0.0.10 0.0.0.10 0.0.0.10 0.0.0.10 0.0.0.10 0.0.0.10 0.0.0.10 type --------------ASEXTERNALLINK ROUTERLINK ROUTERLINK ROUTERLINK SUMMARYLINK SUMMARYLINK SUMMARYLINK SUMMARYLINK ASSUMMARYLINK ROUTERLINK ROUTERLINK SUMMARYLINK SUMMARYLINK SUMMARYLINK SUMMARYLINK SUMMARYLINK ASSUMMARYLINK LSDB ID --------------0.0.0.0 10.239.1.1 10.239.1.2 10.239.7.1 10.10.0.0 10.239.3.2 10.239.6.0 10.239.7.0 10.239.6.1 10.239.3.1 10.239.7.1 10.10.0.0 10.99.1.53 10.239.0.0 10.239.6.0 10.239.7.0 10.239.6.1 router ID --------------10.239.7.1 10.239.1.1 10.239.1.2 10.239.7.1 10.239.7.1 10.239.7.1 10.239.7.1 10.239.7.1 10.239.7.1 10.239.3.1 10.239.7.1 10.239.7.1 10.239.7.1 10.239.7.1 10.239.7.1 10.239.7.1 10.239.7.1
shelf ----1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1
instance -------1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1
To display configuration information about the OSPF neighbor router states:

% SHOW OSPF NBR ALL
CUDA% show ospf nbr all Node: TPUBS Date: 2002/02/06 19:21:14 GMT Zone: GMTMINUS05-EASTERN-US
shelf ----1 1 instance IP address router ID priority state ---- -------- --------------- --------------- -------- ---------1 10.239.1.5 10.239.7.1 1 FULL 1 10.239.3.2 10.239.7.1 1 FULL
Differentiated Services DiffServ

The IP FILTER object provides a method of selecting outbound packets according to combinations of criteria that include IP protocol, IP application, from IP address, to IP address, from logical port number, to logical port number, and transmitting NIF. When an IP filter is active, each outbound packet ultimately matches or doesnt match the filter. The DIFFSERV MARK object is associated with a particular IP 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 filter. (See the TOS parameter description in Packet Service Profile on page 3-241.) 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 monitoring and management of network resources is called Traffic Engineering (TE). The IP 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 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
3-110
use these values to prioritize or shape the traffic that originates from the GSX.
Command Syntax
CREATE IP FILTER ipfiltername CONFIGURE IP FILTER ipfiltername .. SOURCEADDRESS START sipaddress CONFIGURE IP FILTER ipfiltername .. SOURCEADDRESS START sipaddress DESTINATIONADDRESS START sipaddress CONFIGURE IP FILTER ipfiltername .. SOURCEADDRESS START sipaddress ENDADDR eipaddress DESTINATIONADDRESS START sipaddress CONFIGURE IP FILTER ipfiltername .. SOURCEADDRESS START sipaddress ENDADDR eipaddress
DESTINATIONADDRESS START sipaddress ENADDR eipadress
CONFIGURE IP FILTER ipfiltername .. SOURCEPORT START sportnumber CONFIGURE IP FILTER ipfiltername .. SOURCEPORT START sportnumber DESTINATIONPORT START sportnumber CONFIGURE IP FILTER ipfiltername .. SOURCEPORT START sportnumber ENDPORT eportnumber DESTINATIONPORT START sportnumber CONFIGURE IP FILTER ipfiltername .. SOURCEPORT START sportnumber ENDPORT eportnumber
DESTINATIONPORT START sportnumber ENDPORT eportnumber
CONFIGURE IP FILTER ipfiltername PROTOCOL protocol CONFIGURE IP FILTER ipfiltername NIF nifname CONFIGURE IP FILTER ipfiltername .. APPLICATION application NIF nifname CONFIGURE IP FILTER ipfiltername STATE admin-state SHOW IP FILTER ipfiltername SHOW IP FILTER ALL DELETE IP FILTER ipfiltername CREATE DIFFSERV MARK FILTER ipfiltername CONFIGURE DIFFSERV MARK FILTER ipfiltername DSCP dscp
3-111
SHOW DIFFSERV MARK ipfiltername SHOW DIFFSERV MARK ALL DELETE DIFFSERVE MARK FILTER ipfiltername
3-112
Command Parameters
TABLE 3 -30.
IP FILTER and DIFFSERV Parameters

Field Length 1-23 N/A Description The name of the IP filter. The 32-bit IP address of an Ethernet port that will be a criterion of the IP 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 filter. If ENDADDR is present, this is the start of a range of IP addresses, that will apply to the IP 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 filter.
Parameter ipfiltername sipaddress
eipaddress3
N/A
The 32-bit IP address of an Ethernet port that will be a criterion of the IP 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 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 number of an Ethernet port that will be a criterion of the IP 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 filter. If ENDPORT is present, this is the start of a range of logical ports that will apply to the IP 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 filter.
eportnumber
N/A
The logical port number of an Ethernet port that will be a criterion of the IP 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 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.
3-113
TABLE 3 -30.
IP FILTER and DIFFSERV Parameters

Field Length N/A Description The IP protocol type that will be a criterion of the IP filter: any - filter all protocols icmp - filter ICMP only udp - filter UDP only tcp - filter TCP only ospf - filter ospf only These protocols are typically associated with particular logical port values.
Parameter protocol
nifname
1-23
The name of the Network Interface that will be a criterion of the IP filter. The strings ALL, all, and cause all NIFs to match the filter. The application type that will be a criterion of the IP filter: any - 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.
application
N/A
dscp
N/A
The TOS value to be inserted into the packet header of all packets that match the named IP 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-241. The administrative state of the IP filter: disabled - Inactive and may be configured. enabled - Active, the IP filter can be enabled only if it is unique among existing enabled filters.
admin-state
N/A
Command Example
The commands below create and configure an IP 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
3-114
filter criteria. By creating and associating a DiffServ mark with that IP 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 FILTER f1 % CONFIGURE IP FILTER f1 PROTOCOL udp % CONFIGURE IP FILTER f1 SOURCEADDRESS .. START 10.20.20.0 ENDADDR 10.20.20.255 % CONFIGURE IP FILTER f1 SOURCEPORT .. START 5000 ENDPORT 5999 % CONFIGURE IP FILTER f1 DESTINATIONPORT .. START 6000 ENDPORT 6999 % CONFIGURE IP FILTER f1 STATE enabled % CREATE DIFFSERV MARK FILTER f1 % CONFIGURE DIFFSERV MARK FILTER f1 DSCP 5
To display configuration information about IP filter f1:

% SHOW IP FILTER f1
Node: TPUBS Date: 2002/02/07 19:40:37 GMT Zone: GMTMINUS05-EASTERN-US app srcIPAddrEnd dstIPAddrEnd srcPrtEnd ipProt
name
adminState srcIPAddrStart dstIPAddrStart srcPrtSt NIF ------------------------ --------------f1 ENABLED 10.20.20.0 0.0.0.0 5000 ANY
dstPrtSt
dstPrtEnd
--------------- --------- --------ANY UDP 10.20.20.255 255.255.255.255 5999 6000 6999
To display configuration information about the DiffServ mark associated with IP filter f1:
% SHOW DIFFSERV MARK f1
filter name dscp ------------------------ -------f1 5
Sonus PSX
SonusSoftSwitch
These objects identify and configure the Sonus PSX that the GSX9000 will use for route lookups.
Sonus PSX
3-115
Sonus PSX
The Sonus PSX performs route lookups and other related tasks. You can provide Sonus PSX redundancy by configuring up to two Sonus PSXs per GSX9000 node. Sonus PSXs are always in one of two administrative states:
enabled disabled
Redundant Sonus PSXs are always in one of three operational states:
active standby outofservice
From (operational state)
Changing to (operational state)
active active
-
standby
Remain in
outofservice
Affirm the prompt query. You may change the
admin-state enabled.
(Redundant PS changes to active.)
admin-state to disabled
after completing this command. (Redundant PS changes to active.)
standby
Remain in
admin-state enabled.
(The redundant PS changes to standby.)
Affirm the prompt query. You may change the
admin-state to disabled
after completing this command. Change the -
outofservice
Change the
admin-state to enabled if
necessary. (The redundant
admin-state to enabled if
necessary. (No change to the redundant active PS.)
active PS
changes to
standby.)
Command Syntax
CREATE SONUS SOFTSWITCH ssswname CONFIGURE SONUS SOFTSWITCH ssswname ..
3-116
Sonus PSX
IPADDRESS ipaddress PORT portnumber RETRY TIMER delaytime RETRY LIMIT retries KEEPALIVE TIMER keep-alive TRANSACTION TIMER transtime CONFIGURE SONUS SOFTSWITCH ssswname STATE admin-state CONFIGURE SONUS SOFTSWITCH ssswname .. MODE oper-state ACTION action CONFIGURE SONUS SOFTSWITCH .. SWITCHOVER switchover RETRY retrytime SHOW SONUS SOFTSWITCH ssswname STATUS SHOW SONUS SOFTSWITCH ssswname ADMIN SHOW SONUS SOFTSWITCH ALL STATUS SHOW SONUS SOFTSWITCH ALL ADMIN SHOW SONUS SOFTSWITCH SWITCHOVER DELETE SONUS SOFTSWITCH ssswname
Sonus PSX
3-117
Command Parameters
TABLE 3 -31.
Sonus SoftSwitch Parameters

Field Length 1-23 N/A Description An alphanumeric name that you assign to the Sonus PSX. 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. The logical port number for the GSX to use for IP communication with the Sonus PSX. Default is 3055. 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. The number of times to retry any Sonus PSX transaction. Must be 1-32, default is 3. 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. 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. The administrative state of the Sonus PSX: disabled - in this state the Sonus PSX is inactive and oper-state is outofservice. enabled - in this state the Sonus PSX operstate is active or standby.
Parameter ssswname ipaddress
portnumber
N/A
delaytime
N/A
retries
N/A N/A
keep-alive
transtime
N/A
admin-state
N/A
oper-state
N/A
The operational state of the Sonus PSX: active - In-service. standby - available for use but not active. outofservice - 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 - all queue entries are processed to completion unless retries expires. force - all queue transactions are dropped immediately.
3-118
Sonus PSX
TABLE 3 -31.
Sonus SoftSwitch Parameters

Field Length Description 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.
Parameter switchover
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.
Command Example
To create a single Sonus PSX and activate it:
% CREATE SONUS SOFTSWITCH ps1 % CONFIG SONUS SOFTSWITCH ps1 IPADDRESS 128.7.8.9 % CONFIG SONUS SOFTSWITCH ps1 PORT 1775 % CONFIG SONUS SOFTSWITCH ps1 RETRY TIMER 500 % CONFIG SONUS SOFTSWITCH ps1 RETRY LIMIT 3 % CONFIG SONUS SOFTSWITCH ps1 KEEPALIVE TIMER 15 % CONFIG SONUS SOFTSWITCH ps1 TRANSACTION TIMER 500 % CONFIG SONUS SOFTSWITCH ps1 MODE active
% CONFIG SONUS SOFTSWITCH ps1 ACTION dryup

% CONFIG SONUS SOFTSWITCH SWITCHOVER automatic % CONFIG SONUS SOFTSWITCH RETRY 8 % CONFIG SONUS SOFTSWITCH ps1 STATE enabled
To display the configuration of all Sonus PSXs:

% SHOW SONUS SOFTSWITCH ALL ADMIN
Node: TPUBS Date: 2000/08/04 19:45:18 GMT Zone: GMTMINUS05-EASTERN-US Action State ------ -------DRYUP ENABLED DRYUP ENABLED
Sonus Softswitch IpAddress Port Mode ------------------------ ----------------- ---- -----------rubble 128.6.254.225 3055 ACTIVE amber 128.6.254.249 3055 STANDBY
To display the status of all Sonus PSXs:

% SHOW SONUS SOFTSWITCH ALL STATUS
Node: TPUBS Date: 2000/08/04 19:44:45 GMT Zone: GMTMINUS05-EASTERN-US (ms) Ver Avg Recon Retries ----- ----- ------- -----1 4 0 0 1 0 0 0
Sonus Softswitch ----------------rubble amber
Failed Completed State -------- --------- ----0 55 ACTIVE 0 0 STANDBY
SS7 Gateway
3-119
The version of the Diameter protocol, used to communicate between the Sonus PSX and the GSX, is shown in the status display above.
SS7 Gateway
SS7Gateway
These objects identify and configure the SS7 gateway that will be accessed for call signaling control.
SS7 Gateway
The SS7 gateway interfaces the GSX9000 to the SS7 network. By supplying two gateways 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
Redundant SS7 gateways are always in one of two operational states:

Changing to (operational state) inservice outofservice Affirm the prompt query. You may disable after completing this command. If there are two SS7 gateways, the service may be impacted on a gateway failure. If there is only one SS7 gateway, this will stop all call processing and the SS7 node will be notified and marked outofservice.
outofservice
Change to enabled.
Command Syntax
CREATE SS7 GATEWAY ss7gwname CONFIGURE SS7 GATEWAY ss7gwname PRIMARY.. HOSTNAME pname IPADDRESS p-ipaddress
3-120
SS7 Gateway
ALTIPADDRESS a-ipaddress CONFIGURE SS7 GATEWAY ss7gwname SECONDARY.. HOSTNAME sname IPADDRESS s-ipaddress ALTIPADDRESS a-ipaddress CONFIGURE SS7 GATEWAY ss7gwname .. PRIMARY MODE oper-state CONFIGURE SS7 GATEWAY ss7gwname .. SECONDARY MODE oper-state CONFIGURE SS7 GATEWAY ss7gwname STATE admin-state SHOW SS7 GATEWAY ss7gwname ADMIN SHOW SS7 GATEWAY ss7gwname STATUS SHOW SS7 GATEWAY ALL ADMIN SHOW SS7 GATEWAY ALL STATUS DELETE SS7 GATEWAY ss7gwname
SS7 Gateway
3-121
Command Parameters
TABLE 3 -32.
SS7 Gateway Parameters

Field Length 1-23 1-39 N/A Description An alphanumeric name you assign to the SS7 gateway. The name of the host computer that will be the primary SS7 gateway. This name should be a DNS entry. The 32-bit IP address of the primary host (above) specified in dotted decimal form (for example 128.127.50.224). Default is 0.0.0.0. The 32-bit IP address of the alternate host (above) specified in dotted decimal form (for example 128.127.50.224). Default is 0.0.0.0. The operational state of the associated (primary or secondary) host: inservice outofservice
Parameter ss7gwname pname p-ipaddress
a-ipaddress
N/A
oper-state
N/A
sname s-ipaddress
1-39 N/A
The name of the secondary SS7 gateway host. This name should be a DNS entry. The 32-bit IP address of the secondary host (above) specified in dotted decimal form (for example 128.127.50.224). Default is 0.0.0.0. The administrative state of this SS7 gateway: disabled - Not active. enabled - Active.
admin-state
N/A
Command Example
To show all SS7 Gateway configuration information:
% SHOW SS7 GATEWAY ALL ADMIN
SS7 Gateway MaSS7Gateway Configuration Index: 1 Admin. State: ENABLED Socket Type: TCP Active Host: PRIMARY Primary Link: Host Name: amber IP Address: 192.6.54.249 Mode: INSERVICE Oos Delay: 0 minutes Secondary Link: Host Name: IP Address: 0.0.0.0 Mode: OUTOFSERVICE Oos Delay: 0 minutes
3-122
SS7 Node Profile
SS7 Node Profile

This object specifies the SS7 node profile for the SS7 gateway server application that the GSX client uses for call signaling control. You may assign required service properties to this application. You can use the profile to ensure that the SS7 nodes are always in one of two administrative states:
enabled disabled
SS7 nodes are always in one of two operational states:
Changing to (operational state) inservice outofservice Affirm the prompt query. The trunk group and ISUP service group objects are notified and the operational state for each of them goes to outofservice. When the timeout value expires, the SS7 node is in operational state outofservice and the administrative state may be disabled.
outofservice
Change administrative state to enabled. Change operational state to inservice.
Specifying SS7 Timers

The GSX9000 allows you to modify the default values for about 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. The SS7 timers on the SGX are set to sensible default values, for those timers where the ranges of possible values for all available protocols (ANSI, ITU, etc.) overlap. For timers where the legal ranges of values for the various protocols do not overlap, you must program the timer to a value that makes sense for the protocol you are using. 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.
Command Syntax
CREATE SS7 NODE PROFILE ss7nodeprofname
SS7 Node Profile
3-123
CONFIGURE SS7 NODE PROFILE ss7nodeprofname ... POINTCODE SIZE pcsize POINTCODE FORMAT pcformat CONFIGURE SS7 NODE PROFILE ss7nodeprofname ... SERVER PROTOCOL servprotocol SERVER HANDSHAKE INTERVAL hsinterval TIMER timer-name timer-value NETWORK INDICATOR indicator SLSBITS slsbits CONFIGURE SS7 NODE PROFILE ss7nodeprofname ... STATE admin-state SHOW SS7 NODE PROFILE ss7nodeprofname SHOW SS7 NODE PROFILE ALL DELETE SS7 NODE PROFILE ss7nodeprofname
3-124
SS7 Node Profile
Command Parameters
TABLE 3 -33.
SS7 Node Profile Parameters

Field Length 1-23 N/A Description The name of the SS7 Node Profile. This name is created when you create the SS7 Node Profile. 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.
Parameter ss7nodeprofname pcsize
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 accomodates any point code representation consisting of decimal numbers separated by dashes, adding up to the total number of bits in the point code. The sum of w1+w2+w3[+wn] must be no greater than 32 (bits). For example, 8-8-8 specifies three 8-bit values which, 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 8-8-8 format is the default for ANSI point codes. The default ITU point code format is 3-83, or 14 total bits. If you want to use a different point code format, without changing the default point code size, use the PC FORMAT parameter, instead.
servprotocol
N/A
The server protocol used on this interface between the SS7 Client on the GSX and the SS7 Gateway (SGX). dgmsProp - SGX proprietary dgmsRaw - ISUP Raw mode tekTali - not yet supported dgmsSuperRaw - ISUP Super Raw mode. See Table 3 -36, Release 4.0 SS7 Server Protocols and ISUP Variants.
SS7 Node Profile
3-125
TABLE 3 -33.
SS7 Node Profile Parameters

Field Length 1 - 255 Description Handshake interval between the client and the server in seconds. This feature is not yet in use but will be in the future. See Table 3 -34, SS7 Node Profile Timer Parameters for TIMER names. For additional detail on the function of each timer, see the ANSI T1.113-1995 specification.
Parameter hsinterval
timer-name
timer-value
See Table 3 -34, SS7 Node Profile Timer Parameters for TIMER values. For additional detail on the function of each timer, see the ANSI T1.113-1995 specification.
slsbits indicator
N/A N/A
Specifies the number of SLS bits to use. Must be 48, default is 5 (SLS bits). 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 - Corresponds to 10 natl1 - Corresponds to 11
admin-state
N/A
The administrative state of this SS7 node: disabled - Not active and must be in outofservice oper-state beforehand. enabled - Active.
3-126
SS7 Node Profile
TABLE 3 -34.
SS7 Node Profile Timer Parameters

timer-value type INTEGER Description The Timer T1 can be changed from its default using this parameter. The valid ranges are 4 - 15 (seconds) for ANSI and 15 - 60 (seconds) for ITU. The Timer T2 can be changed from its default using this parameter. The valid value for ITU is 180 (seconds). Range 1 - 255. Default is 180. This timer has no relevance in the ANSI network. The T3 timer is started on receipt of an Overload message in the ITU network. This has no relevance in the ANSI network. The valid ITU recommended value is 120 (seconds). Range is 1 255. Default is 120. The Timer T4 can be changed from its default using this parameter. Range is 300 - 900. The T5 Timer is started when the release message is sent. The valid values as per the specifications are 60 seconds for ANSI and 300 to 900 (seconds) for ITU. Range is 60 - 900. The timer T6 is started when the suspend message is received. Range is 10 - 32 (seconds). Default is 22. The Timer T7 can be changed from its default using this parameter. Range is 20 - 30. The T8 timer is the timer to be started when a continuity check has been indicated in the IAM. Range is 10 to 15 (seconds). Default is 13. The Timer T9 is started when the outgoing international exchange receives an ACM. The valid range is 120 - 240 (seconds). Default is 180. The Timer T10 is started when the last digit is received in interworking situations. This timer has no relevance to ANSI. Range is 240 - 360. Default is 300. The Timer T11 is started when the latest address message is received in interworking situations. The valid range is 15 - 20 (seconds). The Timer T12 is started when a blocking message is sent. The valid ranges are 4 - 15 (seconds) for ANSI and 15 - 60 (seconds) for ITU. The Timer T13 is started when the initial blocking messge is sent. The valid value for ANSI is 60 (seconds) and for ITU is 300 - 900 (seconds). Range is 60 - 900. The Timer T14 is started when an unblocking message is sent. The valid values are 4 - 15 (seconds) for ANSI and 15 - 60 (seconds) for ITU. Range is 4 - 60.
timer-name T1
T2
INTEGER
T3
INTEGER
T4 T5
INTEGER INTEGER
T6
INTEGER
T7 T8
INTEGER INTEGER
T9
INTEGER
T10
INTEGER
T11
INTEGER
T12
INTEGER
T13
INTEGER
T14
INTEGER
SS7 Node Profile
3-127
TABLE 3 -34.

timer-value type INTEGER Description The Timer T15 is started when the initial unblocking message is sent. The valid values are 60 (seconds) for ANSI and 300 - 900 (seconds) for ITU. Range is 60 - 900. The Timer T16 is started when the reset circuit is started which was not due to expiration of T5. The valid ranges are 4 - 15 (seconds) for ANSI and 15 - 60 (seconds) for ITU. Range is 4 - 60. The Timer T17 is started when initial reset message is sent. The valid values are 60 (seconds) for ANSI and 300 - 900 for ITU. Range is 60 - 900. The Timer T18 is started when circuit group blocking message is sent. The valid values are 4 15 (seconds) for ANSI and 15 - 60 (seconds) for ITU. Range is 4 - 60. The Timer T19 is started when an initial group blocking message is sent. The valid values are 60 (seconds) for ANSI and 300 - 900 (seconds) for ITU. Range is 60 - 900. The Timer T20 is started when a group unblocking message is sent. The valid ranges are 4 - 15 (seconds) for ANSI and 15 - 60 (seconds) for ITU. Range is 4 - 60. The Timer T21 is started when an initial group blocking message is sent. The valid values are 60 (seconds) for ANSI and 300 - 900 (seconds) for ITU. Range is 60 - 900. The Timer T22 is started when a circuit group reset message is sent. The valid values are 4 - 15 (seconds) for ANSI and 15 - 60 (seconds) for ITU. Range is 4 - 60. The Timer T23 is started when an initial group reset message is sent. The valid values are 60 (seconds) for the ANSI and 300 - 900 (seconds) for the ITU. Range is 60 - 900. The Timer T24 is started when a check tone is sent. The value is less than 2 (seconds). Range is 1 - 2. The Timer T25 is started when initial continuity check failure is detected. The range is 1 - 10 (seconds). Default is 5. The Timer T26 is started when a second or subsequent continuity failure is detected. Range is 60 180 (seconds). Default is 120. The Timer T27 is started when a continuity fail message is received. The valid values are more than 180 (seconds) for ANSI and 240 seconds for ITU. Range is 180 - 36000. Default is 240. The Timer T28 is started when a Circuit Query Message is sent. The valid value is 10 (seconds). Range is 5 - 12. Default is 10.
timer-name T15
T16
INTEGER
T17
INTEGER
T18
INTEGER
T19
INTEGER
T20
INTEGER
T21
INTEGER
T22
INTEGER
T23
INTEGER
T24
INTEGER
T25
INTEGER
T26
INTEGER
T27
INTEGER
T28
INTEGER
3-128
SS7 Node Profile
TABLE 3 -34.

timer-value type INTEGER Description The Timer T29 is started when a Congestion indication is received when T29 is not running. The valid range is 300 - 600 (milliseconds). This timer has no relevance for ANSI. Range is 300 600. The Timer T30 is started when a congestion indication is received when T29 is not running. The valid range is 5 - 10 (seconds) for the ITU. This timer has no relevance under ANSI. Range is 5 10. The Timer T31 is started on release of ISUP signalling connection based on CO SCCP. The value should be set to greater than 360 (seconds). Range is 360 - 65520. The Timer T32 is started when the first end-toend message is received. Under ANSI this timer is started after the response to such a message is sent. The valid values are 3 - 5 (seconds). Default is 4. The Timer T33 is started when Information Request Message is sent. Range is 12 - 15 (seconds). Default is 14. The Timer T34 is started when Loop Back Acknowledgement is sent under ANSI. The Timer T34 is started when segmentation is received for IAM, ACM, CPG, ANM or CON under ITU. The valid range for ANSI is 10 - 15 (seconds). The valid range for ITU is 2 - 4 (seconds).
timer-name T29
T30
INTEGER
T31
INTEGER
T32
INTEGER
T33
INTEGER
T34
INTEGER
T35
INTEGER
The Timer T35 is started when the last digit received is not an ST digit or the fixed number of digits have been received. This procedure is only valid for overlap hence ITU. This timer has no relevence in ANSI. Range is 15 - 20. Default is 18. The Timer T36 is started when IAM is recived with a segmentation indication for ANSI. This timer is started when transit or incoming international exchange recieves Continuity check request message. The valid range for ANSI is 2 4 (seconds) and 10 - 15 (seconds) for ITU. Overall range is 2 - 15. The Timer T37 is started when User Part Availability test is started under ANSI. This timer is started when a request for and Echo control device is sent to another exchange under ITU. The valid value for ANSI is 30 (seconds) and for ITU is 2 - 4 (seconds). The Timer T38 is started when a suspend message is sent to the preceding switch. This timer is only relevant under ITU. Range is 10 - 60. Default is 30.
T36
INTEGER
T37
INTEGER
T38
INTEGER
SS7 Node Profile
3-129
TABLE 3 -34.

timer-value type INTEGER Description The Timer T39 is started when MCID request is sent. It is relevant only in ITU. Range is 1 65535. The Timer T40 could be changed from its default using this parameter. Range is 1 - 65535. This Bellcore specific timer is the guard timer on outgoing SS7 circuit before idling. Range is 0 1000, default is 0 (milliseconds). Automatic Congestion Control Timer as per ANSI T1.113.4 - 1995. Range is 3 - 8 (seconds). Default value of the timer is 5 (seconds). This Bellcore specific timer is started when blocking a circuit with a BLO, and after any call is released. This information is used to notify maintenance. Range is 240 - 360, default is 300 (milliseconds?). Continuity Check Request Timer. Default value as per ANSI T1.113.4 - 1995 is 2 (seconds). Range is 1 - 3. TCcrr Timer is started when Continuity Check Failed Received. Default value as per ANSI T1.113.4 - 1995 is 20 (seconds). Range is 16 - 31. Timer started on receipt of a Circuit Group Block Message. Default value as per ANSI T1.113.4 1995 is 5 (seconds). Range is 3 - 8. This Bellcore specific timer is started when sending an IAM requesting continuity check. Range is 0 - 500, default is 0 (milliseconds). This Bellcore specific timer is started when receiving a second COT coded failed while awaiting receipt of a CCR. Range is 240 - 300, default is 250 (milliseconds?). Timer started when Circuit Reservation Acknowledgment is sent. Default value as per ANSI T1.113.4 - 1995 is 20 (seconds). Range is 16 - 31. This timer is started when the circuit reservation message is sent. Range as per ANSI T1.113.4 1995 is 3 - 4 (seconds). Default is 4 (seconds). The Timer TCVT is started when the Circuit Validation Test message is sent. This message is only valid for ANSI. Range is 5 - 12. Default is 10. The Timer TExm is started when IAM is sent to the succeeding network. This timer has no relevance in ITU. Range is 1 - 65535. This timer is started when a circuit group reset message is received. This timer is only relevant in the ANSI network. Range is 3 - 8. Default is 5.
timer-name T39
T40 TA
INTEGER INTEGER
TAcc
INTEGER
TBlom
INTEGER
TCcr
INTEGER
TCcrr
INTEGER
TCgb
INTEGER
TCotd
INTEGER
TCotl
INTEGER
TCra
INTEGER
TCrm
INTEGER
TCvt
INTEGER
TExm
INTEGER
TGrs
INTEGER
3-130
SS7 Node Profile
TABLE 3 -34.

timer-value type INTEGER Description This timer is started on recognition of carrier loss. It is only relevent in ANSI network. Range is 0 300 (seconds). Default is 150. This timer is started when initial demand continuity check fails in the SCGA group. Range is 0 120 (seconds). Default is 60. This timer is started on failure of demand continuity check in the SCGA group. Range is 5 - 120. Default is 65. This Bellcore specific timer is started when a SUS message is sent by the terminating switch while awaiting called party off-hook or REL. Range is 14 -16, default is 15 (seconds). This timer is started after a network initiated SUS is received at a transit exchange for ITU. Range is 2 - 1800, default is 1200 (seconds). This timer is started after a network initiated SUS is recevied at a terminating exchange for ITU. Range is 2 to 180, default is 140 (seconds). This timer is started after an ACM is received at a Transit exchange for ITU. Range 300 to 900, default is 600 (seconds). This timer is started after an ACM is received at an interworking or at an international exchange for ITU. Range is 120 to 900, default is 200 (seconds). This timer is started at the originating exchange after an ACM is received for ITU. Range is 300 to 900, default is 600 (seconds). This BT7 specific timer is started on nonreceipt of Unblocking Acknowledgement (UBA), to await the receipt of UBA. Range is 300 to 900, default is 360 (seconds). This BT7 specific timer is started when awaiting Circuit Free or Blocking Message. Range is 300 to 900, default is 360 (seconds). This BT7 specific timer could be changed from its default using this entry. The valid ranges are 0 to 180, default is 0 (seconds). This BT7 specific timer could be changed from its default using this entry. The valid ranges are 0 to 120, default is 0 (seconds). This BT7 specific timer could be changed from its default using this entry. The valid ranges are 2 to 180, default is 180 (seconds). This BT7 specific timer could be changed from its default using this entry. The valid ranges are 5 to 86400, default is 86400 (seconds, which is 24 hours).
timer-name THga
TScga
INTEGER
TScgad
INTEGER
TSus
INTEGER
T6Trans
INTEGER
T6Term
INTEGER
T9Trans
INTEGER
T9Int
INTEGER
T9Orig
INTEGER
T8a
INTEGER
T12a
INTEGER
T1a
INTEGER
T1b
INTEGER
T1c
INTEGER
T1d
INTEGER
SS7 Node
3-131
Command Example
To display configuration information about all SS7 node profiles:
% SHOW SS7 NODE PROFILE ALL
SS7 Node Profile Default PointCode Size in Bits : PointCode Format : Server Protocol : Handshake Interval : Network Indicator : State : Timer Settings (Secs) : T1 : 10 T11: 17 T2 : 180 T12: 10 T3 : 120 T13: 60 T4 : 600 T14: 10 T5 : 60 T15: 60 T6 : 22 T16: 10 T7 : 25 T17: 60 T8 : 13 T18: 10 T9 : 180 T19: 60 T10: 0 T20: 10 TA : 500 (msecs) TCotd: 250 (msecs) TCotl: 300 SLS bits :
24 8-8-8 DGMSPROP 0 Secs NATL0 DISABLED T21: 60 T31: 420 TAcc: 5 T22: 10 T32: 4 TCcr: 2 T23: 60 T33: 14 TCcrr: 20 T24: 1 T34: 0 TCgb: 5 T25: 5 T35: 18 TCra: 20 T26: 120 T36: 3 TCrm: 4 T27: 240 T37: 30 TCvt: 10 T28: 10 T38: 30 TExm: 0 (msecs) T29: 0 T39: 0 TGrs: 5 T30: 0 T40: 0 THga: 150 TBlom: 300 TScga: 60 TSus : 15 TScgad: 65 5
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. SS7 nodes are always in one of two administrative states:
enabled disabled
SS7 nodes are always in one of two operational states:
3-132
SS7 Node
Changing to (operational state) inservice outofservice Affirm the prompt query. The trunk group and ISUP service group objects are notified and the operational state for each of them goes to outofservice. When the timeout value expires, the SS7 node is in operational state outofservice and the administrative state may be disabled.
outofservice
Change administrative state to enabled. Change operational state to inservice.
Command Syntax
CREATE SS7 NODE ss7nodename PROTOCOL protocol CONFIGURE SS7 NODE ss7nodename .. PC localpc SERVICES services SS7 GATEWAY ss7gwname MODE oper-state CONNECT connect PROFILE profilename POINTCODE SIZE pcsize POINTCODE FORMAT pcformat SERVER PROTOCOL servprotocol SERVER HANDSHAKE INTERVAL hsinterval TIMER timer-name timer-value SLSBITS slsbits NETWORK INDICATOR indicator ISUP VARIANT isupvar TEARDOWN CALLS tdcalls CONFIGURE SS7 NODE ss7nodename STATE admin-state SHOW SS7 NODE ss7nodename ADMIN SHOW SS7 NODE ss7nodename STATUS SHOW SS7 NODE ALL ADMIN SHOW SS7 NODE ALL STATUS
SS7 Node
3-133
DELETE SS7 NODE ss7nodename
Command Parameters
TABLE 3 -35.
SS7 Node Parameters

Field Length 1-23 Description The name of the SS7 node. This name was created when you configured the SS7 gateway software (see the SGX SS7 Signaling Gateway Installation and Operations Guide). The local or originating point code that identifies the SS7 node. The SS7 protocol type supported by this Node entry. Protocol choices are: ansi itu etsi japan bt7 -
Parameter ss7nodename
localpc protocol
N/A N/A
services
N/A
The SS7 services required by this client: isupOnly tcapOnly isupAndTcap
ss7gwname connect
1-23 N/A
The name that you assigned to the SS7 gateway on which this node is configured. 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 - ISUP service connection will be established only if there are ISUP circuits assigned to this node. This parameter applies to ISUP service registration.
profilename pcsize
1 - 24 N/A
Name of the profile. 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.
3-134
SS7 Node
TABLE 3 -35.
SS7 Node Parameters

Field Length N/A Description 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 accomodates any point code representation consisting of decimal numbers separated by dashes, adding up to the total number of bits in the point code. The sum of w1+w2+w3[+wn] must be no greater than 32 (bits). For example, 8-8-8 specifies three 8-bit values which, 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 8-8-8 format is the default for ANSI point codes. The default ITU point code format is 3-8-3, or 14 total bits. If you want to use a different point code format, without changing the default point code size, use the PC FORMAT parameter, instead.
Parameter pcformat
oper-state
N/A
The operational state of the node: inservice outofservice - must be in this state to be disabled.
servprotocol
N/A
The server protocol used on this interface between the SS7 Client on the GSX and the SS7 Gateway (SGX). dgmsProp - SGX proprietary dgmsRaw - ISUP Raw mode tekTali - not yet supported dgmsSuperRaw - ISUP Super Raw mode. See Table 3 -36, Release 4.0 SS7 Server Protocols and ISUP Variants.
hsinterval
1 - 255
Handshake interval between the client and the server in seconds. Not presently in use. Included for a future release. See Table 3 -34, SS7 Node Profile Timer Parameters for TIMER names. For additional detail on the function of each timer, see the ANSI T1.113-1995 specification.
timer-name
timer-value
See Table 3 -34, SS7 Node Profile Timer Parameters for TIMER values. 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 48, default is 5 (SLS bits).
SS7 Node
3-135
TABLE 3 -35.
SS7 Node Parameters

Field Length N/A Description Specifies the SS7 ISUP variant set during Client Initialization: standard - Default ISUP variant. j7ttc - Japan ISUP variant.
Parameter isupvar
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 - 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 - Do not tear down the active calls.
admin-state
N/A
The administrative state of this SS7 node: disabled - Not active and must be in outofservice oper-state beforehand. enabled - Active.
Table 3 -36, Release 4.0 SS7 Server Protocols and ISUP Variants summarizes provisioning relationships between the SS7 NODE SERVER PROTOCOL and the ISUP SERVICE variants (or protocol REVISION). The dgmsSuperRaw SERVER PROTOCOL, used to communicate between the GSX and the SGX, was introduced in Release 4.0. This protocol improves the reliability, performance, and compliance of ISUP processing. This protocol is not yet available for the Japan variant. Eventually, dgmsSuperRaw SERVER PROTOCOL will be the single, Sonus recommended choice for all ISUP variants.
TABLE 3 -36.
Release 4.0 SS7 Server Protocols and ISUP Variants

SS7 NODE SERVER PROTOCOL Server protocol dgmsProp must be used.
ISUP REVISION ansi1992 ansi1995 itu1993 itu1997 itu1988 ituq767 etsi2 belgacom
All server protocols except dgmsProp are available. Sonus recommends dgmsSuperRaw.
3-136
SS7 Node
TABLE 3 -36.
Release 4.0 SS7 Server Protocols and ISUP Variants

SS7 NODE SERVER PROTOCOL
ISUP REVISION denmarkic etsi3 hongkongic italy mexicoic singapore spirou nttfcc
Server protocol dgmsSuperRaw must be used.
Server protocol dgmsRaw must be used.
Command Example
To display configuration information about all SS7 nodes:
% SHOW SS7 NODE ALL ADMIN
SS7 Node QAn2 Configuration Index : Admin. State : Mode : Gateway Assignment : Point Code (decimal) : Protocol Type : Services : Isup Connect Cntrl : PointCode Size in Bits : PointCode Format : Server Protocol : Handshake Interval : Network Indicator : Timer Settings (Secs) : T1 : 10 T11: 17 T2 : 180 T12: 10 T3 : 120 T13: 60 T4 : 600 T14: 10 T5 : 60 T15: 60 T6 Orig: 22 T16: 10 T7 : 25 T17: 60 T8 : 13 T18: 10 T9 Term: 220 T19: 60 T10: 0 T20: 10 TA : 0 (ms) TCotd: 0 (ms) TCotl: 250 T9 Trans: 600 SLS bits : 5 SS7 Node QAn3 Configuration Index : Admin. State : Mode : Gateway Assignment :
1 ENABLED INSERVICE RubbleSS7 2-2-2 (131586) ANSI ISUPONLY ALWAYS 24 8-8-8 DGMSPROP 0 Secs NATL0 T21: 60 T31: T22: 10 T32: T23: 60 T33: T24: 1 T34: T25: 5 T35: T26: 120 T36: T27: 240 T37: T28: 10 T38: T29: 0 T39: T30: 0 T40: TBlom: 300 TSus : 15 T6 Term: 140 T9 Iwk/Intl: 200 420 4 14 12 18 3 30 100 0 0 TAcc: 5 TCcr: 2 TCcrr: 20 TCgb: 5 TCra: 20 TCrm: 4 TCvt: 10 TExm: 0 (ms) TGrs: 5 THga: 150 TScga: 60 TScgad: 65 T6 Trans: 1200 T9 Orig: 600
2 ENABLED INSERVICE AmberSS7
SS7 Node
3-137
Point Code (decimal) Protocol Type Services Isup Connect Cntrl PointCode Size in Bits PointCode Format Server Protocol Handshake Interval Network Indicator Timer Settings (Secs) T1 : 10 T11: 17 T2 : 180 T12: 10 T3 : 120 T13: 60 T4 : 600 T14: 10 T5 : 60 T15: 60 T6 Orig: 22 T16: 10 T7 : 25 T17: 60 T8 : 13 T18: 10 T9 Term: 220 T19: 60 T10: 0 T20: 10 TA : 0 (ms) TCotd: 0 (ms) TCotl: 250 T9 Trans: 600 SLS bits : 5
: : : : : : : : : :
11-3-3 (721667) ANSI ISUPONLY ALWAYS 24 8-8-8 DGMSPROP 0 Secs NATL0 T21: 60 T31: T22: 10 T32: T23: 60 T33: T24: 1 T34: T25: 5 T35: T26: 120 T36: T27: 240 T37: T28: 10 T38: T29: 0 T39: T30: 0 T40: TBlom: 300 TSus : 15 T6 Term: 140 T9 Iwk/Intl: 200 420 4 14 12 18 3 30 100 0 0 TAcc: 5 TCcr: 2 TCcrr: 20 TCgb: 5 TCra: 20 TCrm: 4 TCvt: 10 TExm: 0 (ms) TGrs: 5 THga: 150 TScga: 60 TScgad: 65 T6 Trans: 1200 T9 Orig: 600
To display status information about SS7 node QAn3:

% SHOW SS7 NODE QAn3 STATUS
SS7 Node QAn3 Status Mode: Index: Services: Isup Status:
INSERVICE 2 ISUPONLY ACTIVE
Gateway to Gateway Signaling

GatewaytoGatewaySignaling
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.
3-138
Gateway Signaling Port

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 have been reconfigured 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 reconfigured without shutting down this GSX. Gateway signaling ports are always in one of two administrative states:
enabled disabled
Gateway signaling ports are always in one of two operational states:
inService outOfService
Gateway signaling ports always take one of two roles:
primary secondary
The procedures for changing roles are:
From primary
To primary secondary You are asked to confirm that you know this will keep this GSX from creating new gateway signal links to other GSXs. In the new secondary role, this signal port will listen only.
secondary
(If the other port was primary, it is automatically made secondary.) This GSX will make gateway signal link connection requests to other GSXs using this signal port address as the local address.
3-139
The procedures for changing operational states are:
From (operational state) inService
Changing to (operational state) inService outOfService If this port is currently primary, you will be asked to confirm that you know this action will keep this GSX from creating new gateway signal links. Once the port is outOfService, you can set its administrative state to disabled. Once disabled, the signaling port may be deleted. -
outOfService
First, set the administrative state to enabled. Then, regardless of its ROLE, the port will listen for incoming gateway signal link connection requests.
Command Syntax
CREATE GATEWAY SIGNALING PORT sig-port CONFIGURE GATEWAY SIGNALING PORT sig-port .. IPADDRESS ipaddress PORTNUM log-port INTERFACE nif-type ROLE role MODE oper-state CONFIGURE GATEWAY SIGNALING PORT sig-port .. STATE admin-state SHOW GATEWAY SIGNALING PORT sig-port ADMIN SHOW GATEWAY SIGNALING PORT sig-port STATUS SHOW GATEWAY SIGNALING PORT ALL ADMIN SHOW GATEWAY SIGNALING PORT ALL STATUS DELETE GATEWAY SIGNALING PORT sig-port
3-140
Command Parameters
TABLE 3 -37.
Gateway Signaling Port Parameters

Field Length N/A N/A Description The logical reference number to the port for use with SNMP and/or CLI. Must be 1-2. 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.
Parameter sig-port ipaddress
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. The type of network interface being configured for this function: mgtNif - The Management Network interface on the MNA10 module. nif - The Packet Network interface on any PNA module. If nif (PNA) is chosen, then call signaling bandwidth usage will be taken from the PNA bandwidth budgets. This allocation is approximately 1.2 Mb/sec. For an IP over ATM NIF, the GATEWAY SIGNALING PORT must be configured first before the IP over ATM NIF is configured. By doing so, the IP over ATM NIF will properly allocate 10% of its bandwidth for call signaling. If an ATM NIF is configured before the GATEWAY SIGNALING PORT, the ATM maximum bandwidth calculation will not allocate the 10% overhead required for gateway to gateway signaling.
nif-type
N/A
role
N/A
The main role of the signaling port: primary - 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.
3-141
TABLE 3 -37.
Gateway Signaling Port Parameters

Field Length N/A Description The operational state of the signaling port: inService - 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 - Not active. enabled - Active.
Command Example
To create and configure a gateway signaling port on the MNA10 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
To display the administrative status of this gateway:

% SHOW GATEWAY SIGNALING PORT 1 ADMIN
Node: TPUBS Date: 2001/02/09 17:00:57 GMT Zone: GMTMINUS05-EASTERN-US Port Num Intf Role Mode State ---- ---- --------- --------- ------2569 NIF PRIMARY INSERVICE ENABLED
Port Num IP Addr ---- ---------------1 128.2.3.4
To create a gateway signaling port and configure it to use an IP over ATM NIF:
% CREATE GATEWAY SIGNALING PORT 1 % CONFIGURE GATEWAY SIGNALING PORT 1 .. INTERFACE nif IPADDR 10.99.1.53 % CONFIGURE GATEWAY SIGNALING PORT 1 STATE enabled % CONFIGURE GATEWAY SIGNALING PORT 1 MODE inservice % CONFIGURE NIF IPOA-1-9-1-1 IPADDRESS 10.7.10.65 .. MASK 255.255.255.0 NEXTHOP 0.0.0.0 % CONFIGURE NIF IPOA-1-9-1-1 STATE enabled
3-142
Gateway Signaling Service
Note
This example properly configures an IP over ATM NIF for gateway signaling. The gateway signaling port is created and configured first. If the ATM NIF is configured before the gateway signaling port, the ATM maximum bandwidth calculation will not allocate the 10% overhead required for gateway to gateway signaling.
Gateway Signaling Service

This object specifies the call timers for call signaling between this GSX and other gateways. These timers take effect on new calls but not on currently active calls.
Command Syntax
CONFIGURE GATEWAY SIGNALING SERVICE .. T301 establishtime T303 setuptime SHOW GATEWAY SIGNALING TIMERS ADMIN
Command Parameters
TABLE 3 -38.
Gateway Signaling Service Parameters

Field Length N/A Description This parameter is no longer accessed by the GSX software. It remains in this reference because its MIB is still present. This parameter is no longer accessed by the GSX software. It remains in this reference because its MIB is still present.
Parameter establishtime
setuptime
N/A
Gateway Signaling Link

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.
Command Syntax
CONFIGURE GATEWAY SIGNALING LINK OPEN .. IPADDRESS ipaddress CONFIGURE GATEWAY SIGNALING LINK OPEN .. IPADDRESS ipaddress PORTNUM log-port CONFIGURE GATEWAY SIGNALING LINK CLOSE .. IPADDRESS ipaddress DIRECTION direction CONFIGURE GATEWAY SIGNALING LINK ..
Gateway Signaling Link
3-143
ESTABLISHTIMER establishtime KEEPALIVETIMER katime SHOW GATEWAY SIGNALING LINK SUMMARY ACTIVE SHOW GATEWAY SIGNALING TIMERS ADMIN SHOW GATEWAY SIGNALING LINK .. IPADDRESS ipaddress ACTIVE SHOW GATEWAY SIGNALING LINK .. IPADDRESS ipaddress STATISTICS
Command Parameters
TABLE 3 -39.
Gateway Signaling Link Parameters

Field Length N/A Description 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. The logical port number to use for this connection. The direction in which to tear down the link: to - 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.
Parameter ipaddress
log-port direction
N/A N/A
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. The time interval (in seconds) between keepalive polls between GSXs. Must be 1-65535, default is 3 (seconds).
katime
N/A
Command Example
To open a link to a GSX at Internet address 128.6.7.8 on logical port 1999:
% CONFIG GATEWAY SIGNAL LINK OPEN .. IPADDRESS 128.6.7.8 PORT 1999
To display the administrative status of all active links:

% SHOW GATEWAY SIGNALING LINK SUMMARY ACTIVE
Node: TPUBS Date: 2001/02/01 15:10:44 GMT Zone: GMTMINUS05-EASTERN-US Num Calls From ----0
Num Calls IP Addr To ---------------- ----128.6.7.8 417
ToState FromState --------- --------INSERVICE OUTOFSERV
Intf ---NIF
3-144
H323 Signaling Service
H323 Signaling Service H323

This object allows you to configure H323 signaling ports on the GSX, allowing the GSX to function as an H323 Gateway, supporting H323 Network to Network call interoperability. The overview of H323 services is described elsewhere in the Sonus technical documentation. The signaling services that must be configured are:
H.225 for call setup and release H.245 for audio control
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:
Configure the signaling addresses and timers described below. Configure the Packet Service Profile appropriately, as described in Packet Service Profile on page 3-241; this object is used for all H323 Gateway to GSX calls. G.711 A-law G.711 U-law G.729A+B voice compression G.729A voice compression 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 number of active calls number of ingress calls attempted number of ingress calls completed number of egress calls attempted number of egress calls completed number of H225 TCP connections opened number of H.225 bytes and messages sent number of H.225 bytes and messages received number of H.245 TCP connections opened number of H.245 TCP listening ports allocated number of H.245 bytes and messages sent (when in a separate TCP channel) number of H.245 bytes and messages received (when in a separate TCP channel)
The following H323 audio capabilities are supported:
The H323 SHOW commands provide the following statistics:
3-145
Note
Call accounting records will be generated by both the GSX and the PSX for H323 calls that involve a GSX. The accounting records generated by the GSX do not include the H323 Call Identifier. The H323 service on the GSX is always in one of two administrative states:
enabled disabled
The H323 service on the GSX is always in one of two operational states:
3-146
Changing to (operational state) inService outOfService Affirm the prompt query. If ACTION is none, then no further action is taken and the H323 service remains inservice. If ACTION is dryup and TIMEOUT is not specified or its value is 0, then no new calls are accepted and all currently active calls are allowed an indefinite time period to finish before the action described below is taken. If TIMEOUT is nonzero, then no new calls are accepted, and all currently active calls are allowed TIMEOUT minutes to finish. After TIMEOUT minutes, all remaining active calls are dropped. If ACTION is not specified or ACTION is force, no new calls are accepted and all active calls are immediately dropped. When no more calls are active, for any of the above reasons, the H323 service goes to operational state outofservice. The logical addresses for H.225 and H.245 are removed, and will no longer respond to a ping. The administrative state of the H323 service may be disabled.
outofservice
Change the admin-state to enabled, if necessary. Change operational state to inservice. The H323 service is started on the specified PNS module: The logical addresses for H.225 and H.245 should both respond to a ping. Ingress and egress calls may be made.
Command Syntax
CONFIGURE H323 SERVICE H225 SIGNALING ..
3-147
SHELF shelf SLOT slot IPADDRESS ipaddress1 PORTNUM log-port CONFIGURE H323 SERVICE H245 SIGNALING .. SHELF shelf SLOT slot IPADDRESS ipaddress2 CONFIGURE H323 SERVICE MODE oper-state CONFIGURE H323 SERVICE MODE oper-state ACTION action CONFIGURE H323 SERVICE MODE oper-state .. ACTION action TIMEOUT timeout CONFIGURE H323 SERVICE TIMER .. T301 t301 T303 t303 T310 t310 TCPESTABLISH tcpestablish TCPCONNECT tcpconnect CONFIGURE H323 SERVICE STATE admin-state SHOW H323 SERVICE ADMIN SHOW H323 SERVICE STATUS
3-148
Command Parameters
TABLE 3 -40.
H323 Signaling Service Parameters

Field Length N/A N/A Description The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. 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. 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. 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. The logical port number to use for this connection. This defines the H.225 well known port. Must be 165535, default is 1720. 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. 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 0127, default is 4 (seconds). A value of 0 means use the default. 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. The TCPESTABLISH timer , applicable only to ingress calls, (in seconds). This is the maximum interval between a TCP connection that has been accepted by the GSX and the receipt of an H.225 SETUP. Must be 0-127, default is 4 (seconds). A value of 0 means use the default. Specifies the maximum time (in seconds) to wait for the TCP connection to be established (when the GSX originates the H323 call). If this timer expires and there are additional routes, then then a reattempt with a new route will be tried. A value of 0 disables this timer. Must be 0-127, default is 3 (seconds). Sonus recommends a minimum value of 3 seconds for this parameter.
ipaddress1
N/A
ipaddress2
N/A
log-port
N/A
t301
N/A
t303
N/A
t310
N/A
tcpestablish
N/A
tcpconnect
N/A
3-149
TABLE 3 -40.
H323 Signaling Service Parameters

Field Length N/A Description 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. The administrative state of this H323 signaling service: disabled - Not active. enabled - Active.
admin-state
N/A
Command Example
To configure an H323 server 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):
% CONFIGURE H323 SERVICE H225 SIGNALING SHELF 1 .. SLOT 3 IPADDRESS 128.6.7.8 % CONFIGURE H323 SERVICE H245 SIGNALING SHELF 1 .. SLOT 3 IPADDRESS 128.6.7.8 % CONFIGURE H323 SERVICE TIMER TCPESTABLISH 10 % CONFIGURE H323 SERVICE STATE enabled % CONFIGURE H323 SERVICE MODE inService
To display the current configuration of the H323 signaling ports:

% SHOW H323 SERVICE ADMIN
H323 Service: Mode State ------------ -----INSERVICE ENABLED
3-150
SIP Signaling Port
H225 IP Addr PortNum Shelf Slot ---------------- ------- ----- ---128.6.7.8 1720 1 3 H245 IP Addr PortNum Shelf Slot ---------------- ------- ----- ---128.6.7.8 N/A 1 3 H323 H323 H323 H323 H323 H323 Timers: Call Establishment timer (T301): 180 seconds Call Setup timer (T303): 4 seconds Call Proceeding (T310): 10 seconds Link Establishment timer: 10 seconds TCP Connect timer: 3 seconds
To display the current status of the H323 signaling ports:

% SHOW H323 SERVICE STATUS
Node: TPUBS Date: 2001/01/23 18:52:59 GMT Zone: GMTMINUS05-EASTERN-US --------------------------------------------------------------------H323 Service Mode: INSERVICE State: ENABLED Active Calls: Call Attempts: Call Completions: H225 Port Status: Messages Sent: Bytes Sent: TCP Connections: H245 Port Status: AVAILABLE Messages Sent: 14 Messages Received: 12 Bytes Sent: 348 Bytes Received: 406 TCP Connections: 2 TCP Listen Ports Allocated: 0 --------------------------------------------------------------------AVAILABLE 66 3682 3 Messages Received: Bytes Received: 69 6655 0 Ingress: Ingress:
6 1
Egress: Egress:
3 3
SIP Signaling Port SIP

This object is the logical port on which the GSX sends and listens for Session Initiation Protocol (SIP) call signaling packets. This UDP port is dedicated to the exchange of UDP packets with other authorized SIP Application Servers only. Using the command syntax described below, you may configure 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 ACLSTATE parameter provides a security mechanism on the port. Each received SIP message is screened by the IPADDRESS of its sender, as described below. 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 3GSX9000 Open Services Switch Operations Guide Version 4.01, Document Version 2
SIP Signaling Port
3-151
138. The ports may be assigned to either an MNA module or a PNA module, through the INTERFACE parameter as discussed below. Two SIP 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 sending and listening. When all other Application Servers have have been reconfigured to connect to this GSX (acting as a User Agent Client or Server) on the new primary port, the former port can be safely placed out of service, disabled, and deleted. In this manner, the network can be reconfigured without shutting down this GSX. The SIP signaling port is always in one of two administrative states:
enabled disabled
The SIP signaling port is always in one of two operational states:
The SIP signaling port always take one of two roles:
primary secondary
The procedures for changing roles are:
From primary
To primary secondary You are asked to confirm that you know this will keep this GSX from creating new signal links to other SIP Application Servers. -
secondary
(If the other port was primary, it is automatically made secondary.) This GSX will make gateway signal link requests to other SIP Application Servers using this signal port address as the local address.
3-152
SIP Signaling Port
Changing to (operational state) inService outOfService If this port is currently primary, you will be asked to confirm that you know this action will keep this GSX from requesting new gateway signal links to SIP Application Servers on this address. Once the port is outOfService, you can set its administrative state to disabled. Once disabled, this signaling port may be deleted. -
outOfService
First, set the administrative state to enabled. Then, regardless of its ROLE, the port will listen for incoming signal link requests from SIP Application Servers.
Command Syntax
CREATE SIP SIGNALING PORT sig-port .. IPADDRESS ipaddress CONFIGURE SIP SIGNALING PORT sig-port .. PORTNUM log-port ROLE role MODE oper-state ACLSTATE aclstate CONFIGURE SIP SIGNALING PORT sig-port .. INTERFACE nif-type CONFIGURE SIP SIGNALING PORT sig-port .. STATE admin-state SHOW SIP SIGNALING PORT sig-port ADMIN SHOW SIP SIGNALING PORT sig-port STATUS SHOW SIP SIGNALING PORT ALL ADMIN SHOW SIP SIGNALING PORT ALL STATUS SHOW SIP SIGNALING PORT sig-port STATISTICS SHOW SIP SIGNALING PORT ALL STATISTICS RESET SIP SIGNALING PORT sig-port STATISTICS COUNTS
SIP Signaling Port
3-153
DELETE SIP SIGNALING PORT sig-port
3-154
SIP Signaling Port
Command Parameters
TABLE 3 -41.
SIP SIGNALING PORT Parameters

Field Length N/A N/A Description The logical reference number to the port for use with SNMP and/or CLI. Must be 1 or 2. The 32-bit IP address of the sig-port (above) specified in dotted decimal form (for example 128.127.50.224). This address MUST DIFFER FROM all existing network interface addresses. Although it will use one of these physical interfaces (see nif-type), its Internet Address must be unique. This parameter is mandatory, and takes no default value. A value of 0.0.0.0 will not be accepted.
Parameter sig-port ipaddress
log-port
N/A
The logical port number of the UDP port to use for this link. Default is 5060. If you use a PNA NIF for SIP signaling (nif), then logical port numbers cannot be in the range of port numbers reserved for RTP. That is, they must be less than 5000 or greater than 15240.
nif-type
N/A
The type of network interface being configured for the SIP signaling port: mgtnif - The Management Network interface on the MNA10 module. nif - The Packet Network interface on a PNA module. If nif (PNA) is chosen, then SIP signaling bandwidth usage will be taken from the PNA bandwidth budgets. This allocation is approximately 1.2 Mb/sec. For an IP over ATM NIF, the SIP SIGNALING PORT must be configured first before the IP over ATM NIF is configured. By doing so, the IP over ATM NIF will properly allocate 10% of its bandwidth for SIP signaling. If an ATM NIF is configured before the SIP SIGNALING PORT, the ATM maximum bandwidth calculation will not allocate the 10% overhead required for SIP signaling.
role
N/A
The main role of the SIP signaling port: primary - the default port, whose IPADDRESS will be used for SIP call signaling with other Application Servers. secondary - an alternate port that remains active but is not selected by default for new SIP signal requests. When a secondary port is configured to be primary, the previous primary is automatically made secondary.
SIP Signaling Port
3-155
TABLE 3 -41.
SIP SIGNALING PORT Parameters

Field Length N/A Description Specifies whether or not to check the IPADDRESS of a received SIP message against the Access Control List (ACL): enabled - check against the ACL and discard the message if the sender is not a member of the ACL. disabled - accept and act accordingly on the message, without regard for the IPADDRESS of the sender. This parameter provides a security mechanism on this SIP signaling port.
Parameter aclstate
oper-state
N/A
The operational state of the SIP signaling port: inService - 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 - Not active. enabled - Active.
Command Example
To create, configure, and enable a SIP signaling port on the MNA10 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
To display the status of this SIP signaling port:

% SHOW SIP SIGNALING PORT 1 STATUS
Node: TPUBS Date: 2001/02/10 19:38:12 GMT Zone: GMTMINUS05-EASTERN-US Port Num ---5060
Port Num IP Addr ---- ---------------1 128.99.55.6
Intf Role State -------- ---- ---MGTN PRIMARY INSERVICE
To display the configuration of this SIP signaling port:

% SHOW SIP SIGNALING PORT 1 ADMIN
Node: TPUBS Date: 2001/07/16 18:03:44 GMT Zone: GMTMINUS05-EASTERN-US ACL State -----
Port Port Num IP Addr Num Interface Role ---- ------------- ---- --------- ----
Mode ----
State ----
3-156
SIP Signaling Controls
1 10.99.55.1
5060 MGTNIF
PRIMARY
DISABLED
INSERVICE ENABLED
To display the statistics associated with this SIP signaling port:

% SHOW SIP SIGNALING PORT 1 STATISTICS
Node: TPUBS Date: 2001/02/10 19:42:47 GMT Zone: GMTMINUS05-EASTERN-US Port Call Orig Num Rate Calls ----- ----- ----5060 0 8 Term Calls ----0
Port Num IP Addr ---- ---------1 128.99.55.6
TxPDUs -----43
RxPDUs -----63
TxBYTES ------14113
RxBYTES ------16116
To reset all statistics associated with this SIP signaling port:

% RESET SIP SIGNALING PORT 1 STATISTICS COUNTS

These objects specify the timers, retry counts, and authorized Application Servers for signaling between this GSX and other Application Servers. These timer intervals are applied on a per call basis; a change takes effect on new calls but not on currently active calls. The Access Control List (ACL) defines the group of SIP Application Servers authorized to exchange messages on the SIP signaling port. The ACL is configured via the ACL LIST object. The ACL is enabled or disabled as an authorization tool by configuring the SIP SIGNALING PORT object, described previously.
Command Syntax
CONFIGURE SIP SIGNALING TIMERS .. T1 t1timer T2 t2timer SESSIONKEEPALIVE sessionka CONFIGURE SIP SIGNALING RETRY .. GENERAL general INVITE-BYE-CANCEL invite CONFIGURE SIP ACL LIST ADD APPSRV appsrv .. IPADDRESS ipaddress CONFIGURE SIP ACL LIST DELETE APPSRV appsrv SHOW SIP SIGNALING TIMERS ADMIN SHOW SIP SIGNALING RETRYS ADMIN SHOW SIP ACL LIST APPSRV appsrv ADMIN SHOW SIP ACL LIST ALL ADMIN
3-157
Command Parameters
TABLE 3 -42.
SIP SIGNALING CONTROLS Parameters

Field Length N/A Description The SIP protocol retransmission timer T1 (in milliseconds). This value applies to all future SIP calls. Must be 300-1100, default is 500 (milliseconds). The SIP protocol retransmission timer T2 (in milliseconds). This value applies to all future SIP calls. Must be 2000-8000, default is 4000 (milliseconds) or 4 seconds. Via this mechanism, the GSX will accept, but will not request, session timeouts.
Parameter t1timer
t2timer
N/A
sessionka
N/A
The SIP protocol session keep-alive timer (in seconds). This value applies to all future SIP calls. Must be 0-1000, default is 120 (seconds). A value of 0 causes keep-alive to be turned off. This timer allows the GSX to support: Draft-ietf-sip-session-timer-02
general
N/A
The number of retransmissions for all SIP messages. This value applies to all future SIP calls. Must be 412, default is 7. The number of retransmissions for SIP INVITE messages. This value applies to all future SIP calls. Must be 0-12, default is 3. A value of 0 means no retransmission of any INVITE message. The name of an application server that you are adding to the Access Control LIST (ACL), thereby authorizing it to access and exchange messages with this GSX. This name should be a Domain Naming System (DNS) entry. The ACL is limited to a maximum of 20 entries. The 32-bit IP address of the APPSRV (above), specified in dotted decimal form (for example 128.127.50.224). This parameter is mandatory, and takes no default value. A value of 0.0.0.0 will not be accepted.
invite
N/A
appsrv
1-23
ipaddress
N/A
Command Example
To add the Application Server, sylantro with IP address 128.20.9.73 to the ACL for this GSX:
% CONFIGURE SIP ACL LIST ADD sylantro .. IPADDRESS 128.20.9.73
To remove the above named Application Server from the ACL:

% CONFIGURE SIP ACL LIST DELETE sylantro
To set the retry counters to 5 for SIP messages and 2 for SIP INVITE messages:
% CONFIGURE SIP SIGNALING RETRY GENERAL 5 INVITE 2
To set the timers to 600 for T1, 6000 for T2, and 220 for session keep-alive:
3-158
% CONFIGURE SIP SIGNALING TIMERS T1 600 T2 6000 .. SESSIONKEEPALIVE 220
To display the configuration of the SIP timers:

% SHOW SIP SIGNALING TIMERS ADMIN
SIP T1 Timer is: 600 ms SIP T2 Timer is: 6000 ms SIP Session Keepalive Timer is: 220 s
To display the configuration of the SIP retry counters:

% SHOW SIP SIGNALING RETRYS ADMIN
general SIP message number of retry is: 5 times INVITE message number of retry is: 2 times
To display the ACL, or all Application Servers that may access this GSX:
% SHOW SIP ACL LIST ALL ADMIN
Index Name IpAddr -------------------------------------------------------0000000001 amber 10.6.254.249 0000000002 niter 10.1.1.5 0000000003 sylantro 128.20.9.73 0000000004 pactolus-appserver1 10.20.9.80 0000000005 lab 10.10.247.82 0000000006 tgong 10.128.131.15 0000000007 labsw12 10.6.247.13 0000000008 labsw27 10.6.247.16 0000000009 mon 10.99.55.6 0000000010 per 10.20.254.253 0000000011 ciscophone 10.20.9.70 0000000012 BS-AS 10.20.9.51
To display the configuration of a particular Application Server in the ACL:

% SHOW SIP ACL LIST APPSVR sylantro ADMIN
Index Name IpAddr -------------------------------------------------------0000000007 sylantro 128.20.9.73
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 51 for a detailed discussion of this GSX9000 facility.
Accounting
3-159
Accounting
This object allows you to create, configure and capture call accounting information. This information is stored in the system event logs in the /ACT subdirectory of the GSX system tree (see Figure 4-17, GSX System Tree). Additional detail about statistics that are displayed by SHOW ACCOUNTING .. commands is contained in the table below:
Statistic Total Call Attempts
Description This is the total number of Call Attempts made on this GSX since the last reboot or MNS switchover. This includes Call Attempts from PSTN as well as IP side. This includes Call Attempt Completions as well as Failures. This is the total number of call attempts made on this GSX since the last reboot or MNS switchover, which did not reach the completion state This is the total number of call attempts made on this GSX since the last reboot or MNS switchover, which reached the completion state. Otherwise stated, these are calls that were answered ( by detecting an ANM or CONNECT message). This is the total number of call attempts made on this GSX since the last reboot or MNS switchover, which received Blocking/Screening Treatment by the PSX, and hence were released by the GSX. Typically there would have been an announcement or tone played to the calling party before the call was released by the GSX. This is the current call arrival rate into the GSX, in calls/sec. It is computed every minute. This statistic is always: (Number of Call Attempts in Last One Minute )/ 60 This is identical to Total Call Attempts for the first hour of operation following a reboot or MNS switchover. 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.
Total Call Attempt Failures Total Call Completions
Total Call Attempts Blocked or Screened Call Attempt Rate in Calls/sec in Last One Minute Busy Hour Call Attempt Rate
Average Call Duration in seconds
This is the Average Service Time, or the time from when a call is answered until it is released. Also known as talk time. This is an average that uses all calls established since the last reboot or MNS switchover.
Command Syntax
CONFIGURE ACCOUNTING GENERATE generate CONFIGURE ACCOUNTING .. INTERMEDIATE RECORDS STATE admin-state INTERMEDIATE RECORDS INTERVAL interval
3-160
Accounting
SECOND STAGE INHERIT FIRST ssinherfirst POPULATE NON-PORTED LNP NUMBERS popnplnpnum SHOW ACCOUNTING ADMIN SHOW ACCOUNTING SUMMARY RESET ACCOUNTING SUMMARY
Accounting
3-161
Command Parameters
TABLE 3 -43.
Accounting Parameters
Field Length N/A Description The type of calls for which accounting records should be logged on this GSX: origination - 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.
Parameter generate
admin-state
N/A
The administrative state of accounting logging: disabled - not activated. enabled - activated.
interval
N/A
The time (in seconds) for generating intermediate call records. Must be 5-86400, default is 60. Not meaningful unless admin-state is enabled. 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 - fields are not inherited from the first stage fields See Second Stage Accounting Records on page 571 for a list of fields that may be inherited, subject to this parameter.
ssinherfirst
N/A
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 - 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 5-27 and Called Number Before Translation #2 Field on page 5-28 for detail about the associated accounting record fields.
Command Example
3-162
Local Time Zone
To direct the capture of intermediate accounting records at 15 second intervals:

% CONFIG ACCOUNTING GENERATE origination % CONFIG ACCOUNTING INTERMED RECORDS STATE enabled % CONFIG ACCOUNTING INTERMEDIATE RECORDS INTERVAL 15
To display the accounting summary:

% SHOW ACCOUNTING SUMMARY
-----------------------------------------------------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
To display the configuration of the accounting information subsystem:

% SHOW ACCOUNTING ADMIN
-------------------------------------------------------Accounting Configuration -------------------------------------------------------Accounting LogTo: EVENTLOG Accounting Generate: ORIGINATION Accounting 2nd Stage Records Inherit 1st Stage: TRUE Accounting Intermediate Acct State: DISABLED Accounting Intermediate Acct Interval (in seconds): 60
Local Time Zone

This object designates the local time zone for the GSX you are configuring.
Command Syntax
CONFIGURE LOCAL TIMEZONE localtzone SHOW LOCAL TIMEZONE
Command Parameter
localtzone is the time zone in which the GSX is located. Valid values are:
gmtMinus12-Eniuetok gmtMinus11-MidwayIsland gmtMinus10-Hawaii gmtMinus09-Alaska
Local Time Zone
3-163
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 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
Command Example
To set the local time zone in Aniak, Alaska:
% CONFIG LOCAL TIMEZONE gmtMinus09-Alaska
3-164
Carrier
To display the local time zone:

% SHOW LOCAL TIMEZONE
Node: None Date: 1999/05/05 14:13:57 Zone: GMTMINUS09-ALASKA GMTMINUS09-ALASKA
Local GSX9000 Time Zone:
Trunk Groups
TrunkGroups
These objects specify the ISUP, ISDN, and CAS trunks.
Carrier
This object specifies a carrier. The carrier name is a parameter for trunk group profiles and trunk groups.
Command Syntax
CREATE CARRIER carriername CONFIGURE CARRIER carriername .. CODE carriercode NETWORK TYPE networktype NETWORK PLAN networkplan CONFIGURE CARRIER carriername STATE admin-state SHOW CARRIER carriername ADMIN SHOW CARRIER ALL ADMIN DELETE CARRIER carriername
Trunk Group Profile
3-165
Command Parameters
TABLE 3 -44.
CARRIER Parameters
Field Length 1-23 1-4 N/A Description The name of the carrier that is being configured by this object. A code to be associated with this carrier. May be up to four numeric digits. The type of network identification for this carrier code: ccitt national other
Parameter carriername carriercode networktype
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 N-RESERVED1 N-RESERVED2
admin-state
N/A
The administrative state of this carrier: disabled - Not active. enabled - Active.
Command Example
To display all carrier code designations:
% SHOW CARRIER ALL ADMIN
Node: TPUBS Date: 2001/02/22 22:15:12 GMT Zone: GMTMINUS05-EASTERN-US Code Type Network Plan State ---- -------- ------------------------- --------0321 NATIONAL N-4_DIGIT_CARRIERCODE ENABLED 0320 NATIONAL N-4_DIGIT_CARRIERCODE ENABLED
Carrier Name ---------------------uswest uscas
Trunk Group Profile

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
CREATE TRUNK GROUP PROFILE profilename
3-166
Trunk Group Profile
CONFIGURE TRUNK GROUP PROFILE profilename .. SELECT selection LNP lnptrans INBOUND reserved CARRIER carrier SS7 NODE ss7nodename NUM800 num800 NUMVERIFY numverify SIMULATED FACILITY GROUP TYPE sfg-type CONFIGURE TRUNK GROUP PROFILE profilename .. STATE admin-state SHOW TRUNK GROUP PROFILE profilename ADMIN SHOW TRUNK GROUP PROFILE ALL ADMIN DELETE TRUNK GROUP PROFILE profilename
Trunk Group Profile
3-167
Command Parameters
TABLE 3 -45.
Trunk Group Profile Parameters

Field Length 1-23 N/A Description The name of the profile that can be applied to a trunk group object. The method of hunting through service groups for trunk groups: leastcost - examine the leastcost service group first, then the next least etc. configured - examine the first configured service group first, then the second, etc. 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.
Parameter profilename selection
lnptrans
N/A
LNP translation for the called number: false - dont translate true - translate
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-169.
carrier ss7nodename num800
1-23 1-23 N/A
The name of the carrier that is assigned to this trunk group. The name of the SS7 node that provides SS7 signaling for this trunk group. Specifies that this PSTN trunk group may require 800 number translation for the called number: true false
numverify
N/A
Specifies that this PSTN trunk group may require verification for the calling number: true false
3-168
Trunk Group Profile
TABLE 3 -45.
Trunk Group Profile Parameters

Field Length N/A Description The type of Simulated Facility Group (SFG) used by this trunk group: none - 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 accomodate calls that act as the user side of the user-network interface.
Parameter sfg-type
admin-state
N/A
The administrative state of this trunk group profile: disabled - Not active. enabled - Active.
Command Example
To set up a trunk group profile:
% CREATE TRUNK GROUP PROFILE pstnprofile % CONFIGURE TRUNK GROUP PROFILE pstnprofile SELECT configured LNP true NUM800 false NUMVERIFY true INBOUND 90 CARRIER att SS7 NODE a7n3 % CONFIGURE TRUNK GROUP PROFILE pstnprofile .. STATE enabled
To display all trunk group profiles:

% SHOW TRUNK GROUP PROFILE SUMMARY
Node: TPUBS Date: 2000/06/06 14:28:49 GMT Zone: GMTMINUS05-EASTERN-US Carrier ----------------------att qwest IsupNode ----------------------a7n3 a7n3 State --ENABLED ENABLED
Trunk Profile Name ----------------------pstnprofile amerprofile
To display the configuration of trunk group profile pstnprofile:

% SHOW TRUNK GROUP PROFILE SUMMARY
Trunk Profile Name Carrier IsupNode State ----------------------- ----------------------- ----------------------- ------pstnprofile att a7n3 ENABLED ENABLED DISABLED
Trunk Group
3-169
Select ---------------LEASTCOST ENABLED
LNP ------TRUE ENABLED
TFree -------TRUE ENABLED
ClgNVfy INBRSV -------- -----FALSE 0 ENABLED ENABLED
Trunk Group
This object allows you to associate service groups with trunk groups between switching systems. Trunk groups are always in one of two administrative states:
enabled disabled
Trunk groups are always in one of two operational states:
Changing to (operational state) inservice outofservice Associated service groups must already be disabled, or this request will be rejected. Affirm the prompt query. No new usage of the trunk group is allowed. If ACTION dryup is specified, current users have until TIMEOUT expires to complete their call. After TIMEOUT expires, all calls are dropped, the trunk group is outofservice and its administrative state may be disabled and then it may be deleted.
outofservice
Change the administrative state to enabled, if necessary. Change operational state to inservice.
Command Syntax
CREATE TRUNK GROUP tgname CONFIGURE TRUNK GROUP tgname .. TRUNKPROFILENAME profilename SELECT selection LNP lnptrans
3-170
Trunk Group
NUM800 num800 NUMVERIFY numverify INBOUND reserved CARRIER carrier SS7 NODE ss7nodename CIRCUIT RESERVATION STATE crstate PRIORITY CALL priority INCOMING CALL incoming OUTGOING CALL outgoing SIMULATED FACILITY GROUP TYPE sfg-type CONFIGURE TRUNK GROUP tgname .. STATE admin-state CONFIGURE TRUNK GROUP tgname .. MODE oper-state CONFIGURE TRUNK GROUP tgname .. MODE oper-state ACTION action CONFIGURE TRUNK GROUP tgname .. MODE oper-state ACTION action TIMEOUT timeout SHOW TRUNK GROUP SHOW TRUNK GROUP SHOW TRUNK GROUP tgname ADMIN tgname STATUS tgname SERVICEGROUPS
SHOW TRUNK GROUP SUMMARY SHOW TRUNK GROUP ALL STATUS SHOW TRUNK GROUP ALL ADMIN SHOW TRUNK MEMBER ALL SHOW TRUNK MEMBER ALL TRUNK GROUP tgname SHOW TRUNK MEMBER tmember-no TRUNK GROUP tgname CLEAR TRUNK MEMBER tmember-no TRUNK GROUP tgname DELETE TRUNK GROUP tgname
Trunk Group
3-171
Note
See TRUNK MEMBER on page 3-317 for additional detail on this object.
Command Parameters
TABLE 3 -46.
Trunk Group Parameters

Field Length 1-23 1-23 1-23 1-23 N/A Description The name of the trunk group being configured. This name may not contain a period (.). The name of the trunk group profile to apply to this trunk group. The name of the SS7 node that provides SS7 signaling for this trunk group. The name of the carrier that supports this trunk group. LNP translation for the called number: false - dont translate true - translate
Parameter tgname profilename SS7nodename carrier lnptrans
selection
N/A
The method of hunting through service groups for trunk resources: leastcost - examine the leastcost 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.
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.
num800
N/A
Specifies that this PSTN trunk group may require 800 number translation for the called number: true false
numverify
N/A
Specifies that this PSTN trunk group may require verification for the calling number: true false
3-172
Trunk Group
TABLE 3 -46.

Field Length N/A Description The state of the circuit reservation feature: disabled 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.
Parameter crstate
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. The minimum number of incoming call circuits to be reserved for this trunk group. Must be 0-100, default is 1. This value is ignored if crstate is disabled. The type of Simulated Facility Group (SFG) used by this trunk group: none - 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 accomodate calls that act as the user side of the user-network interface.
incoming
N/A
sfg-type
N/A
outgoing
N/A
The minimum percentage of outgoing call circuits to be reserved for this trunk group. Must be 0-100, default is 10%. This value is ignored if crstate is disabled. The operational state of the trunk group: inservice outofservice - must be in this state to enter the disabled administrative state.
oper-state
N/A
admin-state
N/A
The administrative state of this trunk group: disabled - Not activated, able to be deleted. enabled - Activated, available for immediate use.
Trunk Group
3-173
TABLE 3 -46.

Field Length N/A Description The method by which active calls on this trunk group are processed when oper-state goes to outofservice: dryup - all calls are allowed to complete until TIMEOUT expires. force - all calls are dropped immediately.
Parameter action
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. 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.
tmember-no
N/A
Command Example
To create and configure a trunk group named tg1:
% CREATE TRUNK GROUP tg1 % CONFIGURE TRUNK GROUP tg1 SELECT leastcost % CONFIGURE TRUNK GROUP tg1 LNP true % CONFIGURE TRUNK GROUP tg1 NUM800 true % CONFIGURE TRUNK GROUP tg1 NUMVERIFY false % CONFIGURE TRUNK GROUP tg1 CARRIER att % CONFIGURE TRUNK GROUP tg1 PRIORITY CALL 10 % CONFIGURE TRUNK GROUP tg1 INCOMING CALL 15 % CONFIGURE TRUNK GROUP tg1 OUTGOING CALL 20 % CONFIGURE TRUNK GROUP tg1 CIRCUIT RESERVATION .. STATE enabled % CONFIGURE TRUNK GROUP tg1 STATE enabled
To display the status of all trunk groups:

% SHOW TRUNK GROUP ALL STATUS
Outbound Cir. Total Cir. Inbound Cir. Usages Oper Local Trunk Name Config Avail Resv Usage non-prio prio State ----------------------- -------------- ------------- -------------- ----------inpri 644 644 0 0 0 0 INSERVICE outpri 0 0 0 0 0 0 INSERVICE ss7in 672 672 0 0 0 0 INSERVICE ss7out 0 0 0 0 0 0 INSERVICE
To display the status of the trunk group tg1:

% SHOW TRUNK GROUP tg1 STATUS
3-174
Simulated Facility Group
Outbound Cir. Total Cir. Inbound Cir. Usages Oper Local Trunk Name Config Avail Resv Usage non-prio prio State ----------------------- -------------- ------------- -------------- ----------tg1 672 534 0 138 0 0 INSERVICE Current ACL value => 0
Note
The ACL value in the above display shows the congestion level in the tg1 trunk group is greater than or equal to 0 (no congestion). This value is always 0, 1, or 2, with 2 representing the highest congestion. To display the configuration of the trunk group casin2:
% SHOW TRUNK GROUP casin2 ADMIN
Local Trunk Name Carrier IsupNode State ----------------------- ----------------------- ----------------------- ------casin2 uswest ENABLED Select LNP TFree ClgNVfy INBRSV Mode Action Timeout(min) ---------------- ----- ----- ------- ------ ------------ ------ -----------LEASTCOST TRUE TRUE FALSE 0 INSERVICE DRYUP 5 Circuit Reservation Priority Calls Incoming Calls Outgoing Calls SFG Type ------------------- -------------- -------------- -------------- -------DISABLED 1 1 10 NONE
To display the service group that is bound to trunk group casin2:

% SHOW TRUNK GROUP casin2 ADMIN
Local Trunk Name Service Group Name Service Group Type ------------------------ ----------------------- -----------------casin2 cas2 CAS
Simulated Facility Group ISDNUserAdaptation

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 the Simulated Facility Group (SFG), each call with matching criteria is allowed on the underlying trunk group if the MAX ALLOCATION for that call criteria has not yet been met for that SFG on that trunk. If the MAX ALLOCATION has been met, the call may be turned over to the control of another SFG for that trunk. The new SFG may be a null SFG, effectively rejecting the call. Calls that do not match the criteria are not impacted, and therefore not restricted, by the SFG. As PRI lines are added to the trunk group, more calls are subjected to SFG criteria. Typically, the MAX ALLOCATION should be adjusted upwards. 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. 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
3-175
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 DIRECTORY number
For egress calls, matching call criteria are sought in the following order: service type of private
DIRECTION BEARER CAPABILITIES
You must properly configure the MAX ALLOCATION and the OVERFLOW .. parameters to limit the calls of any particular service type on the trunk. Only matching calls are limited by these SFG parameters on a trunk group. When multiple SFGs match, a best match is determined according to the hierarchy listed above. This object is recognized only by trunk groups that are configured as ISDN PRIs. ISUP and CAS trunk groups will ignore this object.
Command Syntax
CREATE SIMULATED FACILITY GROUP sfgnum.. TRUNK GROUP tgname TYPE servicetype
CONFIGURE SIMULATED FACILITY GROUP sfgnum TRUNK GROUP tgname..
CARRIER CODE NONE CARRIER CODE carrier FACILITY CODING VALUE fcv SERVICE PARAMETERS servicepar DIRECTION direction BEARER CAPABILITIES NONE BEARER CAPABILITIES bearercap MAX ALLOCATION maxalloc DIRECTORY NUMBER NONE DIRECTORY NUMBER dirnum OVERFLOW SIMULATED FACILITY GROUP oversfg
CONFIGURE SIMULATED FACILITY GROUP sfgnum TRUNK GROUP tgname..
STATE admin-state SHOW SIMULATED FACILITY GROUP sfgnum.. TRUNK GROUP tgname ADMIN SHOW SIMULATED FACILITY GROUP sfgnum.. TRUNK GROUP tgname STATISTICS
3-176
SHOW SIMULATED FACILITY GROUP TRUNK GROUP tgname.. ADMIN SHOW SIMULATED FACILITY GROUP TRUNK GROUP tgname.. STATISTICS SHOW SIMULATED FACILITY GROUP ALL ADMIN SHOW SIMULATED FACILITY GROUP ALL STATISTICS DELETE SIMULATED FACILITY GROUP sfgname.. TRUNK GROUP tgname
3-177
Command Parameters
TABLE 3 -47.
SIMULATED FACILITY GROUP Parameters

Field Length N/A Description The number or index of this simulated facility group (SFG) within the associated trunk group. This uniquely defines this SFG. Must be 1-127. 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 4-75.) 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.
Parameter sfgnum
tgname
1-23
servicetype
N/A
carrier
1-4
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.
3-178
TABLE 3 -47.

Field Length 8 Description 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 an eight character string of ones and zeroes, such as 00100110.
Parameter fcv
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.
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.
3-179
TABLE 3 -47.

Field Length N/A Description 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 doesnt meet the specified criteria or when this parameter is not present.
Parameter bearercap
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. 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.
dirnum
1-23
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 doesnt exist, then new calls are rejected on this trunk group when this SFG reaches its maximum allocation. Must be 0-127, default is 0. The administrative state of this Simulated Facility Group: disabled - Not active, able to be configured. enabled - Active.
admin-state
N/A
Command Example
To display all defined SFGs (which in this case is one):
% SHOW SIMULATED FACILITY GROUP ALL ADMIN
Local Trunk Name: tg2 SFG Index: 1 --------------------------------------------------------------------------Service Type : PUBLIC State : ENABLED Direction : TWOWAY
3-180
T1 Profile
Bearer Capability Carrier Code Directory Number Facility Code Value Service Parameter Maximum Allocation Overflow SFG Index
: SPEECH|AUDIO31K|DATA56K|DATA64K : : : 00 : 0 : 99 : 0
To display all statistics associated with all defined SFGs (which in this case is one):
% SHOW SIMULATED FACILITY GROUP ALL STATISTICS
SFG Current Local Trunk Name Index Carrier Type Usage Attempts Failures ----------------------- ----- ------- ------- ---------- ---------- ---------tg2 1 PUBLIC 0 4 0
T1 Circuits
T1Circuits
These objects specify the T1 links connected to the GSX Circuit Network Adapters.
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. The 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 twentyfour hours. For additional information, see:
American National Standard for Telecommunications -- Digital Hierarchy -- Layer 1 In-Service Digital Transmission Performace Monitoring, T1.231, Sept 1993 CCITT Specifications Volume III, Recommendation G.821, Error Performance Of An International Digital Connection Forming Part Of An Integrated Services Digital Network, July 1988 ITU-T G.826: Error performance parameters and objectives for international, constant bit rate digital paths at or above the primary rate, November 1993
Command Syntax
CREATE T1 PROFILE t1profile CONFIGURE T1 PROFILE t1profile .. BUILDOUT buildout LINETYPE linetype CODING coding SIGNALING signaling FDL fdl IDLECODE idlecode
T1 Profile
3-181
AVAILABLE CHANNELS avchannels CONFIGURE T1 PROFILE t1profile THRESHOLDS .. FIFTEENMIN NEAREND ERROREDSECONDS erroredseconds CONFIGURE T1 PROFILE t1profile THRESHOLDS .. FIFTEENMIN NEAREND SEVERELYERRSECS severrsecs CONFIGURE T1 PROFILE t1profile THRESHOLDS .. FIFTEENMIN NEAREND CONTROLLEDSLIPSECS contslipsecs CONFIGURE T1 PROFILE t1profile THRESHOLDS .. FIFTEENMIN NEAREND UNAVAILABLESECS unavailablesecs CONFIGURE T1 PROFILE t1profile THRESHOLDS .. FIFTEENMIN NEAREND PATHCODEVIOLATIONS pcviolations CONFIGURE T1 PROFILE t1profile THRESHOLDS .. FIFTEENMIN NEAREND LINECODEVIOLATIONS lcviolations CONFIGURE T1 PROFILE t1profile THRESHOLDS .. FIFTEENMIN FAREND ERROREDSECONDS erroredseconds CONFIGURE T1 PROFILE t1profile THRESHOLDS .. FIFTEENMIN FAREND SEVERELYERRSECS severrsecs CONFIGURE T1 PROFILE t1profile THRESHOLDS .. FIFTEENMIN FAREND UNAVAILABLESECS unavailablesecs CONFIGURE T1 PROFILE t1profile THRESHOLDS .. FIFTEENMIN FAREND PATHCODEVIOLATIONS pcviolations CONFIGURE T1 PROFILE t1profile THRESHOLDS .. FIFTEENMIN FAREND LINECODEVIOLATIONS lcviolations CONFIGURE T1 PROFILE t1profile THRESHOLDS .. DAY NEAREND ERROREDSECONDS erroredseconds CONFIGURE T1 PROFILE t1profile THRESHOLDS .. DAY NEAREND SEVERELYERRSECS severrsecs CONFIGURE T1 PROFILE t1profile THRESHOLDS .. DAY NEAREND CONTROLLEDSLIPSECS contslipsecs CONFIGURE T1 PROFILE t1profile THRESHOLDS .. DAY NEAREND UNAVAILABLESECS unavailablesecs CONFIGURE T1 PROFILE t1profile THRESHOLDS .. DAY NEAREND PATHCODEVIOLATIONS pcviolations CONFIGURE T1 PROFILE t1profile THRESHOLDS .. DAY NEAREND LINECODEVIOLATIONS lcviolations CONFIGURE T1 PROFILE t1profile THRESHOLDS .. DAY FAREND ERROREDSECONDS erroredseconds CONFIGURE T1 PROFILE t1profile THRESHOLDS .. DAY FAREND SEVERELYERRSECS severrsecs CONFIGURE T1 PROFILE t1profile THRESHOLDS .. DAY FAREND UNAVAILABLESECS unavailablesecs CONFIGURE T1 PROFILE t1profile THRESHOLDS .. DAY FAREND PATHCODEVIOLATIONS pcviolations CONFIGURE T1 PROFILE t1profile THRESHOLDS ..
3-182
T1 Profile
DAY FAREND LINECODEVIOLATIONS lcviolations CONFIGURE T1 PROFILE t1profile STATE admin-state SHOW T1 PROFILE t1profile DELETE T1 PROFILE t1profile
T1 Profile
3-183
Command Parameters
TABLE 3 -48.
T1 Profile Parameters
Field Length 1-23 N/A Description The name of the profile that can be applied to a T1 object. 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
Parameter t1profile buildout
linetype
N/A
The frame format used on the T1: ESF D4
coding
N/A
The T1 line coding: AMI B8ZS
signaling
N/A N/A
Signaling used for this T1: none The facility data link type: none Ansi
fdl
idlecode avchannels
N/A N/A
This value is inserted in an idle channel. Must be 0255, default is 127 (0x7F). 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
1,3,5,8,10,12,14,15, and 16.
3-184
T1 Profile
TABLE 3 -48.
Field Length N/A Description The administrative state of this T1 profile:
Parameter admin-state

erroredseconds N/A
disabled - Not activated, able to be configured or deleted. enabled - Activated, available for immediate use.
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 THRESHOLD ranges and defaults are: fifteen minute interval, NEAREND - range 1-900, default 65 fifteen minute interval, FAREND - range 1-900, default 65 one day interval, NEAREND - range 1-65535, default 648 one day interval, FAREND - range 1-65535, default 648
severrsecs
N/A
A Severely Errored Second (SES) is a one second interval in which any one or more of the following error conditions are present: 320 or more path code violations out of frame defect AIS defect The THRESHOLD ranges and defaults are: fifteen minute interval, NEAREND - range 1-900, default 10 fifteen minute interval, FAREND - range 1-900, default 10 one day interval, NEAREND - range 1-65535, default 100 one day interval, FAREND - range 1-65535, default 100
contslipsecs
N/A
A one second interval in which the information bits received in a frame are replicated or deleted, except during an unavailable second (see below). The THRESHOLD ranges and defaults are: fifteen minute interval, NEAREND - range 1-900, default 1 one day interval, NEAREND - range 1-65535, default 4
T1 Profile
3-185
TABLE 3 -48.
Field Length N/A Description 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. The THRESHOLD ranges and defaults are: fifteen minute interval, NEAREND - range 1-900, default 10 fifteen minute interval, FAREND - range 1-900, default 10 one day interval, NEAREND - range 1-65535, default 100 one day interval, FAREND - range 1-65535, default 100
Parameter unavailablesecs
pcviolations
N/A
A frame synchronization bit error. The THRESHOLD ranges and defaults are: fifteen minute interval, NEAREND - range 116383, default 13296 fifteen minute interval, FAREND - range 1-16383, default 72 one day interval, NEAREND - range 1-1,048,575, default 132960 one day interval, FAREND - range 1-1,048,575, default 691
lcviolations
N/A
An occurance 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 The THRESHOLD ranges and defaults are: fifteen minute interval, NEAREND - range 116383, default 13296 fifteen minute interval, FAREND - range 1-16383, default 72 one day interval, NEAREND - range 1-1,048,575, default 132960 one day interval, FAREND - range 1-1,048,575, default 691
Command Example
To set up and activate a T1 profile:
% CREATE T1 PROFILE ourt1s % CONFIG T1 PROFILE ourt1s IDLECODE 255 % CONFIG T1 PROFILE ourt1s STATE enabled
3-186
T1
Note
This profile has the default values for all parameters that are not explicitly configured. For example, the BUILDOUT value is 110_220ft.
T1
This object specifies a T1 circuit that is supported by a Circuit Network Server on the GSX. The T1 circuit is assigned all 24 DS0 channels by default, but any subset of those channels may be specified. Twelve T1 objects or spans are automatically created and named when a CNS10/CNA10 module set is added to the GSX9000 via the CREATE SERVER .. ADAPTER command. See Server on page 3-16 for additional information. The default name of each T1 object is 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. This name may be changed via the CONFIG 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. 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 CNS10/CNA10 module set is removed via the DELETE SERVER .. ADAPTER command. The STATISTICS associated with this object are kept for fifteen minute intervals, up to a total of 96 intervals or twenty-four hours. INITIALIZE STATISTICS resets the current interval or fifteen minute statistics. SHOW .. TOTAL STATISTICS always summarizes statistics for the previous intervals since the GSX was booted, or the previous 96 intervals, whichever is less. The 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 twentyfour hours. For additional information, see:
T1s are always in one of two administrative states:
enabled disabled
T1s are always in one of two operational states:
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
T1
3-187
shown below in the command syntax. Changing the operational state to inservice makes the channels available for general use. The rules for changing operational states are:
inservice inservice
-
outofservice
Affirm the prompt query. No new calls on the T1 channels are allowed. If action dryup is specified, current calls have until timeout expires to complete. After timeout expires, all calls are dropped, the T1 is outofservice and it may be disabled. Once disabled, the T1 may be configured.
outofservice
Make sure the T1 channels are ready for general usage. Change administrative state to enabled. Change operational state to inservice.
Command Syntax
CONFIGURE T1 t1name .. PROFILE t1profile BUILDOUT buildout LINETYPE linetype CODING coding SIGNALING signaling FDL fdl IDLECODE idlecode AVAILABLE CHANNELS avchannels ZEROSUPPRESSION zerosup ECHO PROFILE ecprofile CIRCUIT ID circuitid CONFIGURE T1 t1name INITIALIZE STATISTICS CONFIGURE T1 t1name NAME newt1name CONFIGURE T1 t1name STATE admin-state CONFIGURE T1 t1name SENDPATTERN pattern CONFIGURE T1 t1name LOOPBACK NEAREND nearend CONFIGURE T1 t1name LOOPBACK FAREND farend
3-188
T1
CONFIGURE T1 t1name MODE oper-state .. CONFIGURE T1 t1name MODE oper-state ACTION action CONFIGURE T1 t1name MODE oper-state .. ACTION action TIMEOUT timeout CONFIGURE T1 t1name THRESHOLDS .. FIFTEENMIN NEAREND ERROREDSECONDS erroredseconds CONFIGURE T1 t1name THRESHOLDS .. FIFTEENMIN NEAREND SEVERELYERRSECS severrsecs CONFIGURE T1 t1name THRESHOLDS .. FIFTEENMIN NEAREND CONTROLLEDSLIPSECS contslipsecs CONFIGURE T1 t1name THRESHOLDS .. FIFTEENMIN NEAREND UNAVAILABLESECS unavailablesecs CONFIGURE T1 t1name THRESHOLDS .. FIFTEENMIN NEAREND PATHCODEVIOLATIONS pcviolations CONFIGURE T1 t1name THRESHOLDS .. FIFTEENMIN NEAREND LINECODEVIOLATIONS lcviolations CONFIGURE T1 t1name THRESHOLDS .. FIFTEENMIN FAREND ERROREDSECONDS erroredseconds CONFIGURE T1 t1name THRESHOLDS .. FIFTEENMIN FAREND SEVERELYERRSECS severrsecs CONFIGURE T1 t1name THRESHOLDS .. FIFTEENMIN FAREND UNAVAILABLESECS unavailablesecs CONFIGURE T1 t1name THRESHOLDS .. FIFTEENMIN FAREND PATHCODEVIOLATIONS pcviolations CONFIGURE T1 t1name THRESHOLDS .. FIFTEENMIN FAREND LINECODEVIOLATIONS lcviolations CONFIGURE T1 t1name THRESHOLDS .. DAY NEAREND ERROREDSECONDS erroredseconds CONFIGURE T1 t1name THRESHOLDS .. DAY NEAREND SEVERELYERRSECS severrsecs CONFIGURE T1 t1name THRESHOLDS .. DAY NEAREND CONTROLLEDSLIPSECS contslipsecs CONFIGURE T1 t1name THRESHOLDS .. DAY NEAREND UNAVAILABLESECS unavailablesecs CONFIGURE T1 t1name THRESHOLDS .. DAY NEAREND PATHCODEVIOLATIONS pcviolations CONFIGURE T1 t1name THRESHOLDS .. DAY NEAREND LINECODEVIOLATIONS lcviolations CONFIGURE T1 t1name THRESHOLDS .. DAY FAREND ERROREDSECONDS erroredseconds CONFIGURE T1 t1name THRESHOLDS .. DAY FAREND SEVERELYERRSECS severrsecs CONFIGURE T1 t1name THRESHOLDS ..
T1
3-189
DAY FAREND UNAVAILABLESECS unavailablesecs CONFIGURE T1 t1name THRESHOLDS .. DAY FAREND PATHCODEVIOLATIONS pcviolations CONFIGURE T1 t1name THRESHOLDS .. DAY FAREND LINECODEVIOLATIONS lcviolations SHOW T1 t1name ADMIN SHOW T1 t1name STATUS SHOW T1 t1name THRESHOLDS SHOW T1 t1name STATISTICS SHOW T1 t1name CURRENT STATISTICS SHOW T1 t1name TOTAL STATISTICS SHOW T1 t1name INTERVAL interval STATISTICS SHOW T1 SHELF shelf SLOT slotno SUMMARY SHOW T1 SHELF shelf SLOT slotno ADMIN SHOW T1 SHELF shelf SLOT slotno STATUS SHOW T1 SHELF shelf SLOT ALL ADMIN SHOW T1 SHELF shelf SLOT ALL STATUS SHOW T1 ALL ADMIN SHOW T1 ALL STATUS
3-190
T1
Command Parameters
TABLE 3 -49.
T1 Parameters
Field Length 1-23 Description The automatically assigned (and possibly changed) name of the T1 span. See the beginning of this section for the structure of the default name. The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. The slot number occupied by the circuit network module that supports this T1. Must be 3-16. The name of the profile to be applied to this T1 object. 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
Parameter t1name
shelf slotno t1profile buildout
N/A N/A 1-23 N/A
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-218.
signaling N/A Signaling used for this T1: none ROBBEDBIT - required for CAS. fdl N/A The facility data link type: none Ansi idlecode N/A This value is inserted in an idle channel. Must be 0255, default is 127 (0x7F).
T1
3-191
TABLE 3 -49.
T1 Parameters
Field Length N/A Description 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:
Parameter avchannels
1,3,5,8-12+2,14-16
1,3,5,8,10,12,14,15, and 16.

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. Therefore this operation should be performed right after the CNS10/CNA10 module set is configured via CREATE SERVER, if it is performed at all. 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-263. The name of the circuit ID. The operational state of this T1: inservice outofservice - must be in this state to enter the disabled admin-state. admin-state N/A The administrative state of this T1: disabled - Not activated. In this state the T1 can be reconfigured or deleted. enabled - Available for immediate use. This activates a configured or reconfigured T1.
zerosup
N/A
circuitid oper-state
1-23 N/A
3-192
T1
TABLE 3 -49.
T1 Parameters
Field Length N/A Description The method by which active calls on this T1 are processed when oper-state outofservice is requested: dryup - 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.
Parameter action
timeout
N/A
The time (in minutes) to wait to place the T1 in the outofservice oper-state. Must be 01440, default is 5. A value of 0 causes the change immediately. Possible values for the SENDPATTERN parameter are: SENDNOCODE NONE QRS 3IN24
pattern
N/A
nearend
N/A
The type of local loopback to be applied on this switch for this T1 span: noloop - not in the loopback state. payloadloop - the received signal is looped back for retransmission after it has passed through the devices 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.
farend
N/A
The type of remote loopback to be applied on this switch for this T1 span: sendnocode - send normal data. sendlinecode - send a request for a line loopback. sendpayloadcode - send a request for payload loopback. sendresetcode - send a loopback termination request. sendqrspattern - send a Quasi-Random Signal (QRS) test pattern. send3in24pattern - send a fixed test pattern of 3 bits set in 24.
T1
3-193
TABLE 3 -49.
T1 Parameters
Field Length N/A Description 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 96 intervals (24 hours) are accumulated, the next interval overwrites the earliest, so that no more than 24 hours of statistics may be accessed.Interval 1 always contains the most recent statistics and interval 96 (if existent) the oldest. Must be 1-96. 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 THRESHOLD ranges and defaults are: fifteen minute interval, NEAREND - range 1-900, default 65 fifteen minute interval, FAREND - range 1-900, default 65 one day interval, NEAREND - range 1-65535, default 648 one day interval, FAREND - range 1-65535, default 648
Parameter interval
erroredseconds
N/A
severrsecs
N/A
contslipsecs
N/A
A one second interval in which the information bits received in a frame are replicated or deleted, except during an unavailable second (see below). The THRESHOLD ranges and defaults are: fifteen minute interval, NEAREND - range 1-900, default 1 one day interval, NEAREND - range 1-65535, default 4
3-194
T1
TABLE 3 -49.
T1 Parameters
Field Length N/A Description 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. The THRESHOLD ranges and defaults are: fifteen minute interval, NEAREND - range 1-900, default 10 fifteen minute interval, FAREND - range 1-900, default 10 one day interval, NEAREND - range 1-65535, default 100 one day interval, FAREND - range 1-65535, default 100
Parameter unavailablesecs
pcviolations
N/A
A frame synchronization bit error. The THRESHOLD ranges and defaults are: fifteen minute interval, NEAREND - range 116383, default 13296 fifteen minute interval, FAREND - range 1-16383, default 72 one day interval, NEAREND - range 1-1,048,575, default 132960 one day interval, FAREND - range 1-1,048,575, default 691
lcviolations
N/A
An occurance 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 The THRESHOLD ranges and defaults are: fifteen minute interval, NEAREND - range 116383, default 13296 fifteen minute interval, FAREND - range 1-16383, default 72 one day interval, NEAREND - range 1-1,048,575, default 132960 one day interval, FAREND - range 1-1,048,575, default 691
Command Example
To set up and configure a T1 circuit:
% CREATE SERVER SHELF 1 SLOT 3 HWTYPE cns10 .. ADAPTER cna10 % CREATE SERVER SHELF 1 SLOT 3 STATE enabled % CONFIG T1 t1-1-3-1 AVAILABLE CHANNELS 1-24 % CONFIG T1 t1-1-3-1 STATE enabled
T1
3-195
% CONFIG T1 t1-1-3-1 MODE inservice % CONFIG T1 t1-1-3-2 AVAILABLE CHANNELS 1-24 % CONFIG T1 t1-1-3-2 STATE enabled % CONFIG T1 t1-1-3-2 MODE inservice . . % CONFIG T1 t1-1-3-12 AVAILABLE CHANNELS 1-24 % CONFIG T1 t1-1-3-12 STATE enabled % CONFIG T1 t1-1-3-12 MODE inservice
To display summary information regarding T1s on the CNS10 module in slot 3:

% SHOW T1 SHELF 1 SLOT 3 SUMMARY
--------------------------------------------------------------------------T1 Summary Shelf: 1 Slot: 3 --------------------------------------------------------------------------Port |DS3 |DS1 |Circuit Name |State |Status |Allocated Channels | | | | | |1---------------------24 --------------------------------------------------------------------------1 |0 |1 |T1-1-3-1 |ENABLED |NO ALARM |000000000000000000000000 2 |0 |1 |T1-1-3-2 |DISABLED |NO ALARM |000000000000000000000000 3 |0 |1 |T1-1-3-3 |DISABLED |NO ALARM |000000000000000000000000 4 |0 |1 |T1-1-3-4 |DISABLED |NO ALARM |000000000000000000000000 5 |0 |1 |T1-1-3-5 |DISABLED |NO ALARM |000000000000000000000000 6 |0 |1 |T1-1-3-6 |DISABLED |NO ALARM |000000000000000000000000 7 |0 |1 |T1-1-3-7 |DISABLED |NO ALARM |000000000000000000000000 8 |0 |1 |T1-1-3-8 |DISABLED |NO ALARM |000000000000000000000000 9 |0 |1 |T1-1-3-9 |DISABLED |NO ALARM |000000000000000000000000 10 |0 |1 |T1-1-3-10 |DISABLED |NO ALARM |000000000000000000000000 11 |0 |1 |T1-1-3-11 |DISABLED |NO ALARM |000000000000000000000000 12 |0 |1 |T1-1-3-12 |DISABLED |NO ALARM |000000000000000000000000
To display the configuration of the T1 span t1-1-9-12:

% SHOW T1 t1-1-9-12 ADMIN
-----------------------------------------------------Shelf: 1 Slot: 9 Port:12 DS3: 0 DS1: 1 -----------------------------------------------------T1 Configuration -----------------------------------------------------IfIndex: 63 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: ROBBEDBIT FDL Type: ANSI Line Build Out: 110_220FT Idle Code: 0x7f Zero Suppression: NONE Mode: INSERVICE Timeout: 5 Circuit Id: circuit-629 -----------------------------------------------------Echo Canceller Configuration
3-196
T1
-----------------------------------------------------Profile Name: prof1 Max Tail: MILLISEC64 Audio Type: ULAW Signaling Tone: NONE NLP Disable: 6 NLP Enabled: 75 Echo Return Loss: DB6 Residual Echo Control: COMFORTNOISE Modem Tone: G165 Narrow Band Detection: OFF
To display the status of the T1 span t1-1-3-2:

% SHOW T1 t1-1-3-2 STATUS
-----------------------------------------------------Shelf: 1 Slot: 3 Port: 2 DS3: 0 DS1: 1 -----------------------------------------------------T1 Status -----------------------------------------------------Circuit Name: T1-1-3-2 Status: NO ALARM Channels:1----------------------24 111111111111111111111111 000000000000000000000000
Enabled Channels: Allocated Channels:
To display the thresholds of the T1 span t1-1-3-2:

% SHOW T1 t1-1-3-2 THRESHOLDS
-----------------------------------------------------Shelf: 1 Slot: 3 Port: 2 DS3: 0 DS1: 1 -----------------------------------------------------T1 Threshold Configuration -----------------------------------------------------Thresholds for 15 Minute Intervals: ----------------------------------Near End Far End Errored Seconds: 65 65 Severely Errored Seconds: 10 10 Unavailable Seconds: 10 10 Path Code Violations: 13296 72 Line Code Violations: 13340 72 Controlled Slip Seconds: 1 N/A ----------------------------------Thresholds for 24 Hour Intervals: ----------------------------------Errored Seconds: 648 648 Severely Errored Seconds: 100 100 Unavailable Seconds: 100 100 Path Code Violations: 132960 691 Line Code Violations: 133400 691 Controlled Slip Seconds: 4 N/A
T1 Channels
3-197
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. T1 channel objects are always in one of two operational states:
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. The rules for changing operational states are:
inservice inservice
-
outofservice
Affirm the prompt query. No new calls on the T1 channels are allowed. If action dryup is specified, current calls have until timeout expires to complete. After timeout expires, all calls are dropped, the T1 channels are in operational state outofservice. For local loopback testing, the T1 to which these channels belong must remain in loopback enabled.
outofservice
Make sure the T1 channels are ready for general usage. Change loopback to disabled. Change operational state to
inservice.
Command Syntax
CONFIGURE T1 t1name CHANNEL chrange IDLECODE idlecode CONFIGURE T1 t1name CHANNEL chrange TONE tonetype CONFIGURE T1 t1name CHANNEL chrange LOOPBACK loopback CONFIGURE T1 t1name CHANNEL chnum IDLECODE idlecode CONFIGURE T1 t1name CHANNEL chnum TONE tonetype CONFIGURE T1 t1name CHANNEL chnum LOOPBACK loopback CONFIGURE T1 t1name CHANNEL chnum MODE oper-state
3-198
T1 Channels
CONFIGURE T1 t1name CHANNEL chnum .. MODE oper-state ACTION action CONFIGURE T1 t1name CHANNEL chnum .. MODE oper-state ACTION action TIMEOUT timeout SHOW T1 t1name CHANNEL chrange ADMIN SHOW T1 t1name CHANNEL ALL ADMIN
T1 Channels
3-199
Command Parameters
TABLE 3 -50.
T1 CHANNEL Parameters
Field Length 1-23 Description 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. 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:
Parameter t1name
chrange
N/A
1,3,5,8-12+2,14-16
1,3,5,8,10,12,14,15, and 16.

chnum idlecode oper-state N/A N/A N/A The single channel being configured into this object. Must be in the range 1-24. This value is inserted in these channels when they are idle. Must be 0-255, default is 127 (0x7F). The operational state of these T1 channels:

action N/A
inservice outofservice - must be in this state for loopback and tone testing.
The method by which active calls on this T1 are processed when oper-state outofservice is requested:
timeout N/A
dryup - 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.
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.
3-200
T1 Channels
TABLE 3 -50.
T1 CHANNEL Parameters
Field Length N/A Description The type of test tone to be applied on these channels when they are outofservice and loopback is enabled: dmw (Digital Milliwatt 1000 Hz) The state of local loopback on the channels: disabled enabled
Parameter tonetype
loopback
N/A
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.
% CONFIGURE T1 t1-1-3-1 CHANNEL 10 .. MODE outofservice ACTION force % CONFIGURE T1 t1-1-3-1 CHANNEL 11 .. MODE outofservice ACTION force % CONFIGURE T1 t1-1-3-1 CHANNEL 12 .. MODE outofservice ACTION force % CONFIGURE T1 t1-1-3-1 CHANNEL 10-12 .. LOOPBACK enabled
To display the current configuration of channels 10-12 on the T1 span t1-1-3-1:

% SHOW T1 t1-1-3-1 CHANNEL 10-12 ADMIN
-----------------------------------------------------Channel Admin Shelf: 1 Slot: 3 Port: 1 DS3: 0 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
E1 Profile
3-201
Idle Code: 0x7f Tone: NONE Loopback: DISABLED ------------------------------------------------------
E1 Circuits
E1Circuits
These objects specify the E1 links connected to the GSX Circuit Network Adapters.
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. The 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 twentyfour hours. For additional information, see:
Command Syntax
CREATE E1 PROFILE e1profile CONFIGURE E1 PROFILE e1profile .. BUILDOUT buildout LINETYPE linetype CODING coding SIGNALING signaling IDLECODE idlecode AVAILABLE CHANNELS avchannels CONFIGURE E1 PROFILE e1profile THRESHOLDS .. FIFTEENMIN NEAREND ERROREDSECONDS erroredseconds CONFIGURE E1 PROFILE e1profile THRESHOLDS .. FIFTEENMIN NEAREND SEVERELYERRSECS severrsecs CONFIGURE E1 PROFILE e1profile THRESHOLDS .. FIFTEENMIN NEAREND CONTROLLEDSLIPSECS contslipsecs CONFIGURE E1 PROFILE e1profile THRESHOLDS ..
3-202
E1 Profile
FIFTEENMIN NEAREND UNAVAILABLESECS unavailablesecs CONFIGURE E1 PROFILE e1profile THRESHOLDS .. FIFTEENMIN FAREND ERROREDSECONDS erroredseconds CONFIGURE E1 PROFILE e1profile THRESHOLDS .. FIFTEENMIN FAREND SEVERELYERRSECS severrsecs CONFIGURE E1 PROFILE e1profile THRESHOLDS .. FIFTEENMIN FAREND UNAVAILABLESECS unavailablesecs CONFIGURE E1 PROFILE e1profile THRESHOLDS .. DAY NEAREND ERROREDSECONDS erroredseconds CONFIGURE E1 PROFILE e1profile THRESHOLDS .. DAY NEAREND SEVERELYERRSECS severrsecs CONFIGURE E1 PROFILE e1profile THRESHOLDS .. DAY NEAREND CONTROLLEDSLIPSECS contslipsecs CONFIGURE E1 PROFILE e1profile THRESHOLDS .. DAY NEAREND UNAVAILABLESECS unavailablesecs CONFIGURE E1 PROFILE e1profile THRESHOLDS .. DAY FAREND ERROREDSECONDS erroredseconds CONFIGURE E1 PROFILE e1profile THRESHOLDS .. DAY FAREND SEVERELYERRSECS severrsecs CONFIGURE E1 PROFILE e1profile THRESHOLDS .. DAY FAREND UNAVAILABLESECS unavailablesecs CONFIGURE E1 PROFILE e1profile STATE admin-state SHOW E1 PROFILE e1profile DELETE E1 PROFILE e1profile
E1 Profile
3-203
Command Parameters
TABLE 3 -51.
E1 PROFILE Parameters
Field Length 1-23 N/A Description The name of the profile that can be applied to an E1 object. The drive capacity of the E1 wire: 120_OHMS 75_OHMS
Parameter e1profile buildout
linetype
N/A
The frame format used on the E1: e1 e1crc
coding
N/A N/A N/A N/A
The E1 line coding: hdb3 Signaling used for this E1: none This value is inserted in an idle channel. Must be 0255, default is 84 (0x54). 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:
signaling
idlecode avchannels
1,3,5,8-12+2,14-16
1,3,5,8,10,12,14,15, and 16.

admin-state N/A The administrative state of this E1 profile: disabled - Not activated, able to be configured or deleted. enabled - Activated, available for immediate use.
3-204
E1 Profile
TABLE 3 -51.
Field Length N/A Description 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 THRESHOLD ranges and defaults are: fifteen minute interval, NEAREND - range 1-900, default 65 fifteen minute interval, FAREND - range 1-900, default 65 one day interval, NEAREND - range 1-65535, default 648 one day interval, FAREND - range 1-65535, default 648
Parameter erroredseconds
severrsecs
N/A
E1
3-205
TABLE 3 -51.
Field Length N/A Description A one second interval in which the information bits received in a frame are replicated or deleted, except during an unavailable second (see below). The THRESHOLD ranges and defaults are: fifteen minute interval, NEAREND - range 1-900, default 1 one day interval, NEAREND - range 1-65535, default 4
Parameter contslipsecs
unavailablesecs
N/A
A one second interval in which the E1 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. The THRESHOLD ranges and defaults are: fifteen minute interval, NEAREND - range 1-900, default 10 fifteen minute interval, FAREND - range 1-900, default 10 one day interval, NEAREND - range 1-65535, default 100 one day interval, FAREND - range 1-65535, default 100
Command Example
To set up and activate an E1 profile:
% CREATE E1 PROFILE oure1s % CONFIG E1 PROFILE oure1s IDLECODE 255 % CONFIG E1 PROFILE oure1s STATE enabled
Note
This profile has the default values for all parameters that are not explicitly configured. For example, the BUILDOUT value is 120_OHMS.
E1
This object specifies n E1 circuit that is supported by a Circuit Network Server on the GSX. 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/CNA20 module set is added to the GSX9000 via the CREATE SERVER .. ADAPTER command. See Server on page 3-16 for additional information. The default name of each E1 object is E1-shn-sln-spn, where shn is the shelf number, sln is the slot number, and spn is the span number (1-8). For example, E1-1-3-2 identifies the second E1 span on the E1 circuit that connects to the port on the CNA20 that resides behind the CNS20 in slot 3 of shelf 1. This name may be changed via the CONFIGURE E1..NAME command shown in the command syntax below. Renaming must
3-206
E1
be performed while the E1 is disabled and before any other configuration commands are issued. No additional E1 objects may be created nor may the automatically created (and possibly renamed) E1s be directly deleted. These E1s are removed only when the CNS20/CNA20 module set is removed via the DELETE SERVER .. ADAPTER command. The STATISTICS associated with this object are kept for fifteen minute intervals, up to a total of 96 intervals or twenty-four hours. INITIALIZE STATISTICS resets the current interval or fifteen minute statistics. SHOW .. TOTAL STATISTICS always summarizes statistics for the previous intervals since the GSX was booted, or the previous 96 intervals, whichever is less. The 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 twentyfour hours. For additional information, see:
E1s are always in one of two administrative states:
enabled disabled
E1s are always in one of two operational states:
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.
E1
3-207
inservice inservice
-
outofservice
Affirm the prompt query. No new calls on the E1 channels are allowed. If action dryup is specified, current calls have until timeout expires to complete. After timeout expires, all calls are dropped, the E1 is outofservice and it may be disabled. Once disabled, the E1 may be configured.
outofservice
Make sure the E1 channels are ready for general usage. Change administrative state to enabled. Change operational state to inservice.
Command Syntax
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 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 CONFIGURE E1 e1name THRESHOLDS ..
3-208
E1
FIFTEENMIN NEAREND ERROREDSECONDS erroredseconds CONFIGURE E1 e1name THRESHOLDS .. FIFTEENMIN NEAREND SEVERELYERRSECS severrsecs CONFIGURE E1 e1name THRESHOLDS .. FIFTEENMIN NEAREND CONTROLLEDSLIPSECS contslipsecs CONFIGURE E1 e1name THRESHOLDS .. FIFTEENMIN NEAREND UNAVAILABLESECS unavailablesecs CONFIGURE E1 e1name THRESHOLDS .. FIFTEENMIN FAREND ERROREDSECONDS erroredseconds CONFIGURE E1 e1name THRESHOLDS .. FIFTEENMIN FAREND SEVERELYERRSECS severrsecs CONFIGURE E1 e1name THRESHOLDS .. FIFTEENMIN FAREND UNAVAILABLESECS unavailablesecs CONFIGURE E1 e1name THRESHOLDS .. DAY NEAREND ERROREDSECONDS erroredseconds CONFIGURE E1 e1name THRESHOLDS .. DAY NEAREND SEVERELYERRSECS severrsecs CONFIGURE E1 e1name THRESHOLDS .. DAY NEAREND CONTROLLEDSLIPSECS contslipsecs CONFIGURE E1 e1name THRESHOLDS .. DAY NEAREND UNAVAILABLESECS unavailablesecs CONFIGURE E1 e1name THRESHOLDS .. DAY FAREND ERROREDSECONDS erroredseconds CONFIGURE E1 e1name THRESHOLDS .. DAY FAREND SEVERELYERRSECS severrsecs CONFIGURE E1 e1name THRESHOLDS .. DAY FAREND UNAVAILABLESECS unavailablesecs SHOW E1 e1name ADMIN SHOW E1 e1name STATUS SHOW E1 e1name THRESHOLDS SHOW E1 e1name STATISTICS SHOW E1 e1name CURRENT STATISTICS SHOW E1 e1name TOTAL STATISTICS SHOW E1 e1name INTERVAL interval STATISTICS SHOW E1 SHELF shelf SLOT slotno SUMMARY SHOW E1 SHELF shelf SLOT slotno ADMIN SHOW E1 SHELF shelf SLOT slotno STATUS SHOW E1 SHELF shelf SLOT ALL ADMIN SHOW E1 SHELF shelf SLOT ALL STATUS SHOW E1 ALL ADMIN SHOW E1 ALL STATUS
E1
3-209
Command Parameters
TABLE 3 -52.
E1 Parameters
Field Length 1-23 Description The automatically assigned (and possibly changed) name of the E1 span. See the beginning of this section for the structure of the default name. The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. The slot number occupied by the circuit network module that supports this E1. Must be 3-16. The name of the profile to be applied to this E1 object. The drive capacity of the E1 wire: 120_OHMS 75_OHMS
Parameter e1name
shelf slotno e1profile buildout
N/A N/A 1-23 N/A
linetype
N/A
The frame format used on the E1: e1 e1crc
coding
N/A N/A
The E1 line coding: hdb3 Signaling used for this E1: none ROBBEDBIT - required for CAS.
signaling
ecprofile
1-23
The name of an echo canceller profile to be applied to this E1 circuit. See Echo Canceller Profile on page 3-263. The name of the circuit ID. This value is inserted in an idle channel. Must be 0255, default is 84 (0x54). 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:
circuitid idlecode avchannels
1-23 N/A N/A
1,3,5,8-12+2,14-16
1,3,5,8,10,12,14,15, and 16.
3-210
E1
TABLE 3 -52.
E1 Parameters
Field Length 1-23 Description 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. Therefore this operation should be performed right after the CNS20/CNA20 module set is configured via CREATE SERVER, if it is performed at all. The operational state of this E1: inservice outofservice - must be in this state to enter the disabled admin-state.
Parameter newe1name
oper-state
N/A
admin-state
N/A
The administrative state of this E1: disabled - Not activated. In this state the E1 can be reconfigured or deleted. enabled - Available for immediate use. This activates a configured or reconfigured E1.
action
N/A
The method by which active calls on this E1 are processed when oper-state outofservice is requested: dryup - 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 01440, default is 5. A value of 0 causes the change immediately. The type of local loopback to be applied on this switch for this E1 span: noloop - 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.
nearend
N/A
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 96 intervals (24 hours) are accumulated, the next interval overwrites the earliest, so that no more than 24 hours of statistics may be accessed.Interval 1 always contains the most recent statistics and interval 96 (if existent) the oldest. Must be 1-96.
E1
3-211
TABLE 3 -52.
E1 Parameters
Field Length N/A Description 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 THRESHOLD ranges and defaults are: fifteen minute interval, NEAREND - range 1-900, default 65 fifteen minute interval, FAREND - range 1-900, default 65 one day interval, NEAREND - range 1-65535, default 648 one day interval, FAREND - range 1-65535, default 648
Parameter erroredseconds
severrsecs
N/A
3-212
E1
TABLE 3 -52.
E1 Parameters
Field Length N/A Description A one second interval in which the information bits received in a frame are replicated or deleted, except during an unavailable second (see below). The THRESHOLD ranges and defaults are: fifteen minute interval, NEAREND - range 1-900, default 1 one day interval, NEAREND - range 1-65535, default 4
Parameter contslipsecs
unavailablesecs
N/A
A one second interval in which the E1 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. The THRESHOLD ranges and defaults are: fifteen minute interval, NEAREND - range 1-900, default 10 fifteen minute interval, FAREND - range 1-900, default 10 one day interval, NEAREND - range 1-65535, default 100 one day interval, FAREND - range 1-65535, default 100
Command Example
To set up and configure an E1 circuit:
% CREATE SERVER SHELF 1 SLOT 3 HWTYPE cns20 .. ADAPTER cna20 % CONFIG SERVER SHELF 1 SLOT 3 STATE enabled % CONFIG E1 e1-1-3-1 AVAILABLE CHANNELS 1-31 % CONFIG E1 e1-1-3-1 STATE enabled % CONFIG E1 e1-1-3-1 MODE inservice % CONFIG E1 e1-1-3-2 AVAILABLE CHANNELS 1-31 % CONFIG E1 e1-1-3-2 STATE enabled % CONFIG E1 e1-1-3-2 MODE inservice . . % CONFIG E1 e1-1-3-8 AVAILABLE CHANNELS 1-31 % CONFIG E1 e1-1-3-8 STATE enabled % CONFIG E1 e1-1-3-8 MODE inservice
To display summary information regarding E1s on the CNS10 module in slot 4:

% SHOW E1 SHELF 1 SLOT 4 SUMMARY
-----------------------------------------------------------------------------------
E1
3-213
E1 Summary Shelf: 1 Slot: 4 ----------------------------------------------------------------------------------Port |DS3 |DS1 |Circuit Name |State |Status |Allocated Channels | | | | | |1---------------------------31 ----------------------------------------------------------------------------------1 |0 |1 |E1-1-4-1 |ENABLED |NO ALARM |0000000000000000000000000000000 2 |0 |1 |E1-1-4-2 |ENABLED |NO ALARM |0000000000000000000000000000000 3 |0 |1 |E1-1-4-3 |ENABLED |NO ALARM |0000000000000000000000000000000 4 |0 |1 |E1-1-4-4 |ENABLED |NO ALARM |0000000000000000000000000000000 5 |0 |1 |E1-1-4-5 |ENABLED |NO ALARM |0000000000000000000000000000000 6 |0 |1 |E1-1-4-6 |ENABLED |NO ALARM |0000000000000000000000000000000 7 |0 |1 |E1-1-4-7 |ENABLED |NO ALARM |0000000000000000000000000000000 8 |0 |1 |E1-1-4-8 |ENABLED |NO ALARM |0000000000000000000000000000000
To display the status of the E1 span e1-1-4-2:

% SHOW E1 e1-1-4-2 STATUS
----------------------------------------------------------Shelf: 1 Slot: 4 Port: 2 DS3: 0 DS1: 1 ----------------------------------------------------------E1 Status ----------------------------------------------------------Circuit Name: E1-1-4-2 Status: NO ALARM Channels:1----------------------------31 1111111111111111111111110000000 0000000000000000000000000000000
Enabled Channels: Allocated Channels:
To display the configuration of the E1 span e1-1-4-2:

% SHOW E1 e1-1-4-2 ADMIN
-----------------------------------------------------Shelf: 1 Slot: 4 Port: 2 DS3: 0 DS1: 1 -----------------------------------------------------E1 Configuration -----------------------------------------------------IfIndex: 16 State: ENABLED Available Channels: 1-24 Line Type: E1CRC Line Coding: HDB3 Circuit Name: E1-1-4-2 Loopback Config: NOLOOP Signaling Mode: NONE Transmit Clock: THROUGHTIMING Line Build Out: 120_OHMS Idle Code: 0x54 Mode: INSERVICE Action: DRYUP Timeout: 5
To display the thresholds of the E1 span e1-1-4-2:

% SHOW E1 e1-1-4-2 THRESHOLDS
3-214
E1 Channels
-----------------------------------------------------Shelf: 1 Slot: 4 Port: 2 DS3: 0 DS1: 1 -----------------------------------------------------E1 Threshold Configuration -----------------------------------------------------Thresholds for 15 Minute Intervals: ----------------------------------Near End Far End Errored Seconds: 65 65 Severely Errored Seconds: 10 10 Unavailable Seconds: 10 10 Controlled Slip Seconds: 1 N/A ----------------------------------Thresholds for 24 Hour Intervals: ----------------------------------Errored Seconds: 648 648 Severely Errored Seconds: 100 100 Unavailable Seconds: 100 100 Controlled Slip Seconds: 4 N/A
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. E1 channel objects are always in one of two operational states:
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.
E1 Channels
3-215
inservice inservice
-
outofservice
Affirm the prompt query. No new calls on the E1 channels are allowed. If action dryup is specified, current calls have until timeout expires to complete. After timeout expires, all calls are dropped, the E1 channels are in operational state outofservice. For local loopback testing, the E1 to which these channels belong must remain in loopback enabled.
outofservice
Make sure the E1 channels are ready for general usage. Change loopback to disabled. Change operational state to
inservice.
Command Syntax
CONFIGURE E1 e1name CHANNEL chrange IDLECODE idlecode CONFIGURE E1 e1name CHANNEL chrange TONE tonetype CONFIGURE E1 e1name CHANNEL chrange LOOPBACK loopback CONFIGURE E1 e1name CHANNEL chnum IDLECODE idlecode CONFIGURE E1 e1name CHANNEL chnum TONE tonetype CONFIGURE E1 e1name CHANNEL chnum LOOPBACK loopback CONFIGURE E1 e1name CHANNEL chnum MODE oper-state CONFIGURE E1 e1name CHANNEL chnum .. MODE oper-state ACTION action CONFIGURE E1 e1name CHANNEL chnum .. MODE oper-state ACTION action TIMEOUT timeout SHOW E1 e1name CHANNEL chrange ADMIN SHOW E1 e1name CHANNEL ALL ADMIN
3-216
E1 Channels
Command Parameters
TABLE 3 -53.
E1 CHANNEL Parameters
Field Length 1-23 Description 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. 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:
Parameter e1name
chrange
N/A
1,3,5,8-12+2,14-16
1,3,5,8,10,12,14,15, and 16.

chnum idlecode oper-state N/A N/A N/A The single channel being configured into this object. Must be in the range 1-31. This value is inserted in these channels when they are idle. Must be 0-255, default is 84 (0x54). The operational state of these E1 channels: inservice 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 - 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. 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
tonetype
N/A
E1 Channels
3-217
Command Example
To configure channels 10-12 on the E1 span e1-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.
% CONFIGURE E1 e1-1-3-1 CHANNEL 10 .. MODE outofservice ACTION force % CONFIGURE E1 e1-1-3-1 CHANNEL 11 .. MODE outofservice ACTION force % CONFIGURE E1 e1-1-3-1 CHANNEL 12 .. MODE outofservice ACTION force % CONFIGURE E1 e1-1-3-1 CHANNEL 10-12 .. LOOPBACK enabled
To display the current configuration of channels 10-12 on the E1span e1-1-3-1:

% SHOW E1 e1-1-3-1 CHANNEL 10-12 ADMIN
-----------------------------------------------------Channel Admin Shelf: 1 Slot: 3 Port: 1 DS3: 0 DS1: 1 -----------------------------------------------------Channel: 10 State: AVAILABLE Mode: INSERVICE Action: DRYUP Timeout: 5 Idle Code: 0x54 Tone: NONE Loopback: DISABLED -----------------------------------------------------Channel: 11 State: AVAILABLE Mode: INSERVICE Action: DRYUP Timeout: 5 Idle Code: 0x54 Tone: NONE Loopback: DISABLED -----------------------------------------------------Channel: 12 State: AVAILABLE Mode: INSERVICE Action: DRYUP Timeout: 5 Idle Code: 0x54 Tone: NONE Loopback: DISABLED ------------------------------------------------------
3-218
T3
T3 Circuits
T3Circuits
These objects specify the T3 links connected to the GSX Circuit Network Adapters.
T3
This object specifies a T3 circuit that is supported by a Circuit Network Server on the GSX. 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/CNS31/CNA30 module set is added to the GSX9000 via the CREATE SERVER .. ADAPTER command. See Server on page 3-16 for additional information. The default name of the T3 is T3-shn-sln-ptn, where shn is the shelf number, sln is the slot number, and ptn is the T3 index (always 1). 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/CNS31/CNA30 module set is removed via the DELETE SERVER .. ADAPTER command. The underlying T1 objects that comprise the T3 circuit (see T1 on page 3-186) are also automatically created and named when the CNS30/CNS31/CNA30 module set is added to the GSX9000. The default name of each T1 object is T1-shn-sln-ptn-spn, where shn is the shelf number, sln is the slot number, ptn is the T3 index (always 1), and spn 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 may be changed via the CONFIG T1...NAME command shown in the T1 command syntax (see T1 on page 3-186). 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/CNS31/CNA30 module set is removed via the DELETE SERVER .. ADAPTER command. The STATISTICS associated with this object are kept for fifteen minute intervals, up to a total of 96 intervals or twenty-four hours. INITIALIZE STATISTICS resets the current interval or fifteen minute statistics. SHOW .. TOTAL STATISTICS always summarizes statistics for the previous intervals since the GSX was booted, or the previous 96 intervals, whichever is less. T3s are always in one of two administrative states:
enabled disabled
T3
3-219
T3s are always in one of two operational states:
The default operational state is outofservice, where T3 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. Note that the T1s need to be outofservice and disabled to be configured. The rules for changing operational states are:
inservice inservice
-
outofservice
Affirm the prompt query. No new calls on the T1 spans 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 T3 is in operational state outofservice and its administrative state may be disabled. Once disabled, the T3 and the undelying T1s may be configured.
outofservice
If you wish to simultaneously put the underlying T1 spans into service, make sure the spans are ready for general usage, and disable DS1OVERRIDE. Change administrative state to
enabled.
Change operational state to inservice.
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
3-220
T3
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 CONFIGURE T3 t3name MODE outofservice ACTION action TIMEOUT timeout CONFIGURE T3 t3name MODE inservice .. DS1OVERRIDE ds1or-state CONFIGURE T3 t3name LOOPBACK NEAREND nearend CONFIGURE T3 t3name LOOPBACK FAREND farend CONFIGURE T3 t3name LOOPBACK FAREND farend .. T1 t1number SHOW T3 t3name ADMIN SHOW T3 t3name STATUS SHOW T3 ALL ADMIN SHOW T3 All STATUS SHOW T3 t3name STATISTICS SHOW T3 t3name CURRENT STATISTICS SHOW T3 t3name T1 t1range SUMMARY SHOW T3 t3name T1 ALL SUMMARY SHOW T3 t3name TOTAL STATISTICS SHOW T3 t3name INTERVAL interval STATISTICS SHOW T3 SHELF shelf SLOT slot SUMMARY
T3
3-221
Command Parameters
TABLE 3 -54.
T3 Parameters
Field Length N/A N/A Description The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. The slot number occupied by the CNS server module for which the T3 summary is being displayed. This number must be 3-16. The automatically assigned (and possibly changed) name of the T3 circuit. See the beginning of this section for the structure of the default name. The frame format used on the T3: m23 cbit
t3name
1-23
linetype
N/A
coding
N/A N/A
The T3 line coding: B3ZS 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:
t1range
1,3,5,8-12+2,14-16
1,3,5,8,10,12,14,15, and 16.

t1number buildout N/A N/A The single T1 span being used for T1 loopback. Must be 1-28, default is 1. The length of T3 wire that must be driven. This is the length between the GSX and a repeater or patch panel: 0_100ft 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 module set is configured via CREATE SERVER, if it is performed at all. The name of the circuit ID.
circuitid
1-23
3-222
T3
TABLE 3 -54.
T3 Parameters
Field Length N/A Description The operational state of this T3: inservice - Ready for immediate use. Underlying T1s are also placed into service subject to DS1OVERRIDE. outofservice - 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 - 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 - 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 - 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 01440, default is 5. A value of 0 causes the change immediately. The type of local loopback to be applied on this switch for this T3: noloop - not in the loopback state. payloadloop - the received signal is looped back for retransmission after it has passed through the devices 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.
nearend
N/A
T3
3-223
TABLE 3 -54.
T3 Parameters
Field Length N/A Description The type of remote loopback to be applied on this switch for this T3: sendnocode - 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.
Parameter farend
interval
N/A
This number specifies the 15 minute interval for which you seek statistics. Statistics are stored in intervals of 15 minutes since the GSX was booted. When 96 intervals (24 hours) are accumulated, the next interval overwrites the earliest, so that no more than 24 hours of statistics may be accessed.Interval 1 always contains the oldest statistics and interval 96 (if existent) the most recent. Must be 1-96.
Command Example
To set up and configure a T3 port:
% CREATE SERVER SHELF 1 SLOT 3 HWTYPE cns31 .. ADAPTER cna30 % CONFIG SERVER SHELF 1 SLOT 3 STATE enabled % CONFIG T3 t3-1-3-1 AVAILABLE T1 1-28 % CONFIG T1 t1-1-3-1-1 AVAILABLE CHANNELS 1-24 % CONFIG T1 t1-1-3-1-2 AVAILABLE CHANNELS 1-24 % . % . % CONFIG T1 t1-1-3-1-28 AVAILABLE CHANNELS 1-24 % CONFIG T3 t3-1-3-1 STATE enabled .. DS1OVERRIDE disabled % CONFIG T3 t3-1-3-1 MODE inservice DS1OVERRIDE disabled
To display the administrative status of T3 t3-1-3-1:

% SHOW T3 t3-1-3-1 ADMIN
-----------------------------------------------------Shelf: 1 Slot:3 Port: 1 DS3: 1 -----------------------------------------------------DS3 Configuration
3-224
T3
-----------------------------------------------------IfIndex: 74 State: ENABLED 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
To display the accumulated statistics of T3 t3-1-3-1:

% SHOW T3 t3-1-3-1 STATISTICS
-----------------------------------------------------Shelf: 1 Slot:3 Port: 1 DS3: 1 -----------------------------------------------------DS3 Statistics -----------------------------------------------------Circuit Name: T3-1-3-1 Total Line Code Violations: 35287 Total Framing Errors: 412 Total Excessive Zeroes: 1224 Total Parity Errors: 13 Total C-Bit Parity Errors: 10 Total FEBE: 44 Total AIS Errors: 0 Total LOS Errors: 0
To display the current statistics of T3 t3-1-3-1:

% SHOW T3 t3-1-3-1 CURRENT STATISTICS
-----------------------------------------------------Shelf: 1 Slot:3 Port: 1 DS3: 1 -----------------------------------------------------DS3 Current Statistics -----------------------------------------------------Near End -------IfIndex: 74 Line Code Violations: 0 P-Bit Violations: 0 C-Bit Coding Violations: 0 P-Bit Errored Seconds: 0 P-Bit Severely Errored Seconds: 0 Severely Errored Framing Seconds: 0 Unavailable Seconds: 0 Line Errored Seconds: 0 C-Bit Errored Seconds: 0 C-Bit Severely Errored Seconds: 0 -------Far End -------Time Elapsed: 276 Valid Intervals: 0
System Timing Shelf
3-225
C-Bit Errored Seconds: C-Bit Severely Errored Seconds: C-Bit Coding Violations: Unavailable Seconds:
0 0 0 0
To display the current status of T3 t3-1-3-1:

% SHOW T3 t3-1-3-1 STATUS
-----------------------------------------------------Shelf: 1 Slot:3 Port: 1 DS3: 1 -----------------------------------------------------DS3 Status -----------------------------------------------------Circuit Name: T3-1-3-1 DS3 Alarms: NO ALARM DS3 Loopback: NO LOOPBACK Valid Intervals: 14
System Timing
SystemTiming
These objects configure the system synchronized timing for all circuit (CNS10, CNS20, CNS30, and CNS31) modules in the shelf. The Management Timing Adapter (MTA10 or MTA20) is required for this timing. By installing two MTA10s or two MTA20s, you can provide redundant timing. When two such MTAs are present, they are referred to as MTA1 and MTA2 according to the slot they occupy. Note A configuration of one MTA10 and one MTA20 is not considered in this discussion. This configuration will be possible in future GSX9000 releases. The synchronized timing signal used in the immediate GSX9000 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 4-2 for additional detail.
System Timing Shelf

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.
Command Syntax
CONFIGURE ST SHELF shelf ..
3-226
System Timing Shelf
FAILOVERGUARDTIME failoverguardtime RECOVERYGUARDTIME recoveryguardtime REVERTIVEREFSWITCH revertiverefswitch REVERTIVEMTASWITCH revertivemtaswitch INSERTDELAY insertdelay RESEQUENCE RECONFIGURATION ALGORITHM reconfigalg MTA SOURCE AFFINITY sourceaffinity SHOW ST SHELF shelf ADMIN SHOW ST ALL ADMIN SHOW ST SHELF shelf STATUS SHOW ST ALL STATUS
System Timing Shelf
3-227
Command Parameters
TABLE 3 -55.
ST Parameters
Field Length N/A N/A Description The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. 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). 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 15120, default is 15 (seconds). Determines whether a previously faulted timing source that has since become valid can be considered for reuse: enabled - eligible to be considered for reuse. disabled - never automatically considered for reuse.
Parameter shelf failoverguardtime
recoveryguardtime
N/A
revertiverefswitch
N/A
revertivemtaswitch
N/A
Determines whether a previously faulted MTA can be considered for reuse. This includes a module swap: enabled - new module is eligible to be considered for reuse. disabled - never automatically considered for reuse.
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.
3-228
System Timing Shelf
TABLE 3 -55.
ST Parameters
Field Length N/A Description This object indicates which reconfiguration algorithm should be used to select timing sources for use as System Synchronized sources: ordered-list ssm-quality Selecting ordered_list causes sources to be selected for use in strict numerical order, as assigned by default or by the operator. Selecting ssm_quality will cause sources to be selected based upon the quality level of the timing source, as indicated by the sources Synchronized Status Messages. Do not select ssm_quality unless all the configured timing sources support SSM's.
Parameter reconfigalg
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 - 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 is only applicable if the RECONFIGURATION ALGORITHM is ssm-quality.
Command Example
To display shelf-wide configuration information regarding circuit timing:
% SHOW ST ALL ADMIN
Node: TPUBS Date: 2001/02/16 16:18:39 GMT Zone: GMTMINUS05-EASTERN-US Insert Delay 100 Reconfig MTA Source Algorithm Affinity ORDERED-LIST STICKY
---Guard Time---- -Revertive SwitchingShelf Failover Recovery Reference MTA 1 2 15 ENABLED ENABLED
To display the shelf-wide status of system timing:

% SHOW ST ALL STATUS
Node: TPUBS Date: 1999/08/24 14:24:37 GMT Zone: GMTMINUS05-EASTERN-US Active MTA MTA1 Active Source EXTCLKA
Shelf 1
System Timing MTA
3-229
System Timing MTA

This object specifies the timing policies that will be applied to a specific MTA module, either MTA1 or MTA2.
Command Syntax
CONFIGURE ST MTA SHELF shelf MTA mta .. LINEENCODING lineencoding CHANNELBIT channelbit FRAMERMODE framermode CONFIGURE ST MTA SHELF shelf MTA mta STATE admin-state CONFIGURE ST MTA SHELF shelf MTA mta INSERVICE SHOW ST MTA SHELF shelf ADMIN SHOW ST MTA ALL ADMIN SHOW ST MTA SHELF shelf STATUS SHOW ST MTA ALL STATUS
3-230
System Timing MTA
Command Parameters
TABLE 3 -56.
ST MTA Parameters
Field Length N/A N/A N/A Description The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. Specifies which MTA is providing the system synchronized timing signal. Must be 1 or 2. The line coding for the BITS/SETS line interface unit: ami - for BITS line interface unit. b8zs - for BITS line interface unit. hdb3 - for SETS line interface unit.
Parameter shelf mta lineencoding
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 sa5 sa6 sa7 sa8
framermode
N/A
Determines the BITS/SETS framer: d4sf - should be selected for ami LINEENCODING, BITS framer. esf - 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 - 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
To display configuration information regarding all MTAs:
% SHOW ST MTA ALL ADMIN
Node: TPUBS Date: 2001/02/16 16:46:19 GMT Zone: GMTMINUS05-EASTERN-US Admin State ENABLED ENABLED Line Encoding B8ZS B8ZS Framer Channel Mode Bit(E1) ESF SA4 ESF SA4
Shelf 1 1
MTA MTA1 MTA2
To display the current status of all MTAs:

System Timing Source
3-231
% SHOW ST MTA ALL STATUS

Node: TPUBS Date: 2001/02/16 16:48:13 GMT Zone: GMTMINUS05-EASTERN-US MTA Type_Rev MTA10_1 MTA10_1 Status INSERVICE AVAILABLE
Shelf 1 1
MTA Slot MTA1 MTA2
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
To confirm that the above operation performed as intended:

% SHOW ST MTA ALL STATUS
Node: TPUBS Date: 2001/02/16 16:48:13 GMT Zone: GMTMINUS05-EASTERN-US MTA Type_Rev MTA10_1 MTA10_1 Status OUTOFSERVICE INSERVICE
Shelf 1 1
MTA Slot MTA1 MTA2
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

This object specifies and prioritizes up to six input timing sources for an MTA. This command essentially establishes the Timing Source Sequence Table. See Timing Source Sequence Table on page 4-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
CREATE ST SOURCE SHELF shelf MTA mta 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 DELETE ST SOURCE SHELF shelf MTA mta SOURCE source SHOW ST SOURCE SHELF shelf SUMMARY SHOW ST SOURCE ALL SUMMARY SHOW ST SOURCE SHELF shelf STATUS
3-232
SHOW ST SOURCE ALL STATUS
Command Parameters
TABLE 3 -57.
ST Source Parameters
Field Length N/A N/A N/A Description The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. Specifies which MTA is providing the system synchronized timing signal. Must be 1 or 2. Defines a system timing source to be added to or reprioritized in the Timing Source Sequence Table: extClkA - the BITS 1 input on an MTA10, the SETS 1 input on an MTA20 extClkB - the BITS 2 input on an MTA10, the SETS 2 input on an MTA20 refClkA - derived timing signal #1 from a CNS or PNS module refClkB - derived timing signal #2 from a CNS or PNS module oscillator - the MTA on-board stratum 3 oscillator holdover - the MTA replay derived from the current active source
Parameter shelf mta source
seqnum
N/A
This number defines the priority in the Timing Source Sequence Table of the above SOURCE object on the above MTA., where #1 is the highest priority, followed by #2, etc. These priorities are automatically established when the GSX software is initialized. You may change these assignments using this parameter. Must be 1-12. The administrative state of the specified timing source: enabled - Activate the timing source and make it available for service. disabled - Remove the timing source from service.
admin-state
N/A
Command Example
To display configuration information about all system timing sources:
% SHOW ST SOURCE ALL SUMMARY
Node: TPUBS Date: 2001/02/16 19:43:01 GMT Zone: GMTMINUS05-EASTERN-US Source EXTCLKA EXTCLKB REFCLKA REFCLKB HOLDOVER Sequence Number 1 2 3 4 5 State ENABLED ENABLED ENABLED ENABLED ENABLED
Shelf 1 1 1 1 1
MTA Slot 1 1 1 1 1
System Timing Reference Clock Binding
3-233
1 1 1 1 1 1 1
1 2 2 2 2 2 2
OSCILLATOR EXTCLKA EXTCLKB REFCLKA REFCLKB HOLDOVER OSCILLATOR
6 7 8 9 10 11 12
ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED
To administratively remove a timing source from service:

% CONFIGURE ST SOURCE SHELF 1 MTA 2 .. SOURCE holdover STATE disabled
To administratively make a timing source available for service:

% CONFIGURE ST SOURCE SHELF 1 MTA 2 .. SOURCE holdover STATE enabled
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
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 Timing Source EXTCLKA EXTCLKB REFCLKA REFCLKB OSCILLATOR HOLDOVER EXTCLKA EXTCLKB REFCLKA REFCLKB OSCILLATOR HOLDOVER Timing Source Quality Level STRATUM1 INDETERMINATE INDETERMINATE INDETERMINATE STRATUM3 INDETERMINATE INDETERMINATE INDETERMINATE INDETERMINATE INDETERMINATE STRATUM3 INDETERMINATE
Shelf 1 1 1 1 1 1 1 1 1 1 1 1
MTA Slot MTA1 MTA1 MTA1 MTA1 MTA1 MTA1 MTA2 MTA2 MTA2 MTA2 MTA2 MTA2
HW State VALID NOTVALID NOTVALID NOTVALID VALID NOTVALID NOTVALID NOTVALID NOTVALID NOTVALID VALID NOTVALID
Status AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE

This object assigns a T1 or E1 span from a CNS10/CNS20/CNS30/CNS31 or PNA21 module as a reference clock into the MTA. Two reference clocks (A and B) may be defined. These constitute derived timing sources. This assignment must be removed (deleted) in order to change it to another span. Each reference clock is connected in parallel to MTA1 and MTA2. A different span should be selected for each reference clock. Sonus recommends that you select a different span on a different CNS module whenever possible. When you specify an OC12 CLOCK, the source is derived from OC-12 SONET channel on port number 1 (the only port) on the PNA21. When you specify an OC3TDM CLOCK, the source is derived from the active OC-3 SONET channel on port number 1 (the only port) on the CNA33.
3-234
Command Syntax
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 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 DELETE ST REFCLK BINDING SHELF shelf SLOT slot .. OC12 CLOCK clock SHOW ST REFCLK BINDING SHELF shelf SUMMARY SHOW ST REFCLK BINDING ALL SUMMARY
Circuit Service Profile
3-235
Command Parameters
TABLE 3 -58.
ST REFCLK Binding Parameters

Field Length N/A N/A Description The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. The slot number occupied by the CNS10/CNS20/CNS30/CNS31 or PNA21 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. The OC12 port number that will provide the derived timing source. Must be 1 (PNS20). 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
port span
N/A N/A
clock
N/A
The backplane signal the derived clock source should be bound to: refClkA refClkB
Command Example
To display configuration information regarding all reference clock sources:
% SHOW ST REFCLK BINDING ALL SUMMARY
Node: TPUBS Date: 1999/08/24 19:50:39 GMT Zone: GMTMINUS05-EASTERN-US Channel 1 1 RefClk REFCLKA REFCLKB
Shelf 1 1
Slot 7 8
Circuit Service Group

CircuitServiceGroup
This object provides a generic circuit service profile.

This object assists node resource management by creating a template for the circuit endpoint; it may be applied to an ISUP circuit, ISDN B-channel or a Media Gateway circuit.
3-236
Command Syntax
CREATE CIRCUIT SERVICE PROFILE csprofile CONFIGURE CIRCUIT SERVICE PROFILE csprofile .. ENCODING encoding BANDWIDTH bandwidth ECHO CANCEL echocancel CONTINUITYTEST TYPE contesttype TIMEOUT timeout MIN DETECT mindetect MIN RELEASE minrelease CAPABILITIES capabilities DATAPARAM TYPE dparams DTMF PROFILE dtmfprofile INTERWORKING XFRCAP xfrcap TX LEVEL CONTROL txlevelcontrl RX LEVEL CONTROL rxlevelcontrl TX GAIN txgain RX GAIN rxgain CONFIGURE CIRCUIT SERVICE PROFILE csprofile .. STATE admin-state SHOW CIRCUIT SERVICE PROFILE csprofile ADMIN SHOW CIRCUIT SERVICE PROFILE ALL ADMIN DELETE CIRCUIT SERVICE PROFILE csprofile
3-237
Command Parameters
TABLE 3 -59.
Circuit Service Profile Parameters

Field Length 1-23 N/A Description The name of the profile that can be applied to a circuit service object. The audio encoding method to be performed on the voice data received from, and destined to the PSTN. g711ulaw g711alaw
Parameter csprofile encoding
bandwidth echocancel
N/A N/A
The number of channels to group for Nx64 connections. Must be 1-24, default is 1. 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. Voice Packet Assembler/Disassembler operates in a circuit emulation mode. enabled - Activated according to the ECHO CANCELLER PROFILE parameters. See Echo Canceller Profile on page 3-263.
contesttype
N/A
Specifies the type of continuity test to perform based on the configuration of the remote switch or trunk connection: remoteLoopback - 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. Specifies the minimum duration time in milliseconds for a tone to satisfy the continuity test requirements. Must be 10-60, default is 45. 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.
mindetect
N/A
minrelease
N/A
3-238
TABLE 3 -59.

Field Length N/A Description Specifies the data capabilities for the circuit: voiceOnly - voice only circuitModeData - circuit mode data only voiceOrCircuitModeData - 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.
Parameter capabilities
dparams
N/A
Specifies the data parameters for circuits with circuitModeData or voiceOrCircuitModeData capabilities: unrestricted - 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-485. 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 audio31Khz
xfrcap
N/A
3-239
TABLE 3 -59.

Field Length N/A Description Specifies the type of level control to be applied to non-data bearer signals transmitted to the PSTN: none - 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.
Parameter txlevelcontrl
rxlevelcontrl
N/A
Specifies the type of level control to be applied to the non-data bearer signals received from the PSTN: none - 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.
3-240
TABLE 3 -59.

Field Length N/A Description 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.
Parameter rxgain
admin-state
N/A
The administrative state of this circuit service profile: disabled - Not activated, able to be reconfigured, able to be deleted. enabled - Activated. Ready to be applied.
Command Example
To create a circuit service profile, csprof1, and apply it to a media gateway circuit defined on the T1 span T1-1-7-1-1:
% CREATE CIRCUIT SERVICE PROFILE csprof1 % CONFIGURE MEDIA GATEWAY CIRCUIT PORT T1-1-7-1-1 .. CHANNEL 1-24 MODE blocked % CONFIGURE MEDIA GATEWAY CIRCUIT PORT T1-1-7-1-1 .. CHANNEL 1-24 STATE disabled % CONFIGURE MEDIA GATEWAY CIRCUIT PORT T1-1-7-1-1 .. CHANNEL 1-24 SERVICEPROFILENAME csprof1 % CONFIGURE MEDIA GATEWAY CIRCUIT PORT T1-1-7-1-1 .. CHANNEL 1-24 STATE enabled % CONFIGURE MEDIA GATEWAY CIRCUIT PORT T1-1-7-1-1 .. CHANNEL 1-24 MODE unblocked
To disable the default circuit service profile, turn off echo cancellation, and then reenable the profile:
% CONFIG CIRC SERVICE PROFILE default STATE disabled % CONFIG CIRC SERV PROFILE default ECH CANC disabled % CONFIG CIRC SERVICE PROFILE default STATE enabled
To display the default circuit service profile:

% SHOW CIRCUIT SERVICE PROFILE default ADMIN
Circuit Service Profile default Configuration Index: 1 Admin. State: ENABLED Capabilities: VOICEORCIRCUITMODEDATA Audio Encoding: G711ULAW
Packet Service Profile
3-241
Bandwidth (for Nx64): Echo Cancellation: Restricted/Unrestricted Data: Interworking Transfer Cap: TX Level Control: RX Level Control: Tx Gain (dB): Rx Gain (dB): DTMF Profile: Continuity Test Parameters: Test Type: Overall Test Timeout (secs): Minimum Tone Detect Time (ms): Minimum Tone Release Time (ms):
1 DS0 Channel(s) ENABLED UNRESTRICTED SPEECH NONE NONE 0 0 defaultDtmf REMOTELOOPBACK 2 45 25
Packet Service Group

PacketServiceGroup
This object provides a generic packet service profile.

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:
From PSTN to GSX to GSX to PSTN From PSTN to H.323 From PSTN to SIP
Each Policy Request reply contains one or more routes for the call. Each route includes a particular Packet Service Profile that is derived and passed to the GSX. See the PSX Policy Server Provisioning Guide for further information about configuring and managing individual call profiles on the PSX. For other call types, including calls into the GSX from SIP or H.323 peers, the Packet Service Profile used by the call must be configured and derived from the Packet Service Profile object on the GSX. The types of calls that receive this treatment are:
From H.323 to PSTN (uses the default Packet Service Profile) From SIP to PSTN (uses the default Packet Service Profile) Static Calls to provide SS7 F-links in international environments (uses the call configured Packet Service Profile). See Static Call on page 3-491.
Packet Service Negotiation

To determine the packet service used on a packet call, negotiation between the peers is necessary to arrive at an optimal compression algorithm to use between them. The Release 4.0 Packet Service Profile supports up to four audio encoding entries or CODECs. The available compression algorithms that may be assigned to these CODECs are:
3-242
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
The T.38 store and forward fax protocol may be used with any of the above algorithms. 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. An example of a negotiation scenario that may occur is 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. 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. In the command syntax below, two types of parameters are described:
COMMON - These parameters apply universally to all CODECs in the list, unless noted otherwise in their descriptions. See Table 3 -60, COMMON PACKET SERVICE PROFILE Parameters. CODEC - These parameters apply only to the particular CODEC that is being provisioned. See Table 3 -61, CODEC PACKET SERVICE PROFILE Parameters.
Command Syntax
CREATE PACKET SERVICE PROFILE psprofile CONFIGURE PACKET SERVICE PROFILE psprofile .. SILENCE FACTOR silencef VOICE INITIAL PLAYOUT BUFFER DELAY voicedelay TOS service DATAPARAMS PAYLOADTYPE dppayload INITIAL .. PLAYOUT BUFFER DELAY initialdelay G711 SID PAYLOADTYPE sidpayload SID HEARTBEAT sidheartbeat RTCP rtcp RTCP PACKET LOSS THRESHOLD plthreshold RTCP PACKET LOSS ACTION plaction RTCP PEER ABSENCE ACTION peeraction T38 ERROR CONTROL TYPE t38ect T38 NUMBER OF REDUNDANT PACKET t38hsnum
3-243
T38 MAX BIT RATE t38mxbr T38 DATA RATE MANAGEMENT TYPE t38drmt HONOR REMOTE PRECEDENCE honorrp AAL1 PAYLOAD SIZE aal1payloadsz CONFIGURE PACKET SERVICE PROFILE psprofile .. STATE admin-state CONFIG PACKET SERVICE PROFILE psprofile PRIORITY pri .. CODEC NONE CONFIG PACKET SERVICE PROFILE psprofile PRIORITY pri .. CODEC G711 CONFIG PACKET SERVICE PROFILE psprofile PRIORITY pri .. CODEC G711 PACKET SIZE G711pktsize LAW law MODEM TREATMENT modemtrtmnt FAX TREATMENT faxtrtmnt MODEM FAILURE modemfailure FAX FAILURE faxfailure DTMF RELAY dtmfrelay DTMF REMOVE DIGITS dtmfrlyrd CONFIG PACKET SERVICE PROFILE psprofile PRIORITY pri .. CODEC G711SS CONFIG 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 CONFIG PACKET SERVICE PROFILE psprofile PRIORITY pri .. CODEC G7231 CONFIG 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 CONFIG PACKET SERVICE PROFILE psprofile PRIORITY pri ..
3-244
CODEC G7231A CONFIG 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 DTMF RELAY dtmfrelay DTMF REMOVE DIGITS dtmfrlyrd CONFIG PACKET SERVICE PROFILE psprofile PRIORITY pri .. CODEC G726 CONFIG PACKET SERVICE PROFILE psprofile PRIORITY pri .. CODEC G726 PACKET SIZE G729pktsize CODING RATE codingrat726 MODEM TREATMENT modemtrtmnt FAX TREATMENT faxtrtmnt MODEM FAILURE modemfailure FAX FAILURE faxfailure DTMF RELAY dtmfrelay DTMF REMOVE DIGITS dtmfrlyrd CONFIG PACKET SERVICE PROFILE psprofile PRIORITY pri .. CODEC G729A CONFIG PACKET SERVICE PROFILE psprofile PRIORITY pri .. CODEC G729A PACKET SIZE G729pktsize MODEM TREATMENT modemtrtmnt FAX TREATMENT faxtrtmnt MODEM FAILURE modemfailure FAX FAILURE faxfailure DTMF RELAY dtmfrelay DTMF REMOVE DIGITS dtmfrlyrd CONFIG PACKET SERVICE PROFILE psprofile PRIORITY pri .. CODEC G729AB CONFIG PACKET SERVICE PROFILE psprofile PRIORITY pri .. CODEC G729AB PACKET SIZE G729pktsize MODEM TREATMENT modemtrtmnt FAX TREATMENT faxtrtmnt MODEM FAILURE modemfailure FAX FAILURE faxfailure DTMF RELAY dtmfrelay DTMF REMOVE DIGITS dtmfrlyrd SHOW PACKET SERVICE PROFILE psprofile ADMIN SHOW PACKET SERVICE PROFILE ALL ADMIN
3-245
DELETE PACKET SERVICE PROFILE psprofile
3-246
Command Parameters
TABLE 3 -60.
COMMON PACKET SERVICE PROFILE Parameters

Field Length 1-23 N/A Description The name of the profile that can be applied to a packet service object. Specifies the 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. 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-252. 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).
Parameter psprofile silencef
voicedelay
N/A
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. 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. 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. Default is 50 (milliseconds). Specifies the G.711 SID RTP payload type. This parameter applies only if the selected CODEC is G711SS. Must be 0-127, default is 19.
dppayload
N/A
initialdelay
N/A
sidpayload
N/A
3-247
TABLE 3 -60.

Field Length N/A Description Specifies whether SID packets should be sent within some minimum interval during a silence period: enabled - 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
Parameter sidheartbeat
rtcp
N/A
Specifies whether Real Time Control Protocol (RTCP) is enabled for the call: enabled - use RTCP for the call. disabled - 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. Specifies the action to take when plthreshold is exceeded: none - no action. trap - issue a trap. trapAndDisconnect - issue trap and disconnect the call. This parameter applies only if RTCP is enabled.
plaction
N/A
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 - no action. trap - issue a trap. trapAndDisconnect - issue trap and disconnect the call. This parameter applies only if RTCP is enabled.
t38ect
N/A
This field specifies the T.38 error correction type: redundancy - Repeat the previous secondary Internet Facsimile Protocol (IFP) messages along with a primary message. This is the only valid enumeration.
3-248
TABLE 3 -60.

Field Length N/A Description 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-1, default is 1. 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
Parameter t38hsnum
t38mxbr
N/A
t38drmt
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 - 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.
honorrp
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 peers Packet Service Profile CODEC priority list takes precedence over the local peers list disabled - the local peers Packet Service Profile CODEC priority list takes precedence over the remote peers list.
aal1payloadsz
NA
Specifies the VTOA AAL1 payload size in bytes. For G.711, this value must be 40, 44, or 47 bytes; default is 47 (bytes). The administrative state of this packet service profile: disabled - Not activated, able to be deleted. enabled - Activated, available for immediate use.
admin-state
N/A
3-249
TABLE 3 -61.
CODEC PACKET SERVICE PROFILE Parameters

Field Length N/A Description 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. 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.
Parameter pri
G711pktsize
N/A
G723pktsize
N/A
For CODECs G7231 and G7231A, the packet size in milliseconds. Must be 30-90, 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.
law
N/A
For CODECs G711 and G711SS, the G.711 Law value: lawFromCircuit - determine the G.711 Law from the Circuit Service Profile setting for this call. aLaw uLaw 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 - 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
codingrate726
N/A
For CODEC G726, the coding rate in bits per second: r32kbps - currently, the only supported rate
3-250
TABLE 3 -61.

Field Length N/A Description Specifies the treatment taken when the modem tone is detected: none - Do nothing when modem tone detected; does not require a compression resource. notifyPeer - Notify peer when modem tone detected; does require a compression resource. disconnect - Disconnect the call when modem tone detected; does require a compression resource. g711Fallback - Fallback to G.711 when modem tone detected; does require a compression resource if a compression resource was in use when the modem tone was detected.
Parameter modemtrtmnt
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 - continue to process the call
faxtrtmnt
N/A
Specifies the treatment taken when the fax tone is detected: none - Do nothing when fax tone detected; does not require a compression resource. notifyPeer - Notify peer when fax tone detected; does require a compression resource. disconnect - Disconnect the call when fax tone detected; does not require a compression resource. g711fallback - Fallback to G.711 when fax tone detected; does require a compression resource if a compression resource was in use when the modem tone was detected. faxRelay - Fax relay when fax tone detected; does require a compression resource. faxRelayOrG711Fallback - Fax relay / Fallback to G.711 when fax tone detected; does require a compression resource if a compression resource was in use when the modem tone was detected.
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 - continue to process the call u
3-251
TABLE 3 -61.

Field Length N/A Description Specifies the type of DTMF Relay to use to denote the presence of DTMF digits in the data stream: none - None. longDigit - # (or ##), applicable to SIP only. outOfBand - Applicable to SIP INFO or H245; requires a compression resource. rfc2833 - Requires a compression resource. 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-252.
Parameter dtmfrelay
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 - Remove DTMF digits.
Considerations for GSX to GSX Signaling

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.
MODEM TREATMENT - A specified value of notifyPeer is changed to none. Sonus recommends that g711Fallback be used for GSX to GSX modem calls. FAX TREATMENT - A specified value of notifyPeer is changed to none. Sonus recommends that faxRelayOrG711Fallback (T.38) be used for GSX to GSX FAX calls. DTMF RELAY / DTMF REMOVE DIGITS - A specified value of outOfBand or longDigit is changed to rfc2833. Sonus recommends that rfc2833 be used for all GSX to GSX compressed calls. This results in the removal of DTMF digits from the coded (RTP) voice data stream, transmitted over the IP network. These digits are reinserted before transmission to the PSTN.
Command Example
To display the default packet service profile:
% SHOW PACKET SERVICE PROFILE default ADMIN
Packet Service Profile default Configuration Index: Admin. State: Silence Factor: Voice Initial Playout Buffer Delay (ms): Type Of Service (TOS) Setting:
1 ENABLED 0 10 0x00
3-252
Packet Assembler Disassembler (PAD) Resources
VTOA AAL1 Payload Size (bytes): Data Parameters: RTP Payload Type: Initial Playout Buffer Delay (ms): Silence Suppression Parameters: G.711 SID Payload Type: SID Heartbeat: RTCP Parameters: RTCP: Packet Loss Threshold: Packet Loss Action: Peer Absence Action: T.38 Parameters: Error Control Type High Speed Number of Redundant Packet: Maximum Bit Rate (kbits/s): Data Rate Management Type: Honor Remote Precedence: Audio Encodings: G.711 DTMF Pkt Size/ Law/ Relay/ Priority Codec Code Rate Send SID Remove 1 G711 10 LAWFROMCIR NONE 0BPS DISABLED ENABLED 2 G729A 20 LAWFROMCIR NONE 0BPS DISABLED ENABLED 3 G729AB 20 LAWFROMCIR NONE 0BPS DISABLED ENABLED 4 G711SS 10 LAWFROMCIR NONE 0BPS DISABLED ENABLED
47 56 50 19 ENABLED DISABLED 0 NONE NONE REDUNDANCY 0 14400BPS TYPE2 DISABLED Modem Treatment/ Failure NONE CONTINUE NONE CONTINUE NONE CONTINUE NONE CONTINUE Fax Treatmnt Failure NONE CONTINUE FAXRELAY CONTINUE FAXRELAY CONTINUE NONE CONTINUE
Voice Packet Resources

ResourcePad
These objects specify packet assembly and echo canceller processing that takes place on the circuit network server modules.

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 SPS30 server module. The GSX9000 provides two server modules that perform audio compression via their onboard Digital Signal Processors (DSPs):
SPS30 - The Signal Processing Server (SPS30) is a CNS30 server module without a CNA30 adapter module. This module is 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 SPS30 supports one and only one compression type but individual SPS30s may assigned to different compression types.
3-253
CNS25 - The CNS25 server module supports the E1 circuits that are physically attached to its adapter module, the CNA25. In addition, each CNS25 contains a number of DSPs that are available to calls on other E1/T1 circuits connected to the GSX. Unlike the SPS30s, all CNS25s are restricted to one and only one of the three possible COMPRESSION TYPE values.
Audio compression of the following types may be assigned to the above mentioned resources:
G.729A - achieved through a COMPRESSION TYPE of g729AB G.729A+B (Silence Suppression) - achieved through a COMPRESSION TYPE of g729AB G.723.1 - achieved through a COMPRESSION TYPE of g7231 G.723.1A (Silence Suppression) - achieved through a COMPRESSION TYPE of g7231 G.726 - achieved through a COMPRESSION TYPE of g726
A packet outage is the loss of incoming voice (RTP) packets. If a PAD on any CNS or SPS30 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/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 below.
3-254
Packet Outage Detection Summary

Packet Outage Detection without Silence Suppression No N/A N/A N/A
Protocol, Algorithm, or GSX Peer T.38 G.723.1A G.729AB G.711SS
Packet Outage Detection with Silence Suppression N/A Yes - if SID HEARTBEAT is enabled. Yes - if SID HEARTBEAT is enabled. Yes - if SID HEARTBEAT is enabled and SEND SID is enabled. No - because GSX is not guaranteed of silence interval packets from this peer. No - because GSX is not guaranteed of silence interval packets from this peer. No - because GSX is not guaranteed of silence interval packets from this peer.
Sonus Recommended Ratio of Heartbeat Interval to Packet Outage Interval with Silence Suppression N/A 1 to 2+ 1 to 2+ 1 to 2+
H.323 endpoint SIP endpoint
Yes
1 to 2+
Yes
1 to 2+
MGCP endpoint
Yes
1 to 2+
Through the SHOW commands, you may examine the configuration and status of the PAD resources on any individual CNS or SPS30 server module.
Command Syntax
CONFIGURE RESOURCE PAD SHELF shelf JITTER .. EVALPERIOD evper MINOCCTHRSH minocthrsh CONFIGURE RESOURCE PAD SHELF shelf RTPPAYLOADTYPE .. DTMFRELAY dtmfrelay FAXRELAY faxrelay CONFIGURE RESOURCE PAD SHELF shelf THRESHOLD .. G729AB g729abthrsno STATE g729ab_state CONFIGURE RESOURCE PAD SHELF shelf THRESHOLD .. G7231 g7231thrsno STATE g7231_state CONFIGURE RESOURCE PAD SHELF shelf THRESHOLD .. G726 g726thrsno STATE g726_state CONFIGURE RESOURCE PAD SHELF shelf THRESHOLD .. TONE tonethrsno STATE tone_state
CONFIGURE RESOURCE PAD SHELF shelf SILENCE SUPPRESSION ..
MINSIDINTERVAL mintime MAXSIDINTERVAL maxtime HANGOVERTIME hangovertime MINVADLEVEL minnoise

3-255
MAXVADLEVEL maxnoise INITIAL COMFORT ENERGY energy CONFIGURE RESOURCE PAD SHELF shelf .. COMPRESSION TYPE cmpresstype CONFIGURE RESOURCE PAD SHELF shelf SLOT slotnumber .. COMPRESSION TYPE cmpresstype CONFIGURE RESOURCE PAD SHELF shelf .. PACKET OUTAGE THRESHOLD pothreshold PACKET OUTAGE RESET TOTAL COUNTER SHOW RESOURCE PAD SHELF shelf ADMIN SHOW RESOURCE PAD SHELF shelf ALL ADMIN SHOW RESOURCE PAD SHELF shelf SLOT slotnumber STATUS SHOW RESOURCE PAD SHELF shelf SUMMARY
3-256
Command Parameters
TABLE 3 -62.
RESOURCE PAD Parameters

Field Length N/A N/A Description The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. The slot number occupied by the CNS25 or SPS30 server module for which PAD Resource status is being assigned or displayed. This number must be 316. 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.
Parameter shelf slotnumber
g7231thrsno
N/A
g7231_state
N/A
Specifies whether a trap will be generated when G.723.1 resources are reduced beyond a threshold value: enabled - 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 - 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.
3-257
TABLE 3 -62.

Field Length N/A Description Specifies whether a trap will be generated when G.729A+B resources are reduced beyond a threshold value: enabled - generate the trap disabled - do not generate the trap
Parameter g729ab_state
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 - 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 10300000, default is 1000.
3-258
TABLE 3 -62.

Field Length N/A Description 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. This integer specifies the RTP payload type to use for DTMF Relay during compressed calls. Must be 0-127, default is 100. This integer specifies the RTP payload type to use for Fax Relay during compressed calls. Must be 0127, default is 101. 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). This integer specifies the minimum 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).
Parameter minocthrsh
dtmfrelay
N/A
faxrelay
N/A
mintime
N/A
maxtime
N/A
3-259
TABLE 3 -62.

Field Length N/A Description 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). 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). 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). 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).
Parameter hangovertime
minnoise
N/A
maxnoise
N/A
energy
N/A
3-260
TABLE 3 -62.

Field Length N/A Description The type of compression that is being assigned to the applicable PAD resouces: g729AB - G.729A or G.729A+B (Silence Suppression) g7231 - G.723.1 or G.723.1A (Silence Suppression) g726 - G.726 The applicable resources depend on the SLOT parameter. If no SLOT is specified, then the PAD resources of every CNS25 server module are assigned to that type of compression. If a SLOT is specified and the slot is occupied by an SPS30 server module, then the PAD resources on that SPS30 are assigned to that type of compression.
Parameter cmpresstype
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 or SPS30 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 and SPS30 server modules is cleared by RESET TOTAL COUNTER. Must be 100-60000 (milliseconds), default is 6000.
Command Example
To direct all of the PAD resources of the SPS30 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 .. COMPRESSION TYPE g726 % CONFIGURE SERVER SHELF 1 SLOT 14 STATE enabled % CONFIGURE SERVER SHELF 1 SLOT 14 MODE inservice
To change the G.729A+B percentage threshold to 80 and then reenable events for this resource:
% CONFIGURE RESOURCE PAD SHELF 1 .. THRESHOLD G729AB STATE disabled % CONFIGURE RESOURCE PAD SHELF 1 THRESHOLD .. G729AB 80 % CONFIGURE RESOURCE PAD SHELF 1 .. THRESHOLD G729AB STATE enabled
3-261
To display the PAD Resource summary of SPS30s and CNS25s and their respective configurations in a shelf:
% SHOW RESOURCE PAD SHELF 1 ALL ADMIN
-----------------------------------------------------Shelf/Server PAD Configurations -----------------------------------------------------Shelf Slot Compression Type ----------------------1 G729AB 1 6 G729AB (shelf-based) 1 7 G729AB (shelf-based) 1 8 G729AB (shelf-based) 1 14 G729AB 1 15 G729AB
To display the PAD Resource configuration of a shelf:

% SHOW RESOURCE PAD SHELF 1 ADMIN
-----------------------------------------------------PAD Configuration: Shelf: 1 -----------------------------------------------------------------------------------------------Jitter Parameters ------------------------------------------Jitter Eval Period : 1000ms Jitter Min Occ Threshold : 20ms ------------------------------------------RTP Payload Types ------------------------------------------DTMF Relay : 100 Fax Relay : 101 ------------------------------------------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 ------------------------------------------Comfort Energy Level : -56dBm ------------------------------------------Thresholds % State ------------------------------------------G729AB : 90 ENABLED G7231 : 90 ENABLED G726 : 90 ENABLED Tone : 90 ENABLED Packet Outage : 6000ms ------------------------------------------Compression Type (shelf-based): G729AB
3-262
To display the PAD Resource status of the SPS30 server module in slot 15 of shelf 1:
% SHOW RESOURCE PAD SHELF 1 SLOT 15 STATUS
-----------------------------------------------------DSP Resource Status: Shelf: 1 Slot:15 -----------------------------------------------------Total Utilization Allocation % Failures % ----------------------G711+Echo Cancellation: 0 0 0 G711: 0 0 0 HDLC: 0 0 0 Tone: 0 0 0 G729A+B: 448 0 0 G723.1: 0 0 0 G726: 0 0 0 Packet Outages total: 0 Packet Outages during interval: 0
To display the PAD Resource status of the CNS25 module in slot 6 of shelf 1:
-----------------------------------------------------DSP Resource Status: Shelf: 1 Slot: 6 -----------------------------------------------------Total Utilization Allocation % Failures % ----------------------G711+Echo Cancellation: 432 0 0 G711: 0 0 0 HDLC: 12 0 0 Tone: 108 0 0 G729A+B: 392 0 0 G723.1: 0 0 0 G726: 0 0 0 Packet Outages total: 0 Packet Outages during interval: 0
To display the PAD Resource status of the CNS30 module in slot 11 of shelf 1:
-----------------------------------------------------DSP Resource Status: Shelf: 1 Slot:11 -----------------------------------------------------Total Utilization Allocation % Failures % ----------------------G711+Echo Cancellation: 672 2 0 G711: 0 0 0 HDLC: 28 53 0 Tone: 180 0 0 G729A+B: 0 0 0 G723.1: 0 0 0
Echo Canceller Profile
3-263
G726: 0 0 Packet Outages total: 0 Packet Outages during interval: 0
Note
For SPS30s, only the DSP G729A+B, G723.1, and G726 resources are used. For CNS10s and CNS30s, the DSP G729A+B, G723.1, and G726 resources are never used. For CNS25s, all DSP resources may be used. 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+Echo G711 HDLC Tone Compression Tot Util Fail Tot Util Fail Tot Util Fail Tot Util Fail Tot Util Fail Slot % % % % % % % % % % ---- ------------- ------------- ------------- ------------- ------------6 432 0 0 0 0 0 12 0 0 108 0 0 392 0 0 7 432 0 0 0 0 0 12 0 0 108 0 0 392 0 0 8 432 0 0 0 0 0 12 0 0 108 0 0 392 0 0 9 288 46 0 0 0 0 28 25 0 108 0 0 0 0 0 11 672 2 0 0 0 0 28 53 0 180 0 0 0 0 0 12 672 45 0 0 0 0 28 100 0 180 0 0 0 0 0 13 672 0 0 0 0 0 28 0 0 180 0 0 0 0 0 14 0 0 0 0 0 0 0 0 0 0 0 0 448 90 0 15 0 0 0 0 0 0 0 0 0 0 0 0 448 0 0
Echo Canceller Profile EchoCancellerProfile

This object allows you to specify echo cancellation characteristics and store them in a named profile. This profile may subsequently be applied to one or more T1 circuits.
Command Syntax
CREATE ECHO CANCELLER PROFILE ecprofile CONFIGURE ECHO CANCELLER PROFILE ecprofile .. RETURNLOSS returnloss RESIDUALECHO residecho MODEMDISABLE modemdisable NARROWBANDDETECT narrowbdetect CONFIGURE ECHO CANCELLER PROFILE ecprofile .. STATE admin_state SHOW ECHO CANCELLER PROFILE ecprofile DELETE ECHO CANCELLER PROFILE ecprofile
3-264
Echo Canceller Profile
Command Parameters
TABLE 3 -63.
ECHO CANCELLER PROFILE Parameters

Field Length 1-23 N/A Description The name of the echo canceller profile that is being created and configured. Specifies the echo return loss in dBm0s: dB6 dB3 dB0
Parameter ecprofile returnloss
residecho
N/A
Specifies the residual echo cancellation: cancelOnly suppressResidual comfortNoise
modemdisable
N/A
MODEMDISABLE setting: ignore2100Hz g164 g165
narrowbdetect
N/A
Specifies the status of Echo Cancellation narrow band detection: on - when in G.165 mode, narrow the G.164 bandwidth to the G.165 band.
off admin-state N/A The administrative state of the designated echo canceller profile: disabled - 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 assign it to the T1 span t1-1-3-1:
% CREATE ECHO CANCELLER PROFILE ecprof1 % CONFIGURE ECHO CANCELLER PROFILE ecprof1 .. RESIDUALECHO cancelOnly RETURNLOSS dB3 % CONFIGURE ECHO CANCELLER PROFILE ecprof1 .. STATE enabled % CONFIGURE T1 t1-1-3-1 MODE Outofservice % CONFIGURE T1 t1-1-3-1 STATE disabled % CONFIGURE T1 t1-1-3-1 ECHO PROFILE ecprof1 % CONFIGURE T1 t1-1-3-1 STATE enabled % CONFIGURE T1 t1-1-3-1 MODE Inservice
To display the configuration of echo canceller profile ecprof1:
ISUP Service Profile
3-265
% SHOW ECHO CANCELLER PROFILE ecprof1

-----------------------------------------------------Echo Canceller Profile: ecprof1 -----------------------------------------------------Index: 1 State: ENABLED Echo Return Loss: DB3 Residual Echo Control: CANCELONLY Modem Tone: G165 Narrow Band Detection: OFF
ISUP Service Group

ISUPServiceGroup
These objects configure the SS7 call control services.

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
CREATE ISUP SERVICE PROFILE profilename CONFIGURE ISUP SERVICE PROFILE profilename .. TRUNK GROUP tgname SWITCHTYPE switchtype HUNT hdirection REVISION revision COST cost CONTROL cicControl CONTFREQ continuityTestFreq HOPCOUNTVALUE hopcountval HOPCOUNTSTATE hopcountstat EXCHANGETYPE exchangetype DISCONNECT TREATMENT PROFILE dtprofile TONE PACKAGE tonepkg GRSATSTARTUP grs INSPECTION TIME insptime INSPECTION FREQUENCY inspfreq
3-266
INSPECTION STATE inspstate SIGNALING PROFILE sigprof ACCRESPPROCESS accresproc ACCL1ARCANCELPERCENT accl1ARcanperc ACCL1DRCANCELPERCENT accl1DRperc ACCL2ARCANCELPERCENT accl2ARperc ACCL2DRCANCELPERCENT acc2DRperc ACCL3ARCANCELPERCENT accl3ARcanperc ACCL3DRCANCELPERCENT accl3DRcanperc ACCSENDACL accSendACL OLIPCHECK olipcheck INR INF PROFILE inrinfprof SATELLITE CIRCUITS SatelliteCircuits CLLI TOWN CODE cllitown CLLI STATE CODE cllistate CLLI BUILDING CODE cllibldg CLLI BUILDING SUB DIVISION CODE cllibldgsd ALERT TONE alerttone ALERT TONE NONE CONFIGURE ISUP SERVICE PROFILE profilename .. STATE admin-state SHOW ISUP SERVICE PROFILE profilename ADMIN SHOW ISUP SERVICE PROFILE ALL ADMIN DELETE ISUP SERVICE PROFILE profilename
3-267
Command Parameters
TABLE 3 -64.
ISUP Service Profile Parameters

Field Length 1-23 1-23 N/A Description The name of this profile, which can be applied to an underlying ISUP service. The name of the trunk group that the ISUP service will belong to. The type of central office switch that this service is connected to: dms500 dms250 dms200 dms100 5ess 4ess
Parameter profilename
tgname
switchtype
hdirection
N/A
The hunt algorithm for choosing a specific CIC within a trunk group. This algorithm must complement the one that is 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. bottom2top - start the search at the lowest physical port number on the lowest CNA slot number on the lowest shelf number in the node. 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. 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.
3-268
TABLE 3 -64.

Field Length N/A Description 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 nttfcc - For Japan. itu1997 itu1988 ituq767 - Same as etsii (has been renamed). belgacom etsi3 nttcom spirou mexicoic italy denmarkic hongkongic singapore etsi3 peru chile nttcom - Use the NTT Communications protocol for Japan. See Table 3 -36, Release 4.0 SS7 Server Protocols and ISUP Variants.
Parameter revision
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.
3-269
TABLE 3 -64.

Field Length N/A Description 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.
Parameter cicControl
continuity TestFreq
N/A
The frequency with which Continuity Tests will be 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)
hopcountval
N/A
The initial Hop Counter value to use (if hopcountstat is enabled). Must be 10-20.
3-270
TABLE 3 -64.

Field Length N/A Description 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.
Parameter hopcountstat
exchangetype
N/A
Exchange type to which this service applies: none typeA - An exchange that is not a national or international transit exchange. typeB - A national or international transit exchange, that is, an exchange that acts as a transit node, according to the ITUq767 specification.
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-478. tonepkg grs 1-23 N/A The name of a tone package to be used by the ISUP service. See Tone Package on page 3-490. Specifies whether to issue the GroupReset (GRS) message on all circuits when the CNS module is started. All circuits that belong to the ISUP service and are controlled by the module will receive the GRS message. If GRS is not supported, individual RSC messages will be issued on CNS restart. unsupported - do not issue the GRS message on startup supported - issue the GRS message on startup
3-271
TABLE 3 -64.

Field Length N/A Description 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
Parameter insptime
inspfreq
N/A
Inspection frequency: onehour threehours sixhours twelvehours oneday 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 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. 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.
accresproc
N/A
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.
3-272
TABLE 3 -64.

Field Length N/A Description 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. ACC Level 2 AR Cancel Percentage. Must be 0-100. ACC Level 2 DR Cancel Percentage. Must be 0-100. ACC Level 3 AR Cancel Percentage. Must be 0-100. ACC Level 3 DR Cancel Percentage. Must be 0-100. Specifies the maximum ACL value sent to a remote node for this ISUP Service Group. 0 means ACC is disabled. Must be 0-3. 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. Use this parameter to turn OLIP checking off for certain switches that do not supply OLIP information for such calls: on - check for OLIP off - dont check for OLIP
Parameter accl1DRcanperc
accl2ARcanperc acc2DRcanperc accl3ARcanperc accl3DRcanperc accSendACL
N/A N/A N/A N/A N/A
olipcheck
N/A
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. Specifies whether the circuits in the service group are connected to a satellite: enabled - circuits are connected to a satellite disabled - circuits are not connected to a satellite
SatelliteCircuits
N/A
cllitown
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. 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. 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. 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.
cllistate
cllibldg
cllibldgsd
ISUP Signaling Profile
3-273
TABLE 3 -64.

Field Length 1-23 Description 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. The administrative state of this ISUP service group profile: disabled - Not activated, able to be deleted. enabled - Activated, available for immediate use.
Parameter alerttone
admin-state
N/A
Command Example
To create, configure, and activate an ISUP service group profile named isupsp1:
% CREATE ISUP SERVICE PROFILE isupsp1 % CONFIG ISUP SERV PROF isupsp1 TRUNK GROUP tg1 % CONFIG ISUP SERV PROF isupsp1 SWITCHTYPE 5ESS % CONFIG ISUP SERV PROF isupsp1 HUNT bottom2top % CONFIG ISUP SERV PROF isupsp1 COST 10 % CONFIG ISUP SERV PROF isupsp1 STATE enabled

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.
3-274
Command Syntax
CREATE ISUP SIGNALING PROFILE sigprofilename CONFIGURE ISUP SIGNALING PROFILE sigprofilename .. COMPAT compat ACCESSDEL accessdel GENNUM gennum GENNOTIF gennotif GENDIGS gendigs LOCNUM locnum ORIGISCPC origiscpc TELESERVICE teleservice SEGMENTATION segmentation FALLBACK fallback PROPDELAY propdelay EMCID emcid HOPCOUNTER hopcounter SUBPRIORITYCLS subprioritycls APM apm CONNUMINACM connuminacm CAUSEINCPG causeincpg MULTICARRIERENV multicarrierenv CARRIERSELECTION carrierselection INRINF inrinf CQMCQR cqmcqr CALLREF callref CFN cfn FACILITY facility PAM pam OBCIANM obcianm DRS drs REDNUM rednum LPA lpa UCIC ucic OLM olm BBREL bbrel USR usr BBIAM bbiam CALLMODMSGS callmodmsgs CALLDIV calldiv CALLHIST callhist GENREF genref MLPP mlpp NSF nsf
3-275
REDNUMRIST rednumrist REMOTEOP remoteop SERVACTV servactv SIGPOINTCODE sigpointcode TMRPRIME tmrprime TRANSMEDUSED transmedused USIPRIME usiprime REDNUMINACM rednuminacm REDNUMINANM rednuminanm UUIINREL uuiinrel 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 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
3-276
TRANSITUNREC CCRAW ccraw CGBCGU cgbcgu GRS grs
transitunrec
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 SPECPROCREQ specprocreq TRANSREQ transreq CHGNUM chgnum GENADRESSREL genaddressrel UUINDACM uuindacm UUINFO uuinfo OPERATORSERVINFO operatorservinfo CVTCVR cvtcvr GENNAME genname REDCAP redcap REDCOUNT redcount SENDTWOGRPMSGS sendtwogrpmsgs AWAITTWOGRPMSGS awaittwogrpmsgs CQMONCARDSWAP cqmoncardswap ANSI95GRS ansi95grs CPGBEFOREACM cpgbeforeacm AWAIT DIGITS awaitdigits MAPDMSFEPARAMETER mapdmsfeparameter MXCGNUM mxcgnum MXCDNUM mxcdnum FPH fph ITXTXA itxtxa
3-277
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 GENNUM IN ACM gennuminacm GENNUM IN FAC gennuminfac GENNUM IN INF gennumininf CONFTREAT IN ANM conftreatinanm CONTINUITY continuity TRUNK OFFERING trunkoffering OPERATOR SELECTION operselection DIAGNOSTICS diagnostics OPTIONAL FCI optionalfci CUGIC cugic COM com CON con USI PARAM usiparam CONNECTED NUMBER connectednumber IRIORIRCV iriorircv IRIORISENT iriorisent T11ACTIVE t11active IRIORI iriori TRANSMEDUSEDINNRM transmedusedinnrm RLCACKGRS rlcackgrs INCOMINGTRUNKIDCODE incomingtrunkidcode SPCINIRS spcinirs REDINFOIAM redinfoiam REDIRECTING NUM RedirectingNum SEND BLOCK AFTER SETUP SendBloAfterSetup CALLED DIRECTORY NUMBER CalledDirectoryNum T6 EXPIRY CAUSE VALUE t6causeval T7 EXPIRY CAUSE VALUE t7causeval UUIACM uuiacm ATREL atrel UUINDREL uuindrel EIT eit GI gi TIT tit
3-278
AIT ait TCI tci NFT nft CPNREL cpnrel 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 CONFIGURE ISUP SIGNALING PROFILE profilename .. STATE admin-state SHOW ISUP SIGNALING PROFILE profilename ADMIN SHOW ISUP SIGNALING PROFILE profilename MESSAGES ADMIN SHOW ISUP SIGNALING PROFILE profilename .. PARAMETERS ADMIN SHOW ISUP SIGNALING PROFILE profilename SERVICES ADMIN SHOW ISUP SIGNALING PROFILE SUMMARY DELETE ISUP SIGNALING PROFILE profilename
3-279
Command Parameters
TABLE 3 -65.
ISUP Signaling Profile Parameters

Field Length 1-23 N/A Description The name of the ISUP signaling profile. Specifies whether the compatibility functionality is active: unsupported supported
Parameter sigprofilename compat
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
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
3-280
TABLE 3 -65.

Field Length N/A Description Specifies whether the propagation delay functionality is active: unsupported supported
Parameter propdelay
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
apm
N/A
Specifies whether the 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
3-281
TABLE 3 -65.

Field Length N/A Description Specifies whether the call reference parameter is supported: unsupported supported
Parameter callref
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
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
3-282
TABLE 3 -65.

Field Length N/A Description Specifies whether the Blue Book specific parameters are supported in the IAM message: unsupported supported
Parameter bbiam
callmodmsgs
N/A
Specifies whether the call modification messages CMR, CMA, and CMRJ are supported: unsupported supported
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
sigpointcode
N/A
Specifies whether the signaling point code parameter is supported: unsupported supported
3-283
TABLE 3 -65.

Field Length N/A Description Specifies whether the transmission medium required prime parameter is supported: unsupported supported
Parameter tmrprime
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
conreqinfaa
N/A
Specifies whether the connection request parameter is supported in the FAA message: unsupported supported
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
3-284
TABLE 3 -65.

Field Length N/A Description Specifies whether the circuit assignment map parameter is supported: unsupported supported
Parameter circassmap
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
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
3-285
TABLE 3 -65.

Field Length N/A Description Specifies whether the forward GVNS parameter is supported: unsupported supported
Parameter forwardgvns
loopprevention
N/A
Specifies whether the Loop Prevention 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
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
accesstransin fac
N/A
Specifies whether access transport in the FAC parameter is supported: unsupported supported
3-286
TABLE 3 -65.

Field Length N/A Description Specifies whether the generic notification parameter is supported in the FAC message: unsupported supported
Parameter gennotifinfac
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
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 unsupported
3-287
TABLE 3 -65.

Field Length N/A Description Specifies whether Group ReSet is supported by the ISUP revision currently in use. If set to unsupported, then individual RSC messages will be sent for each circuit, instead. supported unsupported
Parameter grs
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. Specifies the Propagation Delay Value in milliseconds. Must be 0-400, default is 0 (milliseconds). The level of user to user services supported by the ISUP revision currently in use: none level1 level2 level3
pdv u2usrvclevel
N/A N/A
sam
N/A
Specifies whether the Subsequent Address Message is supported by the ISUP revision currently in use: supported unsupported
fot
N/A
Specifies whether the Forward Transfer Message is supported by the ISUP revision currently in use: supported unsupported
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
3-288
TABLE 3 -65.

Field Length N/A Description Specifies whether access transport parameter is supported: unsupported supported
Parameter accesstrans
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
servcodeind
N/A
Specifies whether the Service Code Indicator parameter is supported: unsupported supported
3-289
TABLE 3 -65.

Field Length N/A Description Specifies whether the Special Processing Request parameter is supported: unsupported supported
Parameter specprocreq
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
operatorservinfo
N/A
Specifies whether the Operator Service Information parameter is supported: unsupported supported
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 Group Redirection Count parameter is supported: unsupported supported
3-290
TABLE 3 -65.

Field Length N/A Description Specifies whether to Set the Flag to Send Two Group Messages: unsupported supported
Parameter sendtwogrpmsgs
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
ansi95grs
N/A
Specifies whether the ANSI-95 format for Group Reset Circuit (GRS), 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 supported
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
mxcgnum mxcdnum fph
N/A N/A N/A
The maxium digit string length for the Calling Party Number parameter. Must be 1-30, default is 30. The maxium digit string length for the Called Party Number parameter. Must be 1-30, default is 30. Specifies whether the Freephone Indicators parameter is supported: unsupported supported
itxtxa
N/A
Specifies whether the ITX and TXA messages are supported: unsupported supported
sccpproc
N/A
Specifies whether the SCCP Procedure is supported: unsupported supported
3-291
TABLE 3 -65.

Field Length N/A Description Specifies whether the Connection Request parameter is supported in the IAM: unsupported supported
Parameter cnriam
ccnr
N/A
Specifies whether the CCNR Possible Indicator parameter is supported: unsupported supported
transitcfn
N/A
Specifies whether the CFN message should be transitted: unsupported supported
holdingind
N/A
Specifies whether the Holding Indicator is supported: unsupported supported
dispinfoinacm
N/A
Specifies whether the Display Information parameter in the ACM is supported: unsupported supported
dispinfoincon
N/A
Specifies whether the Display Information parameter in the CON is supported: unsupported supported
dispinfoincpg
N/A
Specifies whether the Display Information parameter in the CPG is supported: unsupported supported
dispinfoiniam
N/A
Specifies whether the Display Information parameter in the IAM is supported: unsupported supported
gennuminacm
1-23
Specifies whether the Generic Number parameter in the ACM is supported: unsupported supported
gennuminfac
N/A
Specifies whether the Generic Number parameter in the FAC is supported: unsupported supported
gennumininf
N/A
Specifies whether the Generic Number parameter in the INF is supported: unsupported supported
3-292
TABLE 3 -65.

Field Length N/A Description Specifies whether the Conference Treatment parameter in the ANM is supported: unsupported supported
Parameter conftreatinanm
continuity
N/A
Specifies whether the Continuity procedures are supported: unsupported supported
trunkoffering
N/A
Specifies whether the trunk offering messages can, fan, ofr, and rcl are supported: unsupported supported
operatorselection
N/A
Specifies whether the operator selection parameter is supported: unsupported supported
diagnostics
N/A
Specifies whether the Diagnostics field is supported: unsupported supported
optionalfci
1-23
Specifies whether the Optional Forward Call Indicators are supported: unsupported supported
cugic
N/A
Specifies whether the Closed User Group Interlock Code is supported: unsupported supported
com
N/A
Specifies whether the COM message is supported: unsupported supported
con
N/A
Specifies whether the CON message is supported: unsupported supported
usiparam
N/A
Specifies whether the User Service Information parameter is supported: unsupported supported
connectednumber
N/A
Specifies whether the connected number is supported: unsupported supported
3-293
TABLE 3 -65.

Field Length N/A Description Specifies whether an IRI/ORI message is expected: unsupported supported
Parameter iriorircv
iriorisent
N/A
Specifies whether an IRI/ORI message is to be sent out: unsupported supported
t11active
N/A
Specifies whether ISUP T10 timing is supported: unsupported supported
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
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
3-294
TABLE 3 -65.

Field Length N/A Description Specifies whether the called directory number parameter is supported: unsupported supported
Parameter CalledDirectoryNum
t6causeval
N/A
Specifies the T6 timer default release cause value used by all ITU protocols. Must be 1-127, default is 16. Specifies the T7 timer default release cause value used by all ITU protocols. Must be 1-127, default is 31. Specifies whether signaling control for the user-touser information (UUI) parameter is supported in the early address complete message (ACM): unsupported supported
t7causeval
N/A
uuiacm
N/A
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-touser 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
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
3-295
TABLE 3 -65.

Field Length N/A Description Specifies whether signaling control for the Network Function Type (NFT) parameter is supported: unsupported supported
Parameter nft
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
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
3-296
TABLE 3 -65.

Field Length N/A Description Specifies whether the Suspend (SUS) message is supported in the forward direction: unsupported supported
Parameter forwardsus
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
admin-state
N/A
The administrative state of this ISUP signaling profile: disabled - Not activated, able to be deleted. enabled - Activated, available for immediate use.
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 following example shows all current named ISUP signaling profiles, including the default profiles.
% SHOW ISUP SIGNALING PROFILE SUMMARY
--------------------------------------------------------------------ISUP Signaling Profile Summary --------------------------------------------------------------------Name Admin State Base Profile (if applicable) ------------------------ ------------- -----------------------------
3-297
Default_ANSI_1992 Default_ANSI_1995 Default_Belgacom Default_CHILE Default_DENMARK Default_ETSI_V2 Default_ETSI_V3 Default_German Default_GR317 Default_HONGKONG_IC Default_ITALY Default_ITU_1988 Default_ITU_1993 Default_ITU_1997 Default_ITU_Q767 Default_MEXICO_IC Default_NTT_FCC Default_PERU Default_SINGAPORE Default_SPIROU Default_NTT_COM
ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED
To view the default ISUP signaling profile parameter controls for I, type the command:
% SHOW ISUP SIGNALING PROFILE Default_German .. PARAMETERS ADMIN
---------------------------------------------------------------------ISUP Signaling Profile : Default_German Parameter Controls ---------------------------------------------------------------------AccessDel : SUPPORTED AccessTrans : SUPPORTED AccessTransInFac : UNSUPPORTED BackwardGVNS : UNSUPPORTED BBIam : SUPPORTED BBRel : SUPPORTED Business Group : UNSUPPORTED CalledInNum : UNSUPPORTED CallDiv : SUPPORTED CallDivTreat : UNSUPPORTED CallHist : SUPPORTED CallOfrTreat : UNSUPPORTED CallRef : SUPPORTED 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 ConReq : UNSUPPORTED ConReqInFaa : SUPPORTED ConReqInFar : SUPPORTED CorrelationId : UNSUPPORTED CseInRlc : SUPPORTED CUG Interlock Cd : SUPPORTED Diagnostics : SUPPORTED DispInfo : UNSUPPORTED DispInfoInAcm : UNSUPPORTED DispInfoInCon : UNSUPPORTED DispInfoInCpg : UNSUPPORTED DispInfoInIam : UNSUPPORTED EchoCntrlInIam : SUPPORTED EchoCntrlParam : SUPPORTED EgressService : UNSUPPORTED Freephone Ind : UNSUPPORTED ForwardGVNS : UNSUPPORTED GenAddressREL : UNSUPPORTED GenDigs : SUPPORTED GenName : UNSUPPORTED GenNotif : SUPPORTED GenNotifInFac : UNSUPPORTED GenNum : SUPPORTED GenNumInAcm : UNSUPPORTED GenNumInCpg : UNSUPPORTED GenNumInFac : UNSUPPORTED GenNumInInf : UNSUPPORTED GenRef : SUPPORTED Holding Indicator : SUPPORTED IncomingTrunkIdCode: UNSUPPORTED InformationInd : UNSUPPORTED Jurisdiction : UNSUPPORTED LocNum : SUPPORTED MLPP : SUPPORTED MultiCarrierEnv : SUPPORTED NetworkMgmt : UNSUPPORTED NotifInd : UNSUPPORTED NSF : SUPPORTED Ntp : UNSUPPORTED ObciAnm : SUPPORTED OCN : UNSUPPORTED Operator Sel : UNSUPPORTED OperatorServInfo : UNSUPPORTED Optional FCI : SUPPORTED OrigIscPC : SUPPORTED RecInCai : UNSUPPORTED RedCap : UNSUPPORTED
3-298
RedCount RedInfoIam RedNumInAcm RedNumRist RemoteOpInRel SCCP Procedure SigPointCode ServCodeInd SpcInIrs TeleService TransMedUsed TranReq UIDActionInd UsiPrime UuiInRel UuindCpg Base Profile Admin State
: : : : : : : : : : : : : : : : : :
UNSUPPORTED SUPPORTED SUPPORTED SUPPORTED UNSUPPORTED UNSUPPORTED SUPPORTED UNSUPPORTED UNSUPPORTED SUPPORTED SUPPORTED UNSUPPORTED UNSUPPORTED SUPPORTED SUPPORTED SUPPORTED ENABLED
RedInfoAcm RedNum RedNumInAnm RemoteOp SCFId ServActv SpecProcReq SubPriorityCls TmrPrime TransMedUsedInNrm Transit Ntwk Sel UIDCapInd USI Support UuindAnm UUInfo
: : : : : : : : : : : : : : :
UNSUPPORTED SUPPORTED SUPPORTED SUPPORTED UNSUPPORTED SUPPORTED UNSUPPORTED SUPPORTED SUPPORTED SUPPORTED SUPPORTED UNSUPPORTED SUPPORTED SUPPORTED UNSUPPORTED
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 --------------------------------------------------------------------AwaitDigits : UNSUPPORTED Compatibility : SUPPORTED CC Raw : UNSUPPORTED Fallback : UNSUPPORTED Hop Counter : SUPPORTED IRI / ORI Receive : UNSUPPORTED IRI / ORI Send : UNSUPPORTED IRI / ORI Support : UNSUPPORTED Propagation Delay : SUPPORTED Map DMS FE Parameter : UNSUPPORTED Max CDPN digits : 16 Max CGPN digits : 16 Prop Delay Value : 12 Rlc Ack Grs : UNSUPPORTED Special Digits : DIGITB|DIGITC|DIGITF T11 Active : UNSUPPORTED Transit Unrec Params : UNSUPPORTED U2U Service Level : LEVEL3 Base Profile Admin State : : ENABLED
To view the default ISUP signaling profile message controls for Germany, type the command:
% SHOW ISUP SIGNALING PROFILE Default_German .. MESSAGE ADMIN
---------------------------------------------------------------------ISUP Signaling Profile : Default_German Message Controls ---------------------------------------------------------------------APM / PRI : SUPPORTED CFN : SUPPORTED CGB / CGU : SUPPORTED CMR / CMC / CMRJ : UNSUPPORTED COM : UNSUPPORTED CON : SUPPORTED CQM / CQR : UNSUPPORTED COT / CCR : SUPPORTED CVT / CVR : UNSUPPORTED DRS : UNSUPPORTED FAC : UNSUPPORTED
ISUP INR INF Profile
3-299
FAR / FAA / FRJ GRS INR / INF ITX / TXA LPA OFR, CAN, FAN, RLL PAM SGM UPA / UPT Transit CFN Send 2 Group Msgs CQM on card swap Base Profile Admin State
: : : : : : : : :
SUPPORTED SUPPORTED SUPPORTED UNSUPPORTED UNSUPPORTED UNSUPPORTED SUPPORTED SUPPORTED UNSUPPORTED
FOT GRS ( ANSI'95 ) IDR / IRS LOP NRM OLM SAM UCIC USR CPG before ACM Await 2 Group Msgs
: : : : : : : : :
SUPPORTED UNSUPPORTED SUPPORTED UNSUPPORTED SUPPORTED UNSUPPORTED SUPPORTED SUPPORTED SUPPORTED
: UNSUPPORTED : UNSUPPORTED : UNSUPPORTED : : ENABLED
: UNSUPPORTED : UNSUPPORTED
To view the default ISUP signaling profile service controls for Peru, type the command:
% SHOW ISUP SIGNALING PROFILE Default_Peru .. SERVICES ADMIN
--------------------------------------------------------------------ISUP Signaling Profile : Default_PERU Service Controls --------------------------------------------------------------------AwaitDigits : UNSUPPORTED BLO after setup : UNSUPPORTED Compatibility : SUPPORTED CC Raw : UNSUPPORTED Fallback : SUPPORTED Hop Counter : UNSUPPORTED IRI / ORI Receive : UNSUPPORTED IRI / ORI Send : UNSUPPORTED IRI / ORI Support : UNSUPPORTED Propagation Delay : SUPPORTED Map DMS FE Parameter : UNSUPPORTED Max CDPN digits : 30 Max CGPN digits : 30 Prop Delay Value : 12 Rlc Ack Grs : UNSUPPORTED Special Digits : DIGITB|DIGITC|DIGITF T11 Active : UNSUPPORTED Transit Unrec Params : UNSUPPORTED U2U Service Level : LEVEL3 T6 Expiry Cause Value: 16 T7 Expiry Cause Value: 31 Base Profile Admin State : : ENABLED

This object creates a template for the ISUP information requests 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.
3-300
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:
tear down the call if the requested information is not received or continue the call despite the missing information
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.
Command Syntax
CREATE ISUP INR INF PROFILE sigprofilename CONFIGURE ISUP INR INF PROFILE sigprofilename .. CPC REQUEST cpcreq CLI REQUEST clireq CRG INFO REQUEST crginforeq CPC NOT RECVD FAIL cpcnrf CLI NOT RECVD FAIL clinrf CRGINFO NOT RECVD FAIL crginfonrf USE SOLICITED INF ONLY solinfonly CONFIGURE ISUP INR INF PROFILE sigprofilename .. STATE admin-state SHOW ISUP INR INF PROFILE sigprofilename ADMIN SHOW ISUP INR INF PROFILE ALL ADMIN SHOW ISUP INR INF PROFILE SUMMARY
3-301
DELETE ISUP INR INF PROFILE sigprofilename
3-302
Command Parameters
TABLE 3 -66.
ISUP INR INF Profile Parameters

Field Length 1-23 Description The name of the ISUP INR INF Profile, which is always identical to the associated ISUP Signaling Profile name. Specifies whether a calling party category (CPC) should be requested if the value received was unknown: unsupported - dont request CPC supported - request CPC
Parameter sigprofilename cpcreq
N/A
clireq
N/A
Specifies whether a calling line ID (CLI) should be requested if it was not received: unsupported - dont request the CLI supported - request the CLI
crginforeq
N/A
Specifies whether charge information should be requested if it was not received: unsupported - dont request charge information supported - request charge information
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 - 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
3-303
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
The following example shows all existing ISUP INR INF profiles:
% SHOW ISUP INR INF PROFILE SUMMARY
--------------------------------------------------------------------ISUP INR INF Profile Summary --------------------------------------------------------------------INR INF Profile Name Admin State ------------------------ ------------Default_ANSI_1992 ENABLED Default_ANSI_1995 ENABLED Default_Belgacom ENABLED Default_DENMARK ENABLED Default_ETSI_V2 ENABLED Default_ETSI_V3 ENABLED Default_German ENABLED Default_HONGKONG_IC ENABLED Default_ITALY ENABLED Default_ITU_1988 ENABLED Default_ITU_1993 ENABLED Default_ITU_1997 ENABLED Default_ITU_Q767 ENABLED Default_MEXICO_IC ENABLED Default_NTT_FCC ENABLED Default_SINGAPORE ENABLED Default_SPIROU ENABLED
The following example shows all current Default_German ISUP INR INF profile control settings:
% SHOW ISUP INR INF PROFILE Default_German ADMIN
--------------------------------------------------------------------ISUP INR INF Profile : Default_German --------------------------------------------------------------------INFORMATION REQUEST ACTIONS --------------------------------------------------------------------Request Calling Party Category if not received : UNSUPPORTED
3-304
ISUP Service
Request Calling Line ID if not received Request Charge Info if not received
: UNSUPPORTED : UNSUPPORTED
ACTIONS TAKEN ON RECEIPT OF INFORMATION MESSAGE --------------------------------------------------------------------Fail Call if CPC requested but not received : UNSUPPORTED Fail Call if CLI requested but not received : UNSUPPORTED Fail Call if Charge Info requested but not received : UNSUPPORTED Act only on solicited information message : UNSUPPORTED Admin State : ENABLED
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-315). The mechanisms used to carry out these configuration changes are summarized below. An ISUP service is always in one of two administrative states:
enabled disabled
An ISUP service is always in one of two operational states:
ISUP Service
3-305
Changing to (operational state) inservice outofservice Affirm the prompt query. If no action or the action force is specified, then all calls are dropped and the ISUP service is immediately set to outOfService. If action dryUp is specified, then for timeout minutes, each underlying channel on each ISUP circuit is set to outOfService when the active call on the channel completes. If all calls complete before timeout minutes expire, then the ISUP service is immediately set to outOfService. If timeout minutes expire before all calls complete, then the remaining calls are dropped and the ISUP service is immediately set to outOfService. The admin-state can be changed to disabled once the operational state is outOfService. To delete the ISUP service, you must first delete every underlying ISUP circuit.
outofservice
Change admin-state to enabled, if necessary. Change oper-state to inservice. All circuits that were unblocked when the operational state went to outofservice will be unblocked. All circuits that were blocked when the operational state went to outofservice will remain blocked.
3-306
ISUP Service
Performing GROUP operation: blocked Affirm the prompt query. If no action or the action force is specified, then each call on each underlying ISUP circuit is dropped. All circuits are set to blocked. The adminstate 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. unblocked All circuits will be unblocked, including any that may have been selectively blocked by operations at the ISUP circuit level. The adminstate remains enabled. reset An SS7 reset will occur on all circuits. All circuits will be unblocked, including any that were blocked by ISUP circuit level operations. admin-state stays enabled.
outofservice
The GROUP operations cannot be used when the operational state is outofservice.
Command Syntax
CREATE ISUP SERVICE isname CONFIGURE ISUP SERVICE isname .. PROFILENAME profilename SIGNALING PROFILE sigprofilename TRUNK GROUP tgname DPC dpc SWITCHTYPE switchtype REVISION revision HUNT hdirection COST cost CONTROL cicControl
ISUP Service
3-307
CONTFREQ continuityTestFreq HOPCOUNTVALUE hopcountval HOPCOUNTSTATE hopcountstat EXCHANGETYPE exchangetype DISCONNECT TREATMENT PROFILE dtprofile TONE PACKAGE tonepkg GRSATSTARTUP grs INSPECTION TIME insptime INSPECTION FREQUENCY inspfreq INSPECTION STATE inspstate ACCRESPPROCESS accresproc ACCL1ARCANCELPERCENT accl1ARcanperc ACCL1DRCANCELPERCENT accl1DRperc ACCL2ARCANCELPERCENT accl2ARperc ACCL2DRCANCELPERCENT acc2DRperc ACCL3ARCANCELPERCENT accl3ARcanperc ACCL3DRCANCELPERCENT accl3DRcanperc ACCSENDACL accSendACL OLIPCHECK olipcheck GATEWAY OUTAGE gwoutage INR INF PROFILE inrfprof SATELLITE CIRCUITS SatelliteCircuits CLLI TOWN CODE cllitown CLLI STATE CODE cllistate CLLI BUILDING CODE cllibldg CLLI BUILDING SUB DIVISION CODE cllibldgsd ALERT TONE alerttone ALERT TONE NONE CONFIGURE ISUP SERVICE isname .. GROUP group CONFIGURE ISUP SERVICE isname .. GROUP group ACTION action CONFIGURE ISUP SERVICE isname .. GROUP group ACTION action TIMEOUT timeout CONFIGURE ISUP SERVICE isname .. MODE oper-state CONFIGURE ISUP SERVICE isname .. MODE oper-state ACTION action CONFIGURE ISUP SERVICE isname .. MODE oper-state
3-308
ISUP Service
ACTION action TIMEOUT timeout CONFIGURE ISUP SERVICE isname STATE admin-state SHOW ISUP SERVICE isname ADMIN SHOW ISUP SERVICE isname STATUS SHOW ISUP SERVICE ALL ADMIN SHOW ISUP SERVICE ALL STATUS DELETE ISUP SERVICE isname
Command Parameters
TABLE 3 -67.
ISUP Service Parameters

Field Length 1-23 1-23 1-23 1-23 N/A Description The name of the ISUP service you are configuring. The name of the ISUP service profile that you are applying to this ISUP service. The name of the ISUP signaling profile that you are applying to this ISUP service. The name of the trunk group to which this ISUP service belongs. 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.
Parameter isname profilename sigprofilename tgname dpc
switchtype
N/A
The type of central office switch to which this service is connected: dms500 dms250 dms200 dms100 5ess 4ess
exchangetype
N/A
Specifies the Exchange Type to which this service applies: none typeA - single user services. typeB - services that affect multiple users.
ISUP Service
3-309
TABLE 3 -67.

Field Length N/A Description 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 nttfcc - For Japan. itu1997 itu1988 ituq767 - Same as etsii (has been renamed). belgacom etsi3 nttcom spirou mexicoic italy denmarkic hongkongic singapore etsi3 peru chile nttcom - Use the NTT Communications protocol for Japan. See Table 3 -36, Release 4.0 SS7 Server Protocols and ISUP Variants.
Parameter revision
3-310
ISUP Service
TABLE 3 -67.

Field Length N/A Description The hunt algorithm for choosing a specific CIC within a trunk group. This algorithm must complement the one that is 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. bottom2top - start the search at the lowest physical port number on the lowest CNA slot number on the lowest shelf number in the node. 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. 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.
Parameter hdirection
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. 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.
cicControl
N/A
ISUP Service
3-311
TABLE 3 -67.

Field Length N/A Description The frequency with which Continuity Tests will be 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)
Parameter continuityTestFreq
hopcountval hopcountstat
N/A N/A
The initial Hop Counter value to use (if hopcountstat is enabled). Must be 10-32. 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

for the ISUP service. See Disconnect Treatment Profile on page 3-478. tonepkg grs 1-23 N/A The name of a tone package to be used by the ISUP service. See Tone Package on page 3-490. Specifies whether to issue the GroupReset (GRS) message on all circuits when the CNS module is started. All circuits that belong to the ISUP service and are controlled by the module will receive the GRS message. If GRS is not supported, individual RSC messages will be issued on CNS restart. unsupported - do not issue the GRS message on startup supported - issue the GRS message on startup
3-312
ISUP Service
TABLE 3 -67.

Field Length Description 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
Parameter insptime
inspfreq
Inspection frequency: onehour threehours sixhours twelvehours oneday 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 enabled
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. 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. ACC Level 2 AR Cancel Percentage. Must be 0-100. ACC Level 2 DR Cancel Percentage. Must be 0-100. ACC Level 3 AR Cancel Percentage. Must be 0-100.
accl1DRcanperc
N/A
accl2ARcanperc acc2DRcanperc accl3ARcanperc
N/A N/A N/A
ISUP Service
3-313
TABLE 3 -67.

Field Length N/A N/A Description ACC Level 3 DR Cancel Percentage. Must be 0-100. Specifies the maximum ACL value sent to a remote node for this ISUP Service Group. 0 means ACC is disabled. Must be 0-3. 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. Use this parameter to turn OLIP checking off for certain switches that do not supply OLIP information for such calls: on - check for OLIP off - dont check for OLIP
Parameter accl3DRcanperc accSendACL
olipcheck
N/A
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. Specifies whether the ISUP service group should try to keep active calls when the gateway disconnects: keepCalls - preserve calls removeCalls - release calls
gwoutage
N/A
SatelliteCircuits
N/A
Specifies whether the circuits in the service group are connected to a satellite: enabled - circuits are connected to a satellite disabled - circuits are not connected to a satellite
cllitown
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. 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. 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. 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. 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.
cllistate
cllibldg
cllibldgsd
alerttone
1-23
3-314
ISUP Service
TABLE 3 -67.

Field Length N/A Description 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.
Parameter group
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 - 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 outOfServiceoper-state. Must be 1-1440. 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.
oper-state
N/A
admin-state
N/A
The administrative state of this ISUP service: disabled - Inactive, can be deleted enabled - Active, available for use.
Command Example
To create and configure ISUP service ss71:
% CREATE ISUP SERVICE ss71 % CONFIG ISUP SERVICE ss71 DPC 11-4-4 % CONFIG ISUP SERVICE ss71 TRUNK GROUP LttTrunkGroup % CONFIG ISUP SERVICE ss71 SWITCHTYPE LUCENT-5ESS % CONFIG ISUP SERVICE ss71 HUNT BOTTOM2TOP % CONFIG ISUP SERVICE ss71 COST 10 % CONFIG ISUP SERVICE ss71 STATE ENABLED
To display all ISUP services:

% SHOW ISUP SERVICE ALL ADMIN
----------------------------------------------------------------
ISUP Circuit
3-315
ISUP Service : SS71 Point Code : 100-100-100 ---------------------------------------------------------------Trunk Group : TestUnitTrunkG Service Profile : Switch Type : 5ESS Revision : ANSI1995 Hunt Algorithm : TOP2BOTTOM Cost : 10 CicControl : ALLCICS Continuity Freq : 0 Hop Counter : DISABLED Hop Counter Value : 10 Disc Treatment : isupDefault Tone Package : default GRS at Startup : DISABLED Mode : INSERVICE Admin State : ENABLED ---------------------------------------------------------------ISUP Service : SS72 Point Code : 100-100-100 ---------------------------------------------------------------Trunk Group : TestUnitTrunkG Service Profile : Switch Type : 5ESS Revision : ANSI1995 Hunt Algorithm : TOP2BOTTOM Cost : 10 CicControl : ALLCICS Continuity Freq : 0 Hop Counter : DISABLED Hop Counter Value : 10 Disc Treatment : isupDefault Tone Package : default GRS at Startup : DISABLED Mode : INSERVICE Admin State : ENABLED ----------------------------------------------------------------ISUP Service : ITU1 Point Code : 5-251-0 ----------------------------------------------------------------Trunk Group : TestUnitTrunkG Service Profile : Switch Type : 5ESS Revision : ITU1993 Hunt Algorithm : TOP2BOTTOM Cost : 10 CicControl : ALLCICS Continuity Freq : 0 Hop Counter : DISABLED Hop Counter Value : 10 Disc Treatment : isupDefault Tone Package : default GRS at Startup : DISABLED Mode : INSERVICE Admin State : ENABLED
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. Note The SHOW ... FAREND commands invoke ISUP Conformance Tests as described in Verifying ISUP Circuits on page 4-62. These commands should be used with caution. An ISUP circuit is always in one of two administrative states:
enabled disabled
An ISUP circuit is always in one of two basic operational states:
blocked - circuit is not available for calls unblocked - circuit is available for calls
In addition, an ISUP circuit may enter one of two transitional operational states:
reset - an SS7 reset is performed on the circuit cot - a continuity check procedure is performed on the circuit between the GSX and the far end circuit switch.
3-316
ISUP Circuit
The MODE command is used to change operational states. The rules for changing between basic and transitional operational states are:
From (basic operational state)
Changing to (basic operational state)
unblocked unblocked
-
blocked
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 adminstate to disabled. You may now delete the circuit.
blocked
Change admin-state to enabled. Change oper-state to unblocked. All circuits will be unblocked.
ISUP Circuit
3-317
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
cot
You may not perform a continuity check on an unblocked circuit. The command will be rejected.
oper-state unblocked, adminstate 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
Change admin-state to enabled. Change oper-state to cot. A continuity check procedure will be performed on all circuits. 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 4-62 for detail about this procedure. After a success return or a timeout, all circuits will be in oper-state blocked, admin-state enabled.
oper-state unblocked, adminstate 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.
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
3-318
ISUP Circuit
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. When you disable the circuit, the TRUNK MEMBER is released.
Command Syntax
CREATE ISUP CIRCUIT SERVICE icsname CIC cicrange CONFIGURE ISUP CIRCUIT SERVICE icsname CIC cicrange .. PORT t1name CHANNEL chanrange SERVICEPROFILENAME csprofilename DIRECTION direction TRUNK MEMBER tmember TRUNK MEMBER UNSET CONFIGURE ISUP CIRCUIT SERVICE icsname CIC cicrange .. MODE oper-state CONFIGURE ISUP CIRCUIT SERVICE icsname CIC cicrange .. MODE oper-state ACTION action CONFIGURE ISUP CIRCUIT SERVICE icsname CIC cicrange .. MODE oper-state ACTION action TIMEOUT timeout CONFIGURE ISUP CIRCUIT SERVICE icsname CIC cicrange .. FAREND TEST farend-test CONFIGURE ISUP CIRCUIT SERVICE icsname CIC ALL .. FAREND TEST farend-test CONFIGURE ISUP CIRCUIT SERVICE icsname CIC cicrange .. STATE admin-state SHOW ISUP CIRCUIT SERVICE icsname CIC cicrange ADMIN SHOW ISUP CIRCUIT SERVICE icsname CIC cicrange STATUS SHOW ISUP CIRCUIT SERVICE icsname CIC ALL ADMIN SHOW ISUP CIRCUIT SERVICE icsname CIC ALL STATUS SHOW ISUP CIRCUIT SERVICE icsname CIC cicrange .. FAREND ADMIN SHOW ISUP CIRCUIT SERVICE icsname CIC cicrange .. FAREND CURRENT ADMIN SHOW ISUP CIRCUIT SERVICE icsname CIC cicrange .. FAREND STATUS SHOW ISUP CIRCUIT SERVICE icsname CIC cicrange .. FAREND CURRENT STATUS SHOW ISUP CIRCUIT SERV icsname CIC ALL FAREND ADMIN SHOW ISUP CIRCUIT SERV icsname CIC ALL FAREND STATUS SHOW ISUP CIRCUIT SERV icsname CIC ALL .. FAREND CURRENT ADMIN
ISUP Circuit
3-319
SHOW ISUP CIRCUIT SERV icsname CIC ALL .. FAREND CURRENT STATUS DELETE ISUP CIRCUIT SERVICE icsname CIC cicrange
3-320
ISUP Circuit
Command Parameters
TABLE 3 -68.
ISUP Circuit Parameters

Field Length 1-23 N/A Description The name of the ISUP service used by the circuit that you are configuring. 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:
Parameter icsname cicrange
1,3,5,8-12+2,14-16
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. 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:
chanrange
N/A
1,3,5,8-12+2,14-16
1,3,5,8,10,12,14,15, and 16.
ISUP Circuit
3-321
TABLE 3 -68.

Field Length N/A Description 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:
Parameter tmember
1,3,5,8-12+2,14-16
1,3,5,8,10,12,14,15, and 16.

csprofilename direction 1-23 1-23 The name of the Circuit Service Profile that you are applying to this ISUP circuit. The type of call traffic these CICs can handle:

farend-test 1-23
twoway - accept all PSTN calls onewayin - accept only inbound PSTN calls onewayout - accept only outbound PSTN calls cqm - circuit query message cvt - circuit validation test reset - reset the 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. disabled - Not activated, able to be deleted. enabled - Activated, available for immediate use.
The farend action taken on this ISUP circuit:

oper-state N/A
The operational state of the ISUP circuit:
admin-state N/A
The administrative state of this ISUP circuit:
3-322
ISUP Circuit
TABLE 3 -68.

Field Length N/A Description The method by which active calls on these ISUP circuits are processed when oper-state goes to blocked:
Parameter action
timeout N/A
dryup - all calls are allowed to complete until timeout expires, when they are dropped. force - all calls are dropped immediately.
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 1-1440. If not specified, the default system setting is 0. This causes dryups and cots to attempt indefinitely until successful.
Command Example
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
To display the status of CICs 7989-7991 on ISUP service ss71:

% SHOW ISUP CIRC SERVICE ss71 CIC 7989-7991 STATUS
Trunk Group : tg1 ISUP Service : ss71 Service Mode : INSERVICE Point Code : 1-1-1 Service Status : AVAILABLE -----------------------------------------------------------------Circuit Maint Maint HW HW Man CIC Port Ch Status Mode Local Remot Local Remot Cot ----- ------------------------ -- -------- ------- ----- ----- --
ISDN Service Profile
3-323
7989 7990 7991
T1-1-3-1-1 T1-1-3-1-1 T1-1-3-1-1
1 2 3
IDLE IDLE IDLE
UNBLOCK UNBLK UNBLK TRN-U UNBLK N/A UNBLOCK UNBLK UNBLK TRN-U UNBLK N/A UNBLOCK UNBLK UNBLK TRN-U UNBLK N/A
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 4-62 for more detail about the manual continuity check procedure. To assign TRUNK MEMBER 100 to CIC 7989 on ISUP service ss71:
% CONFIGURE ISUP CIRC SERVICE ss71 CIC 7989 PORT T1-1-1-3-1 CHANNEL 1 ADMIN SERVICEPROFILENAME default DIRECTION twoway TRUNK MEMBER 100
To display the configuration of CICs 7989-7990 on ISUP service ss71:

% SHOW ISUP CIRC SERVICE ss71 CIC 7989-7990 ADMIN
Trunk Group : tg1 ISUP Service : ss71 Point Code : 1-1-1 ---------------------------------------------------------------Trunk Admin CIC Port Chnl Membr Direction State Profile ----- ---------------- ---- ----- --------- --------- --------------7989 T1-1-3-1-1 1 100 TWOWAY ENABLED default 7990 T1-1-3-1-1 2 UNSET TWOWAY ENABLED default
ISDN Service Group

ISDNServiceGroup
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
CREATE ISDN SERVICE PROFILE profilename CONFIGURE ISDN SERVICE PROFILE profilename .. TRUNK GROUP tgname
3-324
HUNT hdirection COST cost DIRECTORY NUMBER NONE DIRECTORY NUMBER dirnum CALLING PARTY NUMBER PROVISION cpn_prov CALLING PARTY NUMBER DISCARD cpn_disc CALLING PARTY NUMBER PRESENTATION cpn_present CALLING PARTY NUMBER DELIVERY cpn_deliver CALLING PARTY SUBADDRESS TRANSFER cps_tran CALLING PARTY SUBADDRESS DELIVERY cps_deliver CALLED PARTY SUBADDRESS TRANSFER cdps_tran CALLED PARTY SUBADDRESS DELIVERY cdps_deliver CALLING PARTY NAME DELIVERY cpnam_deliver TONE PACKAGE tonepkg ALERT TONE alerttone ALERT TONE NONE EARLY ACM FOR INTERWORKING WITH ISUP earlyacm EARLY CUT THROUGH AUDIBLE RING ectar EARLY CUT THROUGH NETWORK INTERWORKING ectni DISCONNECT TREATMENT PROFILE dtprofile DISCONNECT SSP dssp DISCONNECT SSP NONE CONFIGURE ISDN SERVICE PROFILE profilename .. STATE admin-state SHOW ISDN SERVICE PROFILE profilename ADMIN SHOW ISDN SERVICE PROFILE ALL ADMIN DELETE ISDN SERVICE PROFILE profilename
3-325
Command Parameters
TABLE 3 -69.
ISDN SERVICE PROFILE Parameters

Field Length 1-23 1-23 N/A Description The name of the ISDN service profile that is being created and configured. The name of the trunk group that this ISDN service belongs to. The hunt algorithm used to select channels for calls destined to this service group: lowlow - 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).
Parameter profilename tgname hdirection
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. 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. Specifies whether a CPN is required in the incoming setup: necessary - the incoming call is rejected if no CPN is provided. notNecessary - the DN must be specified and is used as the CPN.
dirnum
N/A
cpn_prov
N/A
cpn_disc
N/A
Specifies whether a CPN, or Redirecting Number (RN), that is not screened or that fails screening is discarded: no yes
cpn_present
N/A
Specifies the default presentation indicator: no - presentation prohibited yes - 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.
3-326
TABLE 3 -69.

Field Length N/A Description Specifies whether a CPN or RN is included within an outgoing setup: no yes
Parameter cpn_deliver
cps_tran
N/A
Specifies whether a calling party subaddress information element (CPS) is accepted in the incoming setup: no - discard the CPS. yes - 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 - include the CPS in the setup. conditional - include the CPS if the CPN was also accepted.
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 - 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 - 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
Specifies whether the Calling Party Name is delivered in an outgoing SETUP message: no - Do not include Calling Party Name in the outgoing SETUP message. yes - Include Calling Party Name in the outgoing SETUP message.
3-327
TABLE 3 -69.

Field Length N/A Description When interworking between ISDN and ISUP, specifies whether or not to deliver an early address complete message (ACM): no - 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.
Parameter earlyacm
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. The name of a Disconnect Treatment Profile that will be used to map a disconnect reason code to a
dtprofile
1-23

for this service group. See Disconnect Treatment Profile on page 3-478. 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-480. The name of a tone package to be used by this ISDN service group. See Tone Package on page 3-490. Specifies whether early cut through is allowed on an audible ring: no - Disable early cut through. yes - Enable early cut through. ectni N/A Specifies whether early cut through is allowed on network interworking: no - Disable early cut through. yes - Enable early cut through. admin-state N/A The administrative state of this ISDN service group profile: disabled - Not activated, able to be deleted. enabled - Activated, available for immediate use.
tonepkg ectar
1-23 N/A
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
To display the configuration of all ISDN service profiles on the GSX:

% SHOW ISDN SERVICE PROFILE ALL ADMIN
3-328
ISDN Switch Profile
Zone: GMTMINUS05-EASTERN-US --------------------------------------------------------------------ISDN Service Profile: isdnprof1 --------------------------------------------------------------------Trunk Group : Hunt Algorithm : LOWLOW Cost : 50 State : DISABLED Default Calling Calling Calling Calling Calling Calling Calling Directory Number Party Number Provision Party Number Discard Party Number Presentation Party Number Delivery Party Subaddress Transfer Party Subaddress Delivery Party Name Delivery : : : : : : : :
NECESSARY NO YES YES YES YES YES
ISDN Switch Profile

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
CREATE ISDN SWITCH PROFILE swprofilename CONFIGURE ISDN SWITCH PROFILE swprofilename .. SWITCHSIDE switchside SWITCHTYPE switchtype BCHANNEL AVAILABILITY SIGNALING bcas BCHANNEL INITIAL RESTART initialres T302 t302 T303 t303 T304 t304 T305 t305 T306 t306 T308 t308 T309 t309 T310 t310 T312 t312 T313 t313 T314 t314 T318 t318 T319 t319 T322 t322 K k T200 t200 T203 t203
ISDN Switch Profile
3-329
N200 n200 N201 n201 REMOTE SWITCH TYPE rswitchtype CONFIGURE ISDN SWITCH PROFILE profilename .. STATE admin-state SHOW ISDN SWITCH PROFILE swprofilename ADMIN SHOW ISDN SWITCH PROFILE ALL ADMIN DELETE ISDN SWITCH PROFILE swprofilename
3-330
ISDN Switch Profile
Command Parameters
TABLE 3 -70.
ISDN SWITCH PROFILE Parameters

Field Length 1-23 N/A Description The name of the ISDN switch profile that is being created and configured. The network switch type the ISDN service group will emulate: ni2 dms250 dms100 5ess 4ess euroIsdn ins1500 - directs the GSX software to conform to the Japan INS 1500 ISDN variant
Parameter swprofilename switchtype
switchside
N/A
The switch side that this ISDN service group should act as: network - 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 - 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 - 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.
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. 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.
t303
N/A
ISDN Switch Profile
3-331
TABLE 3 -70.

Field Length N/A Description 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. 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. The Q.931, T306 timer value (in seconds). This timer is used on the network side only. Must be 0127, default is 30 (seconds). A value of 0 disables this timer. 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. 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. 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. The Q.931, T302 timer value (in seconds). This timer is used on the network side only. Must be 0127, default is 6 (seconds). A value of 0 disables this timer. 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. 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. 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. 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. The Q.931, T322 timer value (in seconds). This timer is used on the network side only. Must be 0127, default is 4 (seconds). A value of 0 disables this timer. The Q.921, K parameter. Specifies the maximum number of outstanding I frames. Must be 1-127, default is 7. GSX9000 Open Services Switch Operations Guide
Parameter t304
t305
N/A
t306
N/A
t308
N/A
t309
N/A
t310
N/A
t312
N/A
t313
N/A
t314
N/A
t318
N/A
t319
N/A
t322
N/A
N/A
3-332
ISDN Switch Profile
TABLE 3 -70.

Field Length N/A Description 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). 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. The Q.921, N200 parameter. Specifies the maximum number of retransmissions of a frame. Must be 1100, default is 3. The Q.921, N201 parameter. Specifies the maximum number of octets in an information field. Must be 1260, default is 260. 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 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.
Parameter t200
t203
N/A
n200
N/A
n201
N/A
rswitchtype
N/A
admin-state
N/A
The administrative state of this ISDN switch profile: disabled - 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 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
To display the configuration of all ISDN service profiles on the GSX:

% SHOW ISDN SWITCH PROFILE isdnsw1 ADMIN
--------------------------------------------------------------------ISDN Switch Profile: isdnsw1 --------------------------------------------------------------------Switch Type : 4ESS Switch Side : USER B-channel Availability Signaling : YES B-channel Initial Restart : YES State : DISABLED
ISDN Service
3-333
Profile Layer 3 Timer Parameters: T302 : 25 T303 : 8 T305 : 4 T306 : 0 T309 : 0 T310 : 0 T313 : 4 T314 : 0 T319 : 4 T322 : 0 Profile Layer 2 Parameters: K : 7 T200 N200 : 3 N201
T304 T308 T312 T318
: : : :
0 4 0 4
: 1 : 260
T203
: 10
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. 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 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 Bchannel on page 3-351). 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 Dchannel from the inService D-channel. An ISDN service is always in one of two administrative states:
enabled disabled
An ISDN service is always provisioned to one of two operational states:
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 ISDN service must be provisioned to inService. At least one of the D-channels (primary or backup) must be inService. The trunk group to which the service belongs must be inservice.
The conventions that must be used to transition between operational states, as well as to perform other GROUP operations, are summarized below.
3-334
ISDN Service
The rules for changing operational states of the ISDN service are:
Changing to (operational state) inService outOfService Affirm the prompt query. If no ACTION or the ACTION force is specified, then all calls are dropped and the ISDN service is immediately set to outOfService. If ACTION dryUp is specified, then for TIMEOUT minutes, each underlying Bchannel on each ISDN Interface is set to outOfService when the active call on the channel finishes. If all calls finish before TIMEOUT minutes expire, then the ISDN service is immediately set to outOfService. If TIMEOUT minutes expire before all calls finish, then the remaining calls are dropped and the ISDN service is immediately set to outOfService. The administrative state can be changed to disabled once the operational state is outOfService. To delete the ISDN service, you must first delete every underlying ISDN Interface.
outofservice
Change the administrative state to enabled, if necessary. Change the operational state to inService. All B-channels with no other reason to be outofservice will be inService. See ISDN B-channel on page 3351.
The GROUP operations below are performed on the underlying B-channels in order to prepare to change the operational state of the ISDN service. In order to achieve an inService operational state on a B-channel by performing the GROUP operation inService:
The ISDN service must be the operational state inService. The T1 span that contains the B-channel must be in operational state inService.
ISDN Service
3-335
The conventions for performing these GROUP operations from the two respective operational states of the ISDN service are:
From ISDN Service (operational state) inService
Performing GROUP operation: inService maintenance Affirm the prompt query. The ACTION and TIMEOUT parameters are not used. If calls are active, the underlying channel enters dryUp state while waiting indefinitely for the call to clear. When each B-channel is cleared, its operational state is immediately set to maintenance. outOfService Affirm the prompt query. If no ACTION or the ACTION force is specified, then each call on each underlying B-channel is dropped and the Bchannel operational state is immediately set to outOfService. If ACTION dryUp is specified, then for TIMEOUT minutes, each underlying Bchannel on each ISDN Interface is set to outOfService when the active call on the channel completes. If TIMEOUT minutes expire before the call completes, then the call is dropped and the Bchannel is immediately set to outOfService.
outOfService
Change GROUP to inService. Each underlying Bchannels operational state is immediately set to inService.
Change GROUP to maintenance. Each underlying Bchannels operational state is immediately set to maintenance.
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:
3-336
ISDN Service
From ISDN Service (operational state)
Performing GROUP operation: restart clearStats Change GROUP to clearStats. All call D-channel statistics of the ISDN service are reset to zero. dchannelSwitchover Change GROUP to dchannelSwitchover. The status of the standby D-channel changes to inService. The status of the currently inService Dchannel changes to standby. This GROUP operation has no effect when the ISDN service is outOfService.
inService
Change GROUP to restart. Each underlying Bchannel is unconditionally restarted.
outOfService
This GROUP operation has no effect when the ISDN service is outOfService.
Change GROUP to clearStats. All call D-channel statistics of the ISDN service are reset to zero.
Command Syntax
CREATE ISDN SERVICE servicename CONFIGURE ISDN SERVICE servicename .. TRUNK GROUP tgname TRUNK GROUP NONE HUNT hdirection COST cost SWITCHSIDE switchside SWITCHTYPE switchtype PRIMARY DCHANNEL INTERFACE pdi PRIMARY DCHANNEL TIMESLOT pdts PRIMARY DCHANNEL MODE pdm BACKUP DCHANNEL INTERFACE bdi BACKUP DCHANNEL TIMESLOT bdts BACKUP DCHANNEL MODE bdm DIRECTORY NUMBER NONE DIRECTORY NUMBER dirnum CALLING PARTY NUMBER PROVISION cpn_prov CALLING PARTY NUMBER DISCARD cpn_disc CALLING PARTY NUMBER PRESENTATION cpn_present CALLING PARTY NUMBER DELIVERY cpn_deliver
ISDN Service
3-337
CALLING PARTY SUBADDRESS TRANSFER cps_tran CALLING PARTY SUBADDRESS DELIVERY cps_deliver CALLED PARTY SUBADDRESS TRANSFER cdps_tran CALLED PARTY SUBADDRESS DELIVERY cdps_deliver BCHANNEL AVAILABILITY SIGNALING bcas BCHANNEL INITIAL RESTART initialres ALERT TONE alerttone ALERT TONE NONE DISCONNECT TREATMENT PROFILE dtprofile TONE PACKAGE tonepkg SWITCHPROFILE switchprofile PROFILENAME profilename IUA APPLICATION SERVER NONE IUA APPLICATION SERVER as_name IUA AUTOMATIC DATALINK ESTABLISH iua_auto_dl CALLING PARTY NAME DELIVERY cpnam_deliver REMOTE SWITCH TYPE rswitchtype EARLY ACM FOR INTERWORKING WITH ISUP earlyacm EARLY CUT THROUGH AUDIBLE RING ectar EARLY CUT THROUGH NETWORK INTERWORKING ectni DISCONNECT SSP dssp DISCONNECT SSP NONE CONFIGURE ISDN SERVICE servicename MODE oper-state CONFIGURE ISDN SERVICE servicename .. MODE oper-state ACTION action CONFIGURE ISDN SERVICE servicename .. MODE oper-state ACTION action TIMEOUT timeout CONFIGURE ISDN SERVICE servicename GROUP group CONFIGURE ISDN SERVICE servicename .. GROUP group ACTION action CONFIGURE ISDN SERVICE servicename .. GROUP group ACTION action TIMEOUT timeout CONFIGURE ISDN SERVICE servicename STATE admin-state CONFIGURE ISDN SERVICE servicename TRACE NONE CONFIGURE ISDN SERVICE servicename TRACE LAYER2 CONFIGURE ISDN SERVICE servicename TRACE LAYER2 .. VERBOSE traceformat CONFIGURE ISDN SERVICE servicename TRACE LAYER3 CONFIGURE ISDN SERVICE servicename TRACE LAYER3 .. VERBOSE traceformat CONFIGURE ISDN SERVICE servicename TRACE BOTH CONFIGURE ISDN SERVICE servicename TRACE BOTH .. VERBOSE traceformat
3-338
ISDN Service
SHOW ISDN SERVICE servicename ADMIN SHOW ISDN SERVICE servicename STATUS SHOW ISDN SERVICE servicename PARAMETERS SHOW ISDN SERVICE ALL ADMIN SHOW ISDN SERVICE ALL STATUS SHOW ISDN SERVICE ALL PARAMETERS SHOW ISDN SERVICE SUMMARY STATUS DELETE ISDN SERVICE servicename
ISDN Service
3-339
Command Parameters
TABLE 3 -71.
ISDN SERVICE Parameters

Field Length 1-23 1-23 N/A Description The name of the ISDN service that is being created and configured. The name of the trunk group that this ISDN service belongs to. The hunt algorithm used to select channels for calls destined to this service group: lowlow - 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).
Parameter servicename tgname hdirection
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. The switch side that this ISDN service group should act as: network - A switch on the network side. user - A switch on the user side.
switchside
N/A
switchtype
N/A
The network switch type the ISDN service group will emulate: ni2 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 layer3 messages on an ISDN D-Channel in the trace event log. traceformat values are: off - limited decoding. on - full decoding. To completely disable decoding, use the TRACE NONE command.
3-340
ISDN Service
TABLE 3 -71.

Field Length N/A Description 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. Specifies whether a CPN is required in the incoming setup: necessary - the incoming call is rejected if no CPN is provided. notNecessary - the DN must be specified and is used as the CPN.
Parameter dirnum
cpn_prov
N/A
cpn_disc
N/A
Specifies whether a CPN, or Redirecting Number (RN), that is not screened or that fails screening is discarded: no yes
cpn_present
N/A
Specifies the default presentation indicator: no - presentation prohibited yes - 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 yes
cps_tran
N/A
Specifies whether a calling party subaddress information element (CPS) is accepted in the incoming setup: no - discard the CPS. yes - 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 - include the CPS in the setup. conditional - include the CPS if the CPN was also accepted.
ISDN Service
3-341
TABLE 3 -71.

Field Length N/A Description Specifies whether a called party subaddress information element is accepted in the incoming setup: no - discard the called party subaddress. yes - accept the called party subaddress information element. conditional - accept the called party subaddress information element if the called party number is also accepted.
Parameter cdps_tran
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 - 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
Specifies whether the Calling Party Name is delivered in an outgoing SETUP message: no - Do not include Calling Party Name in the outgoing SETUP message. yes - Include Calling Party Name in the outgoing SETUP message.
bcas
N/A
Specifies whether SERVICE messages will be used to communicate the B-channel state: yes - 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 - 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-20, default is 0.
3-342
ISDN Service
TABLE 3 -71.

Field Length N/A Description The ISDN service group primary D-channel time slot. Must be 0-31, default is 24, or 16 when SWITCHTYPE is euroIsdn. The ISDN service group primary D-channel mode: inService - active outOfService - inactive
Parameter pdts
pdm
N/A
bdi bdts
N/A N/A
The ISDN service group backup D-channel interface. Must be 0-20, default is 1. The ISDN service group backup D-channel time slot. Must be 0-31, default is 24, or 16 when SWITCHTYPE is euroIsdn. The ISDN service group backup D-channel mode: inService - active outOfService - inactive unEquipped -unable to be used for signaling
bdm
N/A
dtprofile
1-23

for this service group. See Disconnect Treatment Profile on page 3-478. tonepkg as_name 1-23 1-23 The name of a tone package to be used by this ISDN service group. See Tone Package on page 3-490. The name of the IUA Application Server to which this D-channel group belongs. Use the keyword NONE to specify that no IUA Application Server is present in this configuration. Specifies whether the GSX should bring up the Dchannel that is associated with this service automatically or await an explicit command from the IUA Application Server Process: yes - automatic datalink establishment no - ASP must explicitly issue a command to perform the datalink establishment oper-state N/A The operational state of the ISDN service: outofservice - The ISDN service can carry new calls. inservice - The ISDN service is prevented from carrying 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.
iua_auto_dl
N/A
ISDN Service
3-343
TABLE 3 -71.

Field Length N/A Description The time (in minutes) to wait to place the ISDN channels in the operational state outOfService. Must be 0-1440, default is 0 (or attempt indefinitely to dryup). 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.
Parameter timeout
group
N/A
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 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.
admin-state
N/A
The administrative state of this ISDN service group: disabled - 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. The name of an ISDN service profile to use to provide all undeclared parameter values in this ISDN service. When interworking between ISDN and ISUP, specifies whether or not to deliver an early address complete message (ACM): no - 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.
profilename
1-23
earlyacm
N/A
3-344
ISDN Service
TABLE 3 -71.

Field Length 1-23 Description The name of a Disconnect SSP Profile that will be used for this service group. See Disconnect Signaling Sequence Profile on page 3-480. 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. Specifies whether early cut through is allowed on an audible ring: no - Disable early cut through. yes - Enable early cut through.
Parameter dssp
alerttone
1-23
ectar
N/A
ectni
N/A
Specifies whether early cut through is allowed on network interworking: no - Disable early cut through. yes - Enable early cut through.
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-349 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
To display the configuration of the ISDNSERV1 service:

% SHOW ISDN SERVICE isdnserv1 ADMIN
--------------------------------------------------------------------Trunk Group : tg1 ISDN Service: ISDNSERV1 State: ENABLED Mode: INSERVICE
ISDN Service
3-345
Default Directory Number Calling Party Number Provision Calling Party Number Discard Calling Party Number Presentation Calling Party Number Delivery Calling Party Subaddress Transfer Calling Party Subaddress Delivery B-channel Availability Signaling B-channel Initial Restart Disconnect Treatment Profile Tone Package IUA Application Server IUA Automatic Datalink Establish Calling Party Name Delivery Service Profile: Hunt Algorithm : Cost : Trace Layers : Verbose Trace :
: : : : : : : : : : : : : :
NECESSARY NO YES YES YES YES YES YES isdnDefault default NO YES : USER : NI2 :
LOWLOW 40 NONE ON
Switch Side Switch Type Switch Profile
Dchannel Interface Dchannel Time Slot Dchannel Mode
Primary: 0 Primary: 24 Primary: INSERVICE
Backup: 1 Backup: 24 Backup: UNEQUIPPED
To display the status of the ISDN service ISDNSERV1:

% SHOW ISDN SERVICE isdnserv1 STATUS
--------------------------------------------------------------------Trunk Group : tg1 Mode: INSERVICE ISDN Service: ISDNSERV1 Mode: INSERVICE Status: AVAILABLE Bchannels Configured: 23 Available: 23 Active Calls Call Attempts Call Completions Ingress: 0 Ingress: 223 Ingress: 222 Egress: 0 Egress: 0 Egress: 0
Primary Dchannel Backup Dchannel Mode :INSERVICE Status :INSERVICE Mode : INSERVICE Status : STANDBY InPkts:2034 OutPkts:2034 InPkts: 0 OutPkts: 0 InByts:22788 OutByts:14179 InByts: 0 OutByts: 0
Note (1)
The SHOW screen in the example above, is only possible after the CNS server module that drives the interface is running and the primary Dchannel 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-349 for details.
Note (2)
3-346
ISDN Service
% 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 % CREATE ISDN INTERFACE SERVICE isdnserv2 INTERFACE 0 % CONFIGURE ISDN INTERFACE SERVICE isdnserv2 .. INTERFACE 0 PORT T1-1-3-1 % CONFIGURE ISDN SERVICE isdnserv2 .. PRIMARY DCHANNEL INTERFACE 0 PRIMARY DCHANNEL TIMESLOT 24 PRIMARY DCHANNEL MODE inService % CONFIGURE ISDN SERVICE isdnserv2 .. BACKUP DCHANNEL INTERFACE 1 BACKUP DCHANNEL TIMESLOT 24 BACKUP DCHANNEL MODE inService % CONFIGURE ISDN SERVICE isdnserv2 STATE enabled
Then the configuration of the ISDNSERV2 service may be displayed by:

--------------------------------------------------------------------Trunk Group : tg1 ISDN Service: ISDNSERV2 State: ENABLED Mode: INSERVICE Default Directory Number Calling Party Number Provision Calling Party Number Discard Calling Party Number Presentation Calling Party Number Delivery Calling Party Subaddress Transfer Calling Party Subaddress Delivery B-channel Availability Signaling B-channel Initial Restart Disconnect Treatment Profile Tone Package IUA Application Server IUA Automatic Datalink Establish Calling Party Name Delivery Service Profile: Hunt Algorithm : Cost : Trace Layers : Verbose Trace : : : : : : : : : : : : : : :
NECESSARY NO YES YES YES YES YES YES isdnDefault default NO YES : USER : 4ESS :
LOWLOW 40 NONE ON
Switch Side Switch Type Switch Profile
Primary: 0 Primary: 24 Primary: INSERVICE
Backup: 1 Backup: 24 Backup: INSERVICE
And the operational status of ISDN service ISDNSERV2 would be shown by:
ISDN Service
3-347

--------------------------------------------------------------------Trunk Group : tg1 Mode: INSERVICE ISDN Service: ISDNSERV2 Mode: INSERVICE Status: AVAILABLE Bchannels Configured: 382 Available: 382 Active Calls Call Attempts Call Completions Ingress: 0 Ingress: 0 Ingress: 0 Backup Mode : InPkts: InByts: Egress: 0 Egress: 0 Egress: 0 Dchannel INSERVICE Status : INSERVICE 682 OutPkts: 683 2727 OutByts: 2723
Primary Dchannel Mode :INSERVICE Status :STANDBY InPkts:2202 OutPkts:2202 InByts:19526 OutByts:19513
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 (CCITT/Speech/Circuit/64kbps/Q921 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 (Explicit/Primary/Preferred/IntId#80/CCITT/Ch#13 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 (Explicit/Primary/Preferred/IntId#80/CCITT/Ch#13 IntfID= Explicit[ID=80] Intf=Primary Pref/Excl=Exclusive ChanSel=#12 Coding=CCITT)
3-348
ISDN Service
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
An ISDN service group status summary screen is shown below:

% SHOW ISDN SERVICE SUMMARY STATUS
Node: TPUBS Date: 2002/01/18 20:31:11 GMT Zone: GMTMINUS05-EASTERN-US Op Status ---------AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE Pri D Status -----INSERV INSERV INSERV INSERV INSERV INSERV INSERV INSERV INSERV INSERV INSERV INSERV INSERV INSERV INSERV INSERV INSERV INSERV INSERV INSERV INSERV INSERV INSERV INSERV INSERV INSERV INSERV INSERV INSERV INSERV INSERV INSERV INSERV Bck D Status -----MANUAL MANUAL MANUAL MANUAL MANUAL MANUAL MANUAL MANUAL MANUAL MANUAL MANUAL MANUAL MANUAL MANUAL MANUAL MANUAL MANUAL MANUAL MANUAL MANUAL MANUAL MANUAL MANUAL MANUAL MANUAL MANUAL MANUAL MANUAL MANUAL MANUAL MANUAL MANUAL MANUAL Bch Config -----23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 Bch Avail ----23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 Active Ing Call -------0 0 0 0 0 0 0 0 0 0 0 0 8 8 10 7 10 8 9 9 10 9 10 9 9 10 9 9 10 10 9 10 10 Active Egr Call -------0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
ISDN Service ----------------------PRI91 PRI92 PRI93 PRI94 PRI95 PRI96 PRI97 PRI111 PRI112 PRI113 PRI114 PRI115 PRI121 PRI122 PRI123 PRI124 PRI125 PRI126 PRI127 PRI128 PRI129 PRI1210 PRI1211 PRI1212 PRI1213 PRI1214 PRI1215 PRI1216 PRI1217 PRI1218 PRI1219 PRI1220 PRI1221
ISDN Interface
3-349
PRI1222 PRI1223 PRI1224 PRI1225 PRI1226 PRI1227 PRI1228 infas1 infas2 infas3 infas4 infas5
AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE AVAILABLE
INSERV INSERV INSERV INSERV INSERV INSERV INSERV INSERV INSERV INSERV INSERV INSERV
MANUAL MANUAL MANUAL MANUAL MANUAL MANUAL MANUAL STANDB STANDB STANDB STANDB STANDB
23 23 23 23 23 23 23 118 118 118 94 94
23 23 23 23 23 23 23 118 118 118 94 94
9 10 10 9 9 9 9 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0 0 0
ISDN Interface
This object binds a T1 span to an ISDN service and assigns it a number. For an NFAS service group, up to 20 spans may be assigned, depending on the configuration of the D-channel (see Adding an ISDN NFAS Group on page 4-79). These spans may occupy an interface range of 0-20.
Command Syntax
CREATE ISDN INTERFACE SERVICE servicename .. INTERFACE interface CONFIGURE ISDN INTERFACE SERVICE servicename .. INTERFACE interface PORT port CONFIGURE ISDN INTERFACE SERVICE servicename .. INTERFACE interface MODE mode CONFIGURE ISDN INTERFACE SERVICE servicename .. INTERFACE interface STATE admin-state SHOW ISDN INTERFACE SERVICE servicename .. INTERFACE interface ADMIN SHOW ISDN INTERFACE SERVICE servicename .. INTERFACE ALL ADMIN DELETE ISDN INTERFACE SERVICE servicename .. INTERFACE interface
3-350
ISDN Interface
Command Parameters
TABLE 3 -72.
ISDN INTERFACE Parameters

Field Length 1-23 N/A 1-23 Description The name of the ISDN service to which this ISDN Interface is linked. The Q.931 interface identifier. Must be 0-19 or 1-20. The automatically created (and possibly changed) name of the T1 or E1 span that is assigned to the ISDN Interface. Operation(s) that may be applied to the interface: restart - restart the interface (not currently supported).
Parameter servicename interface port
mode
N/A
admin-state
N/A
The administrative state of this ISDN interface: disabled - Not activated, able to be reconfigured or deleted. enabled - Activated, available for immediate use.
Command Example
To create, configure, and enable ISDN Interface 0, binding T1 span T1-1-3-1 to ISDN service isdnserv1:
% CREATE ISDN INTERFACE SERVICE isdnserv1 INTERFACE 0 % CONFIGURE ISDN INTERFACE SERVICE isdnserv1 .. INTERFACE 0 PORT T1-1-3-1 % CONFIGURE ISDN INTERFACE SERVICE isdnserv1 .. INTERFACE 0 STATE enabled
To display the configuration of ISDN Interface 0:

% SHOW ISDN INTERFACE SER isdnserv1 INTERFACE 0 ADMIN
Trunk Group : tg1 ISDN Service : ISDNSERV1 ---------------------------------------------------------------Interface Port State ---------------------------------0 T1-1-3-1 ENABLED
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
ISDN B-channel
3-351
% 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
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. A B-channel on an ISDN Interface is always in one of two administrative states:
enabled disabled
A B-channel on an ISDN Interface is always provisioned to one of three operational states:
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.
3-352
ISDN B-channel
If BCAS is enabled (see ISDN Service on page 3-333), 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:
From (operational state) outOfService
Changing to (operational state) outOfService maintenance Change adminstate to enabled (if necessary). Change operstate to maintenance. All channels will be in maintenance state. inService Change adminstate to enabled (if necessary). Change operstate to inService. All channels will be in oper-state inService, admin-state enabled.
ISDN B-channel
3-353
From (operational state) maintenance
Changing to (operational state) Change operational state to outOfService. All designated channels will be in MODE outOfService. Change administrative state to enabled (if necessary). Change operational state to inService. All channels will be in MODE inService, STATE enabled.
inService
Affirm the prompt query. If the ACTION force is specified, then all calls on the specified channels are dropped and each channel is immediately set to outOfService. If ACTION dryUp is specified, then for TIMEOUT minutes on each designated channel, the channel is set to outOfService when the active call on the channel completes. If TIMEOUT minutes expire before all channels complete, then the remaining calls are dropped and those channels are immediately set to outOfService. If no ACTION is specified, the behavior is indefinite dryup.
Affirm the prompt query. The ACTION and TIMEOUT parameters are not used. If a call is active, the channel enters dryup state while waiting indefinitely for the call to clear. When each B-channel clears, its operational status is immediately set to maintenance.
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
3-354
ISDN B-channel
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. When you disable the circuit, the TRUNK MEMBER is released.
Command Syntax
Note The commands below affect a specific B-channel.
CONFIGURE ISDN BCHANNEL SERVICE servicename .. INTERFACE interface BCHANNEL bchannel CIRCUITPROFILENAME circuitprofilename DIRECTION direction TRUNK MEMBER tmember-no TRUNK MEMBER UNSET CONFIGURE ISDN BCHANNEL SERVICE servicename .. INTERFACE interface BCHANNEL bchannel MODE oper-state CONFIGURE ISDN BCHANNEL SERVICE servicename .. INTERFACE interface BCHANNEL bchannel MODE oper-state ACTION action CONFIGURE ISDN BCHANNEL SERVICE servicename .. INTERFACE interface BCHANNEL bchannel MODE oper-state ACTION action 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.

CONFIGURE ISDN BCHANNEL SERVICE servicename .. INTERFACE interface
ISDN B-channel
3-355
BCHANNEL bchannelrange CIRCUITPROFILENAME circuitprofilename DIRECTION direction TRUNK MEMBER tmember-rng TRUNK MEMBER UNSET CONFIGURE ISDN BCHANNEL SERVICE servicename .. INTERFACE interface BCHANNEL bchannelrange MODE oper-state CONFIGURE ISDN BCHANNEL SERVICE servicename .. INTERFACE interface BCHANNEL bchannelrange MODE oper-state ACTION action CONFIGURE ISDN BCHANNEL SERVICE servicename .. INTERFACE interface BCHANNEL bchannelrange MODE oper-state ACTION action TIMEOUT timeout CONFIGURE ISDN BCHANNEL SERVICE servicename .. INTERFACE interface BCHANNEL bchannelrange BCHANNEL operation CONFIGURE ISDN BCHANNEL SERVICE servicename .. INTERFACE interface BCHANNEL bchannelrange STATE admin-state
Note
The SHOW commands display either one specific channel or all channels.
SHOW ISDN BCHANNEL ALL ADMIN SHOW ISDN BCHANNEL SERVICE servicename ADMIN SHOW ISDN BCHANNEL SERVICE servicename .. INTERFACE interface ADMIN SHOW ISDN BCHANNEL SERVICE servicename .. INTERFACE interface BCHANNEL bchannel ADMIN SHOW ISDN BCHANNEL ALL STATUS SHOW ISDN BCHANNEL SERVICE servicename STATUS SHOW ISDN BCHANNEL SERVICE servicename .. INTERFACE interface STATUS SHOW ISDN BCHANNEL SERVICE servicename .. INTERFACE interface BCHANNEL bchannel STATUS
3-356
ISDN B-channel
Command Parameters
TABLE 3 -73.
ISDN BCHANNEL Parameters

Field Length 1-23 N/A N/A N/A Description The name of the ISDN service to which the designated Bchannels are bound. The number of the ISDN Interface that contains the designated B-channels. Must be 0-20. A single B-channel number. Must be in the range 1-23. A set of B-channels. Must be one or more ranges of Bchannels 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:
Parameter servicename interface bchannel bchannelrange
1,3,5,8,10,12,14,15, and 16.

circuitprofilename direction 1-23 N/A The name of the Circuit Service Profile that you are applying to the designated B-channels. The direction of traffic allowed on the designated Bchannel(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.
ISDN B-channel
3-357
TABLE 3 -73.
ISDN BCHANNEL Parameters

Field Length N/A Description 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:
Parameter tmember-rng
1,3,5,8-12+2,14-16
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 operstate. Must be 1-1440, when dryup is specified. Default system setting is 0 (or attempt indefinitely to dryup). 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 - Not activated, able to be reconfigured. enabled - Active.
operation
N/A
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
3-358
ISDN B-channel
% 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:
% CONFIGURE ISDN BCHANNEL SERVICE isdnserv1 .. INTERFACE 0 BCHANNEL 20-23 .. MODE outOfService ACTION dryup TIMEOUT 300 % CONFIGURE ISDN BCHANNEL SERVICE isdnserv1 .. INTERFACE 0 BCHANNEL 20-23 DIRECTION oneWayIn % CONFIGURE ISDN BCHANNEL SERVICE isdnserv1 .. INTERFACE 0 BCHANNEL 20-23 MODE inService
To display the status of the B-channels using Interface 0 on ISDN service isdnserv1:
% SHOW ISDN BCHANNEL SERVICE isdnserv1 .. INTERFACE 0 STATUS
Node: TPUBS Date: 2002/01/18 19:39:33 GMT Zone: GMTMINUS05-EASTERN-US Local Admn ----IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS Local Hdwr ----IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS Remote Maint ---------IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS
ISDN Service ----------------------ISDNSERV1 ISDNSERV1 ISDNSERV1 ISDNSERV1 ISDNSERV1 ISDNSERV1 ISDNSERV1 ISDNSERV1 ISDNSERV1 ISDNSERV1 ISDNSERV1 ISDNSERV1 ISDNSERV1 ISDNSERV1 ISDNSERV1 ISDNSERV1 ISDNSERV1 ISDNSERV1 ISDNSERV1 ISDNSERV1 ISDNSERV1 ISDNSERV1 ISDNSERV1
Int --0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Ch -1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
Usage --------IN-BUSY IDLE IDLE IN-BUSY IN-BUSY IDLE IN-BUSY IN-BUSY IN-BUSY IDLE IDLE IDLE IDLE IDLE IDLE IDLE IDLE IDLE IDLE IDLE IDLE IDLE IDLE
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 the B-channels using Interface 0 on ISDN service isdnserv1:
% SHOW ISDN BCHANNEL SERVICE isdnserv1 ..
ISDN B-channel
3-359
INTERFACE 0 BCHANNEL ALL ADMIN

Trunk ISDN Service Int Ch Membr Circuit Profile Direct State Mode ------------------- --- -- ----- --------------- --------- --------- ---------ISDNSERV1 0 1 UNSET default TWOWAY ENABLED INSERVICE ISDNSERV1 0 2 UNSET default TWOWAY ENABLED INSERVICE ISDNSERV1 0 3 UNSET default TWOWAY ENABLED INSERVICE ISDNSERV1 0 4 UNSET default TWOWAY ENABLED INSERVICE ISDNSERV1 0 5 UNSET default TWOWAY ENABLED INSERVICE ISDNSERV1 0 6 UNSET default TWOWAY ENABLED INSERVICE ISDNSERV1 0 7 UNSET default TWOWAY ENABLED INSERVICE ISDNSERV1 0 8 UNSET default TWOWAY ENABLED INSERVICE ISDNSERV1 0 9 UNSET default TWOWAY ENABLED INSERVICE ISDNSERV1 0 10 UNSET default TWOWAY ENABLED INSERVICE ISDNSERV1 0 11 UNSET default TWOWAY ENABLED INSERVICE ISDNSERV1 0 12 UNSET default TWOWAY ENABLED INSERVICE ISDNSERV1 0 13 UNSET default TWOWAY ENABLED INSERVICE ISDNSERV1 0 14 UNSET default TWOWAY ENABLED INSERVICE ISDNSERV1 0 15 UNSET default TWOWAY ENABLED INSERVICE ISDNSERV1 0 16 UNSET default TWOWAY ENABLED INSERVICE ISDNSERV1 0 17 UNSET default TWOWAY ENABLED INSERVICE ISDNSERV1 0 18 UNSET default TWOWAY ENABLED INSERVICE ISDNSERV1 0 19 UNSET default TWOWAY ENABLED INSERVICE ISDNSERV1 0 20 UNSET default TWOWAY ENABLED INSERVICE ISDNSERV1 0 21 UNSET default TWOWAY ENABLED INSERVICE ISDNSERV1 0 22 UNSET default TWOWAY ENABLED INSERVICE 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:
% CONFIGURE ISDN BCHANNEL SERVICE isdnserv1 .. INTERFACE 0 BCHANNEL 1 .. CIRCUITPROFILENAME default DIRECTION twoWay TRUNK MEMBER 100 % CONFIGURE ISDN BCHANNEL SERVICE isdnserv1 .. INTERFACE 0 BCHANNEL 1 STATE enabled % CONFIGURE ISDN BCHANNEL SERVICE isdnserv1 .. INTERFACE 0 BCHANNEL 1 MODE inService
To display the the result of the above configuration.

% SHOW ISDN BCHANNEL SERVICE isdnserv1 .. INTERFACE 0 BCHANNEL 1 ADMIN
Trunk ISDN Service Int Ch Membr Circuit Profile Direct State Mode ------------------- --- -- ----- --------------- --------- --------- ---------ISDNSERV1 0 1 100 default TWOWAY ENABLED INSERVICE
ISDN Call Support under MGCP

ISDNCallSupportUnderMGCP
The objects discussed in this section describe the Sonus backhauling mechanism to exchange ISDN Q.931 User Messages over IP between a Media Gateway Controller (MGC) running MGCP and a GSX. This facility permits D-channel signaling information to be passed between the GSX and the MGCP soft switch using a UDP connection.
3-360
IUA Gateway
This Sonus implementation is modeled after the Internet-Draft ISDN Q921-User Adaptation Layer (IUA). Figure 3-2, ISDN Backhaul Facility under MGCP, depicts the hardware components of this facility. A comprehensive configuration example is presented at the end of this section.
Ethernet MGCP soft switch IP "backhaul" channels GSX9000 ISDN Switch B-channels T1
D-channel
CNAxx PNAxx
MNA10
IP
Ethernet
FIGURE 3-2
ISDN Backhaul Facility under MGCP
IUA Gateway
This object specifies the global IP configuration values that will be used to exchange ISDN Q.931 User Messages between this GSX and any IUA Application Servers that use the GSX to backhaul these messages. This object is created when the GSX software is initialized. This object is the only profile that is used for this purpose, regardless of the number of IUA Application Servers that are supported by this GSX.
Command Syntax
CONFIGURE IUA GATEWAY .. PORT port HEART BEAT TIMEOUT hb_timeout APPLICATION SERVER PENDING TIMEOUT asp_timeout ESTABLISH RELEASE INDICATION RETRIES eri_retries ESTABLISH RELEASE INDICATION TIMEOUT eri_timeout DATA INDICATION TIMEOUT di_timeout
IUA Gateway
3-361
DATA INDICATION RETRY EXPONENT di_etry_exp DATA INDICATION WINDOW SIZE di_window_size DATA INDICATION MAXIMUM TIMEOUT di_max_timeout SHOW IUA GATEWAY ADMIN
Command Parameters
TABLE 3 -74.
IUA GATEWAY Parameters

Field Length N/A N/A Description The logical port number of the IUA Listen Port (or the backhaul port). Must be 1-65535. Default is 9900. The timeout interval for any message between this GSX and an IUA Application Server Process, in milliseconds. You may disable this timeout by setting this value to 0. Must be 0-20000, default is 3000 (milliseconds).
Parameter port hb_timeout
asp_timeout
N/A
The Application Server pending timeout interval, in milliseconds. Must be 0-20000, default is 250 (milliseconds). For Establish/Release Message Indications, the number of retries allowed. Must be 1-5, default is 2. For Establish/Release Message retries, the timeout interval, in milliseconds. Must be 1-5000, default is 250 milliseconds. For Data Indication Message retries, the timeout interval, in milliseconds. Must be 1-5000, default is 250 milliseconds. The Data Indication retry exponent. Must be 1-5, default is 2. The number of Data Indication Messages that may be sent before an acknowledgement is required. Must be 132, default is 16. The maximum number of Data Indication timeouts allowed. Must be 1-20, default is 5.
eri_retries eri_timeout
N/A N/A
di_timeout
N/A
di_retry_exp di_window_siz e di_max_timeou t
N/A N/A
N/A
Command Example
To override the default heart beat timeout from 5 seconds to 6 seconds, and the Data Indication timeout from 1/4 second to 5 seconds:
% CONFIGURE IUA GATEWAY HEART BEAT TIMEOUT 6000 % CONFIGURE IUA GATEWAY DATA INDICATION TIMEOUT 5000
To display the IUA Gateway global IP configuration values:

% SHOW IUA GATEWAY ADMIN
Node: TPUBS Date: 2001/04/27 17:37:01 GMT Zone: GMTMINUS05-EASTERN-US 9900 6000
Listen Port: Heart Beat Timeout(ms):
3-362
IUA Application Server
Pending Timeout(ms): Est/Rel Indication Retries: Est/Rel Indication Timeout(ms): Data Indication Timeout(ms): Data Indication Retry Exponent: Data Indication Window Size: Data Indication Max. Timeouts:
250 2 250 5000 2 16 5

This named object is the collection of D-channels, or interfaces, (see ISDN Interface on page 3-349) that are controlled as a group. Each IUA Application Server (AS) has one or more IUA Application Server Processes (ASP) configured to control the Dchannels. An AS is always in one of two administrative states:
enabled disabled
An AS is always provisioned to one of two operational states:
outOfService inService
Changing to (operational state) inService outOfService Assure that no calls are active on this AS. Change operational state to outOfService. Affirm the prompt query. The administrative state of the AS may be disabled.
outOfService
Change the admin-state to enabled, if necessary. Change operational state to inservice.
Command Syntax
CREATE IUA APPLICATION SERVER iua_as .. CONFIGURE IUA APPLICATION SERVER iua_as .. MODE mode STATE admin_state SHOW IUA APPLICATION SERVER iua_as ADMIN
3-363
SHOW IUA APPLICATION SERVER iua_as STATUS SHOW IUA APPLICATION SERVER iua_as DETAILED STATUS SHOW IUA APPLICATION SERVER ALL ADMIN SHOW IUA APPLICATION SERVER ALL STATUS DELETE IUA APPLICATION SERVER iua_as ..
Command Parameters
TABLE 3 -75.
IUA APPLICATION SERVER Parameters

Field Length 1-23 Description The name of the IUA Application Server (AS), (or ISDN Interface), that is being created, enabled, disabled, or deleted. The operational state of the ISDN Interface: inService - available for use to control calls, and not able to be deleted. outOfService - not in use, not available for use, able to be deleted.
Parameter iua_as
mode
N/A
admin-state
N/A
The administrative state of the ISDN Interface: disabled - Not active, able to be reconfigured. enabled - Active.
Command Example
The example below creates and activates the IUA Application Servers as1 and as2:
% CREATE IUA APPLICATION SERVER as1 .. % CONFIGURE IUA APPLICATION SERVER as1 STATE enabled % CONFIGURE IUA APPLICATION SERVER as1 MODE inService % CREATE IUA APPLICATION SERVER as2 .. % CONFIGURE IUA APPLICATION SERVER as2 STATE enabled % CONFIGURE IUA APPLICATION SERVER as2 MODE inService
To display the configuration of all ASs:

% SHOW IUA APPLICATION SERVER ALL ADMIN
Id Name Mode State -------------------------------------------------------------------01 as1 INSERVICE ENABLED 02 as2 INSERVICE ENABLED
3-364
IUA Application Server Process
To display the status of all ASs:

% SHOW IUA APPLICATION SERVER ALL STATUS
Id Name Mode State Status Asp -------------------------------------------------------------------01 as1 INSERVICE ENABLED ACTIVE ASP1 02 as2 INSERVICE ENABLED ACTIVE ASP2
IUA Application Server Process

This object is a Media Gateway Controller (MGC) that handles Q.921 or Link Access Protocol for the D-channels of the Application Server (AS). A single IUA Application Server Process (ASP) controls all the interfaces in an AS. More than one ASP may be configured to an AS, but only one of them may be active at any time. One ASP may be configured to more than one AS such that it controls one AS while serving as a backup ASP for another AS.
Command Syntax
CREATE IUA APPLICATION SERVER PROCESS iua_as_pr CONFIGURE IUA APPLICATION SERVER PROCESS iua_as_pr .. STATE admin_state SHOW IUA APPLICATION SERVER PROCESS iua_as_pr ADMIN SHOW IUA APPLICATION SERVER PROCESS iua_as_pr STATUS SHOW IUA APPLICATION SERVER PROCESS ALL ADMIN SHOW IUA APPLICATION SERVER PROCESS ALL STATUS DELETE IUA APPLICATION SERVER PROCESS iua_as_pr
IUA Connection
3-365
Command Parameters
TABLE 3 -76.
IUA APPLICATION SERVER PROCESS Parameters

Field Length 1-23 Description The name of the IUA Application Server Process (ASP), (or Media Gateway Controller), that is being created, enabled, disabled, or deleted. The administrative state of the ASP: disabled - Not activated, able to be deleted. enabled - Active, cannot be deleted.
Parameter iua_as_pr
admin-state
N/A
Command Example
The example below creates and activates the IUA Application Server Processes asp1 and asp2:
% CREATE IUA APPLICATION SERVER PROCESS asp1 .. % CONFIGURE IUA APPLICATION SERVER PROCESS asp1 STATE enabled % CREATE IUA APPLICATION SERVER PROCESS asp2 .. % CONFIGURE IUA APPLICATION SERVER PROCESS asp2 STATE enabled
To display the configuration of all ASPs:

% SHOW IUA APPLICATION SERVER PROCESS ALL ADMIN
Id Name State ----------------------------------------------------------------01 asp1 ENABLED 02 asp2 ENABLED
To display the status of all ASPs:

% SHOW IUA APPLICATION SERVER PROCESS ALL STATUS
Id Name State Status Servers Conns ------------------------------------------------------------01 asp1 ENABLED UP 2 1 02 asp2 ENABLED UP 2 1
IUA Connection
This object establishes the GSX softwares IP link to one or more IUA Application Server Processes (ASP) running on the Media Gateway Controller. Once this connection is created and enabled, the GSX may exchange messages with this ASP. Whenever
3-366
IUA Connection
the GSX receives a message on the port that is configured with this object (the backhaul port), it verifies the messages source IP address to determine which ASP sent the message.
Command Syntax
CREATE IUA CONNECTION .. IPADDRESS ipaddress PORT port APPLICATION SERVER PROCESS iua_as_pr CONFIGURE IUA CONNECTION .. IPADDRESS ipaddress PORT port STATE admin_state SHOW IUA CONNECTION IPADDRESS ipaddress PORT port ADMIN SHOW IUA CONNECTION IPADDRESS ALL ADMIN DELETE IUA CONNECTION .. IPADDRESS ipaddress PORT port
IUA Connection
3-367
Command Parameters
TABLE 3 -77.
IUA CONNECTION Parameters

Field Length 1-23 Description The name of the IUA Application Server Process (ASP), running in the Media Gateway Controller (MGC), that will use this connection to exchange messages with this GSX. The 32-bit IP address used by the above ASP, with which the GSX will exchange ISDN Q.931 User Messages. Specified in dotted decimal form (for example 128.127.50.224). Default is 0.0.0.0. The logical port number to use for this connection (the IUA Listen Port or the backhaul port). Must be 165535. Default is 9900. The administrative state of this IUA connection: disabled - Not activated, able to be reconfigured or deleted. enabled - Active, unable to be reconfigured or deleted.
Parameter iua_as_pr
ipaddress
N/A
port
N/A
admin-state
N/A
Command Example
The example below creates the connection addresses to a Media Gateway Controller (MGC) using the default logical port 9900. IUA Application Server Process asp1, running on this MGC, uses IP address 128.20.254.253. IUA Application Server Process asp2, running on this MGC, uses IP address 128.21.254.253. To create, configure, and activate these connection addresses for asp1 and asp2:
% CREATE IUA CONNECTION IPADDRESS 128.20.254.253 .. PORT 9900 APPLICATION SERVER PROCESS asp1 % CONFIGURE IUA CONNECTION IPADDRESS 128.20.254.253 .. PORT 9900 STATE enabled % CREATE IUA CONNECTION IPADDRESS 128.21.254.253 .. PORT 9900 APPLICATION SERVER PROCESS asp2 % CONFIGURE IUA CONNECTION IPADDRESS 128.21.254.253 .. PORT 9900 STATE enabled
To display the configuration of all IUA Connections to all IUA Application Server Processes:
% SHOW IUA CONNECTION ALL ADMIN
IP Address Port State ASP ----------------------------------------------------------128.20.254.253 9900 ENABLED asp1 128.21.254.253 9900 ENABLED asp2
3-368
IUA Association
IUA Association
This object binds the IUA Application Server and the IUA Application Server Process together. One IUA Application Server can be associated with multiple IUA Application Server Processes. One IUA Application Server Process can be associated with multiple IUA Application Servers.
Command Syntax
CREATE IUA ASSOCIATION APPLICATION SERVER iua_as .. APPLICATION SERVER PROCESS iua_as_pr SHOW IUA ASSOCIATION APPLICATION SERVER iua_as .. APPLICATION SERVER PROCESS iua_as_pr ADMIN SHOW IUA ASSOCIATION APPLICATION SERVER iua_as ADMIN SHOW IUA ASSOCIATION .. APPLICATION SERVER PROCESS iua_as_pr ADMIN SHOW IUA ASSOCIATION ALL ADMIN DELETE IUA ASSOCIATION APPLICATION SERVER iua_as .. APPLICATION SERVER PROCESS iua_as_pr
Command Parameters
TABLE 3 -78.
IUA ASSOCIATION Parameters

Field Length 1-23 Description The name of the IUA Application Server (AS) that will be (or has been) associated (or bound) with an IUA Application Server Process by this command. The AS is a collection of ISDN D-channels (or IUA INTERFACE) that are controlled as a group. The name of the IUA Application Server Process (ASP) that will be (or has been) associated (or bound) with an AS by this command. The ASP is a Media Gateway Controller (MGC) that handles the call processing and Q.921 protocol for the D-channels of the AS.
Parameter iua_as
iua_as_pr
1-23
Command Example
To associate or bind IUA Application Servers as1 and as2 with Application Server Processes asp1 and asp2:
% CREATE IUA ASSOCIATION APPLICATION SERVER as1 .. APPLICATION SERVER PROCESS asp1 % CREATE IUA ASSOCIATION APPLICATION SERVER as1 .. APPLICATION SERVER PROCESS asp2 % CREATE IUA ASSOCIATION APPLICATION SERVER as2 .. APPLICATION SERVER PROCESS asp1
IUA Interface
3-369
% CREATE IUA ASSOCIATION APPLICATION SERVER as2 .. APPLICATION SERVER PROCESS asp2
IUA Interface
This object is used to display the hardware configuration of the collection of D-channels created through ISDN and then configured as part of the IUA Application Server. The SHOW ISDN SERVICE .. command also displays the IUA Application Server that is associated with the ISDN service, if applicable.
Command Syntax
SHOW IUA INTERFACE ALL ADMIN SHOW IUA INTERFACE SHELF shelf SLOT slot PORT port .. TS ts ADMIN
Command Parameters
TABLE 3 -79.
IUA INTERFACE Parameters

Field Length N/A Description The shelf number in the GSX node configuration of the GSX on which this IUA INTERFACE resides. In this release, one shelf is supported. Must be 1. The slot number of the CNS module that supports the ISDN D-channels that are being displayed by this command. This number must be 3-16. The number of the T1 or E1 span that contains the ISDN D-channel that is being displayed by this command. Must be 1-28. The time slot of the ISDN D-channel that is being displayed. For a T1 IUA INTERFACE, must be 1-24, and default is 24. For an E1 IUA INTERFACE, must be 1-31, and default is 16.
Parameter shelf
slot
N/A
port
N/A
ts
N/A
Command Example
To display the configuration of all IUA Interfaces, or all collections of D-channels that are associated with an IUA Application Server:
% SHOW IUA INTERFACE ALL ADMIN
% SHOW IUA INTERFACE ALL ADMIN Node: TPUBS Date: 2001/04/27 17:45:21 GMT Zone: GMTMINUS05-EASTERN-US Shelf Slot Port Ts AS Name ----------------------------------------------------------1 3 1 24 as1 1 3 2 24 as2
3-370
IUA ISDN Example
IUA ISDN Example

The following is a sample configuration script that creates two IUA Application Servers, as1 and as2, and two IUA Application Server Processes, asp1 and asp2. The IUA Application Server Processes are bound to both Application Servers.
##################################################################### # # Example Configuration # # Creates two Application Servers (as1 & as2) # Creates two Application Server Processes (asp1 & asp2) # Both ASPs are bound to both ASs # # Create two sample D-channels (on t1-1-3-1 and t1-1-3-2). # One D-channel is bound to as1, the other to as2 ##################################################################### ##################################################################### # Create and enable the ASs # CREATE IUA APPLICATION SERVER as1 CONFIGURE IUA APPLICATION SERVER as1 MODE inservice CONFIGURE IUA APPLICATION SERVER as1 STATE enabled CREATE IUA APPLICATION SERVER as2 CONFIGURE IUA APPLICATION SERVER as2 MODE inservice CONFIGURE IUA APPLICATION SERVER as2 STATE enabled
##################################################################### # Create and enable the ASPs # CREATE IUA APPLICATION SERVER PROCESS asp1 CONFIGURE IUA APPLICATION SERVER PROCESS asp1 STATE enabled CREATE IUA APPLICATION SERVER PROCESS asp2 CONFIGURE IUA APPLICATION SERVER PROCESS asp2 STATE enabled
##################################################################### # Bind the ASs and ASPs together # CREATE IUA ASSOCIATION APP SERVER as1 APPLICATION SERVER PROCESS asp1 CREATE IUA ASSOCIATION APP SERVER as1 APPLICATION SERVER PROCESS asp2 CREATE IUA ASSOCIATION APP SERVER as2 APPLICATION SERVER PROCESS asp1 CREATE IUA ASSOCIATION APP SERVER as2 APPLICATION SERVER PROCESS asp2 CONFIGURE IUA APPLICATION SERVER PROCESS asp1 STATE enabled CONFIGURE IUA APPLICATION SERVER PROCESS asp2 STATE enabled ##################################################################### # Create and enable the connection addresses for the ASPs # CR IUA CONN IPADDRESS 128.20.254.253 PORT 9900 APP SERVER PROCESS asp1 CONFIGURE IUA CONN IPADDRESS 128.20.254.253 PORT 9900 STATE enabled CR IUA CONN IPADDRESS 128.21.254.253 PORT 9900 APP SERVER PROCESS asp2 CONFIGURE IUA CONN IPADDRESS 128.21.254.253 PORT 9900 STATE enabled
IUA ISDN Example
3-371
##################################################################### # Override some defaults in the IUA # # In this case set heartbeat to 6000ms (i.e., 6 sec) # Note: Setting timeout to 0 disables the timeout # # Set the QPTM data indication timeout to 5000ms # CONFIGURE IUA GATEWAY HEART BEAT TIMEOUT 6000 CONFIGURE IUA GATEWAY DATA INDICATION TIMEOUT 5000
##################################################################### # Create the D-channel configurations # # Create a network side D-channel on t1 in slot 3, port 1 # Bind the channel to as1 # CREATE ISDN SERVICE iua-3-1 CONFIGURE ISDN SERVICE iua-3-1 IUA APPLICATION SERVER as1 CONFIGURE ISDN SERVICE iua-3-1 SWITCHSIDE network CREATE ISDN INTERFACE SERVICE iua-3-1 INTERFACE 0 CONFIGURE ISDN INTERFACE SERVICE iua-3-1 INTERFACE 0 PORT t1-1-3-1 CONFIGURE ISDN SERVICE iua-3-1 MODE inservice CONFIGURE ISDN SERVICE iua-3-1 STATE enabled CONFIGURE ISDN INTERFACE SERVICE iua-3-1 INTERFACE 0 STATE enabled ##################################################################### # Create a user side D-channel on t1 in slot 3, port 2 # Bind the channel to as2 # Have the GW bring up the D-channel automatically (without a command # from the ASP) # CREATE ISDN SERVICE iua-3-2 CONFIGURE ISDN SERVICE iua-3-2 IUA APPLICATION SERVER as2 CONFIGURE ISDN SERVICE iua-3-2 SWITCHSIDE user CONFIGURE ISDN SERVICE iua-3-2 IUA AUTOMATIC DATALINK ESTABLISH yes CREATE ISDN INTERFACE SERVICE iua-3-2 INTERFACE 0 CONFIGURE ISDN INTERFACE SERVICE iua-3-2 INTERFACE 0 PORT t1-1-3-2 CONFIGURE ISDN SERVICE iua-3-2 MODE inservice CONFIGURE ISDN SERVICE iua-3-2 STATE enabled CONFIGURE ISDN INTERFACE SERVICE iua-3-2 INTERFACE 0 STATE enabled # # # End of example IUA configuration Script #####################################################################
3-372
IUA ISDN Example
MGCP Soft Switch

MGCPSoftSwitch
To configure the GSX9000 Media Gateway for an MGCP soft switch, you configure the MGCP Gateway, the MGCP Session, one or more MGCP Call Agents, and several MGCP Connections per call agent. These objects are shown in Figure 3-3, MGCP Object Model. This figure shows the conceptual relationships between the software objects on the GSX that allow it to be managed by one or more third party MGCP soft switches.
GATEWAY SESSION SERVICE PROFILE CALL AGENT CALL AGENT CALL AGENT SERVICE PROFILE
CONNECTION CONNECTION CONNECTION CONNECTION CONNECTION CONNECTION CONNECTION SERVICE PROFILE
FIGURE 3-3
MGCP Object Model
The MGCP Gateway object is created automatically by the GSX9000, and contains global configuration data for the entire GSX MGCP Media Gateway (MGW). Each of the configurable parameters has a default value that accommodates most applications. Therefore, you can accept the default values, and are not required to create or configure the MGCP Gateway object. The rest of the configuration objects form an object hierarchy. At the highest level is the MGCP Session, which represents the GSX MGW's view of one or more MGCP Call Agents (CAs) that control the GSX. 1 The Call Agents are remote gateway controllers that are allowed to use the resources of the MGCP Session. A Session has one or more Call Agents bound to it. The Session acts as access control for the GSX. The GSX checks all incoming requests to determine the originating Call Agent. The GSX acts only on requests from Call Agents registered in the GSXs Session. 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 MGW and that is used by the GSX to send messages to the Call Agent. The GSX verifies the Connection address in every incoming MGCP message (command or
1. In future releases the GSX MGW will be able to support more than one Session. In this release only a single Session is allowed. Version 4.01, Document Version 2
MGCP Gateway
3-373
response) against the list of Connection addresses for valid Call Agents. The GSX silently ignores requests from unknown Call Agents. This is a security feature. Call Agent names are used to convert Notified Entity parameters in MGCP commands into IP/port addresses. The Session uses a Service Profile to provide defaults for the attributes for MGCP connections made in this Session.
MGCP Gateway
The MGCP 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
CONFIGURE MGCP GATEWAY ... PORT port RECEIVE COMMAND THROTTLE rcvCmdThrottle RETRANSMIT COUNT reXmitCnt COMMAND TIMEOUT cmdTimeout RESPONSE TIMEOUT rspTimeout CRITICAL TIMEOUT crtTimeout PARTIAL TIMEOUT prtTimeout MESSAGE PIGGYBACKING msgPiggyBack SHOW MGCP GATEWAY ADMIN
3-374
MGCP Session
Command Parameters
TABLE 3 -80.
MGCP GATEWAY Parameters a

Field Length N/A N/A Description MGCP listen port number. Range is 1 - 65535. Default is 2427. Receive flow control threshold. Sets maximum limit on number of concurrent outstanding MGCP commands that have not been responded to. The value 0 disables flow control. Range is 0 - 65535. Default is 0. Maximum consecutive re-transmissions of one MGCP command. Range is 1 - 5000. Default is 5. MGCP command re-transmission timeout in Msec. Range is 1 - 10000. Default is 250. Response cache purge timeout interval in Msec. Range is 1 - 65535. Default is 1000. Sets the value of the MGCP digit map "T-critical" timer. Expressed in Msec. Range is 50 - 60000. Default is16000. Sets the value of the MGCP digit map "T-partial" timer. Expressed in Msec. Range is 50 - 60000. Default is 4000. Enables or disables NTFY piggybacking. Should be set to false if the Call Agent software is unable to support piggyback MGCP messages as described in RFC 2705. true false
Parameter Port
rcvCmdThrottle
reXmitCnt cmdTimeout rspTimeout crtTimeout
N/A N/A N/A N/A
prtTimeout
N/A
msgPiggyBack
N/A
a.Note that the default values for the two timeout parameters are different from the recommended default values in the MGCP RFC 2705. These alternate default values are selected to align with performance requirements for trunking gateways with large numbers of endpoints and high call rates on provisioned private IP networks.
MGCP Session
The MGCP Session object represents MGCP control of the GSX MGW 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. The Media Gateway Circuit Ports bound to the Media Gateway Service belong to the Session and may be used by any Call Agent bound to the Session. See Media Gateway Service on page 378. You may not delete a Session that is being referenced by Call Agents. You must first delete the Call Agents.
Command Syntax
CREATE MGCP SESSION sessionName
MGCP Call Agent
3-375
CONFIGURE MGCP SESSION sessionName ... SERVICE PROFILE profileName MODE operState CONFIGURE MGCP SESSION sessionName STATE adminState DELETE MGCP SESSION sessionName SHOW MGCP SESSION sessionName ADMIN SHOW MGCP SESSION sessionName STATUS SHOW MGCP SESSION sessionName DETAILED STATUS SHOW MGCP SESSION ALL ADMIN SHOW MGCP SESSION ALL STATUS
Command Parameters
TABLE 3 -81.
MGCP SESSION Parameters

Field Length 1 - 23 1 - 23 N/A Description An alphanumeric name that you assign to the MGCP session. Name of the MGCP service profile to be applied to MGCP connections in this session. Default name is default. The operational state of the session: inService - Ready for use. outOfService - Not in use. You must set this state to change adminState to disabled.
Parameter sessionName profileName operState
adminState
N/A
The administrative state of the session: enabled - the session must be in this state to activate its current configuration. disabled - in this state the session is inactive. In this state the Session may be reconfigured, or it may be deleted.
MGCP Call Agent

The MGCP CALL AGENT object represents one remote call agent system 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
CREATE MGCP CALL AGENT callAgentName SESSION sessionName CONFIGURE MGCP CALL AGENT callAgentName ... DEFAULT NOTIFIED ENTITY isDNE CONFIGURE MGCP CALL AGENT callAgentName STATE adminState
3-376
MGCP Connection
DELETE MGCP CALL AGENT callAgentName SHOW MGCP CALL AGENT callAgentName ADMIN SHOW MGCP CALL AGENT callAgentName STATUS SHOW MGCP CALL AGENT ALL ADMIN SHOW MGCP CALL AGENT ALL STATUS
Command Parameters
TABLE 3 -82.
MGCP CALL AGENT Parameters

Field Length 1 - 23 Description An alphanumeric name that you assign to the MGCP Call Agent.The name space of all callAgentNames defines the allowable set of strings that may appear in the Notified Entity field of MGCP commands The alphanumeric name of the parent session. Indicates this Call Agent is the session MGCP default notified entity (see RFC 2705).When a call agent is made the default notified entity, any previous default notified entity is demoted.If there is no enabled call agent who is the default notified entity, the first available call agent is used. true false
Parameter callAgentName
sessionName isDNE
1 - 23
adminState
The administrative state of the call agent: disabled - in this state the call agent is inactive. In this state the call agent may be reconfigured, or it may be deleted. enabled - the call agent must be in this state to activate its current configuration.
MGCP Connection
The MGCP Connection represents one Call Agent address and port, by which the parent Call Agent can be reached and from which MGCP messages may be sent to the MGCP Session.
Command Syntax
CREATE MGCP CONNECTION IPADDRESS ipAddress ... PORT port CALL AGENT callAgentName CONFIGURE MGCP CONNECTION IPADDRESS ipAddress ... PORT port STATE adminState DELETE MGCP CONNECTION IPADDRESS ipAddress... PORT port SHOW MGCP CONNECTION IPADDRESS ipAddress ... PORT port ADMIN
MGCP Service Profile
3-377
SHOW MGCP CONNECTION ALL ADMIN
Command Parameters
TABLE 3 -83.
MGCP CONNECTION Parameters

Field Length 255.255.255.255 Description A 32-bit IP address on this soft switch specified in Dotted decimal form (for example 128.127.50.224). Range is 255.255.255.255 address. Port number for this connection address. Range is 1 - 65535. Default when creating is 2427. 1 - 23 characters The alphanumeric name of the parent call agent. The administrative state of the connection: disabled - in this state the connection may be deleted. enabled - the connection must be in this state to activate its current configuration.
Parameter ipAddress
port callAgentName adminState
MGCP Service Profile

The MGCP Service Profile provides defaults for MGCP 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 Session. You must first remove the reference from the Session. A default version of the MGCP Service Profile, named default, is created by the GSX the first time you boot the GSX. The user can modify the default MGCP Service Profile but cannot delete it. If you use Parameter Loading, your modified default profile will load as the default MGCP Service Profile the next time the GSX is booted. All profiles are stored on the GSX. The total current configuration of the GSX is saved in the Binary Parameter File on the NFS. The Binary Parameter File acts as the archive of the current configuration of the GSX.
Command Syntax
CREATE MGCP SERVICE PROFILE servProfileName CONFIGURE MGCP SERVICE PROFILE servProfileName ... ENCODE TYPE encodeType PACKET PERIOD packetPeriod TYPE OF SERVICE typeOfService ECHO CANCELLATION echoCancel SILENCE SUPPRESSION silenceSuppress CONFIGURE MGCP SERVICE PROFILE servProfileName ... STATE admnState DELETE MGCP SERVICE PROFILE servProfileName SHOW MGCP SERVICE PROFILE servProfileName ADMIN
3-378
Media Gateway Service
SHOW MGCP SERVICE PROFILE ALL ADMIN
Command Parameters
TABLE 3 -84.
MGCP SERVICE PROFILE Parameters

Field Length 1-23 characters N/A Description An alphanumeric name that you assign to the MGCP Service Profile. The audio encoding method to be performed on the voice data received from, and destined to the PSTN: g711ulaw g711alaw g723 g729
Parameter servProfileName encodeType
packetPeriod typeOfService echoCancel
N/A N/A N/A
RTP packet size in msecSize must be in 5 msec increments. Range is 10 - 40 (msec). Default is 10 (msec). Network type of service byte. Range is 0 - 255. Default is 0. Echo cancellation treatment useCktProfile means the configured value of echo treatment in the circuit service profile bound to the media gateway circuit is used: off on USECKT
silenceSuppress
N/A
Silence Suppression treatment (if supported by the codec): off on
admnState
N/A
The administrative state of the service profile: disabled - in this state the service profile may be reconfigured, or it may be deleted. enabled - the service profile must be in this state to activate its current configuration.
Media Gateway Service MediaGatewayController

This object specifies a protocol (service) that will be used by the GSX9000 to communicate with the third party soft switch specified previously. 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.
3-379
A media gateway service is always in one of two administrative states:
enabled disabled
A media gateway service is always in one of two operational states:
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.
unblocked unblocked
-
blocked
All circuits (See Media Gateway Circuit on page 3-382) that use this service should first be blocked. Change oper-state to blocked, affirm the prompt query. No new calls using this protocol will be allowed. If action dryup is specified, current calls have until timeout expires to complete. After timeout expires, all calls are using this service are dropped. When the oper-state becomes blocked, the admin-state may be disabled. However, the underlying circuits that used this service must be themselves disabled. Once they are disabled you may reconfigure mgcname and prottype.
blocked
Before beginning, make sure that mgcname and prottype are properly configured. Change admin-state to enabled, if necessary. Change oper-state to unblocked.
3-380
Command Syntax
CREATE MEDIA GATEWAY SERVICE mgsname CONFIGURE MEDIA GATEWAY SERVICE mgsname .. CONTROLLER mgcname TYPE MGCP CONFIGURE MEDIA GATEWAY SERVICE mgsname .. MODE oper-state CONFIGURE MEDIA GATEWAY SERVICE mgsname .. MODE oper-state ACTION action CONFIGURE MEDIA GATEWAY SERVICE mgsname .. MODE oper-state ACTION action TIMEOUT timeout CONFIGURE MEDIA GATEWAY SERVICE mgsname .. STATE admin-state SHOW MEDIA GATEWAY SERVICE mgsname STATUS SHOW MEDIA GATEWAY SERVICE mgsname ADMIN SHOW MEDIA GATEWAY SERVICE ALL STATUS SHOW MEDIA GATEWAY SERVICE ALL ADMIN DELETE MEDIA GATEWAY SERVICE mgsname
3-381
Command Parameters
TABLE 3 -85.
MEDIA GATEWAY SERVICE Parameters

Field Length 1-23 Description An alphanumeric name that you assign to the protocol (service) that will be used to communicate with the soft switch. The name of the media gateway controller that will provide the (above) service. This may be an MGCP SESSION. The operational state of the service: 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.
Parameter
mgsname
mgcname
1-23
oper-state
N/A
action
N/A
The method by which active calls that use this service are processed when oper-state goes to blocked: 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 service group in the blocked oper-state. Must be 1-1440, default is 60. The administrative state of the soft switch service: disabled - not active. enabled - active.
admin-state
N/A
Command Example
To create, configure, and activate a service that provides MGCP protocol on soft switch softswitch1:
% CREATE MEDIA GATEWAY SERVICE mgcpsrv % CONFIGURE MEDIA GATEWAY SERVICE mgcpsrv .. CONTROLLER mgcpsess1 TYPE mgcp % CONFIG MEDIA GATEW SERVICE mgcpsrv STATE enabled % CONFIG MEDIA GATEW SERVICE mgcpsrv MODE unblocked
To display the configured state of all soft switch services:

% SHOW MEDIA GATEWAY SERVICE ALL ADMIN
--------------------------------------------------------------Media Gateway Service : MGCPSRV ---------------------------------------------------------------
3-382
Media Gateway Circuit
Type Mode Action
: MGCP Controller : mgcpsess1 : UNBLOCKED Admin State : ENABLED : DRYUP Timeout(in minutes) : 60
To display the operational status of all soft switch services:

% SHOW MEDIA GATEWAY SERVICE ALL STATUS
Node: TPUBS Date: 1999/07/20 23:06:38 GMT Zone: GMTMINUS05-EASTERN-US Status ----------AVAILABLE
Media Gateway Service --------------------MGCPSRV

This object associates one or more channels on a T1/E1 span with a soft switch service. The name of the T1/E1 span and a set of up to all 24/31 channels, including a single channel, are associated with the service. You may temporarily remove and restore service on selected channels by toggling their operational states 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. A media gateway circuit is always in one of two administrative states:
enabled disabled
A media gateway circuit is always in one of two operational states:
blocked - the circuit is denied to all new requestors and removed from any existing users according to the settings of the action parameter. unblocked - the circuit is active and available to all requestors.
3-383
unblocked unblocked
-
blocked
Change oper-state to blocked, affirm the prompt query. No new calls using this circuit will be allowed. If action dryup is specified, current calls have until timeout expires to complete. After timeout expires, all calls are dropped and this circuit is blocked. When the oper-state becomes blocked, the admin-state may be disabled. Once disabled you may change the service group name and/or apply a new circuit service profile to the circuit.
blocked
Change admin-state to enabled, if necessary. To do so, the soft switch service mgsname used by this circuit must also be enabled. Change oper-state to unblocked. This action reactivates the specified service protocol on the specified channels on the specified T1 port.
Command Syntax
CREATE MEDIA GATEWAY CIRCUIT PORT spanname .. CHANNEL chanrange
Note
The commands below affect a specific channel.

CONFIG MEDIA GATEWAY CIRCUIT PORT spanname .. CHANNEL channumber SERVICEGROUPNAME mgsname SERVICEPROFILENAME csrvprofile CONFIG MEDIA GATEWAY CIRCUIT PORT spanname ..
3-384
CHANNEL channumber TYPE chantype CONFIG MEDIA GATEWAY CIRCUIT PORT spanname .. CHANNEL channumber TYPE chantype SWITCH TYPE switch_type CONFIG MEDIA GATEWAY CIRCUIT PORT spanname .. CHANNEL channumber MODE oper-state CONFIG MEDIA GATEWAY CIRCUIT PORT spanname .. CHANNEL channumber MODE oper-state ACTION action CONFIG MEDIA GATEWAY CIRCUIT PORT spanname .. CHANNEL channumber MODE oper-state ACTION action TIMEOUT timeout CONFIG MEDIA GATEWAY CIRCUIT PORT spanname .. CHANNEL channumber STATE admin-state
Note
The commands below affect a range of channels.

CONFIG MEDIA GATEWAY CIRCUIT PORT spanname .. CHANNEL chanrange SERVICEGROUPNAME mgsname CONFIG MEDIA GATEWAY CIRCUIT PORT spanname .. CHANNEL chanrange SERVICEPROFILENAME csrvprofile CONFIG MEDIA GATEWAY CIRCUIT PORT spanname .. CHANNEL chanrange MODE oper-state CONFIG MEDIA GATEWAY CIRCUIT PORT spanname .. CHANNEL chanrange STATE admin-state SHOW MEDIA GATEWAY CIRCUIT PORT spanname .. CHANNEL chanrange ADMIN SHOW MEDIA GATEWAY CIRCUIT PORT spanname .. CHANNEL chanrange STATUS SHOW MEDIA GATEWAY CIRCUIT PORT spanname .. CHANNEL ALL ADMIN SHOW MEDIA GATEWAY CIRCUIT PORT spanname ..
3-385
CHANNEL ALL STATUS SHOW MEDIA GATEWAY CIRCUIT PORT NAMES ALL DELETE MEDIA GATEWAY CIRCUIT PORT spanname .. CHANNEL chanrange
3-386
Command Parameters
TABLE 3 -86.
MEDIA GATEWAY CIRCUIT Parameters

Field Length 1-23 Description The name that you assigned to the media gateway service object. This parameter specifies the initial service and may also be used to change a previously configured range of channels from one service to another. The automatically generated (and possibly changed) name of the T1/E1 span that will be associated with this service. The set of channels being configured for this service. Must be in the range 1-24 (T1) or 1-31 (E1). 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:
Parameter mgsname
spanname
1-23
chanrange
N/A
1,3,5,8-12+2,14-16
1,3,5,8,10,12,14,15, and 16.

channumber csrvprofile chantype N/A 1-23 N/A The single channel that is being configured. Must be in the range 1-24 (T1) or 1-31 (E1). Identifies the Circuit Service Profile to apply to these channels. For ISDN Tunneling, the type of channel: data - data channel dc-ne - D-channel, network side dc-ue - D-channel, user side switch_type N/A For ISDN Tunneling, the switch type that the Dchannel is connected to: NI-2 itu 4ESS 5ESS-CUST DMS KDD NTT NET5 1TR6 TS014 VN This field is sent to the soft switch but has no influence on the transmission of the D-channel itself.
3-387
TABLE 3 -86.
MEDIA GATEWAY CIRCUIT Parameters

Field Length N/A Description The operational state of the specified channels: blocked - the soft switch 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 that use this soft switch service on the specified channels are processed when oper-state goes to blocked: 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 channels in the blocked oper-state. Must be 1-1440, default is 60. The administrative state of the specified channels: disabled - not active. enabled - active.
admin-state
N/A
Command Example
To create, configure, and activate all 24 channels of both T1 spans T1-1-3-1 and T1-1-3-2 to use soft switch service mgcpsrv:
% 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 mgcpsrv % 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 STATE enabled % 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 mgcpsrv % 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 STATE enabled
To display the configured state of channels 1-4 on T1 span T1-1-3-1 using soft switch service mgcp-mgw:
% SHOW MEDIA GATEWAY CIRCUIT PORT T1-1-3-1 .. CHANNEL 1-4 ADMIN
3-388
Node: TPUBS
Date: 2001/02/02 16:45:33 GMT Zone: GMTMINUS05-EASTERN-US
--------------------------------------------------------------------------Shelf:1 Slot:3 PORT:1 --------------------------------------------------------------------------D-Chan Time Chan Serv Group Profile Type Proto Mode AdmState Action out --------------------------------------------------------------------------1 mgcp-mgw DEFAULT DATA ITU UNBLOCKED ENABLED DRYUP 60 2 mgcp-mgw DEFAULT DATA ITU UNBLOCKED ENABLED DRYUP 60 3 mgcp-mgw DEFAULT DATA ITU UNBLOCKED ENABLED DRYUP 60 4 mgcp-mgw DEFAULT DATA ITU UNBLOCKED ENABLED DRYUP 60
To display the status of all soft switch circuits on T1 span T1-1-3-2:

% SHOW MEDIA GATEWAY CIRCUIT PORT T1-1-3-2 .. CHANNEL ALL STATUS
--------------------------------------------------------------Shelf:1 Slot:3 PORT:2 --------------------------------------------------------------Chan Service Group MGC State HW State Dryup In Progress ---------------------------------------------------------------1 MGCPSRV IDLE AVAILABLE FALSE 2 MGCPSRV IDLE AVAILABLE FALSE 3 MGCPSRV IDLE AVAILABLE FALSE 4 MGCPSRV IDLE AVAILABLE FALSE 5 MGCPSRV IDLE AVAILABLE FALSE 6 MGCPSRV IDLE AVAILABLE FALSE 7 MGCPSRV IDLE AVAILABLE FALSE 8 MGCPSRV IDLE AVAILABLE FALSE 9 MGCPSRV IDLE AVAILABLE FALSE 10 MGCPSRV IDLE AVAILABLE FALSE 11 MGCPSRV IDLE AVAILABLE FALSE 12 MGCPSRV IDLE AVAILABLE FALSE 13 MGCPSRV IDLE AVAILABLE FALSE 14 MGCPSRV IDLE AVAILABLE FALSE 15 MGCPSRV IDLE AVAILABLE FALSE 16 MGCPSRV IDLE AVAILABLE FALSE 17 MGCPSRV IDLE AVAILABLE FALSE 18 MGCPSRV IDLE AVAILABLE FALSE 19 MGCPSRV IDLE AVAILABLE FALSE 20 MGCPSRV IDLE AVAILABLE FALSE 21 MGCPSRV IDLE AVAILABLE FALSE 22 MGCPSRV IDLE AVAILABLE FALSE 23 MGCPSRV IDLE AVAILABLE FALSE 24 MGCPSRV IDLE AVAILABLE FALSE
To display all the media gateway circuit port names:

% SHOW MEDIA GATEWAY CIRCUIT PORT NAMES ALL
Port names in use by Media Gateway services are: T1-1-8-1 T1-1-8-2 T1-1-8-3 T1-1-8-4 T1-1-8-5
3-389
T1-1-8-6 T1-1-8-7 T1-1-8-8 T1-1-8-9 T1-1-8-10 T1-1-8-11 T1-1-8-12
Command Example - MGCP Configuration

The following example creates an MGCP session with two call agents, each of which has two IP addresses. The first call agent, callAgent1 is designated as the default notified entity. An alternate MGCP service profile ("myProfile" is created and used in place of the "default" MGCP service profile. This profile is set to use "type of service" value 142 (decimal) and a packet period of 20ms as the default for calls in which the call agents does not specify these parameters. Alternatively the "default" service profile could have been modified to provide these defaults. The steps involving the "myProfile" are not required if the default service profile settings are acceptable for your operation.
% CREATE MGCP SESSION mgcpSession % % CREATE MGCP CALL AGENT callAgent1 SESSION mgcpSession % CREATE MGCP CALL AGENT callAgent2 SESSION mgcpSession % % CREATE MGCP CONNECTION IPADDRESS 10.1.1.1 PORT 2727 CALL AGENT callAgent1 % CREATE MGCP CONNECTION IPADDRESS 10.1.2.1 PORT 2727 CALL AGENT callAgent1 % CONFIGURE MGCP CONNECTION IPADDRESS 10.1.1.1 PORT 2727 STATE enabled % CONFIGURE MGCP CONNECTION IPADDRESS 10.1.2.1 PORT 2727 STATE enabled % % CREATE MGCP CONNECTION IPADDRESS 10.1.1.2 PORT 2727 CALL AGENT callAgent2 % CREATE MGCP CONNECTION IPADDRESS 10.1.2.2 PORT 2727 CALL AGENT callAgent2 % CONFIGURE MGCP CONNECTION IPADDRESS 10.1.1.2 PORT 2727 STATE enabled % CONFIGURE MGCP CONNECTION IPADDRESS 10.1.2.2 PORT 2727 STATE enabled % % CONFIGURE MGCP CALL AGENT callAgent1 DEFAULT NOTIFIED ENTITY true % % CONFIGURE MGCP CALL AGENT callAgent1 STATE enabled % CONFIGURE MGCP CALL AGENT callAgent2 STATE enabled
3-390
% % CREATE MGCP SERVICE PROFILE myProfile % CONFIGURE MGCP SERVICE PROFILE myProfile TYPE OF SERVICE 142 % CONFIGURE MGCP SERVICE PROFILE myProfile PACKET PERIOD 20 % CONFIGURE MGCP SERVICE PROFILE myProfile STATE enabled % % CONFIGURE MGCP SESSION mgcpSession SERVICE PROFILE myProfile % % CONFIGURE MGCP SESSION mgcpSession STATE enabled %
The following commands show the configured Session, Call Agents and Connections.
% SHOW MGCP SESSION ALL ADMIN

Node: SPIRIT Date: 2000/12/21 18:20:41 GMT Zone: GMTMINUS05-EASTERN-US
Id Name Mode State Service Profile --------------------------------------------------------------------01 mgcpSession INSERVICE ENABLED myProfile
% SHOW MGCP SERVICE PROFILE myProfile ADMIN

Node: SPIRIT Date: 2000/12/21 18:20:41 GMT Zone: GMTMINUS05-EASTERN-US
Encode Pkt Type Echo Sil Id Name State Type Per Serv Cancel Suppress -------------------------------------------------------------------------02 myProfile ENABLED G711ULAW 020 0142 USECKT OFF
% SHOW MGCP CALL AGENT ALL ADMIN

Node: SPIRIT GMT US Default Notified Id Name State Session Entity -------------------------------------------------------------------------01 callAgent1 ENABLED mgcpSession TRUE 02 callAgent2 ENABLED mgcpSession FALSE Date: 2000/12/21 18:20:41 Zone: GMTMINUS05-EASTERN-
% SHOW MGCP CONNECTION ALL ADMIN

Node: SPIRIT GMT US IP Address Port State Call Agent Date: 2000/12/21 18:20:41 Zone: GMTMINUS05-EASTERN-
3-391
----------------------------------------------------------10.1.1.1 2727 ENABLED callAgent1 10.1.1.2 2727 ENABLED callAgent2 10.1.2.1 2727 ENABLED callAgent1 10.1.2.2 2727 ENABLED callAgent2
Show Alarms
ShowAlarms
The SHOW ALARMS commands allow you to examine system resources to look for conditions that warrant immediate attention and action. The commands available are:
SHOW ALARMS SUMMARY SHOW ALARMS NODE SHOW ALARMS SHELF shelf SHOW ALARMS NFS SHOW ALARMS EVENT LOG SHOW ALARMS ST SHOW ALARMS MEDIA GATEWAY SHOW ALARMS NIF SHOW ALARMS T1 SHOW ALARMS E1 SHOW ALARMS DS3 SHOW ALARMS GATEWAY SIGNALING SHOW ALARMS NTP SERVER SHOW ALARMS SOFTSWITCH SHOW ALARMS TRUNK GROUP SHOW ALARMS ISUP SERVICE SHOW ALARMS ISUP CIRCUIT SHOW ALARMS ISDN SERVICE SHOW ALARMS MGCP MEDIA GATEWAY
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 Alarm X X
Subsystem Node NFS Event Log ST Trunk Group Gateway Signaling NIF T1
3-392
E1 DS3 NTP Server Softswitch ISUP Service ISUP Circuit Media Gateway ISDN Service ISDN BChannel
would suggest examining the NODE and T1 alarms as shown below:

% SHOW ALARMS NODE
Node: TPUBS
Date: 2001/02/13 18:07:31 GMT Zone: GMTMINUS05-EASTERN-US 1 ABSENT Temp
Shelf: B power: Slot Type
% SHOW ALARMS T1
Node: TPUBS
Date: 2001/02/13 18:09:33 GMT Zone: GMTMINUS05-EASTERN-US Status REDALARM REDALARM
Shelf Slot Port Ds3 Ds1 Name 1 3 1 1 7 T1-1-3-1-7 1 3 1 1 8 T1-1-3-1-8
Show Announcements
ShowAnnouncements
The SHOW ANNOUNCEMENTS commands display announcement segment memory usage for the GSX9000. Each CNS server that generates announcements stores announcement segments in local CNS memory. These commands monitor that memorys utilization.
Command Syntax
SHOW ANNOUNCEMENT MEMORY SUMMARY SHOW ANNOUNCEMENT MEMORY SHELF shelfnumber .. SLOT slotnumber STATUS SHOW ANNOUNCEMENT SEGMENT SUMMARY SHOW ANNOUNCEMENT SEGMENT SHELF shelfnumber .. SLOT slotnumber SUMMARY SHOW ANNOUNCEMENT SEGMENT segmentid .. SHELF shelfnumber SLOT slotnumber STATUS SHOW ANNOUNCEMENT SEGMENT segmentid SUMMARY SHOW ANNOUNCEMENT SEGMENT segmentid STATUS
3-393
Command Parameters
TABLE 3 -87.
SHOW ANNOUNCEMENT Parameters

Field Length N/A N/A Description The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. The slot number occupied by the CNS module for which announcement memory is being accessed. This number must be 3-16. The announcement ID used to access the file by the soft switch and to name the .wav file in the GSX System Tree.
segmentid
N/A
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 NumSegs ------4 4 BytesTotal ---------16578560 16578560 BytesUsed TimeTotal --------- --------509952 34:32 509952 34:32 TimeUsed -------1:03 1:03 Util ---3% 3%
Shelf ----1 1
Slot ---7 9
To display the status of memory usage on a CNS module:

% SHOW ANNOUNCEMENT MEMORY SHELF 1 SLOT 7 STATUS
Segments Loaded: 4 Memory Utilization: 3% Segment Memory --------------Total Used Bytes ---------16578560 509952 Min:Sec -------34:32 1:03
To display the file status of all announcement segments that have been loaded:
% SHOW ANNOUNCEMENT SEGMENT SUMMARY
SegId Version Bytes Seconds NFS Path ----- ------- --------- ------- -----------------------------------------1 1 4000 0.5 SPIRIT/announcements/preload/s1.wav 2 1 4000 0.5 SPIRIT/announcements/preload/s2.wav 5 2 480000 60.5 SPIRIT/announcements/preload/s5.wav 32 1 8004 1.0 SPIRIT/announcements/preload/s32.wav
To display the file status of a given announcement:

% SHOW ANNOUNCEMENT SEGMENT 32 STATUS
3-394
Call Counts
Zone: GMTMINUS05-EASTERN-US SegId: Version: NFS Path: Bytes: Seconds: Preload: 32 1 SPIRIT/announcements/preload/s32.wav 8004 1.0 TRUE
Call and Performance Statistics

ShowCallandPerformanceStatistics
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 GSX9000 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.
Command Syntax
SHOW CALL COUNTS ALL SHOW CALL COUNTS SHELF shelfnumber SHOW CALL COUNTS SHELF shelfnumber SLOT slotnumber SHOW CALL SUMMARY ALL SHOW CALL SUMMARY SHELF shelfnumber SHOW CALL SUMMARY SHELF shelfnumber SLOT slotnumber SHOW CALL SUMMARY SHELF shelfnumber .. SLOT slotnumber CALL callnumber SHOW CALL DETAIL GCID gcidtext SHOW CALL DETAIL GCID gcidtext FULL SHOW CALL DETAIL SHELF shelfnumber .. SLOT slotnumber CALLID callnumber SHOW CALL DETAIL SHELF shelfnumber .. SLOT slotnumber CALLID callnumber FULL RESET CALL COUNTS SHELF shelfnumber SLOT slotnumber
Call Counts
3-395
Command Parameters
TABLE 3 -88.
SHOW CALL COUNTS Parameters

Field Length N/A N/A Description The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. The slot number occupied by the CNS module for which call statistics are being accessed. This number must be 3-16. The internal index of the call on the CNS module.This integer, along with the CNS module designation (slotnumber) uniquely identifies the call within the GSX. The Global Call ID string by which every call is tracked throughout its existence. This hex integer is unique within the GSX node.
callnumber
N/A
gcidtext
N/A
Command Example
To reset all call statistics on the CNS module in slot 5 of shelf 1:
% RESET CALL COUNTS SHELF 1 SLOT 5
To display a summary of all calls on the node:

% SHOW CALL SUMMARY ALL
Node: TPUBS Date: 2000/03/02 19:23:33 GMT Zone: GMTMINUS05-EASTERN-US Gcid Shelf Slot CallId State CallingParty CalledParty ---------------------------------------------------20451 1 3 1106 Stable 0000000769 8085551212 20452 1 3 1107 Stable 0000000772 8085551212 20453 1 3 1108 Stable 0000000770 8085551212 20454 1 3 1109 Stable 0000000771 8085551212 20455 1 3 1110 Stable 0000000773 8085551212 20456 1 3 1111 Stable 0000000774 8085551212 20457 1 3 1112 Stable 0000000775 8085551212 . . .
To display a summary of all call counts on the node:

% SHOW CALL COUNTS ALL
Shelf Slot CallAttempts CallCompletions ActiveCalls StableCalls --------------------------------------------------------------1 3 192932 192911 288 288 1 4 192910 192855 288 288 1 5 347361 347229 430 428 1 6 333617 333551 403 398 1 10 24 12 12 12 1 11 72 36 12 12 1 12 56 28 28 28 1 13 56 28 28 28
3-396
Call Counts
To display the call detail summary for an individual call:

% SHOW CALL DETAIL GCID 21E8D
Gcid: Shelf: Slot: Call Id: Scenario: State:
Detailed Call Data 21E8D Calling Party: 9061234567 1 Called Party: 8085551212 3 Call Translation: NONE 8334 Orig Called Party: SS7_TO_ISDN Establishing Ingress Channel Data 3 Local IP Address: N/A 7 Remote IP Address: N/A 12 Dest.GW Name: N/A ss7in Serv. Profile: default Egress Channel Data 11 Local IP Address: 6 Remote IP Address: 14 Dest. GW Name: OUTPRI Serv. Profile:
Slot: Port: Channel: Trunk Group:
N/A N/A N/A default
To display the call detail summary and the GSX software resouce usage summary for an individual call:
% SHOW CALL DETAIL GCID 50011 FULL
Node: TPUBS Date: 2001/02/26 18:35:52 GMT Zone: GMTMINUS05-EASTERN-US Detailed Call Data Calling Party: Called Party: Call Translation: Orig Called Party:
Gcid: 50011 Shelf: 1 Slot: 6 Call Id: 18 Scenario: UNKNOWN State: Stable Call Duration: 0
N/A N/A NONE N/A
seconds Ingress Channel Data Local IP Remote IP Dest. Serv. Egress Channel Data Local IP Remote IP Dest. Serv.
6 20 24 N/A
Address: N/A Address: N/A GW Name: N/A Profile:
N/A N/A N/A N/A
Address: 0.0.0.0 Address: 0.0.0.0 GW Name: N/A Profile:
packets sent: 0 packets received: 0 packets lost: 0 jitter (ms): 0 Index
RTCP Channel Data octets sent: octets received: packets discarded: latency (ms): Call Resource Data Type Shelf Slot Res.
0 0 0 0 Id
Performance Statistics
3-397
----1 2 3 4 5
------------PRES DRESPSTN BRESDSP2DSP DRESSERVICE BRESSW2DSPLOCAL
----1 1 1 1 1
---6 6 6 6 6
------1418 2600 29 3811 26
The SHOW..PERFORMANCE..STATISTICS commands allow you to examine trunk group usage statistics. These statistics are available on a real time (CURRENT) or on a historical (INTERVAL) basis. The GSX9000 maintains four 15-minute intervals of data, so that at any time the previous hours data is available. You may access these statistics through the Element Management System (EMS) to view additional derived statistics. See the Sonus Networks EMS Users Guide for more information. Note The current performance statistics are invalid until the start of the first 15 minute interval whenever the node is initially powered on or a new CNS module is inserted. Additional detail about the displayed statistics is contained in the table below:
Statistic Inbound Usage Outbound Usage Inbound Completed Calls Outbound Completed Calls Inbound Call Attempts Outbound Call Attempts Maximum Active Calls Call Setup Time Calls Setup
Description The sum of call-seconds on every inbound channel in the trunk group. The sum of call-seconds on every outbound channel in the trunk group. The sum of normal call completions (answered calls) on every inbound channel in the trunk group. The sum of normal call completions (answered calls) on every outbound channel in the trunk group. The sum of call initiations on every inbound channel in the trunk group. The sum of call initiations on every outbound channel in the trunk group. The high water mark of active calls in either direction on the trunk group channels. This number cannot exceed the total number of channels in the trunk group. The sum of call-setup time in hundredths of seconds on every channel in the trunk group. The number of calls setup in both directions.
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. The table below provides additional detail about the Failure causes that are displayed.
3-398
Failure Cause No Routes No Resources
Reason Cause Codes assigned to this Count No route to specified transit network, No route to destination. Channel unacceptable, Preemption, Preemption-circuit reserved for reuse, No circuit/channel available, Access information discarded, Requested circuit/channel not available, ANSI: Preemption, Precedence call blocked, "Resource unavailable, unspecified". Facility rejected, Quality of service unavailable, Requested facility not subscribed, ANSI: Call type incompatible with service request, Outgoing call barred within CUG, ANSI: Call blocked due to group restrictions, Incoming calls barred within CUG, Bearer capability not authorized, Bearer capability not presently available, Inconsistency in designated outgoing access information and subscriber class, "Service or option not available, unspecified, Bearer capability not implemented, Channel type not implemented, Requested facility not implemented, Only restricted digital information bearer capability is available, "Service or option not implemented, unspecified", Unallocated number, unassigned number, number changed, ANSI: Unallocated destination number, ITU: Redirect to new destination, ANSI: Unknown business group, Invalid number format (address incomplete), Incompatible destination. ANSI: Exchange routing error, ANSI: Misrouted call to a ported number, ITU: Non-selected user clearing, ANSI: Number portability query on release-number not found, ITU: Destination out of order, Network out of order, Permanent frame mode connection out of service, Temporary failure, Switching equipment congestion. Invalid call reference value, Identified channel does not exist, "A suspended call exists, but this call identity does not", Call identity in use, No call suspended, Call having the requested call identity has been cleared, User not member of CUG, Non-existent CUG, Invalid transit network selection, "Invalid message, unspecified", Mandatory information element is missing, Message type non-existent or not implemented, Message not compatible with call state or message type nonexistent or not implemented, Information element/parameter non-existent or not implemented, Invalid information element contents, Message not compatible with call state, Recovery on time expiry, "Parameter non-existent or not implemented, passed on", "Message with unrecognized parameter, discarded", "Protocol error, unspecified", "Interworking, unspecified". Send special information tone, Call awarded and being delivered in an established channel, No user responding, No answer from user (user alerted), Subscriber absent, Call rejected, Response to STATUS ENQUIRY, "Normal, unspecified", Permanent frame mode connection operational.
Service Unavailable
Invalid Call Attempt
Network Failure
Protocol Error
Unspecified
Command Syntax
SHOW CURRENT PERFORMANCE TRUNK GROUP trunkgrp .. STATISTICS SHOW CURRENT PERFORMANCE TRUNK GROUP ALL STATISTICS SHOW INTERVAL PERFORMANCE TRUNK GROUP trunkgrp ..
3-399
STATISTICS SHOW INTERVAL PERFORMANCE TRUNK GROUP trunkgrp .. INTERVAL interval STATISTICS SHOW INTERVAL PERFORMANCE TRUNK GROUP ALL STATISTICS SHOW CURRENT PERFORMANCE FAILURES .. TRUNK GROUP trunkgrp STATISTICS SHOW CURRENT PERFORMANCE FAILURES .. TRUNK GROUP ALL STATISTICS SHOW INTERVAL PERFORMANCE FAILURES .. TRUNK GROUP trunkgrp INTERVAL interval STATISTICS SHOW INTERVAL PERFORMANCE FAILURES .. TRUNK GROUP trunkgrp STATISTICS SHOW INTERVAL PERFORMANCE FAILURES .. TRUNK GROUP ALL STATISTICS
Command Parameters
TABLE 3 -89.
SHOW PERFORMANCE STATISTICS Parameters

Field Length 1-23 N/A Description The name of the trunk group for which performance statistics are sought. A number that identifies the fifteen minute interval for which performance statistics are sought. The number 1 selects the most recent fifteen minutes, the number 2 selects 2 intervals ago, and so on. You may display up to four previous fifteen minute intervals.
Parameter trunkgrp interval
Command Example
To display the cumulative statistics of all trunk groups:
% SHOW CURRENT PERFORMANCE TRUNK GROUP ALL STATISTICS
Node: VALIANT Date: 2001/02/26 18:39:51 GMT Zone: GMTMINUS05-EASTERN-US CURRENT TRUNK GROUP PERFORMANCE STATISTICS Calls Setup / In / Out In / Out In / Out Maximum Call SetUsage Completed Call Active up Time Local Trunk Name (sec*DS0) Calls Attempts Calls (10ms*DS0) ----------------------- ---------- ---------- ---------- ---------- ---------tstcusin 31213 998 1002 142 465653 0 0 0 995 tstcusout 0 0 0 124 5797 26015 998 994 995 ss7in 0 0 0 0 0 0 0 0 0 ss7out 0 0 0 0 0 0 0 0 0
To display the historical performance statistics of trunk group tstcusin from 2 intervals (or 15-30 minutes) ago:
% SHOW INTERVAL PERFORMANCE ..
3-400
RTCP
TRUNK GROUP tstcusin INTERVAL 2 STATISTICS

Node: TPUBS Date: 2000/07/31 21:36:47 GMT Zone: GMTMINUS05-EASTERN-US INTERVAL TRUNK GROUP PERFORMANCE STATISTICS Call Set- Maximum up Time Active In / Out In / Out (10 ms) / Calls/ In / Out Completed Call Calls Interval Local Trunk Name I Usage(sec) Calls Attempts Setup Valid ----------------------- - ---------- ---------- ---------- ---------- -----tstcusin 2 0 0 0 0 0 0 0 0 0 TRUE
To display the current failure statistics of trunk group ss7out:

% SHOW CURRENT PERFORMANCE FAILURES .. TRUNK GROUP ss7out STATISTICS
Node: TPUBS Date: 2000/07/31 21:16:29 GMT Zone: GMTMINUS05-EASTERN-US CURRENT TRUNK GROUP FAILURE STATISTICS
Local Trunk Group: ss7out In / Out No Routes ---------0 0 In / Out No Resources ---------0 0 In / Out Service Unavail ---------0 0 In / Out Invalid Call Atmpt ---------0 0 In / Out Network Failure ---------0 0 In / Out Protocol Error ---------0 0 In / Out UnSpecified ---------0 0
RTCP 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-394). 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 PSX 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 MGCP softswitch model. RTCP instances running on the CNS modules generate these SNMP traps. Because sudden network disruptions could result in the GSX9000 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.
RTCP
3-401
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 the following table.
Field Name Source IP Dest IP Total Cnt
Definition The source IP address for this IP connection on the PNS module. The destination IP address on the equipment at the far end of this IP connection. The total number of times the configured packet loss threshold was exceeded, or that loss of bearer plane connectivity was detected, on the IP connection since the last time the system was rebooted or the last time the table was RESET. The number of times the GSX9000 detected that the packet loss threshold was exceeded (LOSS TABLE) or that the peer absence threshold was exceeded (ABSENCE TABLE). The time at which the packet loss or peer absence began. The most recent time at which the packet loss or peer absence was detected. Specifies whether or not the IP connection on the associated PNS port is active: TRUE or FALSE. A value of FALSE indicates that the packet loss or peer absence condition has not occurred in the last fifteen seconds. A value of TRUE indicates that the packet loss or peer absence condition is currently occurring. When the condition (loss or absence) becomes active on the connection, the Count is reset to 1 and Start Time and Last Time are updated.
Count
Start Time Last Time Act
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
CONFIGURE RTCP SHELF shelf SRINTERVAL srinterval ESTABLISHMENT MULTIPLE estmultiple CONFIGURE RTCP SHELF shelf TRAP LOSS TABLE ENTRIES lttentries
3-402
RTCP
CONFIGURE RTCP SHELF shelf TRAP ABSENCE TABLE ENTRIES attentries CONFIGURE RTCP SHELF shelf TRAP LOSS TABLE RESET CONFIGURE RTCP SHELF shelf TRAP ABSENCE TABLE RESET SHOW RTCP SHELF shelf ADMIN SHOW RTCP SHELF shelf SLOT cnsslot TRAP LOSS TABLE SHOW RTCP SHELF shelf SLOT cnsslot TRAP ABSENCE TABLE
Command Parameters
TABLE 3 -90.
RTCP Parameters
Field Length N/A N/A Description The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. The slot number occupied by the CNS module for which RTCP statistics are being accessed. This number must be 3-16. 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-241), may be taken. (That is, a trap may be issued and the call may be released.) Must be 2-31, default is 5 (seconds). 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).
Parameter shelf cnsslot
srinterval
N/A
estmultiple
N/A
RTCP
3-403
TABLE 3 -90.
RTCP Parameters
Field Length N/A Description 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 050, 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-241.
Parameter lttentries
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 050, 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-241.
Command Example
To set up RTCP to issue traps whenever packet losses exceed 6000 packets per 100,000 packets, while running with an MGCP soft switch 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 soft switch 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). 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
3-404
RTCP
To initialize the above loss table and absence table:

% CONFIGURE RTCP SHELF 1 TRAP LOSS TABLE RESET % CONFIGURE RTCP SHELF 1 TRAP ABSENCE TABLE RESET
To display the packet loss trap history for the CNS module in slot 10:
% SHOW RTCP SHELF 1 SLOT 10 TRAP LOSS TABLE
Packet loss history on shelf: 1 slot:10

Source IP --------------10.7.10.115 10.7.10.126 Dest IP Total Cnt Cnt Start Time Last Time Act --------------- --------- ------ -------------- ------------- 10.7.10.116 19 4 04-19,16:20:18 04-19,16:20:33 T 10.7.10.199 8 3 04-19,16:20:20 04-19,16:20:30 F
To display the peer absence trap history for the CNS module in slot 10:
% SHOW RTCP SHELF 1 SLOT 10 TRAP ABSENCE TABLE
Packet loss history on shelf: 1 slot:10

Source IP --------------10.7.10.115 10.7.10.126 Dest IP Total Cnt Cnt Start Time Last Time Act --------------- --------- ------ -------------- ------------- 10.7.10.116 19 4 04-19,16:20:18 04-19,16:20:33 T 10.7.10.199 8 3 04-19,16:20:20 04-19,16:20:30 F
To display the RTCP configuration parameters on this shelf:

% SHOW RTCP SHELF 1 ADMIN
-----------------------------------------------------RTCP Configuration: Shelf: 1 -----------------------------------------------------SR interval: 6 Establishment Multiple: 3 Entries in loss history table: 2 Entries in absence history table: 2
ATM Network Interfaces

ATMNetworkInterfaces
These objects identify and configure the GSX9000 for connecting through an ATM network. 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 ATM network, are properly connected and configured. Then, to build an infrastructure of CLI objects that will process calls between two GSXs, you must:
1. 2. 3.
Create and configure the PNS20/PNA21 module set (CREATE SERVER ..) that will transmit and receive ATM cells over the PNA21 SONET port Configure the SONET Interface that is automatically created by the previous step Configure an ATM Interface (or accept the Sonus defaults for this object and skip this step)
SONET Interface
3-405
4. 5.
Create (if necessary) and configure a PNS20 Network Interface on the SONET port, as explained in PNS20 Network Interface (IP over ATM NIF) on page 3-75 Create and configure an ATM Traffic Descriptor as the first step toward defining the Permanent Virtual Connection (PVC) to the second GSX through the ATM network Create and configure an ATM PVC to the second GSX through the ATM network Create and configure a binding between the IP over ATM NIF and the ATM PVC, created in Steps 4 and 6 Perform the above steps on the second GSX
6. 7. 8.
The object descriptions that follow provide additional detail for each of these steps.
SONET Interface
This object specifies the SONET port on a PNA21 or a CNA33. This object is automatically created when a PNS20/PNA21, or 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 PNA21s, the default name of the SONET port 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 PNA21). For example, SONET-1-5-1 identifies the SONET port on the PNS20/PNA21 modules residing in slot 5 on shelf 1. 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 leftmost) server slot in the triplicate, and ptn is the port number. The CNA33 behind the originating slot (the rightmost 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 PNA21 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:
3-406
SONET Interface
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. The rules for changing operational states are:
Changing to (operational state) inservice outofservice Affirm the prompt query. No new calls on the SONET Interface path 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 SONET Interface path is in operational state outofservice and its administrative state may be disabled. Once disabled, the SONET Interface path may be configured.
outofservice
Make sure that the corresponding path of the OC-3 or OC-12 link is ready for general usage. Change administrative state to enabled. Change operational state to inservice.
Note
When you place a PNA21 SONET Interface (OC-12) into service, or out of service, use the command form that acts on a specific SONET port; do not use the form that acts on a specific path within a SONET port.
Command Syntax
Note The commands below act on a specified SONET port.
CONFIGURE SONET INTERFACE sonetifname .. STATE admin-state CONFIGURE SONET INTERFACE sonetifname .. STATE enabled PATHOVERRIDE pathovstate CONFIGURE SONET INTERFACE sonetifname .. MODE INSERVICE PATHOVERRIDE pathovstate CONFIGURE SONET INTERFACE sonetifname .. MODE OUTOFSERVICE
SONET Interface
3-407
CONFIGURE SONET INTERFACE sonetifname .. MODE OUTOFSERVICE ACTION action CONFIGURE SONET INTERFACE sonetifname .. MODE OUTOFSERVICE ACTION action TIMEOUT timeout CONFIGURE SONET INTERFACE sonetifname .. LOOPBACK loopback CONFIGURE SONET INTERFACE sonetifname .. NAME newsonetifname CONFIGURE SONET INTERFACE sonetifname .. INITIALIZE STATISTICS NEAREND FIFTEENMIN CONFIGURE SONET INTERFACE sonetifname .. INITIALIZE STATISTICS NEAREND DAY CONFIGURE SONET INTERFACE sonetifname .. INITIALIZE STATISTICS FAREND FIFTEENMIN CONFIGURE SONET INTERFACE sonetifname .. INITIALIZE STATISTICS FAREND DAY CONFIGURE SONET INTERFACE sonetifname .. FIBEROPTIC LASER folaser CONFIGURE SONET INTERFACE sonetifname SCRAMBLE .. STS TRANSMIT scramble CONFIGURE SONET INTERFACE sonetifname SCRAMBLE .. STS RECEIVE scramble CONFIGURE SONET INTERFACE sonetifname SCRAMBLE .. ATM TRANSMIT scramble CONFIGURE SONET INTERFACE sonetifname SCRAMBLE .. ATM RECEIVE scramble CONFIGURE SONET INTERFACE sonetifname .. THRESHOLD CV-S FIFTEENMIN fifteenmin CONFIGURE SONET INTERFACE sonetifname .. THRESHOLD CV-S DAY day CONFIGURE SONET INTERFACE sonetifname .. THRESHOLD ES-S FIFTEENMIN fifteenmin CONFIGURE SONET INTERFACE sonetifname .. THRESHOLD ES-S DAY day CONFIGURE SONET INTERFACE sonetifname .. THRESHOLD SES-S FIFTEENMIN fifteenmin CONFIGURE SONET INTERFACE sonetifname .. THRESHOLD SES-S DAY day CONFIGURE SONET INTERFACE sonetifname .. THRESHOLD SEFS-S FIFTEENMIN fifteenmin CONFIGURE SONET INTERFACE sonetifname .. THRESHOLD SEFS-S DAY day
3-408
SONET Interface
CONFIGURE SONET INTERFACE sonetifname .. THRESHOLD CV-L FIFTEENMIN fifteenmin CONFIGURE SONET INTERFACE sonetifname .. THRESHOLD CV-L DAY day CONFIGURE SONET INTERFACE sonetifname .. THRESHOLD ES-L FIFTEENMIN fifteenmin CONFIGURE SONET INTERFACE sonetifname .. THRESHOLD ES-L DAY day CONFIGURE SONET INTERFACE sonetifname .. THRESHOLD SES-L FIFTEENMIN fifteenmin CONFIGURE SONET INTERFACE sonetifname .. THRESHOLD SES-L DAY day CONFIGURE SONET INTERFACE sonetifname .. THRESHOLD UAS-L FIFTEENMIN fifteenmin CONFIGURE SONET INTERFACE sonetifname .. THRESHOLD UAS-L DAY day
Note
The commands below act on a specified path within a SONET port.
CONFIGURE SONET INTERFACE sonetifname PATH pathnum .. STATE path-admin-state CONFIGURE SONET INTERFACE sonetifname PATH pathnum .. STATE path-admin-state DS3OVERRIDE ds3ovstate CONFIGURE SONET INTERFACE sonetifname PATH pathnum .. MODE oper-state CONFIGURE SONET INTERFACE sonetifname PATH pathnum .. MODE INSERVICE DS3OVERRIDE ds3ovstate CONFIGURE SONET INTERFACE sonetifname PATH pathnum .. MODE OUTOFSERVICE ACTION action CONFIGURE SONET INTERFACE sonetifname PATH pathnum .. MODE OUTOFSERVICE ACTION action TIMEOUT timeout CONFIGURE SONET INTERFACE sonetifname PATH pathnum .. INITIALIZE STATISTICS NEAREND FIFTEENMIN CONFIGURE SONET INTERFACE sonetifname PATH pathnum .. INITIALIZE STATISTICS NEAREND DAY CONFIGURE SONET INTERFACE sonetifname PATH pathnum .. INITIALIZE STATISTICS FAREND FIFTEENMIN CONFIGURE SONET INTERFACE sonetifname PATH pathnum .. INITIALIZE STATISTICS FAREND DAY CONFIGURE SONET INTERFACE sonetifname PATH pathnum .. THRESHOLD CV-P FIFTEENMIN fifteenmin
SONET Interface
3-409
CONFIGURE SONET INTERFACE sonetifname PATH pathnum .. THRESHOLD CV-P DAY day CONFIGURE SONET INTERFACE sonetifname PATH pathnum .. THRESHOLD ES-P FIFTEENMIN fifteenmin CONFIGURE SONET INTERFACE sonetifname PATH pathnum .. THRESHOLD ES-P DAY day CONFIGURE SONET INTERFACE sonetifname PATH pathnum .. THRESHOLD SES-P FIFTEENMIN fifteenmin CONFIGURE SONET INTERFACE sonetifname PATH pathnum .. THRESHOLD SES-P DAY day CONFIGURE SONET INTERFACE sonetifname PATH pathnum .. THRESHOLD UAS-P FIFTEENMIN fifteenmin CONFIGURE SONET INTERFACE sonetifname PATH pathnum .. THRESHOLD UAS-P DAY day CONFIGURE SONET INTERFACE sonetifname PATH pathnum .. TRACE trace-state CONFIGURE SONET INTERFACE sonetifname PATH pathnum .. TRACE TRANSMIT MSG transmit-msg CONFIGURE SONET INTERFACE sonetifname PATH pathnum .. TRACE EXPECTED MSG expected-msg CONFIGURE SONET INTERFACE sonetifname PATH pathnum .. RDI MODE rdimode SHOW SONET INTERFACE sonetifname ADMIN SHOW SONET INTERFACE ALL ADMIN SHOW SONET INTERFACE sonetifname PATH pathnum ADMIN SHOW SONET INTERFACE sonetifname PATH pathnum .. STATISTICS CURRENT FIFTEENMIN SHOW SONET INTERFACE sonetifname PATH pathnum .. STATISTICS CURRENT DAY SHOW SONET INTERFACE sonetifname STATUS SHOW SONET INTERFACE ALL STATUS SHOW SONET INTERFACE sonetifname STATISTICS .. CURRENT FIFTEENMIN SHOW SONET INTERFACE sonetifname STATISTICS .. CURRENT DAY SHOW SONET INTERFACE sonetifname STATISTICS .. PREVIOUS INTERVAL interval FIFTEENMIN SHOW SONET INTERFACE sonetifname STATISTICS .. PREVIOUS INTERVAL interval DAY SHOW SONET INTERFACE sonetifname PATH pathnum .. STATISTICS PREVIOUS INTERVAL interval FIFTEENMIN SHOW SONET INTERFACE sonetifname PATH pathnum .. STATISTICS PREVIOUS INTERVAL interval DAY
3-410
SONET Interface
SHOW SONET INTERFACE ALL STATISTICS .. CURRENT FIFTEENMIN SHOW SONET INTERFACE ALL STATISTICS CURRENT DAY SHOW SONET INTERFACE sonetifname ALL STATISTICS .. PREVIOUS FIFTEENMIN SHOW SONET INTERFACE sonetifname ALL STATISTICS .. PREVIOUS DAY
SONET Interface
3-411
Command Parameters
TABLE 3 -91.
SONET INTERFACE Parameters

Field Length 1-23 Description The name of the SONET port on the PNA21. This name is assigned automatically when the PNS20/PNA21 module set is configured via CREATE SERVER. The default value of this string is
Parameter sonetifname
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 PNA21), 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 - 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 - 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. 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.)
3-412
SONET Interface
TABLE 3 -91.

Field Length 1-23 Description A new name for the SONET port on the PNA21 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 PNS20/PNA21 module set is configured via CREATE SERVER, if it is performed at all. Controls whether the fiber-optic laser is on or off: on off
Parameter newsonetifname
folaser
N/A
scramble
N/A
Specifies whether to scramble the SONET layer (STS) or the ATM payload in the TRANSMIT or RECEIVE direction: disabled - scrambling inhibited enabled - scrambling is performed SONET layer scrambling is a requirement of Bellcore GR-253-CORE and ATM payload scrambling is a requirement of the ATM UNI specification. 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
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
SONET Interface
3-413
TABLE 3 -91.

Field Length N/A Description A channel number within this SONET Interface. For the PNA21 SONET Interface (OC-12), this value must always be one and the path must be specified, enabled, and put into service. (Except for those command arguments, noted above, that are invalid on 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.
Parameter pathnum
path-adminstate
N/A
The administrative state of this path of this SONET Interface: disabled - Not activated, able to be configured. enabled - Active. Not able to be configured.
ds3ovstate
Controls whether the oper-state and adminstate of the DS3 specified by pathnum are modified when the oper-state and path-adminstate are modified: disabled - 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 - 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.
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.
3-414
SONET Interface
TABLE 3 -91.

Field Length N/A Description The desired type of SONETport Path Remote Defect Indication to use: normal - use one-bit RDI-P signaling using bit 5 of G1. enhanced - 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.
Parameter rdimode
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. The operational state of the SONET Interface or the SONET Interface path: INSERVICE - This state is set by default when admin-state is enabled. OUTOFSERVICE - Set this state before changing admin-state to disabled.
oper-state
N/A
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 - 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.
Command Example
To put path 1 (the only path) of the SONET Interface on the PNS20/PNA21 module set in slot 5 of shelf 1 into service in a non-redundant environment:
% CREATE SERVER SHELF 1 SLOT 5 HWTYPE pns20 .. ADAPTER pna21 normal % CONFIGURE SERVER SHELF 1 SLOT 5 STATE enabled % CONFIGURE SERVER SHELF 1 SLOT 5 MODE inService % CONFIGURE SONET INTERFACE SONET-1-5-1 STATE enabled % CONFIGURE SONET INTERFACE SONET-1-5-1 PATH 1.. STATE enabled
To display the configuration of all SONET Interfaces (in this case, a pair of interfaces supporting a CNS30-triplicate whose leftmost slot is 3):
% SHOW SONET INTERFACE ALL ADMIN
SONET Interface
3-415
Node: TPUBS
-----------------------------------------------------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 -----------------------------------------------------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
To display the status of all SONET Interfaces:

% SHOW SONET INTERFACE ALL STATUS
3-416
ATM Interface
Node: TPUBS
-----------------------------------------------------Shelf: 1 Slot: 3 Port: 1 -----------------------------------------------------SONET Interface Status -----------------------------------------------------Circuit Identifier: SONET-1-3-1 IfIndex: 36 Operational Status: UP Time Elapsed: 567 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 Time Elapsed: Valid Intervals: Invalid Intervals: 567 1 31
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
-----------------------------------------------------------------------------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
ATM Interface
This object specifies the ATM Interface limits to be supported on this SONET Interface.
ATM Interface
3-417
You must configure this object before you configure any Permanent Virtual Connections (PVCs), or other objects that use Virtual Channel Connections. If the default limit values shown below are satisfactory, you need not configure this object.
Command Syntax
CONFIGURE ATM INTERFACE SHELF shelfnumber .. SLOT slotnumber PORT portnumber MAXIMUM NUMBER OF VCCS vccsmax MAXIMUM NUMBER OF VPI BITS vpiflngth MAXIMUM NUMBER OF VCI BITS vciflngth NEIGHBOR NAME neighborname SHOW ATM INTERFACE SHELF shelfnumber ADMIN SHOW ATM INTERFACE SHELF shelfnumber .. SLOT slotnumber ADMIN SHOW ATM INTERFACE SHELF shelfnumber .. SLOT slotnumber PORT portnumber ADMIN SHOW ATM INTERFACE SHELF ALL ADMIN SHOW ATM INTERFACE SHELF shelfnumber STATISTICS SHOW ATM INTERFACE SHELF shelfnumber .. SLOT slotnumber STATISTICS SHOW ATM INTERFACE SHELF shelfnumber .. SLOT slotnumber PORT portnumber STATISTICS SHOW ATM INTERFACE SHELF ALL STATISTICS
3-418
ATM Interface
Command Parameters
TABLE 3 -92.
ATM INTERFACE Parameters

Field Length N/A N/A Description The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. The slot number occupied by the PNS20/PNA21 module pair associated with the SONET port that you are configuring or displaying. Must be 3-16. The port number on the PNA21 adapter module that you are configuring or displaying. Must be 1 (on a PNA21). The maximum number of Virtual Channel Connections (VCCs) permitted on this SONET Interface. This is the maximum number of PVCs (Permanent Virtual Connections) permitted. Must be 0-496. The maximum number of bits permitted in the Virtual Path Identifier (VPI) field. Must be 0-8, default is 8. The maximum number of bits permitted in the Virtual Channel Identifier (VCI) field. Must be 0-10, default is 10. The textual name of the interface on the neighbor system on the far end of this interface, to which this interface connects.
portnumber
N/A
vccsmax
N/A
vpiflngth
N/A
vciflngth
N/A
neighborname
1-255
Command Example
To limit the number of PVCs to 100, VPI field length to 4, and VCI field length to 8 on the SONET Interface in slot 5:
% CONFIGURE ATM INTERFACE SHELF 1 SLOT 5 PORT 1 .. MAXIMUM NUMBER OF VCCS 100 MAXIMUM NUMBER OF VPI BITS 4 MAXIMUM NUMBER OF VCI BITS 8
To display all ATM Interface configurations:

% SHOW ATM INTERFACE ALL ADMIN
Max Max Max VPI VCI shelf slot port ifIndex VCCS Bits Bits ----- ---- ---- -------- ----- ---- ---1 5 1 40 100 4 8 To display the statistics of all ATM Interfaces: % SHOW ATM INTERFACE ALL STATISTICS Node: TPUBS Date: 2000/03/30 22:16:08 GMT Zone: GMTMINUS05-EASTERN-US Curr Curr VPI VCI
Conf
ATM Traffic Descriptor
3-419
shelf slot port ifIndex VCCS Bits Bits ----- ---- ---- -------- ----- ---- ---1 5 1 40 1 4 8
ATM Traffic Descriptor

This object specifies the traffic characteristics that will be taken by a Permanent Virtual Connection (PVC) to another GSX. In particular, a bandwidth is specified via the Peak Cell Rate parameter of this object. This bandwidth must be matched in the corresponding PVC on the connected GSX. Note If an ATM Traffic Descriptor is in use in an existing PVC, you may neither change its Peak Cell Rate nor delete it.
Command Syntax
CREATE ATM TRAFFIC DESCRIPTOR atmtdi CONFIGURE ATM TRAFFIC DESCRIPTOR atmtdi PCR pcrate SHOW ATM TRAFFIC DESCRIPTOR INDEX atmtdi ADMIN SHOW ATM TRAFFIC DESCRIPTOR ALL ADMIN DELETE ATM TRAFFIC DESCRIPTOR atmtdi
Command Parameters
TABLE 3 -93.
ATM TRAFFIC DESCRIPTOR Parameters

Field Length N/A Description The number of the ATM Traffic Descriptor being configured. This number indexes this ATM Traffic Descriptor in the ATM Traffic Descriptor Parameter Table. Must be 1-100. The maximum number of ATM cells per second that may be transmitted on a PVC using this ATM Traffic Descriptor. This value must be the same at: this PVC endpoint (on this GSX) the ATM switch(es) on this PVC the remote PVC endpoint (on the remote GSX) Unequal settings may cause loss of call data and eventually dropped calls.
Parameter atmtdi
pcrate
N/A
Command Example
To create an ATM Traffic Descriptor with a Peak Cell Rate of 20000 cells per second, as the third entry in the ATM Traffic Descriptor Parameter Table:
% CREATE ATM TRAFFIC DESCRIPTOR 3 % CONFIGURE ATM TRAFFIC DESCRIPTOR 3 PCR 20000
3-420
ATM Permanent Virtual Connection
To display the ATM Traffic Descriptor Parameter Table:

% SHOW ATM TRAFFIC DESCRIPTOR ALL ADMIN
Node: TPUBS Date: 2000/03/24 19:27:00 GMT Zone: GMTMINUS05-EASTERN-US Frame Discard -------TRUE TRUE TRUE Peek Cell Rate ---------300000 300000 20000 Row Status -------ACTIVE ACTIVE ACTIVE
Index ----1 2 3
Service Category -------CBR CBR CBR

This object specifies the ATM Permanent Virtual Connection (PVC) that will provide a logical circuit to another GSX through an ATM network. Each PVC in the ATM network must be specified by each endpoint GSX. The GSX physical endpoint and the bandwidth (declared in the ATM Traffic Descriptor on page 3-419) are also specified via this object. The PVC is established by specifying a unique Virtual Path Identifier (VPI)/Virtual Channel Identifier (VCI) combination that will be used between the GSX and the ATM switch. The VPI/VCI values will be present in the header of each ATM cell that is transmitted, by either device. To fully establish the GSX to GSX circuit, you also need to:
1. 2.
Create a similar PVC between the ATM switch and the second GSX, using another unique VPI/VCI combination. Configure a pair of cross connections in the ATM switch that allow the switch to connect the two PVCs, in both directions.
Note
The discussion above assumes dual GSXs, connected by a single ATM switch. Extend this model as necessary for more complex ATM networks.
Command Syntax
CREATE ATM PVC SHELF shelfnumber SLOT slotnumber .. PORT portnumber VPI vpinumber VCI vcinumber RX QOS tdi TX QOS tdi CONFIGURE ATM PVC SHELF shelfnumber .. SLOT slotnumber PORT portnumber VPI vpinumber VCI vcinumber RX QOS tdi TX QOS tdi SHOW ATM PVC SHELF shelfnumber ADMIN SHOW ATM PVC SHELF shelfnumber SLOT slotnumber ADMIN SHOW ATM PVC SHELF shelfnumber SLOT slotnumber .. PORT portnumber ADMIN SHOW ATM PVC SHELF shelfnumber SLOT slotnumber .. PORT portnumber VPI vpinumber ADMIN SHOW ATM PVC SHELF shelfnumber SLOT slotnumber .. PORT portnumber VPI vpinumber VCI vcinumber ADMIN
3-421
SHOW ATM PVC SHELF ALL ADMIN SHOW ATM PVC SHELF shelfnumber STATUS SHOW ATM PVC SHELF shelfnumber SLOT slotnumber STATUS SHOW ATM PVC SHELF shelfnumber SLOT slotnumber .. PORT portnumber STATUS SHOW ATM PVC SHELF shelfnumber SLOT slotnumber .. PORT portnumber VPI vpinumber STATUS SHOW ATM PVC SHELF shelfnumber SLOT slotnumber .. PORT portnumber VPI vpinumber VCI vcinumber STATUS SHOW ATM PVC SHELF ALL STATUS DELETE ATM PVC SHELF shelfnumber SLOT slotnumber .. PORT portnumber VPI vpinumber VCI vcinumber
3-422
Command Parameters
TABLE 3 -94.
ATM PVC Parameters

Field Length N/A N/A Description The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. The slot number occupied by the PNS20/PNA21 module pair that drives the PVC that you are configuring or displaying. Must be 3-16. The port number on the PNA21 adapter module that is the physical endpoint of the PVC that you are configuring or displaying. Must be 1 (on a PNA21). The value of the Virtual Path Identifier field in the ATM Cell header. The range of valid values is established by the length of the field specified by the VPI BITS parameter of the ATM INTERFACE. The default is length 8, allowing values (0-255). Must equal the value specified by the ATM switch that is connected via this PVC. The value of the Virtual Channel Identifier field in the ATM Cell header. The range of valid values is established by the length of the field specified by the VCI BITS parameter of the ATM INTERFACE. The default is length 10, allowing values 0-1023. Must equal the value specified by the ATM switch that is connected via this PVC. This number indexes an ATM Traffic Descriptor in the ATM Traffic Descriptor Parameter Table. This ATM Traffic Descriptor defines the bandwidth for this PVC through its Peak Cell Rate parameter. This ATM Traffic Descriptor is installed in the PVC through the transmit/receive Quality of Service (QOS) parameter. The RX QOS tdi value should equal the TX QOS value.
portnumber
N/A
vpinumber
N/A
vcinumber
N/A
tdi
N/A
Command Example
To create a PVC that is driven by the PNS20/PNA21 modules in slot 6, that uses a VPI/VCI combination of 0/32, and uses the bandwidth that is specified in the ATM Traffic Descriptor that resides in the third entry of the ATM Traffic Descriptor Parameter Table:
% CREATE ATM PVC SHELF 1 SLOT 6 PORT 1 VPI 0 VCI 32 .. RX QOS 3 TX QOS 3
To display the configuration of all PVCs defined on this GSX:

% SHOW ATM PVC ALL ADMIN
TXTD RXTD Connection Row shelf slot port ifIndex VPI VCI Index Index Kind ---------------------------------------------------1 4 1 40 1 200 1 1 PVC
Status ACTIVE
ATM-Extension Virtual Connection Network Interface (NIF)
3-423
48
201
PVC
ACTIVE

This object binds the Permanent Virtual Connection (PVC) to the IP over ATM Network Interface. When this binding is established at each GSX at each end of a PVC, that PVC may be used to transmit call data. This object must first be created, and then configured by enabling the binding. The Virtual Path Identifier (VPI)/Virtual Channel Identifier (VCI) combination that established the PVC that is being bound must be specified to this object. When the NIF is associated with the unique PVC (VPI/VCI), and enabled, the connection is ready to be used to transmit active call data. This binding may be placed into and taken out of service as explained below: The binding is always in one of two administrative states:
enabled disabled
The binding is always in one of two operational states:

Note
inService - in use, not able to be configured. outOfService - not available, not in use, able to be configured.
You may change the operational state of the ATM extension VC only when the underlying IP over ATM NIF is in service. You may change the administrative state of the ATM extension VC only when the IP over ATM NIF is enabled. The rules for changing operational states are:
3-424
inservice inservice
-
outofservice
Affirm the prompt query. No new calls on this PVC/NIF 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 PVC/NIF is in operational state outofservice and its administrative state may be disabled. Once disabled, this binding may be deleted.
outofservice
Make sure the PVC/NIF is ready for general usage. Change administrative state to enabled. Change operational state to inservice.
Note
When you configure an ATM extension VCs operational state to outofservice, you must also place the corresponding VC in the remote GSX out of service. If you place the VC out of service on one GSX but not on the other, then calls may be attempted on the end that is in service that will fail at the end that is out of service. Alternatively, you may configure the administrative state of the ATM extension VC to disabled after you take it out of service. This will prevent the initiation of calls on that VC at the remote GSX.
Command Syntax
CREATE ATM EXT VC NIF nifname VPI vpi VCI vci CONFIGURE ATM EXT VC NIF nifname VPI vpi VCI vci .. MODE oper-state ACTION teardownmode CONFIGURE ATM EXT VC NIF nifname VPI vpi VCI vci .. MODE oper-state ACTION teardownmode TIMEOUT teardowntime DEVIATION deviation CONTINGENCY contingency
3-425
CONFIGURE ATM EXT VC NIF nifname VPI vpi VCI vci .. STATE admin-state SHOW ATM EXT VC NIF nifname VPI vpi VCI vci ADMIN SHOW ATM EXT VC NIF nifname ADMIN SHOW ATM EXT VC SHELF shelfnumber SLOT slotnumber .. PORT pna21port ADMIN SHOW ATM EXT VC ALL ADMIN DELETE ATM EXT VC NIF nifname VPI vpi VCI vci
3-426
Command Parameters
TABLE 3 -95.
ATM-EXTENSION VIRTUAL CONNECTION NIF Parameters

Field Length 1-23 Description The name of the NIF that you are binding to a PVC. This is either the automatically generated SONET NIF, discussed in PNS20 Network Interface (IP over ATM NIF) on page 3-75, or another NIF of TYPE ipoveratm that was created on that SONET port. The value of the Virtual Path Identifier field in the PVC to which this NIF is being bound. The range of valid values is established by the length of the field specified by the VPI BITS parameter of the ATM INTERFACE. The default is length 8, allowing values (0-255). Must equal the value specified in the corresponding PVC. The value of the Virtual Channel Identifier field in the PVC to which this NIF is being bound. The range of valid values is established by the length of the field specified by the VCI BITS parameter of the ATM INTERFACE. The default is length 10, allowing values 0-1023. Must equal the value specified in the corresponding PVC. The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. The slot number occupied by the PNS20/PNA21 module pair that drives the PVC binding that you are displaying. Must be 3-16. The port number on the PNA21 adapter module that is the physical endpoint of a PVC binding that you are displaying. Must be 1 (on a PNA21). The operational state of the binding: INSERVICE - This state is set by default when admin-state is enabled. OUTOFSERVICE - Set this state before changing admin-state to disabled.
Parameter nifname
vpi
N/A
vci
N/A
shelfnumber slotnumber
N/A N/A
pna21port
N/A
oper-state
N/A
teardownmode
N/A
The method by which calls are torn down when
oper-state goes to outofservice:

dryup - 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 operstate is outofservice and teardownmode is dryup. Must be 1-1440, default is 60.
3-427
TABLE 3 -95.
ATM-EXTENSION VIRTUAL CONNECTION NIF Parameters

Field Length N/A Description The percentage of overall NIF 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. 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 status for actual/expected bandwidths.
Parameter deviation
contingency
N/A
The percentage of the overall NIF bandwidth that is reserved for contigency. If actual bandwidth is greater than the expected bandwdith and less than the overall NIF bandwidth minus contingency amount, calls will still be accepted. Must be 0-100, default is 0. See the NIF status for actual/expected bandwidths. The administrative state of the PVC/NIF binding: disabled - in this state the binding is inactive. enabled - in this state the binding is active.
admin-state
N/A
Command Example
To create and configure a PVC/NIF binding between NIF nif10 and the PVC defined by the VPI/VCI combination of 0/32:
% CREATE ATM EXT VC NIF nif10 VPI 0 VCI 32 % CONFIGURE ATM EXT VC NIF nif10 VPI 0 VCI 32 .. STATE enabled
To display the configuration of all PVC/NIF bindings defined on this GSX:

% SHOW ATM EXT VC ALL ADMIN
Node: TPUBS Date: 2000/05/12 23:16:29 GMT Zone: GMTMINUS05-EASTERN-US vci state mode ------ -------104 ENABLED IS 108 ENABLED IS 109 ENABLED IS 110 ENABLED IS action timeout -------DRYUP 60 DRYUP 60 DRYUP 60 DRYUP 60
loc ---1-12 1-12 1-12 1-12
port ifIndex vpi name ---- ---------- ---1 11 0 IPOA-1-12-1-1 1 11 0 IPOA-1-12-1-1 1 11 0 IPOA-1-12-1-1 1 11 0 IPOA-1-12-1-1
To display the status of all PVC/NIF bindings defined on this GSX:
3-428
ATM Operations and Maintenance (OAM)
% SHOW ATM EXT VC ALL STATUS

Node: TPUBS Date: 2000/05/12 23:20:10 GMT Zone: GMTMINUS05-EASTERN-US vci state #calls cur bw (bytes/sec) oos reason max bw (bytes/sec) ------ ---------- -------- ----------------104 IS 15 238500 N/A 15900000 108 IS 34 540600 N/A 15900000 109 IS 11 174900 N/A 15900000 110 IS 70 1113000 N/A 15900000
loc ---1-12 1-12 1-12 1-12
port ifIndex vpi name ---- --------- ---1 11 0 IPOA-1-12-1-1 1 11 0 IPOA-1-12-1-1 1 11 0 IPOA-1-12-1-1 1 11 0 IPOA-1-12-1-1

This object provides a means of performing different forms of loopbacks on the SONET Interface and displaying the results of those loopbacks.
Command Syntax
CONFIGURE ATM OAM SHELF shelfnumber .. SLOT slotnumber PORT portnumber VPI vpi VCI vci F5 LOOPBACK ENABLE lb_state F5 LOOPBACK TYPE lb_type F5 LOOPBACK TIMER lb_time SHOW ATM OAM F5 SHELF shelfnumber ADMIN SHOW ATM OAM F5 SHELF shelfnumber .. SLOT slotnumber ADMIN SHOW ATM OAM F5 SHELF shelfnumber .. SLOT slotnumber PORT portnumber ADMIN SHOW ATM OAM F5 SHELF shelfnumber .. SLOT slotnumber PORT portnumber VPI vpi ADMIN SHOW ATM OAM F5 SHELF shelfnumber .. SLOT slotnumber PORT portnumber .. VPI vpi VCI vci ADMIN SHOW ATM OAM F5 SHELF ALL ADMIN SHOW ATM OAM F5 SHELF shelfnumber STAT SHOW ATM OAM F5 SHELF shelfnumber .. SLOT slotnumber STAT SHOW ATM OAM F5 SHELF shelfnumber .. SLOT slotnumber PORT portnumber STAT SHOW ATM OAM F5 SHELF shelfnumber .. SLOT slotnumber PORT portnumber VPI vpi STAT SHOW ATM OAM F5 SHELF shelfnumber ..
3-429
SLOT slotnumber PORT portnumber .. VPI vpi VCI vci STAT SHOW ATM OAM F5 SHELF ALL STAT
Command Parameters
TABLE 3 -96.
ATM OAM Parameters

Field Length N/A N/A Description The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. The slot number occupied by the PNS20/PNA21 module pair associated with the SONET port that you are configuring or displaying. Must be 3-16. The port number on the PNA21 adapter module that you are configuring or displaying. Must be 1 (on a PNA21). The value of the Virtual Path Identifier field in the PVC (Permanent Virtual Connection) on which you wish to issue or display loopback. Must equal the value specified in that PVC. The value of the Virtual Channel Identifier field in the PVC on which you wish to issue or display loopback. Must equal the value specified in that PVC. The state of the loopback facility on the specified PVC on the specified SONET Interface: disabled - no loopback is performed. enabled - loopback is performed on the SONET Interface according to the lb_type and lb_time settings.
portnumber
N/A
vpi
N/A
vci
N/A
lb_state
N/A
lb_type
N/A
The type of loopback to be performed on this PVC: end2end - the loopback cell is sent to the GSX at the other end of the circuit and looped back from there. uni - the loopback cell is detected and returned by the SONET Interface on this GSX.
lb_time
N/A
The interval at which loopback cells are issued on the SONET Interface. This number must be 1-20 (seconds), default is 10.
Command Example
To enable end-to-end loopback at 15 second intervals on the PVC defined by the VPI/VCI combination of 0/32 on the SONET Interface in slot 5:
% CONFIGURE ATM OAM SHELF 1 SLOT 5 PORT 1 .. VPI 0 VCI 32 F5 LOOPBACK ENABLE enabled F5 LOOPBACK TYPE end2end F5 LOOPBACK TIMER 15
To display all OAM loopback configurations:
3-430
ATM Transmission Convergence Sublayer
% SHOW ATM OAM F5 ALL ADMIN

Node: TPUBS Date: 2000/03/30 23:19:42 GMT Zone: GMTMINUS05-EASTERN-US Loop Type ------END2END Loop Timer ----10
Loop shelf slot port ifIndex VPI VCI Enable ----- ---- ---- -------- --- ----- ------1 4 1 40 1 200 DISABLE
To display the status of all OAM loopback configurations:

% SHOW ATM OAM F5 ALL STAT
Node: TPUBS Date: 2000/03/30 23:23:15 GMT Zone: GMTMINUS05-EASTERN-US Receive Errored Receive Cells UNI / End-End ---------0 0
End-End Loopback Cells Transmit/ shelf slot port ifIndex VPI VCI Receive ----- ---- ---- -------- --- ----- ---------1 4 1 40 1 200 0 0
UNI Loopback Cells Transmit/ Receive ---------0 0
AIS Cells/ Transmit RDI Cells/ Receive RDI Cells -------0 0 0
With loopback enabled, a properly functioning ATM will display incrementing Transmit cells and if the PVC is working, correspondingly incrementing Receive cells. If the the Receive cells are not incrementing, something in the loop is malfunctioning.
ATM Transmission Convergence Sublayer

This object allows you to inspect the ATM Transmission Convergence (TC) Sublayer on each ATM port. An Out of Cell Delineation event indicates that seven consecutive ATM cells have Header Error Control violations. A high number of these events may indicate a problem with the TC Sublayer. An Alarm State of LCDFAILURE indicates that the TC Sublayer is in the Loss of Cell Delineation (LCD) defect maintenance state. NOALARM indicates that the TC Sublayer is not in the LCD state.
Command Syntax
SHOW ATM TRANSMISSION CONVERGENCE .. SHELF shelf STATISTICS SHOW ATM TRANSMISSION CONVERGENCE .. SHELF shelf SLOT slot STATISTICS SHOW ATM TRANSMISSION CONVERGENCE .. SHELF shelf SLOT slot PORT port STATISTICS SHOW ATM TRANSMISSION CONVERGENCE ALL STATISTICS
AAL5 Shelf Statistics
3-431
Command Parameters
TABLE 3 -97.
ATM TRANSMISSION CONVERGENCE Parameters

Field Length N/A N/A Description The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. The slot number occupied by the PNS20/PNA21 module pair associated with the SONET port that you are displaying. Must be 3-16. The port number on the PNA21 adapter module that is the physical endpoint of the PVC that you are displaying. Must be 1 (on a PNA21).
port
N/A
Command Example
To display the ATM TC Sublayer statistics on all the PNA21 ports in the GSX:
% SHOW ATM TRANSMISSION CONVERGENCE ALL STATISTICS
Node: TPUBS Date: 2001/05/01 17:04:39 GMT Zone: GMTMINUS05-EASTERN-US Out of Cell Delineation ----------44 1 N/A Alarm State ---------NOALARM LCDFAILURE N/A
shelf ----1 1 1
slot ---12 13 14
port ---1 1 1
ifIndex -------7 13 19
The TC Sublayer statistics displayed above for slot 14 indicate than a PNS20 module that was configured for that slot is not present.
AAL5 Shelf Statistics

The commands below display statistics about the specified AAL5 (ATM Adaptation Layer 5) virtual channel connection (VCC).
Command Syntax
SHOW AAL5 SHELF shelfnumber STATISTICS SHOW AAL5 SHELF shelfnumber SLOT slotnumber.. STATISTICS SHOW AAL5 SHELF shelfnumber SLOT slotnumber .. PORT portnumber STATISTICS SHOW AAL5 SHELF shelfnumber SLOT slotnumber.. PORT portnumber VPI vpinumber STATISTICS SHOW AAL5 SHELF shelfnumber SLOT slotnumber.. PORT portnumber VPI vpinumber VCI vcinumber.. STATISTICS SHOW AAL5 ALL STATISTICS
3-432
AAL5 Layer Shelf Statistics
Command Parameters
TABLE 3 -98.
SHOW AAL5 SHELF Parameters

Field Length N/A N/A Description The shelf number in the GSX node configuration. In this release, only one shelf is supported. Must be 1. The slot number occupied by the PNS20/PNA21 module pair associated with the SONET port that you are configuring or displaying. Must be 3-16. The port number on the PNA21 adapter module that you are configuring or displaying. Must be 1 (on a PNA21). The value of the Virtual Path Identifier field in the PVC (Permanent Virtual Connection) on which you wish to display AAL5 statistics. Must equal the value specified in that PVC. The value of the Virtual Channel Identifier field in the PVC on which you wish to display AAL5 statistics. Must equal the value specified in that PVC.
portnumber
N/A
vpinumber
N/A
vcinumber
N/A
Command Example
To display AAL5 statistics for a specific slot on the shelf:
% SHOW AAL5 SHELF 1 SLOT 9 STATISTICS
Oversized shelf slot port ifIndex VPI VCI CRC Errors SDU ----- ---- ---- -------- --- ----- ---------- ---------1 9 1 12 0 102 0 0
AAL5 Layer Shelf Statistics

The commands below display statistics about the AAL5 layer on an entire port.
Command Syntax
SHOW AAL5 LAYER SHELF shelfnumber STATISTICS SHOW AAL5 LAYER SHELF shelfnumber SLOT slotnumber.. STATISTICS SHOW AAL5 LAYER SHELF shelfnumber SLOT slotnumber.. PORT portnumber STATISTICS SHOW AAL5 LAYER ALL STATISTICS
Show IPOA NIF Statistics
3-433
Command Parameters
TABLE 3 -99.
SHOW AAL5 LAYER SHELF Parameters

Field Length N/A N/A Description The shelf number in the GSX node configuration. In this release, only one shelf is supported. Must be 1. The slot number occupied by the PNS20/PNA21 module pair associated with the SONET port that you are configuring or displaying. Must be 3-16. The port number on the PNA21 adapter module that you are configuring or displaying. Must be 1 (on a PNA21).
portnumber
N/A
Command Example
% SHOW AAL5 LAYER SHELF 1 SLOT 9 STATISTICS
Node: TPUBS Date: 2001/03/20 15:25:16 GMT Zone: GMTMINUS05-EASTERN-US Last Change/ Oper Status -----------97876 UP In Packets/ Out Packets -----------30 35 In Discards/ Out Discards -----------0 0 In Errors / Out Errors -----------0 0
Shelf slot ----1 9
port ifIndex -------1 15

The SHOW IPOA commands allow you to examine status and display statistics pertaining to your ATM network.
Command Syntax
SHOW IPOA LIS MAP SUBNET subnet-mask STATUS SHOW IPOA LIS MAP SUBNET subnet-mask .. IFINDEX ifindex STATUS SHOW IPOA LIS MAP ALL STATUS SHOW IPOA ARP CLIENT IP ADDRESS ipaddress STATUS SHOW IPOA ARP CLIENT ALL STATUS SHOW IPOA VC IFINDEX ifindex STATUS SHOW IPOA VC IFINDEX ifindex IP ADDRESS ipaddress .. STATUS SHOW IPOA VC IFINDEX ifindex IP ADDRESS ipaddress .. VPI vpi STATUS SHOW IPOA VC IFINDEX ifindex IP ADDRESS ipaddress .. VPI vpi VCI vci STATUS SHOW IPOA VC ALL STATUS SHOW IPOA PVC SHELF shelf STATUS SHOW IPOA PVC SHELF shelf SLOT slot STATUS
3-434
SHOW IPOA PVC SHELF shelf SLOT slot PORT pna21port .. STATUS SHOW IPOA PVC SHELF shelf SLOT slot PORT pna21port .. VPI vpi STATUS SHOW IPOA PVC SHELF shelf SLOT slot PORT pna21port .. VPI vpi VCI vci STATUS SHOW IPOA PVC ALL STATUS
Command Parameters
TABLE 3 -100.
SHOW IPOA NIF Parameters

Field Length N/A N/A N/A N/A Description The 32-bit subnet mask in dotted decimal form (for example 255.255.255.0) The interface index that was assigned to the NIF when it was created. The 32-bit IP address specified in dotted decimal form (for example 128.127.50.224). The value of the Virtual Path Identifier field in the ATM Cell header. The range of valid values is established by the length of the field specified by the VPI BITS parameter of the ATM INTERFACE. The default is length 8, allowing values (0-255). The value of the Virtual Channel Identifier field in the ATM Cell header. The range of valid values is established by the length of the field specified by the VCI BITS parameter of the ATM INTERFACE. The default is length 10, allowing values 0-1023. The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. The slot number occupied by the PNS20 module. Must be 3-16. The port number on the PNA21 adapter module that is the physical endpoint of the PVC that you are displaying. Must be 1 (on a PNA21).
Parameter subnet-mask ifindex ipaddress vpi
vci
N/A
shelf slot pna21port
N/A N/A N/A
Command Example
To display the status of all Logical IP Subnets (LIS):
% SHOW IPOA LIS MAP ALL STATUS
Node: TPUBS Date: 2000/05/30 22:18:34 GMT Zone: GMTMINUS05-EASTERN-US ifIndex ------15 22 43 44 Row Status ------------ACTIVE ACTIVE ACTIVE ACTIVE
Subnet ------------10.7.0.0 10.7.0.0 10.7.0.0 10.7.0.0
3-435
10.7.0.0
45
ACTIVE
To display the results of all ARP requests on all IPOA VCs:

% SHOW IPOA ARP CLIENT ALL STATUS
Node: TPUBS Date: 2000/05/30 22:27:50 GMT Zone: GMTMINUS05-EASTERN-US In / Out In / Out Invalid ARP Reply ARP Reqs --------- ---------8 0 7 25 7 0 7 25 8 0 7 25 6 0 8 25 5 0 3 25
In / Out IP Address ARP Reqs ------------- ---------10.7.10.17 7 33 10.7.10.18 7 32 10.7.10.19 7 33 10.7.10.20 8 32 10.7.10.25 3 30
To display the status of all PVCs defined on this GSX:

% SHOW IPOA PVC ALL STATUS
Node: TPUBS Date: 2000/05/30 22:40:28 GMT Zone: GMTMINUS05-EASTERN-US port ---1 1 1 1 1 ifIndex -------11 11 11 11 18 VPI --0 0 0 0 0 VCI ----32 33 34 35 36 MTU Size ---------1960 1960 1960 1960 1960 Row Status ------------ACTIVE ACTIVE ACTIVE ACTIVE ACTIVE
shelf ----1 1 1 1 1
slot ---6 6 6 6 10
The MTU size is the largest possible unit of data that can be sent on a given physical medium. This value is always set to 1960 in the GSX software. These are configured values. To display the status of all VCs defined on this GSX (or the Inverse ATM ARP table):
% SHOW IPOA VC ALL STATUS
Node: TPUBS Date: 2000/05/31 14:27:28 GMT Zone: GMTMINUS05-EASTERN-US VPI --0 0 0 0 0 VCI ----32 36 33 34 35 Encap Type ---------LLCSNAP LLCSNAP LLCSNAP LLCSNAP LLCSNAP MTU Size ---------1960 1960 1960 1960 1960
ifIndex -------15 22 43 44 45
IP Address ------------10.7.10.21 10.7.10.26 10.7.10.22 10.7.10.23 10.7.10.24
This is the view to the IP address. The Encapsulation Type, LLCSNAP, is used on all VCs defined on this GSX. These are negotiated values.
3-436
APS Group
Automatic Protection Switching (APS) Interface

AutomaticProtectionSwitchingInterface
These objects provide a mechanism for achieving SONET network packet redundancy within the GSX9000 ATM network or circuit redundancy within the OC-3 TDM subsystem. The Sonus APS implementation is intended to conform in all significant respects to the recommendations in Bellcore GR-253-CORE.
APS Group
This object identifies a redundant SONET network that is automatically created when you configure either a PNS20 redundancy group or an OC-3 TDM subsystem:
The PNS20 redundancy group is created by the CREATE SERVER HWTYPE PNS20.. REDUNDANT command. This group is automatically deleted when the redundant PNS20/PNA21 module set is deleted by the DELETE SERVER command. 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.
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. The default name of the PNA21 APS group is APS-shn-sln-ptn, where shn is the shelf number, sln is the slot number, and ptn is the port number (always 1) of the PNS20/PNA21 in the redundant module set. For example, APS-1-3-1 identifies the redundant SONET network that connects to PNA21 port 1 in slot 3 (that was assigned to the PNS20 redundancy group) and PNA21 port 1 on the PNS20/PNA21 client module set. The redundant module set is in slot 3, and the client module set may be in any one of the slots 4-16. 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 CNS30triplicate, 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. In both cases, this APS group cannot be deleted. The name may however be changed via the CONFIGURE APS GROUP...NAME command shown in the command syntax below. An APS group is always characterized by a working channel that carries the active traffic and a protection channel that stands by to take over whenever a failure occurs on the working channel. See APS Channel on page 3-440.
APS Group
3-437
A switchover between SONET networks occurs when error rates on the OC-12c or OC3 SONET channels exceed a threshold, or when directed by an operator. Following the switchover, you may direct the GSX9000 software to revert to the previously failed network if it recovers satisfactorily. You must configure the APS group in order to:
Change the name of the APS group. Specify whether or not to revert back to the working channel when that SONET network recovers from a previous failure that had induced a switchover to the protection channel. Specify the line error determinants that will trigger a switchover between the working channel and the protection channel. Specify the redundancy model (architecture) used by your SONET NETWORK .
Command Syntax
CONFIGURE APS GROUP apsgname .. SWITCHING MODE reversion FAILED BER THRESHOLD failthreshold DEGRADED BER THRESHOLD degradethreshold WAIT TIME waittime NAME newapsgname ARCHITECTURE architecture SHOW APS GROUP apsgname ADMIN SHOW APS GROUP ALL ADMIN SHOW APS GROUP apsgname STATISTICS SHOW APS GROUP ALL STATISTICS SHOW APS K1K2 ALL STATE SHOW APS K1K2 apsgname STATE
3-438
APS Group
Command Parameters
TABLE 3 -101.
APS GROUP Parameters

Field Length 1-23 Description The name of the APS group generated when the corresponding PNS20 redundancy group or OC-3 TDM subsystem is formed. The default value of this string is APS-shn-sln-ptn, where shn is the shelf num-
Parameter apsgname
ber sln is the slot number, and ptn is the port number (always 1 for PNA21-based APS groups, always 2 for CNA33-based APS groups), for example APS-1-5-1. This name may be changed. See newapsgname..
newapsgname 1-23 A new name for the APS group described above. 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 PNS20/PNA21 or CNS30/CNA33 module sets are configured via CREATE SERVER .. if it is to be performed at all. 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 - Do not automatically restore the working channel. revertive - Automatically switchover to the working channel when it recovers. This action is only allowed 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 5 means that one out of 105 bits are in error or one in 100,000. Must be 3-5. This condition may initiate a switchover. The Bit Error Rate (BER) threshold at which Signal Degrade (SD or soft failure) is declared. The default value of 9 means that one out of 109 bits are in error or one in 1,000,000,000. Must be 5-9. This condition may initiate a switchover. The Wait to Restore time in minutes. The working channel must remain recovered for this interval before a reversion will occur. Must be 5-12, default is 5 (minutes). architecture N/A The redundancy model (or architecture) used by this APS group: onePlusOne - An architecture characterized by permanent electrical bridging to service and protective equipment. CNA33- based APS groups must use this model. resilientUNI - An architecture that must be used with a Lucent GX550 ATM switch. GSX9000 Open Services Switch Operations Guide Version 4.01, Document Version 2
reversion
N/A
degradethreshold
N/A
waittime
N/A
APS Group
3-439
Command Example
To create and configure an APS group that:
is driven by the PNS20 in slot 3 uses the 1:1 redundancy model reverts back to the primary SONET network after a switchover requires the primary to be recovered for seven mintes, before carrying out the above reversion
% CREATE SERVER SHELF 1 SLOT 3 HWTYPE pns20 .. ADAPTER pna21 redundant % CONFIGURE SERVER SHELF 1 SLOT 3 STATE enabled % CONFIGURE SERVER SHELF 1 SLOT 3 MODE inService % CONFIGURE APS GROUP APS-1-3-1 .. ARCHITECTURE onePlusOne % CONFIGURE APS GROUP APS-1-3-1 .. SWITCHING MODE revertive % CONFIGURE APS GROUP APS-1-3-1 .. WAIT TIME 7
To display the configuration of the APS group created above:

% SHOW APS GROUP APS-1-3-1 ADMIN
--------------------------------------------------------------------------APS GROUP ADMIN SUMMARY --------------------------------------------------------------------------Switching / Architecture Row Status -------------- -----------ONEPLUSONE REVERTIVE ACTIVE Degrade/ WTR Fail BER Timer -------- --9 7 5
Name -------------aps-1-3-1
S/SL/P -----1 3 1
Group ID ---------12
To display the APS K1K2 state within the APS group APS-1-3-1:
% SHOW APS K1K2 aps-1-3-1 STATE
--------------------------------------------------------------------------APS GROUP K1K2 BYTE STATE SUMMARY --------------------------------------------------------------------------Transmit K1 Transmit K2 Chan Byte Request Chan Arc Mode Receive K1 Receive K2 Name S/SL/P Group ID Chan Byte Request Chan Arc Mode -------------- ------ ---------- ---- ---- ----------------- ---- --- -----aps-1-3-1 1 3 1 12 0 0010 Reverse Request 0 1+1 0101 Bi 0 0001 Do Not Revert 0 1+1 0101 Bi
Note
See Bellcore GR-253-CORE for bit assignments for the K1 and K2 bytes. To display statistics for the APS group APS-1-3-1:
% SHOW APS GROUP aps-1-3-1 STATISTICS
--------------------------------------------------------------------------APS CHANNEL STATISTICS SUMMARY ---------------------------------------------------------------------------
3-440
APS Channel
Chan Name Group ID Channel S/SL/P Mode -------------- ---------- ------- ------ ---aps-1-3-1 12 0 1 3 1 BI aps-1-3-1 12 1 1 3 1 BI
Sig Failures / Sig Degrades -------------0 0 0 0
Switch Overs / Switchover Time --------------0 0 0 0
Note
For PNA21-based APS groups, the underlying PNS20 redundancy group must never be disabled while the associated APS protect channel is active. Call failures could occur on the working network interface as a consequence of this action.
APS Channel
The APS channels uniquely specify the redundant SONET networks within the APS group. Two APS channels are associated with an APS group:
Channel 0, the protection channel. This channel is automatically created when the APS group is created and stands by as a backup SONET network. Channel 1, the working channel. This channel is automatically created when:
The PNS20 redundancy group client is specified by the CREATE REDUNDANCY CLIENT .. command. See Redundancy Client on page 3-33.
The OC-3 TDM subsystem is specified by the CREATE SERVER .. CNS30

.. cna33 comand. See Server on page 3-16.
The APS channels cannot be created except by the above circumstances. Similarly, they may not be deleted except by deleting the underlying PNS20/PNA21 and CNS30/CNA33 module sets via the DELETE SERVER and DELETE REDUNDANCY CLIENT commands. You may display various channel components to examine the resiliency of the SONET networks. You may direct APS switchovers by invoking the CONFIGURE command on this object.
Command Syntax
CONFIGURE APS CHANNEL apsgname CHANNEL channel .. SWITCH COMMAND scommand SHOW APS CHANNEL apsgname ADMIN SHOW APS CHANNEL ALL ADMIN SHOW APS CHANNEL apsgname CHANNEL channel ADMIN SHOW APS CHANNEL apsgname STATISTICS SHOW APS CHANNEL ALL STATISTICS SHOW APS CHANNEL apsgname CHANNEL channel STATISTICS SHOW APS CHANNEL apsgname STATE SHOW APS CHANNEL ALL STATE SHOW APS CHANNEL apsgname CHANNEL channel STATE SHOW APS LINE SHELF shelfnum SUMMARY SHOW APS LINE SHELF shelfnum SLOT slotnum SUMMARY SHOW APS LINE SHELF shelfnum SLOT slotnum ..
APS Channel
3-441
PORT portnum SUMMARY SHOW APS LINE ALL SUMMARY
Command Parameters
TABLE 3 -102.
APS CHANNEL Parameters

Field Length 1-23 N/A N/A Description The (possibly changed) name of the redundant SONET network. The shelf number in the GSX node configuration. In this release, one shelf is supported. Must be 1. The slot occupied by the: PNS20/PNA21 module set that contains the SONET port that you are displaying originating CNS30 of the OC-3 TDM subsystem that contains the SONET port that you are displaying Must be 3-16.
Parameter apsgname shelfnum slotnum
portnum
N/A
The port number: on the PNA21 adapter module that you are displaying
on the CNA33 pair that you are displaying Must be 1 for PNA21s, must be 1 or 2 for CNS33s. channel N/A Identifies the working channel (0) or the protection channel (1) to be displayed. When this parameter is specified in the CONFIGURE command, it does not influence the operation. Must be 0 or 1. The switch command to be carried out on the specified channel: clear - Clears all switch commands on the channel. lockoutOfProtection - Inhibits any working channel from switching to the protection channel. forcedSwitchOfWorking - Forces a switchover from the working channel to the protection channel. forcedSwitchOfProtection - Forces a switchover back to the working channel from the protection channel. This command is valid only if the architecture is onePlusOne. manualSwitchOfWorking - Requests a switchover to the protection channel from the working channel. manualSwitchOfProtection - Requests a switchover back to the working channel from the protection channel. This command is valid only if architecture is onePlusOne.
scommand
N/A
3-442
APS Channel
Command Example
To unconditionally force a switchover from the working channel to the protection channel that is a member of the APS group APS-1-3-1:
% CONFIGURE APS CHANNEL aps-1-3-1 CHANNEL 1 .. SWITCH COMMAND forcedSwitchOfWorking
To display the APS channel configuration within the APS group APS-1-3-1:
% SHOW APS CHANNEL aps-1-3-1 ADMIN
--------------------------------------------------------------------------APS GROUP ADMIN SUMMARY --------------------------------------------------------------------------Switching / Architecture Row Status -------------- -----------ONEPLUSONE NONREVERTIVE ACTIVE Degrade/ WTR Fail BER Timer -------- --9 5 5
Name -------------aps-1-3-1
S/SL/P -----1 3 1
Group ID ---------12
To display the APS channel statistics within the APS group APS-1-3-1:
% SHOW APS CHANNEL aps-1-3-1 STATISTICS
--------------------------------------------------------------------------APS CHANNEL STATISTICS SUMMARY --------------------------------------------------------------------------Chan Name Group ID Channel S/SL/P Mode -------------- ---------- ------- ------ ---aps-1-3-1 12 0 1 3 1 BI aps-1-3-1 12 1 1 12 1 BI Sig Failures / Sig Degrades -------------0 0 0 0 Switch Overs / Switchover Time --------------0 0 0 0
To display the APS channel states within the APS group APS-1-3-1:
% SHOW APS CHANNEL aps-1-3-1 STATE
--------------------------------------------------------------------------APS CHANNEL STATE SUMMARY --------------------------------------------------------------------------Chan Name Channel S/SL/P Channel Status -------------- ------- ------ --------------------------------------------aps-1-14-1 0 1 14 1 N/A
To display the APS line summary in this shelf:

% SHOW APS LINE SHELF 1 SUMMARY
------------------------APS LINE SUMMARY ------------------------Line S/SL/P -----1 12 1 1 3 1 Group ID ---------12 12
Channel ------1 0
CAS Service Profile
3-443
CAS Service Group

CASServiceGroup
These objects configure the Channel Associated Signaling (CAS) call services. Sonus Networks recommends the following approach to configuring CAS call services:
1.
Create and configure all external (to CAS) profiles first. These include: Trunk Group (see Trunk Group on page 3-169) DTMF/MF Tone Profiles (see Tone Profile on page 3-485) Call Progress and Alerting/Ringback Tone Packages (see Tone Package on page 3-490) Circuit Service (see Circuit Service Profile on page 3-235)
Note
Each T1 circuit must be voiceonly or circuitonly. Each circuit must be restricted (56K). Each T1 span must be explicitly configured for a signaling mode of robbed bit.
2.
Create and configure the CAS objects in the following order:
Digit collection profiles (see CAS CollectionProfile on page 3-472). All necessary CAS signaling sequence profiles (see CAS Signaling Sequence
Profile on page 3-455 and CAS SignalSeq on page 3-457). You must define ingress (incoming calls) and egress (outgoing calls) SSPs. Any necessary CAS signaling condition profiles (see CAS Signaling Condition Profile on page 3-456 and CAS SignalCond on page 3-463). If necessary, the Disconnect Treatment Profile (see Disconnect Treatment Profile on page 3-478). CAS service groups (see CAS Service Profile on page 3-443 and CAS Service on page 3-448).
3.
Assign the channels to the CAS service groups (see CAS Channel on page 3467)
Note
The T1 span must be disabled and configured 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-467.
CAS Service Profile

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
CREATE CAS SERVICE PROFILE profilename CONFIGURE CAS SERVICE PROFILE profilename ..
3-444
CAS Service Profile
TRUNKGROUP tgname HUNT hdirection COST cost SIGNALTYPE signaltype INGRESS_SSP ingrsspname EGRESS_SSP egrsspname HOOKFLASH_SSP hkfsspname PSC_SSP pscsspname MAINTBUSY maintbusy DTMFPROFILE dtmfprofile MFPROFILE mfprofile CPTONEPKG cptonepkg CPTONEREQ cptonereq CPTONEPROV cptoneprov RXWINKMIN rxwinkmin RXWINKMAX rxwinkmax RXFLASHMIN rxflashmin RXFLASHMAX rxflashmax TXWINK txwink TXFLASH txflash GUARDTIME guardtime ALERTTONE alerttone AUTOBUSYTHRESHOLD autobusy DTPROFILE dtprofile SUSPENDTIME suspendtime SWITCHSIDE switchside CONFIGURE CAS SERVICE PROFILE servicename .. STATE admin-state SHOW CAS SERVICE PROFILE profilename ADMIN SHOW CAS SERVICE PROFILE SUMMARY DELETE CAS SERVICE PROFILE profilename
CAS Service Profile
3-445
Command Parameters
TABLE 3 -103.
CAS SERVICE PROFILE Parameters

Field Length 1-23 Description The name of the CAS profile that is being created to use as a template for configuring a CAS service group. The name of the trunk group that this CAS service belongs to. 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 - 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.
Parameter profilename
tgname
hdirection
1-23 N/A
cost
N/A
The (relative) routing cost to the CAS service group. Must be 0-100, default is 0. A value of 100 represents the highest possible cost. The CAS signaling type in use throughout the service group: eM - T1 E & M signaling. The signaling types below are not currently supported but will become available in the future: gsFxo -ground start foreign exchange office. gsFxs - ground start foreign exchange service. lsFxo - loop start foreign exchange office. lsFxs - loop start foreign exchange service. e1Mfr2 -
signaltype
N/A
ingrsspname hkfsspname
1-23 1-23
Name of the signaling sequence profile to use for all ingress calls. Name of the signaling sequence profile to execute whenever a hook flash is detected on an egress CAS channel in a connected call. Name of the signaling sequence profile to use for all egress calls.
egrsspname
1-23
3-446
CAS Service Profile
TABLE 3 -103.

Field Length 1-23 Description 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. Specifies whether the channels are taken off-hook when they are put into maintenance mode (either manually or automatically): enabled - take channels off-hook. disabled - do not take the channels off-hook.
Parameter pscsspname
maintbusy
N/A
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-485. 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-485. 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-490. Specifies whether call progress tones are required on ingress calls: disabled - not required. enabled - required.
mfprofile
1-23
cptonepkg
1-23
cptonereq
N/A
cptoneprov
N/A
Specifies whether call progress tones are provided by the far end switch for egress calls: disabled - not provided. enabled - provided.
rxwinkmin rxwinkmax rxflashmin rxflashmax txwink txflash
N/A N/A N/A N/A N/A N/A
The minimum wink receive time. Must be 100-800, default is 100 (milliseconds). The maximum wink receive time. Must be 100-800, default is 700 (milliseconds). The minimum flash receive time. Must be 300-1100, default is 300 (milliseconds). The maximum flash receive time. Must be 300-1100, default is 700 (milliseconds). The wink transmit time. Must be 100-800, default is 200 (milliseconds). The flash transmit time. Must be 300-1100, default is 500 (milliseconds).
CAS Service Profile
3-447
TABLE 3 -103.

Field Length N/A Description 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 700 (milliseconds). Name of a tone type to play on the ingress call while the connection is in progress. See Tone Type on page 3-489. 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.
Parameter guardtime
alerttone
1-23
autobusy
N/A
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. 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 Table 3 -34, SS7 Node Profile Timer Parameters) 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.
suspendtime
N/A
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.
admin-state
N/A
The administrative state of this CAS service profile: disabled - Not activated, able to be reconfigured or deleted. enabled - Activated, available for immediate use.
Command Example
To create and configure a CAS service group profile profilecas:
% CREATE CAS SERVICE PROFILE profilecas % CONFIGURE CAS SERVICE PROFILE profilecas .. TRUNK GROUP tg1 % CONFIGURE CAS SERVICE PROFILE profilecas .. HUNT top2Bottom % CONFIGURE CAS SERVICE PROFILE profilecas COST 40 % CONFIGURE CAS SERVICE PROFILE profilecas ..
3-448
CAS Service
STATE enabled
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: ENABLED Trunk Group: tg1 Hunt Algorithm: TOP2BOTTOM Requires CPTone: DISABLED MaintBusy: ENABLED Alert Tone: AutoBusy: 0 Provides CPTone: DISABLED Cost: 40 Signal Type: EM TX Wink: 200 PSC SSP: TX Flash: 500 CP Tone Pkg: Guard Time: 700 DTMF Profile: defaultdtmf RX Wink Minimum: 100 MF Profile: defaultmfr1 RX Wink Maximum: 700 Ingress SSP: fgdIngressNAAccess RX Flash Minimum: 300 Egress SSP: fgdEgressNAAccess RX Flash Maximum: 700 Hookflash SSP: Suspend Time: 0 DT Profile: Switch Side: NETWORK
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. a cas service is always in one of two administrative states:
enabled disabled
a cas service is always provisioned to one of two operational states:
CAS Service
3-449
The rules for manually changing operational states of the CAS service are:
inService inservice
-
outOfService
Affirm the prompt query. If no action or the action force is specified, then all calls are dropped and the CAS service is immediately set to outOfService. If action dryUp is specified, then for timeout minutes, each CAS channel is set to outOfService when the active call on the channel completes. If all calls complete before timeout minutes expire, then the CAS service is immediately set to outOfService. If timeout minutes expire before all calls complete, then the remaining calls are dropped and the CAS service is immediately set to outOfService. The admin-state can be changed to disabled once the operational state is outOfService and all ports, channels, and T1s are also outOfService. At this point, you may delete the CAS service.
outofservice
Change admin-state to enabled, if necessary. Change oper-state to inService. All channels with no other reason to be outOfService will be inService.
The GROUP operation resetStats clears all accumulated CAS service group statistics to zero.
Command Syntax
CREATE CAS SERVICE servicename CONFIGURE CAS SERVICE servicename ..
3-450
CAS Service
PROFILENAME profilename TRUNKGROUP tgname HUNT hdirection COST cost SIGNALTYPE signaltype INGRESS_SSP ingrsspname EGRESS_SSP egrsspname HOOKFLASH_SSP hkfsspname PSC_SSP pscsspname MAINTBUSY maintbusy DTMFPROFILE dtmfprofile MFPROFILE mfprofile CPTONEPKG cptonepkg CPTONEREQ cptonereq CPTONEPROV cptoneprov RXWINKMIN rxwinkmin RXWINKMAX rxwinkmax RXFLASHMIN rxflashmin RXFLASHMAX rxflashmax TXWINK txwink TXFLASH txflash GUARDTIME guardtime ALERTTONE alerttone AUTOBUSYTHRESHOLD autobusy DTPROFILE dtprofile SUSPENDTIME suspendtime SWITCHSIDE switchside CONFIGURE CAS SERVICE servicename MODE oper-state CONFIGURE CAS SERVICE servicename .. MODE oper-state ACTION action CONFIGURE CAS SERVICE servicename .. MODE oper-state ACTION action TIMEOUT timeout CONFIGURE CAS SERVICE servicename GROUP group CONFIGURE CAS SERVICE servicename STATE admin-state SHOW CAS SERVICE servicename ADMIN SHOW CAS SERVICE SUMMARY SHOW CAS SERVICE ALL ADMIN DELETE CAS SERVICE servicename
CAS Service
3-451
Command Parameters
TABLE 3 -104.
CAS SERVICE Parameters

Field Length 1-23 1-23 N/A Description The name of the CAS service that is being created and configured. The name of the trunk group of which this CAS service is a member. 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 - 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.
Parameter servicename tgname hdirection
cost
N/A
The (relative) routing cost to the CAS service group. Must be 0-100, default is 0. A value of 100 represents the highest possible cost. The CAS signaling type in use throughout the service group: eM - T1 E & M signaling. The signaling types below are not currently supported but will become available in the future: gsFxo -ground start foreign exchange office. gsFxs - ground start foreign exchange service. lsFxo - loop start foreign exchange office. lsFxs - loop start foreign exchange service. e1Mfr2 -
signaltype
N/A
ingrsspname egrsspname hkfsspname
1-23 1-23 1-23
Name of the signaling sequence profile to use for all ingress calls. Name of the signaling sequence profile to use for all egress calls. Name of the signaling sequence profile to execute whenever a hook flash is detected on an egress CAS channel in a connected call.
3-452
CAS Service
TABLE 3 -104.

Field Length 1-23 Description 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. Specifies whether the channels are taken off-hook when they are put into maintenance mode (either manually or automatically): enabled - take channels off-hook. disabled - do not take the channels off-hook.
Parameter pscsspname
maintbusy
N/A
Channels may be placed into maintenance mode manually by changing the operational state of the channel, named T1 span (see T1 on page 3-186), 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-485. 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-485. 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-490. Specifies whether call progress tones are required on ingress calls: disabled - not required. enabled - required. cptoneprov N/A Specifies whether call progress tones are provided by the far end switch on egress calls: disabled - not provided. enabled - provided. rxwinkmin rxwinkmax rxflashmin rxflashmax N/A N/A N/A N/A The minimum wink receive time. Must be 100-800, default is 100 (milliseconds). The maximum wink receive time. Must be 100-800, default is 700 (milliseconds). The minimum flash receive time. Must be 300-1100, default is 300 (milliseconds). The maximum flash receive time. Must be 300-1100, default is 700 (milliseconds).
mfprofile
1-23
cptonepkg
1-23
cptonereq
N/A
CAS Service
3-453
TABLE 3 -104.

Field Length N/A N/A N/A Description The wink transmit time. Must be 100-800, default is 200 (milliseconds). The flash transmit time. Must be 300-1100, default is 500 (milliseconds). 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 700 (milliseconds). Name of a tone type to play on the ingress call while the connection is in progress. See Tone Type on page 3-489. 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.
Parameter txwink txflash guardtime
alerttone
1-23
autobusy
N/A
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. 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 Table 3 -34, SS7 Node Profile Timer Parameters) 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.
suspendtime
N/A
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.
oper-state
N/A
The operational state of the CAS service: inservice - 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 operstate goes to outOfService. force - all calls dropped immediately. dryup - all calls are allowed to complete normally until timeout expires, when they are dropped.
3-454
CAS Service
TABLE 3 -104.

Field Length N/A Description The time (in minutes) to wait to place the CAS channels in the outOfService oper-state. Must be 1-1440. Default is 1. An operation to be applied to the underlying CAS service group: noAction - perform no group operations. resetStats - causes the statistics for each channel in this service group to be reset.
Parameter timeout
group
N/A
admin-state
N/A
The administrative state of this CAS service group: disabled - Not activated, able to be reconfigured or deleted. (This state clears the CAS service group call statistics.) enabled - Activated, available for immediate use.
Command Example
To create and configure CAS service casinserv:
% CREATE CAS SERVICE casinserv % CONFIGURE CAS SERVICE casinserv TRUNK GROUP 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
To display the configuration of the CAS service casinserv:

% SHOW CAS SERVICE casinserv ADMIN
-----------------------------------------------------------Name: casinserv -----------------------------------------------------------Admin State: ENABLED Trunk Group: tg1 Mode: INSERVICE Hunt Algorithm: BOTTOM2TOP Requires CPTone: DISABLED ProfileName: MaintBusy: ENABLED Alert Tone: AutoBusy: 0 Provides CPTone: DISABLED Cost: 50 Signal Type: EM TX Wink: 200 PSC SSP: TX Flash: 500 CP Tone Pkg: Guard Time: 700 DTMF Profile: defaultdtmf RX Wink Minimum: 100 MF Profile: defaultmfr1 RX Wink Maximum: 700 Ingress SSP: fgdIngressNAAccess RX Flash Minimum: 300 Egress SSP: fgdEgressNAAccess
CAS Signaling Sequence Profile
3-455
RX Flash Maximum: 700 Suspend Time: 0 Switch Side: NETWORK
Hookflash SSP: DT Profile:
To display a summary list of all CAS services:

% SHOW CAS SERVICE SUMMARY
Node: TPUBS Date: 2000/07/12 20:27:54 GMT Zone: GMTMINUS05-EASTERN-US State -------ENABLED ENABLED Mode -----------INSERVICE INSERVICE TrunkGroup -------------------TSTCUSIN TSTCUSOUT
Name ----------------------tstcasin tstcasout
CAS Signaling Sequence Profile

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-480). The CAS SSP is populated when you create and configure these individual signaling sequences. See CAS SignalSeq on page 3-457 for more information on signaling sequences. This object merely creates (names), or deletes a CAS SSP.
Command Syntax
CREATE CAS SSP cassspname SHOW CAS SSP SUMMARY DELETE CAS SSP cassspname
Command Parameters
TABLE 3 -105.
CAS SSP Parameters

Field Length 1-23 Description The name of the CAS Signaling Sequence Profile.
Parameter cassspname
Command Example
To create a CAS SSP:
% CREATE CAS SSP winkDTMFIngress
To display the configuration of all CAS SSPs:

% SHOW CAS SSP SUMMARY
Name Index ----------------------- -----
3-456
CAS Signaling Condition Profile
winkDTMFIngress winkDTMFEgress winkMFIngress winkMFEgress fgdIngressNAAccess fgdEgressNAAccess fgdIngressNAInterSw fgdEgressNAInterSw reorderSSP sitSSP testExecSSP noRouteSSP
1 2 3 4 5 6 7 8 9 10 11 12
CAS Signaling Condition Profile

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 SignalCond on page 3-463 for more information on signaling conditions. This object merely creates (names), or deletes an SCP.
Command Syntax
CREATE CAS SCP casscpname SHOW CAS SCP SUMMARY DELETE CAS SCP casscpname
Command Parameters
TABLE 3 -106.
CAS SCP Parameters

Field Length 1-23 Description The name of the CAS Signaling Condition Profile.
Parameter casscpname
Command Example
To create a CAS SCP:
% CREATE CAS SCP casscp1
To display the configuration of all CAS SCPs:

% SHOW CAS SCP SUMMARY
Node: TPUBS Date: 2000/07/16 20:49:04 GMT Zone: GMTMINUS05-EASTERN-US Index -------1 2
Name ----------------------collectErrors winkErrors
CAS SignalSeq
3-457
CAS SignalSeq
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. Every CAS signaling sequence is comprised of:
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 -109, CAS SIGNALCOND Parameters for a list of exception and optional conditions that may be handled by special SCPs.
Command Syntax
CREATE CAS SIGNALSEQ SSP cassspname INDEX index CONFIGURE CAS SIGNALSEQ SSP cassspname INDEX index .. POSITION position TOKEN token PARAM1 param1 PARAM2 param2 SCPNAME casscpname CONFIGURE CAS SIGNALSEQ SSP cassspname INDEX index .. STATE admin-state SHOW CAS SIGNALSEQ SSP cassspname INDEX index ADMIN SHOW CAS SIGNALSEQ SSP cassspname SUMMARY DELETE CAS SIGNALSEQ SSP cassspname
3-458
CAS SignalSeq
Command Parameters
TABLE 3 -107.
CAS SIGNALSEQ Parameters

Field Length 1-23 N/A N/A Description The name of the CAS Signaling Sequence Profile. A unique key that is assigned to each entry. 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. The CAS signaling token (actions to be performed or conditions to be met). See Table 3 -108, CAS Signaling Tokens below for a list of these values. 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 108, CAS Signaling Tokens. 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 -108, CAS Signaling Tokens. The name of the CAS SCP to invoke in the event of an error in this SSP signaling sequence. The administrative state of this CAS SSP signaling sequence: disabled - Not activated, able to be reconfigured or deleted. enabled - Activated, available for immediate use.
Parameter cassspname index position
token
N/A
param1
1-31
param2
1-31
casscpname admin-state
1-23 N/A
CAS SignalSeq
3-459
TABLE 3 -108.
CAS Signaling Tokens

Description Go off hook. The PARAM1 value may be: NOW - Send the seizure immediately. READY - Delay the seizure until the next digit collection is ready.
Token seize
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.
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. 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.
3-460
CAS SignalSeq
TABLE 3 -108.

Description
Token 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). 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. 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.
Overlap is not supported.

dialDigit playTone Dial the DTMF digit specified in PARAM1. 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-489). 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. Play the announcement specified in PARAM1. The PARAM1 value must match a previously established announcement number (see Announcements on page 4-67). Delay further execution of the SSP for the interval (in milliseconds)specified in PARAM1. 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 causes an indefinite wait. 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.
playAnn
delay waitWink
CAS SignalSeq
3-461
TABLE 3 -108.

Description 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. Issue a Q.931 indication to call control. This message is mapped to the equivalent call control message. The values permitted are SetupComp, progress, alert, connect, or transfer. Initiate call clearing procedures on the call. The disconnect reason is an integer that is specified in PARAM1. This value must be 1255: 1-127, as specified in Q.931/Q.850 128-255, GSX extensions See Table 5 -2, Call Termination Reason Codes.
Token collectDigit
report
clear
exec matchDigits
Start execution of the CAS SSP specified in PARAM1. 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 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) The SCP optional condition, digitMatch, is set if the pattern matches. In that case, the SCP specified by SCPNAME will be executed.
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.
Command Example
To create and configure the CAS SSP named winkDTMFIngress:
% CREATE CAS SSP winkDTMFIngress % CREATE CAS SIGNALSEQ SSP winkDTMFIngress INDEX 1 % CREATE CAS SIGNALSEQ SSP winkDTMFIngress INDEX 2 % CREATE CAS SIGNALSEQ SSP winkDTMFIngress INDEX 3 % CONFIGURE CAS SIGNALSEQ SSP winkDTMFIngress .. INDEX 1 TOKEN WINK PARAM1 ready
3-462
CAS SignalSeq
% CONFIGURE CAS SIGNALSEQ SSP winkDTMFIngress .. INDEX 2 TOKEN COLLECTFIELD PARAM1 dnisDTMF SCPNAME collectErrors % CONFIGURE CAS SIGNALSEQ SSP winkDTMFIngress .. INDEX 3 TOKEN REPORT PARAM1 setupComp % CONFIGURE CAS SIGNALSEQ SSP winkDTMFIngress .. INDEX 1 STATE enabled % CONFIGURE CAS SIGNALSEQ SSP winkDTMFIngress .. INDEX 2 STATE enabled % CONFIGURE CAS SIGNALSEQ SSP winkDTMFIngress .. INDEX 3 STATE enabled
To display the configuration of CAS SSP winkDTMFIngress that was created and configured above:
% SHOW CAS SIGNALSEQ SSP winkDTMFIngress SUMMARY
CAS SSP: winkDTMFIngress Index State Position SCP Name ----- -------- -------- --------------------1 ENABLED 0 2 ENABLED 2 collectErrors 3 ENABLED 2
Token -----------WINK COLLECTFIELD REPORT
Param1 ------ready dnisDTMF setupComp
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 ""
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 CollectionProfile on page 3-472.
% 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
CAS SignalCond
3-463
% 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 % CONFIGURE CAS SIGNALSEQ SSP ingressToneStart .. INDEX 9 TOKEN matchDigits PARAM1 dnis PARAM2 0XX .. SCPNAME collectLd % CONFIGURE CAS SIGNALSEQ SSP ingressToneStart .. INDEX 10 TOKEN collectField PARAM1 dnisLocal .. SCPNAME collectErrors % CONFIGURE CAS SIGNALSEQ SSP ingressToneStart .. INDEX 11 TOKEN report PARAM1 setupComp ..
CAS SignalCond
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.
3-464
CAS SignalCond
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.) Every signaling condition is comprised of:
Condition Token - a well defined set of actions that could occur during a signaling sequence. SSP_Control - one of five possible courses of action to address the error: 1. Skip to the next SSP signaling sequence. 2. Continue processing the current SSP signaling sequence. 3. Execute a new SSP. 4. Abort the call, initiate a default call clearing procedure, but do not count the error toward the automatic maintenance mode threshold discussed under CAS Service on page 3-448. 5. Abort the call, initiate a default call clearing procedure, and count the error toward the automatic maintenance mode threshold discussed under CAS Service on page 3-448.
Parameter (PARAM) - an optional value that qualifies the meaning of the SSP_Control field. For example, a value of SKIP indicates action number 1, while a value of NOSKIP indicates action number 2. A Disconnect Reason Code may be specified for SSP_Control actions 4 and 5. A new SSP may be specified for SSP_Control action 3.
Command Syntax
CREATE CAS SIGNALCOND SCP casscpname TOKEN token CONFIGURE CAS SIGNALCOND SCP casscpname TOKEN token CONFIGURE CAS SIGNALCOND SCP casscpname .. TOKEN token CONTROL control PARAM param CONFIGURE CAS SIGNALCOND SCP casscpname .. TOKEN token STATE admin-state SHOW CAS SIGNALCOND SCP casscpname TOKEN token ADMIN SHOW CAS SIGNALCOND SCP casscpname SUMMARY DELETE CAS SIGNALCOND SCP casscpname TOKEN token
CAS SignalCond
3-465
Command Parameters
TABLE 3 -109.
CAS SIGNALCOND Parameters

Field Length 1-23 N/A Description The name of the CAS Signaling Condition Profile. The CAS signaling condition token. Each of these is a well defined set of exception or optional events that could occur during a signaling sequence: default - a general purpose condition that always succeeds (exception). firstDigitTimeout - indicates no digits were received during the processing of a collectField or collectDigit token (exception). interDigitTimeout - indicates that at least one digit was collected and that a timeout occurred between digits (exception). fieldTimeout - indicates that at least one digit was collected and that a timeout occurred collecting all of the digits (exception). shortCollection - indicates that less than the expected number of digits was received (exception). unexpectedDigit - indicates that the collectDigit token did not receive the expected digit (exception). rxWink - indicates that an unexpected wink was received (exception). rxFlash - indicates that an unexpected hook flash was received (exception). rxAnswer - indicates that an unexpected answer was received (exception). winkTimeout - indicates that a timeout occurred while waiting for a wink (exception). flashTimeout - indicates that a timeout occurred while waiting for a hook flash (exception). answerTimeout - indicates that a timeout occurred while waiting for an answer (exception). cutThrough - 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 (optional). digitMatch - indicates that the SSP matchDigits token was processed and the collected digits matched the digit pattern (optional).
Parameter casscpname token
3-466
CAS SignalCond
TABLE 3 -109.
CAS SIGNALCOND Parameters

Field Length N/A Description One of four courses of (SSP) action that may be taken as a result of the signaling condition (token) that has occurred: proceed - continue processing in the current SSP, by either skipping the current SSP signaling sequence (PARAM=SKIP) or by repeating the current SSP signaling sequence (PARAM=NOSKIP). You should not use NOSKIP to resume an SSP that cannot be continued. See the note below. 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.
Parameter control
param admin-state
1-31 N/A
A text field used to pass a parameter to the control parameter, as discussed above. The administrative state of this CAS SCP entry: disabled - Not activated, able to be reconfigured or deleted. enabled - Activated, available for immediate use.
Note
Do not use the proceed NOSKIP parameter for the SCP error tokens firstDigitTimeout, interDigitTimeout, or fieldTimeout. When these conditions are encountered, the collection cannot be resumed.
Command Example
To create and configure the CAS SCP named collectErrors:
% CREATE CAS SCP collectErrors % CREATE CAS SIGNALCOND SCP collectErrors .. TOKEN FIRSTDIGITTIMEOUT % CREATE CAS SIGNALCOND SCP collectErrors .. TOKEN DEFAULT % CONFIGURE CAS SIGNALCOND SCP collectErrors .. TOKEN FIRSTDIGITTIMEOUT CONTROL EXEC PARAM testExecSSP % CONFIGURE CAS SIGNALCOND SCP collectErrors .. TOKEN DEFAULT CONTROL EXEC PARAM reorderSSP
To display the configuration of the above CAS SCP, collectErrors:

% SHOW CAS SIGNALCOND SCP collectErrors SUMMARY
CAS Channel
3-467
Zone: GMTMINUS05-EASTERN-US SCP Name: collectErrors Index State Token ----- -------- ----------------1 DISABLED DEFAULT 2 DISABLED FIRSTDIGITTIMEOUT
Control ------EXEC EXEC
Param ----------reorderSSP testExecSSP
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
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. A CAS channel service is always in one of two administrative states:
enabled disabled
A CAS channel service is always provisioned to one of two operational states:
3-468
CAS Channel
The rules for changing operational states of the CAS channel service are:
Changing to (operational state) inService outOfService Affirm the prompt query. If no action or the action force is specified, then all calls are dropped and the CAS service is immediately set to outOfService. If action dryUp is specified, then for timeout minutes, each underlying CAS channel is set to outOfService when the active call on the channel completes. If all calls complete before timeout minutes expire, then the CAS channel is immediately set to outOfService. If timeout minutes expire before all calls complete, then the remaining calls are dropped and the associated CAS channel is immediately set to outOfService. The admin-state can be changed to disabled once the operational state is outOfService.
outofservice
Change admin-state to enabled, if necessary. Change oper-state to inService. All channels with no other reason to be outofservice will be inService.
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.
CAS Channel
3-469
When you disable the circuit, the TRUNK MEMBER is released.
Command Syntax
CREATE CAS CHANNEL SERVICE servicename .. PORT port CHANNEL chanrange CONFIGURE CAS CHANNEL SERVICE servicename .. PORT port CHANNEL chanrange CIRCUITPROFILE circuitprofilename DIRECTION direction TRUNK MEMBER tmember TRUNK MEMBER UNSET CONFIGURE CAS CHANNEL SERVICE servicename .. PORT port CHANNEL chanrange MODE oper-state CONFIGURE CAS CHANNEL SERVICE servicename .. PORT port CHANNEL chanrange MODE oper-state ACTION action CONFIGURE CAS CHANNEL SERVICE servicename .. PORT port CHANNEL chanrange MODE oper-state ACTION action TIMEOUT timeout CONFIGURE CAS CHANNEL SERVICE servicename .. PORT port CHANNEL chanrange STATE admin-state SHOW CAS CHANNEL SERVICE servicename .. PORT port CHANNEL channum ADMIN SHOW CAS CHANNEL SERVICE servicename .. PORT port SUMMARY SHOW CAS CHANNEL SERVICE servicename .. PORT port CHANNEL channum STATUS SHOW CAS CHANNEL SERVICE servicename .. PORT port CHANNEL ALL STATUS SHOW CAS CHANNEL SERVICE servicename .. PORT ALL CHANNEL ALL SUMMARY STATUS DELETE CAS CHANNEL SERVICE servicename .. PORT port CHANNEL chanrange
3-470
CAS Channel
Command Parameters
TABLE 3 -110.
CAS CHANNEL Parameters

Field Length 1-23 1-23 Description The name of the CAS service to which the channels are being assigned. The automatically created (and possibly changed) name of the T1 or E1 span that is assigned to the CAS channels. 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:
Parameter servicename port
chanrange
N/A
1,3,5,8-12+2,14-16
1,3,5,8,10,12,14,15, and 16.

circuitprofilename direction 1-23 N/A The name of the Circuit Service Profile that you are applying to the designated channels. The direction of traffic allowed on the designated channel(s): twoWay - 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
1,3,5,8,10,12,14,15, and 16.

CAS Channel
3-471
TABLE 3 -110.
CAS CHANNEL Parameters

Field Length N/A Description The operational state of the designated channel(s): outOfService - All channels out of service. 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 channel in the outOfService oper-state. Must be 11440, default is 5. A single channel number. Must be in the range 1-24. The administrative state of these CAS channels: disabled - Not activated, able to be reconfigured or deleted. enabled - Activated, available for immediate use.
channum admin-state
N/A N/A
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
To assign a range of trunk members to 5 of the first 6 channels configured above:

% CONFIGURE T1 t1-1-9-6 MODE outOfService % CONFIGURE T1 t1-1-9-6 STATE disabled % CONFIGURE CAS CHANNEL SERVICE casserv1 .. PORT t1-1-9-6 CHANNEL 1-3, 5-6
3-472
CAS CollectionProfile
TRUNK MEMBER 100-102, 103-104 % CONFIGURE T1 t1-1-9-6 STATE enabled % CONFIGURE T1 t1-1-9-6 MODE inService
To display the configuration summary of the above CAS channels:

% SHOW CAS CHANNEL SERVICE casserv1 CHANNEL all admin
CAS Service: casserv1 Trunk Group: casserv1 DS1 Port: t1-1-9-6 Trunk Port Name Chan Membr State ------------------- ---- ----- -------t1-1-9-6 1 100 ENABLED t1-1-9-6 2 101 ENABLED t1-1-9-6 3 102 ENABLED t1-1-9-6 4 UNSET ENABLED t1-1-9-6 5 103 ENABLED t1-1-9-6 6 104 ENABLED
Mode --------INSERVICE INSERVICE INSERVICE INSERVICE INSERVICE INSERVICE
Direction --------TWOWAY TWOWAY TWOWAY TWOWAY TWOWAY TWOWAY
Profile ------cas cas cas cas cas cas
To display the status of channel 1above:

% SHOW CAS CHANNEL SERVICE casserv1 PORT t1-1-9-6 .. CHANNEL 1 STATUS
-----------------------------------------------------------CAS Service: casserv1 Port: T1-1-9-6 Channel: 1 -----------------------------------------------------------LocalHw: INSERVICE Trunk Group: casserv1 Usage: IDLE LocalMaint: INSERVICE Busy Failures: 0 RemoteMaint: INSERVICE Ingress Attempts: 0 Ingress Completions: 0 Ingress Failures: 0 Egress Attempts: 0 Egress Completions: 0 Egress Failures: 0
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
CREATE CAS COLLECTIONPROFILE collectpname CONFIGURE CAS COLLECTIONPROFILE collectpname COLLECTID collectid TYPE type
3-473
MINDIGITS mindigits MAXDIGITS maxdigits FIRSTDIGITTIMER firstdigittimer INTERDIGITTIMER interdigittimer FIELDTIMER fieldtimer TERMDIGIT termdigit RESTARTDIGITSEQ restartdigitseq REINPUTDIGITSEQ reinputdigitseq REPORTDIGITS reportdigits FIRSTDIGITQUIET firstdigitquiet ANNOUNCEPROMPT announceprompt TONEPROMPT toneprompt APPENDDIGITS appenddigits SHOW CAS COLLECTIONPROFILE collectpname ADMIN SHOW CAS COLLECTIONPROFILE SUMMARY DELETE CAS COLLECTIONPROFILE collectpname
3-474
Command Parameters
TABLE 3 -111.
CAS COLLECTIONPROFILE Parameters

Field Length 1-23 N/A Description The name of the CAS Collection Profile. 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.
Parameter collectpname collectid
type
N/A
The type of digits to be collected: dtmf - Dual Tone Multi-Frequency. mf - Multi-Frequency.
mindigits maxdigits firstdigittimer interdigittimer
N/A N/A N/A
Minimum number of digits to be collected. Must be 0 to 30, default is 0. Maximum number of digits to be collected. Must be 1 to 30, default is 1. 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. 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. 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.
N/A
fielddigittimer
N/A
3-475
TABLE 3 -111.

Field Length N/A Description 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
Parameter termdigit
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.) 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.) 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.) 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 4-67. You cannot specify this parameter if a tone prompt (below) has already been specified.
reinputdigitseq
1-3
reportdigits
N/A
firstdigitquiet
N/A
3-476
TABLE 3 -111.

Field Length 1-23 Description 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-489. You cannot specify this parameter if an announcement (above) has already been specified. Specifies whether the digits that are being collected are appended to the field specified by COLLECTID: disabled - 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.
Parameter toneprompt
appenddigits
N/A
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
To display the configuration of the above CAS Collection Profile:

% SHOW CAS COLLECTIONPROFILE dnisToneStart ADMIN
Node: TPUBS Date: 2000/07/19 01:28:48 GMT Zone: GMTMINUS05-EASTERN-US dnisToneStart DTMF DNIS 1 10 6000 0 20000 NONE
Name: Type: CollectId: MinDigits: MaxDigits: FirstDigit Timer: InterDigit Timer: Field Timer: Term Digit: Restart Digit: Reinput Digit: Report Digits: FirstDigit Quiet: Announce Prompt: Tone Prompt:
0 DISABLED 0 dial
3-477
Append Digits:
DISABLED
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 INTERDIGITTIMER 6000 FIELDTIMER 20000 APPEND DIGITS enabled
3-478
Disconnect Treatment Profile
Call Disconnect Treatment

CallDisconnectTreatment
These objects are used by CAS, ISUP, ISDN, 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 SSPs that direct call disconnect processing. CAS, ISUP, ISDN, and SIP calls may use this object and its underlying objects to perform disconnect processing. Default profiles are defined for CAS, ISUP, ISDN, and SIP. You may associate CAS, ISUP, and ISDN service groups with other, unique Disconnect Treatment Profiles. SIP disconnect processing must be handled through the default SIP Disconnect Treatment Profile, sipDefault.
Command Syntax
CREATE DISCONNECT TREATMENT PROFILE dtprofile CONFIGURE DISCONNECT TREATMENT PROFILE dtprofile .. ADD REASON reasons DISCONNECT SSP dscsspname CONFIGURE DISCONNECT TREATMENT PROFILE dtprofile .. MODIFY REASON reasons DISCONNECT SSP dscsspname CONFIGURE DISCONNECT TREATMENT PROFILE dtprofile .. DELETE REASON reasons SHOW DISCONNECT TREATMENT PROFILE dtprofile ADMIN SHOW DISCONNECT TREATMENT PROFILE SUMMARY DELETE DISCONNECT TREATMENT PROFILE dtprofile
3-479
Command Parameters
TABLE 3 -112.
DISCONNECT TREATMENT PROFILE Parameters

Field Length 1-23 1-23 Description The name of the Disconnect Treatment Profile that is being created, configured, or deleted. 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. 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 Table 5 -2, Call Termination Reason Codes. 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:
Parameter dtprofile dscsspname
reasons
N/A
1,3,5,8-12+2,14-16
1,3,5,8,10,12,14,15, and 16.
Command Example
To create the Disconnect Treatment Profile, dtprof1:
% CREATE DISCONNECT TREATMENT PROFILE dtprof1
To add the Disconnect SSP reorderSSP to Disconnect Treatment Profile dtprof1 and associate the SSP with disconnect reason code 16:
% CONFIGURE DISCONNECT TREATMENT PROFILE dtprof1 .. ADD REASON 16 DISCONNECT SSP reorderSSP
To display the configuration of Disconnect Treatment Profile dtprof1:

% SHOW DISCONNECT TREATMENT PROFILE dtprof1 ADMIN
Node: TPUBS Date: 2000/10/05 18:41:49 GMT Zone: GMTMINUS05-EASTERN-US Treatment Profile: dtprof1 Disconnect SSP Name ----------------------reorderSSP
Disconnect Reason -----16
To display a list of all Disconnect Treatment Profiles:

% SHOW DISCONNECT TREATMENT PROFILE SUMMARY
Disconnect Treatment Profiles
3-480
Disconnect Signaling Sequence Profile
----------------------------casDefault isdnDefault isupDefault sipDefault
To display the configuration of Disconnect Treatment Profile sipdefault:

% SHOW DISCONNECT TREATMENT PROFILE sipDefault ADMIN
Node: TPUBS Date: 2001/06/04 19:58:48 GMT Zone: GMTMINUS05-EASTERN-US Treatment Profile: sipDefault Disconnect SSP Name -----------------------numchanged
Disconnect Reason -----3
Disconnect Signaling Sequence Profile

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-481 for more information on Disconnect Signaling Sequences. This object merely creates (names), or deletes a Disconnect SSP.
Command Syntax
CREATE DISCONNECT SSP dscsspname SHOW DISCONNECT SSP SUMMARY DELETE DISCONNECT SSP dscsspname
Command Parameters
TABLE 3 -113.
DISCONNECT SSP Parameters

Field Length 1-23 Description The name of the Disconnect Signaling Sequence Profile.
Parameter dscsspname
Command Example
To create a Disconnect SSP:
% CREATE DISCONNECT SSP reorderSSP
To display a list of all Disconnect SSPs:

% SHOW DISCONNECT SSP SUMMARY
Disconnect Signal Sequence Profiles
Disconnect SignalSeq
3-481
Name ----------------------noRouteSSP busySSP reorderSSP playannSSP numchanged sit3SSP sit2SSP sit1SSP masterSSP allTokenSSP
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. Every signaling sequence is comprised of:
Signaling Token - a well defined set of actions to perform before proceeding to the next entry in the SSP. Parameter 1 (PARAM1) - an optional value used to 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.
Command Syntax
CREATE DISCONNECT SIGNALSEQ SSP dscsspname .. INDEX index CONFIGURE DISCONNECT SIGNALSEQ SSP dscsspname .. INDEX index POSITION position TOKEN token PARAM1 param1 PARAM2 param2 CONFIGURE DISCONNECT SIGNALSEQ SSP dscsspname .. INDEX index STATE admin-state SHOW DISCONNECT SIGNALSEQ SSP dscsspname .. INDEX index ADMIN SHOW DISCONNECT SIGNALSEQ SSP dscsspname SUMMARY DELETE DISCONNECT SIGNALSEQ SSP dscsspname .. INDEX index
3-482
Command Parameters
TABLE 3 -114.
DISCONNECT SIGNALSEQ Parameters

Field Length 1-23 N/A N/A Description The name of the Disconnect Signaling Sequence Profile. A unique key that is assigned to each entry. 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. The Disconnect signaling token (actions to be performed). See Table 3 -115, Disconnect Signaling Tokens for a list of these values. 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 -115, Disconnect Signaling Tokens. 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 -115, Disconnect Signaling Tokens. The administrative state of this Disconnect SSP signaling sequence: disabled - Not activated, able to be reconfigured or deleted. enabled - Activated, available for immediate use.
Parameter dscsspname index position
token
N/A
param1
1-31
param2
1-31
admin-state
N/A
TABLE 3 -115.
Disconnect Signaling Tokens

Description 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-489). 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. Play the announcement specified in PARAM1. The PARAM1 value must match a previously established announcement number (see Announcements on page 4-67). Delay further execution of the Disconnect SSP for the interval (in milliseconds)specified in PARAM1.
Token playTone
playAnn
delay
3-483
TABLE 3 -115.
Disconnect Signaling Tokens

Description Initiate call clearing procedures on the call. The disconnect reason is an integer that is specified in PARAM1. This value must be 1255:
Token clear
1-127, as specified in Q.931/Q.850 128-255, GSX extensions
See Table 5 -2, Call Termination Reason Codes. exec Start execution of the SSP specified in PARAM1.
Command Example
To create and configure the Disconnect SSP named reorderSSP:
% CREATE DISCONNECT SSP reorderSSP % CREATE DISCONNECT SIGNALSEQ SSP reorderSSP INDEX 1 % CONFIGURE DISCONNECT SIGNALSEQ SSP reorderSSP .. INDEX 1 TOKEN PLAYTONE PARAM1 reorder % CONFIGURE DISCONNECT SIGNALSEQ SSP reorderSSP .. INDEX 1 STATE enabled
To display the configuration of Disconnect SSP reorderSSP that was created and configured above:
% SHOW DISCONNECT SIGNALSEQ SSP reorderSSP SUMMARY
Disc SSP: reorderSSP Index State Position Token Param1 Param2 ----- -------- -------- ------------ --------------------- -----1 ENABLED 0 PLAYTONE reorder
To create and configure a Disconnect SSP named busySSP:

% CREATE DISCONNECT SSP busySSP % CREATE DISCONNECT SIGNALSEQ SSP busySSP INDEX 1 % CREATE DISCONNECT SIGNALSEQ SSP busySSP INDEX 2 % CONFIGURE DISCONNECT SIGNALSEQ SSP busySSP .. INDEX 1 TOKEN PLAYTONE % CONFIGURE DISCONNECT SIGNALSEQ SSP busySSP .. INDEX 1 PARAM1 BUSY % CONFIGURE DISCONNECT SIGNALSEQ SSP busySSP .. INDEX 1 PARAM2 5000 % CONFIGURE DISCONNECT SIGNALSEQ SSP busySSP .. INDEX 1 STATE enabled % CONFIGURE DISCONNECT SIGNALSEQ SSP busySSP .. INDEX 2 TOKEN CLEAR % CONFIGURE DISCONNECT SIGNALSEQ SSP busySSP .. INDEX 2 STATE enabled
3-484
Tone Resources
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 5-16):
% 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
Disc SSP: numchanged Index State Position ----- -------- -------1 ENABLED 0 2 ENABLED 1
Token -----------PLAYANN EXEC
Param1 Param2 --------------------- -------------------111 busyssp
To display the steps of the Disconnect SSP busyssp from the numchanged Disconnect SSP:
% SHOW DISCONNECT SIGNALSEQ SSP busyssp SUMMARY
Disc SSP: busyssp Index State Position ----- -------- -------1 ENABLED 0 2 ENABLED 1
Token Param1 Param2 ------------ --------------------- -------------------PLAYTONE busy 5000 CLEAR
Tone Processing
ToneProcessing
These objects configure tone processing objects required by other call services, such as CAS.
Tone Resources
The GSX9000 uses Tones and Announcements Packet Assembler Disassembler channels whenever performing MF/DTMF digit/tone collection or generation. This includes:
Collecting MF/DTMF Digits for incoming (ingress) CAS calls Collecting DTMF Digits when executing the two-stage script Collecting DTMF Digits for MGCP calls Generating Ring Back Tone to the ingress CAS side while waiting for the outgoing (egress) to answer Generating Ring Back Tone to the PSTN network for SIP calls Generating DTMF Tones for MGCP calls Generating MF/DTMF Digits on the egress CAS call
Tone Profile
3-485
Generating Disconnect Treatment Tones on CAS (ingress/egress), ISUP, ISDN, and SIP calls
The number of active calls using these resources is limited by the number of tone processing channels resident on the CNS modules. CNS30 modules contain approximately 1.5 times more channels than CNS10/CNS20 modules, while potentially supporting 2.3 times more simultaneous calls than CNS10/CNS20 modules. When all of a modules tone processing resources are in use, the next call on that module that requires such a resource must await the release of the resource by any call that is currently using it. 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. SPS30 modules do not currently provide access to these facilities.
Tone Profile
This object creates and configures a profile for a single frequency, dual frequency, or modulated tone. Tone profiles define the parameters required to generate call progress tones.
Command Syntax
CREATE TONE PROFILE tprofilename .. GENERATION METHOD SINGLE TONE CREATE TONE PROFILE tprofilename .. GENERATION METHOD DUAL TONE CREATE TONE PROFILE tprofilename .. GENERATION METHOD MODULATED TONE CONFIGURE TONE PROFILE tprofilename .. TONE1 FREQUENCY freq TONE1 POWER power TONE2 FREQUENCY freq TONE2 POWER power CARRIER FREQUENCY freq CARRIER POWER power SIGNAL FREQUENCY freq SIGNAL MODULATION INDEX moindex MAKE1 make BREAK1 break MAKE2 make BREAK2 break MAKE3 make BREAK3 break REPEAT repeat
3-486
Tone Profile
SHOW TONE PROFILE SUMMARY SHOW TONE PROFILE tprofilename ADMIN SHOW TONE PROFILE ALL ADMIN DELETE TONE PROFILE tprofilename
Command Parameters
TABLE 3 -116.
TONE PROFILE Parameters

Field Length 1-23 N/A N/A N/A Description The name of the tone profile that is being configured. This name is applied to tone packages. Specifies the tone frequency in Hertz. Must be 03999, default is 0. A value of zero disables the tone. Specifies the tone power in dBm0. Must be between -50 and 3, default is 0. 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. Specifies 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. Specifies the period of silence between tones, in milliseconds. Must be between -1 and 8000, default is 0. A value of -1 generates continuous silence. Specifies the number of times to play a tone. Must be 0-65535, default is 1. A value of 0 causes the tone to be repeated indefinitely.
Parameter tprofilename freq power moindex
make
N/A
break
N/A
repeat
N/A
Command Example
To create and configure a tone profile named defDial:
% CREATE TONE PROFILE defDial .. GENERATION METHOD DUAL TONE % CONFIGURE TONE PROFILE defDial .. TONE1 FREQUENCY 350 TONE1 POWER -20 TONE2 FREQUENCY 440 TONE2 POWER -20 MAKE1 -1
To display the configuration of the tone profile defDial:

% SHOW TONE PROFILE defDial ADMIN
Node: TPUBS Date: 2000/07/20 21:58:04 GMT Zone: GMTMINUS05-EASTERN-US defDial
Tone Profile:
Digit Profile
3-487
Index: Generation Method: Signal Parameters Tone 1 Frequency: Tone 1 Power: Tone 2 Frequency: Tone 2 Power: Carrier Frequency: Carrier Power: Signal Frequency: Modulation Index: Cadence Parameters Cadence 1 Make: Cadence 1 Break: Cadence 2 Make: Cadence 2 Break: Cadence 3 Make: Cadence 3 Break: Repeat:
1 DUALTONE
350 -20 440 -20 N/A N/A N/A N/A
Hz dBm Hz dBm Hz dBm Hz %
-1 0 0 0 0 0 1
msec msec msec msec msec msec
Digit Profile
This object creates and configures a profile for digit collection. Digit profiles define the parameters for DTMF/MF digit generation and collection.
Command Syntax
CREATE DIGIT PROFILE dprofilename TYPE type CONFIGURE DIGIT PROFILE dprofilename .. GENERATE POWER power GENERATE MAKE make GENERATE BREAK break GENERATE MAKE KP makekp DETECT MINIMUM POWER minpower DETECT MINIMUM ON DURATION onduration DETECT MINIMUM OFF DURATION offduration DETECT TWIST CUTOFF twistcutoff DETECT FREQUENCY RANGE freqrange SHOW DIGIT PROFILE SUMMARY SHOW DIGIT PROFILE dprofilename ADMIN SHOW DIGIT PROFILE ALL ADMIN DELETE DIGIT PROFILE dprofilename
3-488
Digit Profile
Command Parameters
TABLE 3 -117.
DIGIT PROFILE Parameters

Field Length 1-23 N/A Description The name of the digit profile that is being configured. 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). mfr2f - Multi-Frequency (R2F). mfr2b - Multi-Frequency (R2B).
Parameter
dprofilename
type
power make
N/A N/A
Specifies the generation power in dBm0. Must be between -50 and 3, default is -10. Specifies the time to hold on the tone that generates the digit, in milliseconds. Must be 0-8000, default is 100. Specifies the period of silence between digits, in milliseconds. Must be 0-8000, default is 100. Specifies the time to hold on the tone that generates the mfr1 KP digit, in milliseconds. Must be 08000, default is 105. Specifies the minimum power (per frequency) that is required for digit collection, in dBm0. Must be between -45 and -25, default is -45. Specifies the minimum on time to successfully collect the digit, in milliseconds. Legal ranges are: dtmf - 25-80, default is 40. mf - 25-100, default is 40. All values must be divisible by 5.
break makekp
N/A N/A
minpower
N/A
onduration
N/A
offduration
N/A
Specifies the minimum off time to successfully collect the digit, in milliseconds. Legal ranges are: dtmf - 25-80, default is 40. mf - 10-100, default is 40. 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. Specifies the frequency tolerance while detecting digits: narrow - for dtmf, must accept within 2%; for mf, must accept within 1.5% + 5 hertz. medium - for dtmf, must accept within 2.5%; for mf, must accept within 1.5% + 10 hertz. wide - for dtmf, must accept within 3%; for mf, must accept within 1.5% + 15 hertz. wider - for dtmf, must accept within 3.5%.
freqrange
N/A
Tone Type
3-489
Command Example
To create and configure the DTMF digit profile defaultDtmf:
% CREATE DIGIT PROFILE defaultDtmf TYPE dtmf % CONFIGURE DIGIT PROFILE defaultDtmf .. DETECT MINIMUM ON DURATION 35 DETECT MINIMUM OFF DURATION 25
To display the configuration of the digit profile defaultDtmf, configured above:

% SHOW DIGIT PROFILE defaultDtmf ADMIN
Node: TPUBS Date: 2000/07/20 23:35:13 GMT Zone: GMTMINUS05-EASTERN-US defaultDtmf 1 DTMF
Digit Profile: Index: Digit Type: Generation Parameters Power: Make: Break: Make KP:
-10 100 100 N/A
dBm msec msec 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
Tone Type
This object creates a tone type. The tone type is a generic call progress tone type, such as dial, ring, busy, and others. Tone types do not require configuration.
Command Syntax
CREATE TONE TYPE tonetype SHOW TONE TYPE SUMMARY DELETE TONE TYPE tonetype
3-490
Tone Package
Command Parameters
TABLE 3 -118.
TONE TYPE Parameters

Field Length 1-23 Description The name of the tone type.
Parameter tonetype
Command Example
To display the default tone types:
% SHOW TONE TYPE SUMMARY
Tone Types Index: 1 Index: 2 Index: 3 Index: 4 Index: 5 Index: 6 Index: 7
Name: Name: Name: Name: Name: Name: Name:
dial ring busy reorder sit1 sit2 sit3
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 an ISUP, ISDN, or CAS service/service profile.
Command Syntax
CREATE TONE PACKAGE tonepackage CONFIGURE TONE PACKAGE tonepackage .. ADD TONE TYPE tonetype TONE PROFILE tprofilename CONFIGURE TONE PACKAGE tonepackage .. MODIFY TONE TYPE tonetype TONE PROFILE tprofilename CONFIGURE TONE PACKAGE tonepackage .. DELETE TONE TYPE tonetype SHOW TONE PACKAGE SUMMARY SHOW TONE PACKAGE tonepackage ADMIN DELETE TONE PACKAGE tonepackage
Static Call
3-491
Command Parameters
TABLE 3 -119.
TONE PACKAGE Parameters

Field Length 1-23 1-23 1-23 Description The name of the tone package. The name of the tone profile to be used to generate the tone type. The name of the tone type.
Parameter tonepackage tprofilename tonetype
Command Example
To add the tone type fastbsy to the default tone package:
% CONFIGURE TONE PACKAGE default .. ADD TONE TYPE fastbsy TONE PROFILE fastbsyprof1
To change the tone profile assigned to the tone type fastbsy in the default tone package to fastbsyprof2:
% CONFIGURE TONE PACKAGE default .. MODIFY TONE TYPE fastbsy TONE PROFILE fastbsyprof2
To delete the tone type fastbsy from the default tone package:
% CONFIGURE TONE PACKAGE default .. DELETE TONE TYPE fastbsy
To display the configuration of the default tone package:

% SHOW TONE PACKAGE default ADMIN
Node: TPUBS Date: 2000/07/21 00:06:35 GMT Zone: GMTMINUS05-EASTERN-US Tone Type -------------dial ring busy reorder sit1 sit2 sit3 Tone Profile -------------defDial defRing defBusy defReorder defSit1 defSit2 defSit3
Index ----1 2 3 4 5 6 7
Tone Package -------------default default default default default default default
Manual Calls
ManualCalls 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
3-492
Static Call
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 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 GSX9000s. 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
CREATE STATIC CALL callname CONFIGURE STATIC CALL callname .. CIRCUIT MODE circuitmode CONFIGURE STATIC CALL callname .. ENDPOINT A SHELF shelf SLOT slot PORT portnum CHANNEL channum SERVICE PROFILE servprofilename CONFIGURE STATIC CALL callname .. ENDPOINT B TYPE type SHELF shelf SLOT slot PORT portnum CHANNEL channum SERVICE PROFILE servprofilename CONFIGURE STATIC CALL callname .. ENDPOINT B TYPE type LOCAL RTP PORT lrtpport LOCAL IPADDRESS ipaddress REMOTE RTP PORT rrtpport REMOTE IPADDRESS ipaddress SERVICE PROFILE servprofilename CONFIGURE STATIC CALL callname STATE admin-state SHOW STATIC CALL callname ADMIN SHOW STATIC CALL callname STATUS SHOW STATIC CALL ALL ADMIN SHOW STATIC CALL ALL STATUS DELETE STATIC CALL callname
Static Call
3-493
Command Parameters
TABLE 3 -120.
STATIC CALL Parameters

Field Length 1-23 N/A Description A name by which to identify this permanent, nailed up, connection. 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.
Parameter callname circuitmode
shelf
N/A
The shelf number in the GSX node configuration that contains a connection endpoint. In this release, one shelf is supported. Must be 1. The slot number occupied by the circuit network module used by one or more of the connection endpoints. Must be 3-16. The span number that contains the channel of the connection endpoint. For a T3 channel, must be 128. For an E1 channel, must be 1-8. For a T1 channel, must be 1-12. 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. 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. The type of endpoint (B) to be configured: CIRCUIT - second endpoint will be PSTN. PACKET - second endpoint will be IP. One endpoint (A) is always PSTN.
slot
N/A
portnum
N/A
channum
N/A
servprofilename
1-23
type
N/A
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. The 32-bit IP address of the RTP port in dotted decimal form (for example 128.127.50.224) The logical number of the remote RTP port of the IP endpoint. The administrative state of the static call: disabled - Not activated, able to be reconfigured or deleted (by GCID). enabled - Activated, available for immediate and permanent use.
ipaddress rrtpport admin-state
N/A N/A N/A
3-494
Static Call
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 END POINT A SHELF 1 .. SLOT 3 PORT 4 CHANNEL 16 SERVICE PROFILE default END POINT B TYPE CIRCUIT SHELF 1 SLOT 5 PORT 28 CHANNEL 1 SERVICE PROFILE default % CONFIGURE STATIC CALL flink1 STATE enabled
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 END POINT A .. SHELF 1 SLOT 3 PORT 4 CHANNEL 16 SERVICE PROFILE default END POINT 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
To display the configuration of all static connections:

% SHOW STATIC CALL ALL ADMIN
Static Call Admin Configuration ------------------------------EndPointA shelf slot port channel servProfile =========== 1 3 4 16 default EndPointB shelf slot port channel servProfile =========== 1 5 28 1 default / / / / LocalRTP LocalIP RemoteRTP RemoteIP
Index ===== 1
Name ========= flink1
AdminState ========== enabled
/ ============
To display the status of all static connections:

% SHOW STATIC CALL ALL STATUS
Static Call Status Information -----------------------------Index GCID OperState
CreationTime
Call GCID
3-495
===== 1
========== 123456
========= Stable
=================== 7/27/00 19:41
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.
Call GCID
This object permits you to manually tear down and delete a call from the system, using the calls 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
CONFIGURE CALL GCID gcid DELETE
Command Parameters
TABLE 3 -121.
CALL GCID Parameters

Field Length N/A Description The GCID number of a call to be torn down and removed.
Parameter gcid
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
Static Call Status Information -----------------------------Index GCID OperState CreationTime ===== ========== ========= =================== 1 123456 OutofServ 7/27/00 19:41
% CONFIGURE CALL GCID 123456 DELETE
Note
The call is actually torn down by the disable command issued above.
Test Call TestCalls

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 GSX9000s that have a trunk connection. Note that test calls may be used on all GSX9000 circuit network server modules except the CNS31.
3-496
Test Call
An operator can use a test call for testing the continuity of a given hard-wired path between two GSX9000 channels or a GSX9000 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. Test calls have the following additional attributes:
When a test call is enabled on a channel, that channel resource is not accessible by the system for any other purpose. There is at this time 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 deallocated.
Performing a Test Call

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 9000
Generate a tone at configured frequency and amplitude on a given INSERVICE channel (DS0). Operator 1
GSX 9000/5ESS
Listen for tone.
Operator 2
Upon creation, a test call is initialized as state=disabled, type=listen, frequency=1004 Hz and power = (-1000 dBm - far below the minimum detection
Test Call
3-497
range). In order to enable the test call function on a given channel, that channel must be INSERVICE. In order to reconfigure the test call mode, frequency, or power, the test call state must be disabled. 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 calls state to enable.
Command Syntax
CREATE TEST CALL callname CONFIGURE TEST CALL callname .. ENDPOINT SHELF shelf SLOT slot .. PORT portnum CHANNEL channum CONFIGURE TEST CALL callname STATE state CONFIGURE TEST CALL callname TYPE type CONFIGURE TEST CALL callname FREQUENCY freq CONFIGURE TEST CALL callname POWER power SHOW TEST CALL callname ADMIN SHOW TEST CALL ALL ADMIN SHOW TEST CALL callname STATUS DELETE TEST CALL callname
Command Parameters
TABLE 3 -122.
TEST CALL Parameters

Field Length 1-23 N/A Description A name by which to identify this test call. The shelf number in the GSX node configuration that contains a connection endpoint. In this release, one shelf is supported. Must be 1. The slot number occupied by the circuit network module used by one or more of the connection endpoints. Must be 3-16. The span number that contains the channel of the connection endpoint. For a T3 channel, must be 128. For an E1 channel, must be 1-8. For a T1 channel, must be 1-12. 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.
Parameter callname shelf
slot
N/A
portnum
N/A
channum
N/A
3-498
Test Call
TABLE 3 -122.
TEST CALL Parameters

Field Length N/A Description The operational state of the test call: disabled - test call is configured but not activated. Able to be reconfigured or deleted. enabled - test call is configured and active.
Parameter state
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 - 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.
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. 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.
power
N/A
Test Call
3-499
Command Example
Please refer to the diagram below throughout the following example.
GSX 9000
Operator 1 / GSX A Generates a tone at 1004 Hz with power level of -6 dDm on a given channel (DS0).
Endpoint: shelf 1 slot 5 port 1 channel 3
GSX 9000 Operater 2 / GSX B Listens for tone.

Endpoint: shelf 1 slot 7 port 1 channel 3
Two operators want to test for power loss between two GSX9000's 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. Step 1 - Operator 1 executes the following CLI commands on GSX A: The call name used in the example below is an arbitrary name - it does not need to be the same as the test call name at the far end. You name a given test call so that you can refer to the call in commands to configure it.
% CREATE TEST CALL callOne % CONFIGURE TEST CALL callOne ENDPOINT SHELF 1 .. SLOT 5 PORT 1 CHANNEL 3 % CONFIGURE TEST CALL TYPE play % CONFIGURE TEST CALL FREQUENCY 1004 % CONFIGURE TEST CALL POWER -6
Step 2 - Operator 2 executes the following CLI commands on GSX B:

% CREATE TEST CALL callOne % CONFIGURE TEST CALL callOne ENDPOINT SHELF 1.. SLOT 7 PORT 1 CHANNEL 3 % CONFIGURE TEST CALL TYPE listen % CONFIGURE TEST CALL FREQUENCY 1004
No power level needs to be assigned here - we only want to indicate what frequency to listen for. Step 3 - Operator 1 now executes the CLI command on GSX A:
% CONFIGURE TEST CALL callOne STATE enable
At this point, a tone of -6dBm at 1004 Hz is generated on the specified channel. AFTER Operator 1 has started playing the tone (by setting his call state to enable), Operator 2 proceeds to the next step below. Step 4 - Operator 2 begins to listen by executing the CLI command on GSX B:
% CONFIGURE TEST CALL callOne STATE enable
3-500
Test Call
At this point, Operator 2 on the listen side will look at the line and detect the level of the incoming tone. Step 5 - The level of the incoming tone can be viewed by executing the CLI command on GSX B:
% SHOW TEST CALL STATUS callOne
Operator 2 can now tell Operator 1 the level at which the tone was received. Step 6 - Reverse the process: The entire process may be reversed (each operator changes his test call type) to detect loss in the other direction. All test calls must be set to STATE disable before you can change any configuration information. 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. 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 MNS1x module.
Warning:
4-1
CHAPTER 4 Managing the GSX
You can manage the GSX in the following ways:
Using the Simple Network Management Protocol (SNMP) Using a Web Browser-based graphical user interface, the Sonus Insight Element Management System (EMS) Using a Command Line Interface (CLI) over a telnet connection (the assumed method in the remainder of this discussion)
This chapter discusses the means available to manage day-to-day GSX operations through the CLI.
4-2
Administration
Administration
Configuring Timing for Circuit Network Modules
Note The parameters discussed below are initially set by the CREATE/CONFIGURE ST SOURCE SHELF command. You must provide a timing signal to the Management Timing Adapter (MTA) for distribution to all CNS10/CNS20/CNS30/CNS31 modules via the Sonus mid-plane. The MTA10 provides signals for T1 circuits processed by CNS10, CNS30, and CNS31 modules. The MTA20 provides timing signals for E1 circuits processed by CNS20 modules. Note A configuration of mixed MTA10s and MTA20s is not considered in this discussion. This configuration will be possible in future GSX9000 releases. The CLI interface symmetrically supports a pair of MTA10s or a pair of MTA20s, as explained below. This signal may originate from one of six sources:
1.
External Clock A: MTA10 - BITS 1 input. Chapter 5 of the GSX9000 Open Services Switch Installation Guide discusses how to connect your external timing source to the BITS port on the MTA10. To connect, attach your primary BITS source to the BITS 1 port on this adapter. MTA20 - SETS (SDH Equipment Timing Source) 1 input. Chapter 5 of the GSX9000 Open Services Switch Installation Guide discusses how to connect your external timing source to the SETS port on the MTA20. To connect, attach your primary SETS source to the SETS 1 port on this adapter.
2.
External Clock B: MTA10 - 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. MTA20 - 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.
3. 4.
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.
5. 6.
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 suc-
Administration
4-3
cessor. This section presents the policies, rules, and procedures for managing these timing sources.
Timing Source Sequence Table

The twelve member prioritized list of timing sources is the Timing Source Sequence Table. The default priority is:
1. 2. 3. 4. 5. 6. 7. 8. 9. 10. 11. 12.
MTA1 External Clock A MTA1 External Clock B MTA1 REFCLK-A MTA1 REFCLK-B MTA1 HOLDOVER MTA1 OSCILLATOR MTA2 External Clock A MTA2 External Clock B MTA2 REFCLK-A MTA2 REFCLK-B MTA2 HOLDOVER MTA2 OSCILLATOR
This default priority is in effect whenever the system is booted and in most cases does not need to be changed. You may add, remove, and reprioritize 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 For example, the command,
% CONFIGURE ST SOURCE SHELF 1 MTA 2 SOURCE extClkA .. STATE disabled % DELETE ST SOURCE SHELF 1 MTA 2 SOURCE extClkA % CONFIGURE ST SHELF 1 RESEQUENCE
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
4-4
Administration
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:
1.
All sources must be grouped by MTA. For example, MTA1 External Clock A MTA2 External Clock A MTA1 HOLDOVER MTA1 OSCILLATOR is illegal, while MTA1 External Clock A MTA1 External Clock B MTA1 HOLDOVER MTA1 OSCILLATOR is legal.
2. 3. 4.
OSCILLATOR must always be the last entry for its MTA. HOLDOVER and OSCILLATOR must always have a lower priority than External Clock and REFCLK on any MTA (that is they must follow in table position). At least one source besides HOLDOVER and OSCILLATOR must be present.
Reference Clock Bindings

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 CNS20 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 the 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 commited 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
Administration
4-5
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
You may reprioritize a REFCLK binding. The command sequence below reprioritizes 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
Timing Source Switchover

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:
1. 2.
The active source fails. The GSX software waits for a period of FAILOVERGUARDTIME before proceeding to insure that the failure is not spurious. If the failure is not detected after FAILOVERGUARDTIME expires, the current source remains active and a notification of a spurious failure is issued. If the failure is again detected after FAILOVERGUARDTIME expires, the new source is selected from the Timing Source Sequence Table, validated, and activated. A switchover notification/trap is then issued.
3.
4-6
Administration
Note
The switchover is initiated only by a failure in the current active source. You may not force the switchover with a CLI command.
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-229 and System Timing Source on page 3-231.) The mechanism by which a source is restored when revertive switching is enabled is:
1. 2.
After failing and being removed from service, the source begins to recover. 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. 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.
3.
Revertive Source Switching

Source with a higher priority than current source recovers No switchover Switchover to recovered source Source with a lower priority than current source recovers No switchover No switchover
REVERTIVEREFSWITCH
disabled enabled
Revertive MTA Switching

REVERTIVEMTASWITCH When a failed MTA is replaced: MTA is automatically brought back online and its timing sources will be made available for consideration as active sources according to Timing Source Sequence Table priorities and revertive source switching rules. MTA is not brought back online and none of its timing sources will be made available for consideration as active sources until the MTA is manually reconfigured to be back online.
enabled
disabled
Administration
4-7
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 thevotes of the participating modules.
Daisy Chaining
The synchronized timing signal may be daisy chained to another shelf via the MTA timing out port as depicted in Figure 4-1, Daisy Chaining from MTA10 Timing Out Port. If you use this mechanism to propagate timing signals, you should be aware that:
1.
Given a Primary Reference Source (PRS) into GSX #1, you may propagate this signal to the BITS or SETS 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.
2.
3. 4. 5. 6.
(Daisy chaining from the MTA20 Timing Out also behaves as above.)
MTA10
Active Fault
MTA10 ports
BITS 1
BITS 2
Daisy chain
0093
Timing Out
FIGURE 4-1
Daisy Chaining from MTA10 Timing Out Port
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:
4-8
Administration
System Administrator User Read-only
System Administrator Access

The System Administrator can do the following for users:
Assign and maintain access privileges for other users. Assign a password when establishing the User ID. Assign a new password if, for example, a user forgets a password.
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 UserID and password, Sonus recommends that you record this information in a secure location. Caution YOU MUST NOT FORGET THE VALUE OF THIS USERID AND PASSWORD. If you do 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.
Adding Hardware Modules

Whenever you add GSX9000 hardware modules, you must configure them through the CLI CREATE/CONFIGURE SERVER commands. See Server on page 3-16. 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 4-17 on page 4-70. By default this files path is <BASEDIR>/cli/scripts/sysinit.tcl. You may modify this file name through the NVS Configuration Menus described in Chapter 8 of the GSX9000 Open Services Switch Installation Guide. To maintain NFS server redundancy (see NFS Server Redundancy on page 4-16) this file must be identical in content and name on each NFS server.
CNS Redundancy
4-9
CNS Redundancy
Sonus supports the N:1 redundancy model for CNS modules. 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-29 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:
only one CNS10 redundancy group or one CNS20 redundancy group may be defined in one shelf, but not both only one CNS30 or one CNS31 redundancy group may be defined in one shelf, but not both 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 a CNS30 redundant module can protect CNS30 or CNS31 redundancy clients, but a CNS31 redundant module can protect only CNS31 redundancy clients the CNS3x redundant module must be installed in slot 16 and a CNA03 adapter module must be installed behind it in adapter slot 16
PNS10 Redundancy
Sonus supports the N:1 redundancy model for PNS10 modules. 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-29. 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-34 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
4-10
PNS20 Redundancy
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.
PNS20 Redundancy
Sonus supports the 1:1 redundancy model for PNS20 modules. A PNS20 redundancy group is created by the CREATE SERVER .. HWTYPE PNS20 .. REDUNDANT command. For example, the command:
CREATE SERVER SHELF 1 SLOT 3 HWTYPE PNS20 redundant
creates the redundancy group PNS20-1-3. 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-29. Subsequently, a primary PNS20 in a different slot can be added to this redundancy group by creating a redundancy client. See Redundancy Client on page 3-34 for additional detail. Sonus recommends however that you use the APS objects to provide redundancy for your SONET network. This mechanism requires the PNS20 redundancy group but operates on higher level objects, the APS Group and the APS Channel. See Automatic Protection Switching (APS) Interface on page 3-496.
Layer 3 PNS Redundancy

Layer 3 PNS redundancy, using PNS10s or PNS30s, 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
4-11
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 end points of voice connections, these connections remain independent from the physical PNS/PNA interfaces. Blocks of logical bearer addresses are defined 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 end points 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 doesnt 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
4-12
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.
Creating Layer 3 PNS/PNA Pairs

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 PNS30/PNA30 pair in slot 3 to be used for Layer 3 redundancy:
% CREATE SERVER SHELF 1 SLOT 3 HWTYPE PNS30 .. ADAPTER pna30 FUNCTION enetLayer3 redundant
These commands create two client PNS30/PNA30 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 PNS30 .. ADAPTER pna30 FUNCTION enetLayer3 % CREATE SERVER SHELF 1 SLOT 5 HWTYPE PNS30 .. ADAPTER pna30 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
Creating and Enabling the Layer 3 Redundancy Group

The Layer 3 redundancy group, pns30-1-3 is created by the CREATE SERVER .. FUNCTION enetLayer3 redundant command shown above. To add the PNS 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
4-13
To enable these two PNS server modules:

% CONFIGURE REDUNDANCY CLIENT GROUP pns30-1-3 SLOT 4 .. STATE enabled % CONFIGURE REDUNDANCY CLIENT GROUP pns30-1-3 SLOT 5 .. STATE enabled
To enable the pns30-1-3 redundancy group:

% CONFIGURE REDUNDANCY GROUP pns30-1-3 STATE enabled
Creating and Configuring the OSPF Process

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-106. 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 % CREATE OSPF IF SHELF 1 IPADDRESS 10.10.4.1 % CONFIGURE OSPF IF SHELF 1 IPADDRESS 10.10.4.1 STATE enabled % CREATE OSPF IF SHELF 1 IPADDRESS 10.10.5.1 % CONFIGURE OSPF IF SHELF 1 IPADDRESS 10.10.5.1 STATE enabled % CREATE OSPF IF SHELF 1 IPADDRESS 10.10.6.1 % CONFIGURE OSPF IF SHELF 1 IPADDRESS 10.10.6.1 STATE enabled .. .. ..
Creating Logical Bearer Addresses for Call Endpoints

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, including the port(s) supported by the redundant PNS/PNA pair. The command below allocates 4 consecutive logical bearer IP addresses, beginning at 21.0.0.1:
% CREATE LOGICAL BEARER ADDRESS 21.0.0.1 SIZE 4
The command below releases the pool created above:

4-14
% DELETE LOGICAL BEARER ADDRESS 21.0.0.1
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. Figure 4-2, below, 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 Service on page 3-171) should be set to approximately 10 seconds. This ensures that the gateway signaling channel remains active upon PNS switchover. Otherwise, the TCP traffic wont move to new routes quickly enough on many routers, and the gateway signaling channels KEEPALIVETIMER facility may report link failure.
logical bearer addresses 21.0.0.1 & 21.0.0.2
active PNS
10.10.4.1
active PNS
OSPF Router
10.10.5.1
standby PNS
10.10.6.1
FIGURE 4-2
PNS30 Layer 3 Redundancy Group
MNS Redundancy
4-15
MNS Redundancy
Sonus supports the 1:1 redundancy model for MNS1x modules. By default, the redundant (standby) MNS1x monitors the active MNS1x from the time the GSX is booted. When the active MNS1x 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 MNS1x becoming active immediately and replacing the previously active MNS1x. If a core dump was initiated on the previously active MNS1x (due to the failure condition), it will complete before that MNS1x 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 MNS1x 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-29 for CLI commands to manually invoke this switchover. When you boot a GSX with redundant MNS1xs the first time, you must configure the NVS parameters. This configuration is perfomed on the active MNS1x while the standby MNS1x is locked out as explained in the the GSX9000 Open Services Switch Installation Guide. Once both are booted and initialized, all configuration commands are synchronized between them. Subsequent boots allow, but do not require, NVS configuration.
Configuring NVS Parameters

The NVS parameters require certain unique values for each MNS1x module. Parameters for both MNS1xs are specified to the active MNS1x through the NVS Configuration Menu when you install your GSX (see Chapter 8 of the GSX9000 Open Services Switch Installation Guide). The active MNS1x will copy its NVS parameters to the standby when the NVS configuration is completed and both MNS1xs are reset. Subsequent changes to the NVS configuration will be similarly replicated to the standby MNS1x (regardless of whether the original active/standby pairings have changed through switchovers). This procedure is referred to as NVS Mirroring. Subsequently, when both MNS1xs 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 MNS1xs through NVS Mirroring.
Configuring the Gateway Call Signal Port Interface

The description below pertains to IP call signaling with redundant MNS1xs when executing in the Sonus SoftSwitch environment. The call signal ports may be configured to use either the MNS1x management ports or the PNS ports. To work with MNS redundancy, call signaling 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-138 for more information about this configuration step.
4-16
NFS Server Redundancy
The effect of this routing is that the router (see Network Configuration Considerations on page 4-40) will reference the PNS interfaces. If the gateway signal port is configured to use management ports then (by the procedures outlined in Network Configuration Considerations on page 4-40) the router(s) must be configured with references to the MNA10 interface addresses. If the standby MNS1x becomes active via switchover, the router would not know which interface should receive the call signal traffic. One consideration when using the PNS 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.
Configuring the SS7 Gateway for Redundant MNS1xs

In the Sonus SoftSwitch environment, you must pre-register each MNS1x pair on each GSX with the SGX using the create-CC-client commands on the SGX. See the SGX SS7 Gateway Installation, Upgrade, and Operations Guide for detail on this operation.

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 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 4-17, GSX System Tree) 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 MNS1xs at all times as depicted in Figure 4-3, MNS and NFS Server Redundancy. In practice, only the active MNS1x accesses the NFS servers unless NFS commands specify the standby MNS1x.
4-17
MNS1 MNS2 S witch
/SonusNFS Data PRIMARY NFS Server SECONDARY NFS Server
/SonusNFS Data
G SX9000
FIGURE 4-3
MNS and NFS Server Redundancy
Once the GSX9000 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 GSX9000 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.
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

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 MNS1x is booted. These values will always be copied to the standby MNS1x. See Non-Volatile Storage (NVS) Parameters on page 3-34 for more information on parameter file loading.
4-18
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.
Manual Unmounting and Mounting

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:
1.
Examine the current configuration status: % SHOW NFS SHELF 1 SLOT 1 STATUS
Node: TPUBS Date: 1999/12/17 16:03:38 Zone: Shelf: Slot: 1 1 Active NFS Server: Standby NFS Server: Status: MOUNTED MOUNTED PRIMARY SECONDARY IP Address: 128.6.254.210 128.6.254.249 Mount Path: /TechPubsNFS /TechPubsNfs GMT
NFS Server: Primary Secondary
Last Error: NONE NONE
2.
Toggle the current ACTIVE to make it STANDBY:

% CONFIGURE NFS SHELF 1 SLOT 1 TOGGLE ACTIVE
3.
Confirm the toggle by examining the new configuration status:

Node: TPUBS Date: 1999/12/17 16:03:45 Zone: Shelf: Slot: 1 1 Active NFS Server: Standby NFS Server: Status: MOUNTED MOUNTED SECONDARY PRIMARY IP Address: 128.6.254.210 128.6.254.249 Mount Path: /TechPubsNFS /TechPubsNfs GMT
4.
Unmount the NFS server:

% CONFIGURE NFS SHELF 1 SLOT 1 UNMOUNT STANDBY
5.
Confirm the unmount:

Node: TPUBS Date: 1999/12/17 16:04:12 Zone: Shelf: Slot: 1 1 Active NFS Server: Standby NFS Server: Status: UNMOUNTED MOUNTED SECONDARY PRIMARY IP Address: 128.6.254.210 128.6.254.249 Mount Path: /TechPubsNFS /TechPubsNfs GMT
To manually mount an NFS server, you need to declare whether it is PRIMARY or SECONDARY. This information to make this declaration is in the SHOW ...
4-19
STATUS screen. In the above case, the PRIMARY is unmounted so you may manually mount it with the command: % CONFIGURE NFS SHELF 1 SLOT 1 MOUNT PRIMARY
Reconfiguring NFS Parameters

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
Then the new mount-point is displayed in the configured parameters,

Node: TPUBS Date: 1999/12/17 16:33:49 Zone: Shelf: UNIX User ID: NFS Server: Primary Secondary 1 1036 IP Address: 128.6.254.210 128.6.254.249 NFS Load Path: TPUBS UNIX Group ID: 101 Mount Path: /TrainingNFS /TechPubsNfs GMT
but the old (and current) mount-point is shown in the status:

Node: TPUBS Date: 1999/12/17 16:51:45 Zone: Shelf: Slot: 1 1 Active NFS Server: Standby NFS Server: Status: MOUNTED MOUNTED SECONDARY PRIMARY IP Address: 128.6.254.210 128.6.254.249 Mount Path: /TechPubsNFS /TechPubsNfs GMT
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 3-5 for more detail on the differences between configured parameters and operational parameters.
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,
4-20
Performing Live Software Upgrades
IN_SERVICE, and NOT_WRITABLE. See Using SNMP on page 4-51 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.
NFS Server Full

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 readonly 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 Mb of disk storage is freed up. (This may require your manual intervention.) At this point, event logging and call accounting will resume.
NFS Server Quotas Exceeded

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.

Beginning with the Version V04.00.02R001 GSX9000 software release, you may install new run-time software and operational firmware, without resetting the GSX9000. This allows stable calls to be preserved without any reduction of call capacity. This procedure is called a Live Software Upgrade (LSWU). Server module redundancy provides the foundation for LSWU. Each server module to be upgraded must be a member of a redundancy group. Server modules which are not part of a redundancy group can be upgraded, but calls carried by those server modules may be dropped. In summary, all stable calls will be preserved if all MNS, CNS, and
4-21
PNS server modules are part of a redundancy group. A GSX with this configuration has full server module redundancy. If your GSX contains any unprotected server modules, a live software upgrade could be disruptive, possibly resulting in dropped calls. This section provides procedures for upgrading systems with full server module redundancy as well as non-redundant systems. Server modules within a redundancy group will not be redundancy protected while that specific redundancy group is being upgraded. Limited access to configuration objects is provided during LSWU. Note New software to be installed must carry a more recent date and higher version number than the software that it replaces. You may not perform a live upgrade to software that carries either an older date or a lesser version number, than the currently running software. To determine software versions that you can perform a live upgrade from, refer to the Release Notes that accompany the new software. The path of the software release directory, hereafter /<SOFTWPTH> as illustrated in Figure 4-17, GSX System Tree, is central to this facility. This directory is populated with the new software and then specified to the CLI when you begin the procedure. While the LSWU is in progress, this directory name is maintained in volatile memory. When the procedure completes successfully, you must perform a CLI command to commit the directory name to non-volatile storage. If any errors occur during the software upgrade, you should leave the directory name uncommited. To recover the previous software, you need only reboot the GSX and it will come back up using the original, unchanged /<SOFTWPTH>. Figure 4-4, Live Software Upgrade With Full Server Module Redundancy depicts the high level events that must be undertaken to successfully complete the LSWU, when upgrading a system with full server module redundancy. This section elaborates upon these events. Subsequent sections detail the LSWU procedure for non-redundant systems. Warning Regardless of your GSX configuration, Sonus recommends that you choose a period of very low traffic volume to carry out a GSX software upgrade.
4-22
Upgrade PSX Upgrade PSX
Upgrade SGX Upgrade SGX
Install new software in Install new software in New /<SOFTWPTH> New /<SOFTWPTH>
Upgrade GSX9000 Upgrade GSX9000 Firmware (if necessary) Firmware (if necessary)
Copy Firmware Files to images directory under Current /<SOFTWPTH>
Upgrade each Module using CLI
Perform LSWU CLI Perform LSWU CLI Commands Commands
Specify /<SOFTWPTH> to Obtain Images From
Verify Software Images & Installed Features
Initiate the LSWU Sequence
Wait for LSWU to Wait for LSWU to Complete Complete
LSWU Internal Procedure
Permanently Configure Permanently Configure the New the New /<SOFTWPTH> /<SOFTWPTH>
FIGURE 4-4
Live Software Upgrade With Full Server Module Redundancy
4-23
Upgrade PSX and SGX

Consult the Sonus PSX Installation Guide and the Sonus SGX SS7 Signaling Gateway Installation and Operations Guide for these procedures.
Install New Software in New /<SOFTWPTH> in the GSX System Tree

Note Specific system software upgrade instructions may accompany your software distribution. If so, those instructions supercede the instructions in this section. Follow the steps listed below to install the GSX9000 software to your NFS server. This software is distributed by Sonus on a CD. These steps are illustrated through an ongoing example in which the user input portion of the dialog is underlined. In this example, the current software is V04.00.02R001. The new software is installed in /<SOFTWPTH> V04.01.00R000 under /BASEDIR GSX1, under the NFS mountpoint /export/home/SonusNFS. Substitute the names in your environment as necessary. Note This procedure requires that your NFS file server have UNIX account ID gsx (1036) with group ID gsx (101) already installed. Typically, this account is factory installed by Sonus before the NFS server is shipped.
1.
Log on to a system that has access to your primary NFS file server and gain superuser privileges.
> su
2.
Change directory to your GSX mount-point directory.

# cd /export/home/SonusNFS
3.
Insert the GSX9000 software distribution CD into the CD drive of your NFS system and verify its contents.
# ls /cdrom/cdrom0 announcements FLASH GSX.V04.01.00R000.tar.Z V04.01.00R000 GSX.V04.01.00R000.README
4.
Create a tmp directory under the mount-point directory.

# mkdir tmp
5.
Change directory to the tmp directory.

# cd tmp
6.
Copy the GSX9000.tar file from the CD to the tmp directory.

# cp /cdrom/cdrom0/GSX.V04.01.00R000.tar.Z ./
7.
Uncompress and untar the GSX9000 distribution software.

# zcat GSX.V04.01.00R000.tar.Z | tar xvf -
8.
Change directory to the distribution base directory (below your temporary directory).
4-24
# cd GSX9000
9.
Copy the new GSX9000 software into the GSX software release directory.
# cp -pR V04.01.00R000 /export/home/SonusNFS/GSX1
10.
Copy the new boot PROM program images to the images directory in the new GSX system tree (in case they are needed in the future):
# cp -p FLASH/V01.08.00R001/*.bin /export/home/SonusNFS/GSX1/V04.01.00R000/images
11.
Copy the new boot PROM program images to the images directory in the current GSX system tree (to be used to install new firmware, if necessary, as described in the next section).
# cp -p FLASH/V01.08.00R001/*.bin /export/home/SonusNFS/GSX1/V04.00.02R001/images
12.
Copy any script files that you need from the current GSX system tree to the new GSX system tree in the GSX Software Release directory. Enter the following commands:
# mkdir -p /export/home/SonusNFS/GSX1/V04.01.00R000/cli/scripts # cp -p /export/home/SonusNFS/GSX1/V04.00.02R001/cli/scripts/*.tcl /export/home/SonusNFS/GSX1/V04.01.00R000/cli/scripts # cp -p /export/home/SonusNFS/GSX1/V04.00.02R001/cli/sys/sysinit.tcl /export/home/SonusNFS/GSX1/V04.01.00R000/cli/sys # cp -p /export/home/SonusNFS/GSX1/V04.00.02R001/cli/sys/sessinit.tcl /export/home/SonusNFS/GSX1/V04.01.00R000/cli/sys
13.
Verify that the new files were copied and that they have the current date.
# ls -lu /export/home/SonusNFS/GSX1/V04.01.00R000/images
-rw-rwr--rw-rwr-. .
14. 15.
1 1036 1 1036
101 5355188 May 3 16:43 cns10.bin 101 5257876 May 3 16:43 cns20.bin
Repeat Steps 9-13 for each GSX served by this NFS server (such as GSX2, GSX3, and so on). Clean up your NFS server by removing the tmp directory.
# cd /export/home/SonusNFS # rm -fr tmp
16.
Remove the CD from the CD drive.

# eject
17.
Access your secondary NFS server and install the software to your secondary NFS by repeating the previous steps.
4-25
Upgrade GSX9000 Firmware

Note Specific system firmware upgrade instructions may accompany your software distribution. If so, those instructions supercede the instructions in this section. This step may or may not be necessary for post 4.00 GSX software releases. When it is necessary, you must install firmware once on each server module. Thereafter, this step may be skipped. The software upgrade instructions that accompany the new software will indicate whether or not a firmware upgrade is, or may be, necessary. If it is necessary, you will perform the following high level procedure:
1. 2.
Install the new software as shown in Install New Software in New /<SOFTWPTH> in the GSX System Tree on page 4-23, but do not initiate the LSWU. Using the CLI, perform the firmware upgrade on each server module from the current images directory.
Then, resume the LSWU procedure. You do not need to copy these new firmware images to the new /images directory, as that was done in Step 1) above.
Upgrade Modules through the CLI

The GSX must not be reset or switched over at any time during this procedure. If a reset does occur while upgrading firmware, contact Sonus Customer Service Center (CSC) for further instructions. Caution If an interruption occurs while a server module is being upgraded (using the procedure described below) the server module may become unuseable and need to be returned to Sonus via the RMA process. This could negatively impact the call handling capacity of your network. To begin, log on to the GSX and carry out the following procedure on each server module. Verify that the /<SOFTWPTH> into which you copied the new firmware files in Install New Software in New /<SOFTWPTH> in the GSX System Tree on page 4-23 is recognized as current by the GSX9000 software:
The value displayed for Software Path: must match the /<SOFTWPTH> that you copied the new firmware files to in that procedure. Verify that the module requires the new firmware. Issue the command:
% SHOW SERVER SHELF 1 SLOT slot STATUS
The value displayed for Firmware Version: will determine whether or not a firmware upgrade is necessary for this module. (If the value is equal to the new firmware version, the upgrade is not necessary.) If the upgrade is required, initiate it with the command:
% CONFIGURE SERVER FLASH SHELF 1 SLOT slot UPGRADE NOW
You will be asked to confirm this command:

Erase and Program Boot PROM FLASH Device - Confirm (Y/N) : Y
You should then monitor the progress of the firmware upgrade with the MONITOR command:
4-26
% MONITOR SERVER FLASH SHELF 1 SLOT slot STATUS
When the State becomes IDLE, terminate the MONITOR command by pressing CTRL-C. Then repeat the SHOW SERVER command shown above to verify that the new firmware has been installed. Upgrade each server module as necessary using this procedure.
LSWU with Full Server Module Redundancy

The sections below describe the actions that are necessary to complete the LSWU for a GSX that is configured with full server module redundancy. These systems will not lose stable calls during an LSWU. Because of full server module redundancy, you need never alter the UNPROTECTED CONTROL parameter (see Software Upgrade on page 3-26). These procedures also pertain to a GSX that does has one or more unprotected server modules, but additional preliminary steps may also be necessary. You may choose to alter the UNPROTECTED CONTROL parameter in this case and these systems could lose some calls during this procedure. After familiarizing yourself with the sections below, see LSWU with One or More Unprotected Server Modules on page 4-32 for these additional steps.
Synchronize All Redundancy Groups

Determine the names of all the GSX redundancy groups. The CLI command below displays this information:
SHOW REDUNDANCY GROUP SUMMARY
Node: TPUBS Date: 2001/12/04 15:36:48 Zone: GMTMINUS05-EASTERN-US -----------------------------------------------------REDUNDANCY GROUPS SUMMARY -----------------------------------------------------GMT
Redundant Name ---------------MNS10-1 PNS10-1-4 CNS10-1 CNS30-1 Shelf ------1 1 1 1 Slot ----------2 4 10 16 Type ------MNS10 PNS10 CNS10 CNS30
Server Function ---------MGMT ENET T1 T3 State -------ENABLED ENABLED ENABLED ENABLED
Ensure that all redundancy groups have achieved synchronization. The CLI command below displays the status of the MNS redundancy group mns10-1:
SHOW REDUNDANCY GROUP mns10-1 STATUS
-----------------------------------------------------REDUNDANCY GROUP STATUS ------------------------------------------------------
4-27
Name: Shelf: Hardware Type, Function: Redundant Slot: Redundant Slot State: Number of Synced Clients: Protected Slot: Last Switchover Reason: Client Slot -------1 Client State ----------------ACTIVESYNCED
MNS10-1 1 MNS10, MGMT 2 STANDBY 1 0 NONE
The client state of ACTIVESYNCED confirms synchronization. If there is a problem with MNS redundancy, it must be fixed before performing a LSWU. Ensure that the Redundant slot in all non-MNS redundancy groups is not currently active using the above commands. If the Redundant slot in any non-MNS redundancy group is active, revert the group using the following CLI command:
CONFIGURE REDUNDANCY GROUP groupName REVERT
Allow the Redundant card to reboot and sync to the Clients in its redundancy group.
Perform LSWU CLI Commands

Carry out the steps below by issuing the appropriate CLI commands. Once these commands have each completed successfully, the internal procedure is executed by the GSX run-time software. This procedure is described and illustrated below, see Upgrade Server Module Software (Internal Procedure) on page 4-29.
Specify the /<SOFTWPTH> to Obtain Images From

This command specifies the repository for the GSX software to use to obtain software images, SHOW screens, configuration files, and other files. To obtain images from the /<SOFTWPTH> V04.01.00R000:
% CONFIGURE SOFTWARE UPGRADE SHELF 1 .. DIRECTORY V04.01.00R000
Allow the parameter file to be written before proceeding. This takes a minimum of 15 seconds from the time the last configuration command is executed.
Verify Software Image Availability

This command clears the previous LSWU status, initiates a check for the availability of software images on the NFS server, and performs a series of consistency checks to ensure that the GSX is ready for an LSWU:
% CONFIGURE SOFTWARE UPGRADE SHELF 1 INITIALIZE
Note that by default, the LSWU process cannot be initialized if MGCP is configured on the GSX. The following error message will be displayed if this feature is configured:
The software upgrade cannot occur because MGCP is configured.
4-28
To skip this software feature compatibility check during LSWU initialization, issue the following command:
% CONFIGURE SOFTWARE UPGRADE SHELF 1 .. INITIALIZE OVERRIDE FEATURES
Note
Your LSWU process may not behave properly, and calls may be dropped, if you use the above command to override the compatibility check. After issuing the INITIALIZE command, you should verify the information on the Software Upgrade status and summary screens:
% SHOW SOFTWARE UPGRADE SHELF 1 STATUS % SHOW SOFTWARE UPGRADE SHELF 1 SUMMARY
The status screen should show a state of INIT. If it does not, then either the INITIALIZE command timed out or some other pre-upgrade check performed by the GSX failed and caused a state of IDLE. The LAST REASON field provides further indication of the failure. The system event logs may also be reviewed to isolate the problem. The summary screen should show the current versions of the software running on each server module as well as the version of the image in the new /<SOFTWPTH>. Verify that these are correct.
Initiate the LSWU Sequence

This command starts the LSWU procedure.
% CONFIGURE SOFTWARE UPGRADE SHELF 1 UPGRADE NOW
A user confirmation is required to allow the LSWU to proceed:

Initiate the automated software upgrade process - Confirm (Y/N) : Y
Warning
Do not use any special debug commands after initiating the LSWU until it is complete. Doing so may result in unpredictable behavior including the possible loss of calls.This could negatively impact the call handling capacity of your network. From this point forward, this procedure is controlled exclusively by the GSX run-time software. Because of the MNS1x switchovers that occur, your original CLI session will be lost. You may monitor the progress of the procedure by issuing the following command on the currently active MNS1x:
% SHOW SOFTWARE UPGRADE SHELF 1 STATUS
Node: TPUBS Date: 2001/10/02 19:57:22 Zone: GMTMINUS05-EASTERN-US GMT
----------------------------------------------SOFTWARE UPGRADE SHELF STATUS -----------------------------------------------
Status: Current Group: Current Slot: Duration:
BUSY CNS30-1 10 368
Directory: Remaining Groups: Remaining Slots: Start Time:
V04.01.00R000 0 3 2001-10-02,19:51:11.07
Current State:
CLIENTSX
4-29
Last State: Last Reason:
CLIENTREVERT NONE
After you confirm the LSWU initiation, the GSX run-time software carries out a systematic replacement of all necessary software in all server modules. See Upgrade Server Module Software (Internal Procedure) on page 4-29 for additional detail. When the LSWU status for all server modules is COMPLETE, and the overall status indicates COMMITREQUIRED, you must commit the new /<SOFTWPTH> to non-volatile storage.
Permanently Configure the New /<SOFTWPTH>

When the LSWU is complete and the new software is verified and running on all server modules, you must permanently configure the /<SOFTWPTH> into the NFS parameters:
% CONFIGURE SOFTWARE UPGRADE SHELF 1 COMMIT DIRECTORY
This establishes the /images directory under the /<SOFTWPTH> V04.01.00R000 as the new non-volatile software image directory for all subsequent GSX boot procedures.
Upgrade Server Module Software (Internal Procedure)

After you confirm the LSWU initiation, the GSX run-time software carries out a systematic replacement of all necessary software in all server modules. The decisions and processes that make up this procedure are illustrated in Figure 4-5 and in Figure 4-6. The discussion below expands upon this illustration. The high level order of processing is:
1. 2. 3. 4. 5. 6. 7. 8. 9.
disable the manual configuration of all objects upgrade the MNS1xs sequentially (this causes 2 MNS switchovers) save the new parameter file under the new /<SOFTWPTH>/param directory save the initial service mode of all non-MNS server modules simultaneously reset all non-MNS redundant server modules and out of service server modules that are enabled configure non-MNS server modules that were initially out of service to in service wait for non-MNS redundancy groups to synchronize wait for the first out of service modules to achieve running state configure all unprotected, enabled server modules that were initially in service to out of service with dryup; (this does not include the unprotected server modules that were initially out of service, which were reset and brought back into service in steps 5-6) perform a redundancy group update (see Figure 4-6) for each enabled, non-MNS redundancy group sequentially reset each remaining unprotected CNS module, configure it in service, and wait it to achieve the running state sequentially reset each remaining unprotected PNS module, configure it in service, and wait for it to achieve the running state Save the new parameter file under the new /<SOFTWPTH> reenable the configuration of all objects
10. 11. 12. 13. 14.
This procedure will be terminated by either:
4-30
1. 2.
successfully loading new software images into all necessary server modules failing to successfully load some image to some server module
4-31
Begin LSWU Phase II
Disable GSX Configuration Commands
Bring server modules initially OOS back In-Service
Wait for CNS to reboot and go active
Perform MNS Switchover #1 (updates MNS1) Wait for redundancy groups to sync and first OOS server modules to come up
Yes More unprotected CNS modules?
MNS1 resets, returns as standby, and syncs to active
No
Perform MNS switchover #2 (updates MNS2)
Take enabled unprotected server modules OOS with dryup
Sequentially reset unprotected PNS modules and bring them back In-Service
MNS2 updated, returns as standby and syncs to active
Save parameter file under SW Upgrade Path
For all enabled redundancy groups: Perform Redundancy Group Update (See details below)
Wait for PNS to reboot and go active
Save initial service mode of nonMNS server modules
More Redundancy Groups?
Yes
More unprotected PNS modules?
Yes
No
No
Simultaneously reset non-MNS Redundant server modules and enabled OOS server modules Sequentially reset unprotected CNS modules and bring them back In-Service
Save new parameter file under SW Upgrade Path
Enable GSX Configuration Commands
Done
0228
FIGURE 4-5
LSWU Internal Procedure
4-32
Begin Redundancy Group Update
Is group enabled with at least one Client enabled? Yes
No
Wait for enabled Client to sync
More Clients initially enabled? Yes
No
No
Is Redundant slot Active? Yes
Reset Synced Client
Disable current Client, Enable next Client
Revert to Protected Client
Wait for Client slot to reboot as standby and sync to Redundant slot
Restore initial Admn state of all Clients Again, mirror this to standby MNS
Save initial Admn state of each Client Mirror this to standby MNS
Revert to Original Client Wait for all enabled Clients to sync to standby Redundant slot
B
Disable all Clients within group except first one
Done Redundancy Group Update

0227
FIGURE 4-6
LSWU Redundancy Group Update Detail
Note that at any arbitrary point in time during the LSWU procedure, different versions of software may be running on the server modules. For this reason, you are restricted to SHOW and MONITOR commands only during the LSWU. You are not prevented from issuing debugging and other commands, but nevertheless you should not attempt them. Remember that no download will occur for a module if it is not necessary (that is, if its current software image is the same version as the corresponding image in the upgrade directory).
LSWU with One or More Unprotected Server Modules

If your GSX has unprotected server modules or server modules that are not members of a redundancy group, then these modules need to be identified, taken out of service with dryup, and upgraded with the new software. When a server module is taken out of ser-
4-33
vice with dryup, active calls using that module are allowed to complete while all new calls are prevented. The dryup period is indefinite. Active calls may be lost if you begin the LSWU before all the calls complete. Also, if the server module that is being upgraded contains unique resources or accesses unique routes, then calls that require those services will be held off while that server module is being upgraded. For these reasons, LSWU to a system without full server module redundancy may cause calls to be dropped. Sonus recommends taking at least one of your multiple SPS30 server modules out of service, in the manner described above, before initiating an LSWU. Then that SPS30 will be able to process new calls, using newly loaded software, while the remaining SPS30s are processing previously active calls, using old software, as the LSWU is in progress. This action will reduce dropped calls but also reduce call capacity until the LSWU successfully completes. The next section details these procedures. The handling of unprotected server modules using this method is intended only for those systems which employ SPS30 server modules, which do not support redundancy. CNS and PNS redundancy is highly recommended. Note Redundant MNS modules must be present to perform the LSWU. If your GSX contains a single MNS module, you must install the new software by rebooting your system as described in the GSX9000 Open Services Switch Installation Guide. The remainder of this section describes the procedures and considerations that are necessary for LSWU in environments that include unprotected server modules.
LSWU Procedure with Unprotected Modules

Sonus recommends the following user actions for performing LSWU to GSX systems with unprotected modules:
1. 2.
Place the desired unprotected server module or modules (described above) out of service with dryup. For you to be able to control the length of time that In Service unprotected server modules are dried up during the LSWU, configure the unprotected control to skip using the following CLI command:
% CONFIGURE SOFTWARE UPGRADE SHELF 1 .. UNPROTECTED CONTROL SKIP
This causes the unprotected server modules that are initially In Service at the start of the upgrade to be skipped and left Out Of Service at the end of the upgrade, as described in the automatic upgrade process below.
3. 4.
Wait for calls to sufficiently dry up on the server modules taken Out Of Service in Step 1. Any calls remaining on them when you proceed will be dropped. Execute the LSWU procedure as directed in Initiate the LSWU Sequence on page 4-28. After the first upgrade process, allow sufficient time for the remaining server modules (initially In Service, now Out of Service) to dry up. Then initialize an initiate a second process to complete the upgrade from where it left off. Upgrades the MNS redundancy group (while preserving stable calls). Upgrades unprotected server modules that were manually placed out of service with dryup and puts them back into service (using them to carry stable calls in the remainder of the procedure).
During the automatic upgrade process, the LSWU software:

1. 2.
4-34
3. 4.
Directs all the remaining unprotected modules out of service with dryup. Upgrades all modules in non-MNS redundancy groups (while preserving stable calls carried by them). This should be the bulk of the upgrade process, taking up to 30 minutes. This is the fixed length of time the initially In Service unprotected server modules are allowed to dry up. (A) If UNPROTECTED CONTROL is set to skip, the LSWU exits here. The server modules that were initially In Service at the beginning are left Out Of Service and are NOT upgraded. This allows you to control the dryup period for these remaining unprotected server modules. You must not issue configuration or debug commands during this dryup period. You must initialize and initiate another live software upgrade when these server modules are sufficiently dried up in order to complete the upgrade from where it left off. This second upgrade automatically brings these server modules back In Service after upgrading them. (B) If UNPROTECTED CONTROL is set to upgrade, the remaining unprotected server modules are upgraded in sequence and brought back In Service. Any calls remaining on them at this time are dropped. You do not have control of the dryup period for these server modules. They are dried up for the duration of the redundancy group updates in Step 4.
5.
Example LSWU with Unprotected SPS30 Modules

In this example, multiple unprotected SPS30 modules are present. Much of the procedure for LSWU with full server module redundancy applies to a GSX with SPS30s. Begin by following each step from Performing Live Software Upgrades on page 4-20 through Synchronize All Redundancy Groups on page 4-26. Place one of the SPS30 modules out of service with ACTION dryup. This step will allow that module to receive upgraded software and then provide packet transport to sustain calls later in the procedure. As an example, to place the SPS30 in slot 5 out of service, issue the command:
% CONFIGURE SERVER SHELF 1 SLOT 5 MODE OutOfService .. ACTION dryup
By default, active calls currently using these SPS resources are allowed to dryup indefinitely. No new calls utilize these SPS resources. Instead, they shift over to an SPS30 module that is still In Service. You may observe the progress of the dryup on this SPS30 server module by issuing the command:
SHOW RESOURCE PAD SHELF 1 SLOT 5 STATUS
When "Utilization %" equals 0, all active calls are complete. Allow sufficient time for all or most of these calls to terminate normally before proceeding. Next, configure the upgrade to skip any In Service unprotected server modules:
% CONFIGURE SOFTWARE UPGRADE SHELF 1 .. UNPROTECTED CONTROL SKIP
After the upgrade process exits, the unprotected SPS30 module(s) that were initially In Service will now be Out Of Service, and still running the old software version. Allow these server modules to finish drying up sufficiently.
Event Monitoring
4-35
Then initialize and initiate another LSWU to complete the upgrade from where it left off. After the second LSWU is done, all server modules will be running the new version of software and will be back In Service. After commiting the new software, see Permanently Configure the New /<SOFTWPTH> on page 4-29, you may freely provision services on this GSX.
Restoring the Previous GSX9000 Software

This procedure does require resetting/rebooting the GSX. If you did not COMMIT the new /<SOFTWPTH>, simply reboot the GSX.
If you did COMMIT the new /<SOFTWPTH>, then permanently configure the previous /<SOFTWPTH> through the CLI,
% CONFIGURE NFS SHELF 1 SOFTWARE PATH old-path
and reboot the GSX.

Warning
You must use the (old) parameter file that was saved in the old /<SOFTWPTH> when you reboot. Attempting to restore the previous software version with a parameter file created in a newer software version will cause unpredictable results. Never use a parameter file with a higher version number than the GSX9000 software version.
Event Monitoring
GSX run-time software maintains ASCII event log files for:
System accounting data (event type acct) System debugging data (event type debug) System trace data (event type trace) System level events (event type system)
Event log files are saved below the <BASEDIR>/evlog/<NODEID>/subdirectory of the GSX System Tree on the NFS server (see Figure 4-17 on page 4-70). 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 discussion 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 Call Accounting on page 5-1, for this information.
File Names
The file names for these log files are constructed as follows:
4-36
Event Monitoring
SXXXXXX.TTT
Where,
S is the shelf number (hex) XXXXXX is a 6 digit sequence number (hex) that increments by one every time a new file is created (as discussed below in Sequence Number in File Name) TTT is the file name extension for the event type: SYS = system level events log TRC = trace data file DBG = debugging data file
Thus a file named 100003A.SYS designates a system event log file for shelf 1, sequence number 58.
File Size
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-53). By default this size is 2048K bytes. Each event log file record is queued in MNS1x 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.
Number of Coexisting Files

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 havent 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.
Sequence Number in File Name

The file NEXTTTTn where,
TTT = file name extension for event type n = shelf number
Event Monitoring
4-37
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. Warning To guarantee that this naming strategy is not violated, do not alter or remove the NEXTTTTn file. The examples below use the shelf 1 system event log (in the /SYS subdirectory) to illustrate the GSX software strategies for creating, naming, and maintaining these files.
NUMFILES value 32
current system event log file name 100000C.SYS
content of NEXTSYS1 00000D
GSX Action to create a new file
delete 100000D.SYS create 100000D.SYS write 00000E into NEXTSYS1 delete 1000001.SYS create 1000001.SYS create NEXTSYS1 and write 000002 into it delete 1000001.SYS create 1000001.SYS write 000002 into NEXTSYS1
32
no existing file (see note)
non-existent file
32
1000020.SYS
000021 * * This overflow value is noted 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
4-38
Event Monitoring
existing version of 1000001.SYS would be lost (because it is recreated).
Configuration
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-53 and Event Filter on page 3-57.
Destination of Events
You can direct the logging of events to disk (that is the GSX System Tree discussed previously), internal MNS1x 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
Event filters allow you to fine tune the event log by adding criteria to event selection. You can select events:
that are associated with a specific GSX software subsystem of a specific criticality that occur on a specific module
The software subsystem is specified by the CLASS parameter to the Event Filter object (see Event Filter on page 3-57). The set of software subsystems to select from are:
Call Processing (callproc) Resource Management (resmgmt) System Management (sysmgmt) Directory Management (directory) Network Management (netmgmt) Signaling (signaling) Routing (routing)
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)
Event Monitoring
4-39
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. 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:
3 - specifies the single module in slot 3 3,5 - specifies the modules in slot 3 and slot 5 3-5 - specifies the modules in slots 3, 4, and 5
The MODE parameter turns the Event Filter object on or off. The example command below captures only system events of critical criticality (filtering out events of major, minor, and informational criticality) that originate in the Resource Management subsystem that occur on the modules that occupy slots 3 and 4 in shelf 1 of the GSX9000:
CONFIGURE EVENT FILTER SHELF 1 SLOT 3,4 LOG system .. CLASS resmgmt LEVEL critical MODE on
Show Commands
The example below shows the configured parameters for all event types:
SHOW EVENT LOG ALL ADMIN
File File Size Type Cnt (KB)
File Msg Save
Mem Size Filter (KB) Level Admin State
Queue To
------ ---- ----- ----- ------ ---- -------- -------SYSTEM 32 DEBUG TRACE ACCT 32 32 8 2048 2048 2048 10 10 10 BOTH BOTH 16 16 MINOR MINOR MAJOR MAJOR ENABLED ENABLED ENABLED ENABLED
MEMORY 16 BOTH 16
32768 10
This example shows the configured parameters for system event types (a subset of the above display):
SHOW EVENT LOG system ADMIN
File File Size Type Cnt (KB)
File Msg Save
Mem Size Filter (KB) Level Admin State
Queue To
------ ---- ----- ----- ------ ---- -------- -------SYSTEM 32 2048 10 BOTH 16 MINOR ENABLED
4-40
Network Configuration Considerations
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
File/M File/M File/M Admin Shelf Type State Current File Recs KBytes Events
Logged Logged Dropped
------------------------------------------------------1 SYSTEM ENABLED 100001B.SYS 542 542 1 DEBUG ENABLED 1000004.DBG 19 19 1 TRACE ENABLED 0 0 1 ACCT ENABLED RECOVERING 0 1 87 62 1 0 0 0 0 0 0 0 0 0 0 0 0 0
By default the MNS1x 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 MNS1x server module memory:
SHOW EVENT MEMORY ALL

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.
GSX with Separate Routed Subnet per Interface

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 4-7 the Call Signal Link is configured to share PNS interfaces with the Voice data traffic.
4-41
GSX1 signaling addr 12.1.1.1
1 10.8.1.45 2 10.9.1.46
10.8.1.47
a Router
c d
10.7.1.63
10.7.1.61
1 2
10.9.1.48 b
10.10.1.64 10.10.1.62
Default Routes: intf 1: 10.8.1.47 intf 2: 10.9.1.48 Net Routes: intf 1: 12.1.x.x/10.8.1.47 intf 2: 12.1.x.x/10.9.1.48
Static Routes: 12.1.1.1/10.8.1.45 12.1.1.1/10.9.1.46 12.1.1.2/10.7.1.61 12.1.1.2/10.10.1.62
FIGURE 4-7
GSX with Separate Routed Subnet per Interface
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 4-7), 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 4-7 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. 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.
4-42
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:
# Configure the PNS interfaces CONFIGURE NIF ENET-1-4-1 IPADDRESS 10.8.1.45 .. MASK 255.255.0.0 NEXTHOP 10.8.1.47 . . CONFIGURE NIF ENET-1-4-2 IPADDRESS 10.9.1.46 .. MASK 255.255.0.0 NEXTHOP 10.9.1.48 . . # Create the call signaling listen port CREATE GATEWAY SIGNALING PORT 1 CONFIGURE GATEWAY SIGNALING PORT 1 INTERFACE nif CONFIGURE GATEWAY SIGNALING PORT 1 IPADDRESS 12.1.1.1 . . # 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:
# Configure the PNS interfaces CONFIGURE NIF ENET-1-4-1 IPADDRESS 10.7.1.61 .. MASK 255.255.0.0 NEXTHOP 10.7.1.63 . . CONFIGURE NIF ENET-1-4-2 IPADDRESS 10.10.1.62 .. MASK 255.255.0.0 NEXTHOP 10.10.1.64 . . # Create the call signaling listen port CREATE GATEWAY SIGNALING PORT 1 CONFIGURE GATEWAY SIGNALING PORT 1 INTERFACE nif CONFIGURE GATEWAY SIGNALING PORT 1 IPADDRESS 12.1.1.2 . . # Create network routes to the call signal network
4-43
# 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 4-7, 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 4-15). The network routes are added just as shown, using management interface addresses.
GSX with Shared Routed Subnets

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.
a 1 10.8.1.45 10.8.1.47 2 10.8.1.46 10.8.1.48 b
c Router d
10.7.1.63 10.7.1.61 10.7.1.64 10.7.1.62
1 2
Host Routes: 10.8.1.45 on intf a 10.8.1.46 on intf b 10.7.1.61 on intf c 10.7.1.62 on intf d Static Routes: 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
FIGURE 4-8
GSX With Shared Routed Subnets
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
4-44
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.
GSX with Switched Interfaces to a Single Routed Subnet

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.
switch1
10.8.254.240
Router
10.7.254.240
switch2
10.8.1.46 10.8.1.45 1 2 GSX1 signaling addr 12.1.1.1 Default Routes: intf 1: 10.8.254.240 Net Routes: intf 1: 12.1.x.x/10.8.254.240
Static Routes: 12.1.1.1/10.8.1.45 12.1.1.2/10.7.1.61
10.7.1.61 10.7.1.62 2 1 GSX2 signaling addr 12.1.1.2 Default Routes: intf 1: 10.7.254.240 Net Routes: intf 1: 12.1.x.x/10.7.254.240
FIGURE 4-9
GSX with Switched Interfaces to a Single Routed Subnet
One limitation of the Figure 4-9 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.
GSX with Switched Interfaces to Multiple Routed Subnet Links

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
4-45
router with a corresponding number of interface links. The traffic balancing occurs at the expense of increased configuration requirements.
10.8.1.47 switch1 10.8.1.48
a b Router
c 10.7.1.63 d switch2 10.7.1.64
10.8.1.46 10.8.1.45 1 2 GSX1 signaling addr 12.1.1.1 Default Routes: intf 1: 10.8.1.47 intf 2: 10.8.1.48 Net Routes: intf 1: 12.1.x.x/10.8.1.47 intf 2: 12.1.x.x/10.8.1.48
Host Routes: 10.8.1.45 on intf a 10.8.1.45 on intf b 10.7.1.63 on intf c 10.7.1.63 on intf d Static Routes: 12.1.1.1/10.8.1.45 12.1.1.2/10.7.1.61
10.7.1.61 10.7.1.62 1 2 GSX2 signaling addr 12.1.1.2 Default Routes: intf 1: 10.7.1.63 intf 2: 10.7.1.64 Net Routes: intf 1: 12.1.x.x/10.7.1.63 intf 2: 12.1.x.x/10.7.1.64
FIGURE 4-10
GSX with Switched Interfaces to Multiple Routed Subnet Links
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.
GSXs Directly Connected

This configuration is sometimes used in test labs (where router resources may be scarce).
1 2
10.8.1.1 10.8.1.5
10.8.1.2 10.8.1.6
1 2
Net Routes: intf 1: 12.1.x.x/10.8.1.2 intf 2: 12.1.x.x/10.8.1.6
Net Routes: intf 1: 12.1.x.x/10.8.1.1 intf 2: 12.1.x.x/10.8.1.5
FIGURE 4-11
GSXs Directly Connected
The configuration in Figure 4-11 allows both GSXs to detect that the path between them
4-46
on a specific interface is down. A switch may be inserted (as depicted in Figure 4-12), 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 above in Figure 4-11 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 below in Figure 4-12. Whenever a NIF is connected back to back with another NIF, as in Figure 4-11, 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.
1 2
10.8.1.45 switch 10.8.1.46
10.8.1.61 10.8.1.62
1 2
FIGURE 4-12
GSXs Directly Connected with Switch
GSX in ATM+IP Environments

This configuration is shown in Figure 4-13 below. In this environment, NIFs of all types (ipOverAtm and ethernetCsmacd) must be configured with NEXTHOP set to 0.0.0.0. The following CLI command segment implicitly sets these values by omitting the NEXTHOP parameter:
# Configure a PNS10 interface CONFIGURE NIF ENET-1-4-1 IPADDRESS 10.8.1.45 ..
4-47
MASK 255.255.0.0 # Configure the PNS20 interface CONFIGURE NIF IPOA-1-5-1-1 IPADDRESS 1.2.3.4 .. MASK 255.255.0.0
PNS20
ATM
10.8.1.61 10.8.1.62
PNS20
G SX 1
10.8.1.45 PNS10 10.8.1.46
G SX 2
PNS10
Switch
FIGURE 4-13
GSXs in ATM and IP Networks
Reconfiguring a MNS Network Interface (MGMT NIF)

In order to change the IP address and/or the subnet mask in an MNS 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 NIFs 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. In the example below,
CONFIG MGMT NIF SHELF 1 SLOT 1 PORT 1 .. IPADDRESS 128.2.3.4 MODE standby CONFIG MGMT NIF SHELF 1 SLOT 1 PORT 1 .. IPADDRESS 128.2.3.4 STATE disabled CONFIG MGMT NIF SHELF 1 SLOT 1 PORT 1 NEXTHOP 0.0.0.0 CONFIG MGMT NIF SHELF 1 SLOT 1 PORT 1 .. IPADDRESS 128.5.6.7 MASK 255.0.0.0 .. NEXTHOP 128.6.254.240
a MGMT NIFs 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 reenable 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
4-48
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.
OC-3 TDM Interface Hardware

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 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 CNS30triplicate, according to the conventions discussed in Redundancy Group and Redundancy Client in Chapter 3.
Figure 4-14, OC-3 TDM Subsystem, Top-Down View shows how the above hardware elements are positioned in a GSX9000 chassis:
4-49
OC-3 TDM Subsystem CNA33 (2) Blank SONET Midplane
Adapter Modules Midplane Server Modules
Slots
9 10
11 12 13 14 15 16
CNS30 (3)
GSX Top-down View
FIGURE 4-14
OC-3 TDM Subsystem, Top-Down View
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.
Configuring the OC-3 TDM Group

You specify this subsystem by using the CREATE SERVER .. HWTYPE CNS30 .. with the ADAPTER cna33 parameter. The SLOT must be the leftmost (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
4-50
Configuring an SPS30
% CONFIG SERVER SHELF 1 SLOT 7 STATE enabled
Configuring the SONET Port

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 leftmost) server slot in the triplicate, and ptn is the port number. The CNA33 behind the originating slot (the rightmost 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-51 identifies the SONET port on a CNA33 module residing in slot 5 behind a CNS30triplicate 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-405.
Configuring the APS Group

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 CNS30triplicate, 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-436.
Configuring an SPS30
Sonus offers a Signal Processing Server Module (SPS30). This module is a CNS30 that is used exclusively as a call processing resource to provide packet voice compression, packet voice silence suppression, and other related functions. This module is used without dedicated I/O ports, and thus its corresponding adapter module must be absent. See the GSX9000 Open Services Switch Installation Guide, Chapter 2, for a summary description of the CNS30 server module. This module is used by the GSX9000 software to provide SIP and H.323 call processing support. Redundancy protection is not available for this module.
Using SNMP
4-51
You specify this subsystem by using the CREATE SERVER .. HWTYPE CNS30 .. with the ADAPTER none parameter. To create and activate an SPS30 in slot 8:
% CREATE SERVER SHELF 1 SLOT 8 HWTYPE cns30 .. ADAPTER none % CONFIG SERVER SHELF 1 SLOT 8 STATE enabled
Note
The CNS25 circuit network server module also provides call processing resources for voice compression, in the same manner as the SPS30. This module, however,also simultaneously supports 12 dedicated E1 spans linked through its CNA25 circuit network adapter module. CNS25 configuration is discussed in Server on page 3-16.
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-42.
Support Files for SNMP

The files below assist the implementation of a Network Management System (NMS) to manage GSX9000s. These files reside in the /sys subdirectory within the GSX system tree (see Figure 4-17 on page 4-70).
marlinMib.sum
This file contains a summary of all SNMP MIB Objects that are supported by the GSX9000. It specifies the name, type, access and description of each MIB object. The purpose of this file is to assist with the integration of GSX9000 support into a custom NMS.
marlinTraps.sum
This file contains a summary of all SNMP Notifications (that is, traps) that are supported by the GSX9000. 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 GSX9000 support into a custom NMS.
4-52
Using SNMP
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 (HPNNM). 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 GSX9000. 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. 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 occurances of Error Alarms within this file will have to be replaced with Error Events before it can be successfully loaded. To load this file into HP-NNM, execute the (UNIX) command:
xnmevents -replace sonusTrapd.conf
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.
Trap and MIB Names

Table 4 -1, Sonus GSX Trap Names lists all GSX traps and the full MIB name of the trap. See the referenced MIB source file for further detail. Table 4 -2, Sonus SoftSwitch (PSX6000) MIB Names lists all PSX6000 trap MIB names. These traps cannot be configured through SNMP and hence do not have a trap name alias. Table 4 -3, Sonus Insight MIB Names lists all Sonus Insight trap MIB names. These traps cannot be configured through SNMP and hence do not have a trap name alias.
TABLE 4 -1.
Sonus GSX Trap Names

MIB Name sonusNodeShelfPowerA48VdcNormalNotification sonusNodeShelfPowerB48VdcNormalNotification sonusNodeShelfPowerA48VdcFailureNotification sonusNodeShelfPowerB48VdcFailureNotification
Trap Name shelfPowerA48VdcNormal shelfPowerB48VdcNormal shelfPowerA48VdcFailure shelfPowerB48VdcFailure
Using SNMP
4-53
TABLE 4 -1.

MIB Name sonusNodeShelfFanTrayFailureNotification sonusNodeShelfFanTrayOperationalNotification sonusNodeShelfFanTrayRemovedNotification sonusNodeShelfFanTrayPresentNotification sonusNodeShelfIntakeTempWarningNotification sonusNodeServerTempWarningNotification sonusNodeServerTempFailureNotification sonusNodeServerTempNormalNotification sonusNodeServerInsertedNotification sonusNodeServerRemovedNotification sonusNodeServerResetNotification sonusNodeServerOperationalNotification sonusNodeServerPowerFailureNotification sonusNodeServerSoftwareFailureNotification sonusNodeServerHardwareFailureNotification sonusNodeAdapterInsertedNotification sonusNodeAdapterRemovedNotification sonusNodeMtaInsertedNotification sonusNodeMtaRemovedNotification sonusNodeEthernetActiveNotification sonusNodeEthernetInactiveNotification sonusNodeEthernetDegradedNotification sonusNodeBootNotification sonusNodeSlaveShelfBootNotification sonusNodeNfsServerSwitchoverNotification sonusNodeNfsServerOutOfServiceNotification sonusNodeNfsServerInServiceNotification sonusNodeNfsServerNotWritableNotification sonusNodeServerDisabledNotification sonusNodeServerEnabledNotification sonusNodeServerDeletedNotification sonusParamBackupLoadNotification sonusParamCorruptionNotification sonusNodeAdapterMissingNotification sonusNodeAdapterFailureNotification sonusNodeSlotResetNotification sonusNodeParamWriteCompleteNotification sonusNodeParamWriteErrorNotification sonusNodeBootMnsActiveNotification sonusNodeShelfIntakeTempNormalNotification sonusEventLogFileStateNotification
Trap Name shelfFanTrayFailure shelfFanTrayOperational shelfFanTrayRemoved shelfFanTrayPresent shelfIntakeTempWarning serverTempWarning serverTempFailure serverTempNormal serverInserted serverRemoved serverReset serverOperational serverPowerFailure serverSoftwareFailure serverHardwareFailure adapterInserted adapterRemoved mtaInserted mtaRemoved ethernetActive ethernetInactive ethernetDegraded nodeBoot slaveShelfBoot nfsServerSwitchover nfsServerOutOfService nfsServerInService nfsServerNotWritable serverDisabled serverEnabled serverDeleted paramBackupLoaded paramCorruption adapterMissing adapterFailure slotReset paramWriteComplete paramWriteError nodeBootMnsActive shelfIntakeTempNormal eventLogFileState
4-54
Using SNMP
TABLE 4 -1.

MIB Name sonusEventLogFileCreatedNotification sonusEventLogAcctFileCreatedNotification sonusEventLogFileRestartNotification sonusEventLogAcctFileRestartNotification sonusEventLogFileClosedNotification sonusEventLogAcctFileClosedNotification sonusEventLogFileShutdownNotification sonusEventLogFileCountNotification sonusEventLogFileCountChngNotification sonusEventLogFileSizeChngNotification sonusEventLogFileMsgQueueChngNotification sonusEventLogSaveToChngNotification sonusEventLogFileMaxEventMemSizeChngNotification sonusEventLogFileFilterLevelChngNotification sonusSystemTimingActiveFailedNotification sonusSystemTimingActiveSwitchoverNotification sonusSystemTimingOscillatorActiveNotification sonusSystemTimingMTAFailedNotification sonusSystemTimingMTAOperationalNotification sonusSystemTimingMTATotalFailureNotification sonusNetMgmtClientInformReqQueueFlushedNotification sonusNetMgmtClientInformReqQueueFullNotification sonusAlarmManagerInboundNotification sonusPadThresholdNotification sonusNodeResourcesCallAdmissionSuspendedNotification sonusNodeResourcesCallAdmissionEnabledNotification sonusNodeResourcesCallTraceHitNotification sonusTrunkEnabledNotification sonusTrunkDisabledNotification sonusTrunkInServiceNotification sonusTrunkOutOfServiceNotification sonusTrunkDeletedNotification sonusAnnouncementFileNotFoundNotification sonusAnnouncementFileFoundNotification sonusAnnouncementFileInvalidNotification sonusAnnouncementFileValidNotification sonusAnnouncementSegmentLoadFailureNotification sonusAnnouncementResUnavailRisingThresholdNotification sonusAnnouncementResUnavailFallingThresholdNotification sonusRtcpPacketLossThresholdExceededNotification
Trap Name eventLogFileCreated eventLogAcctFileCreated eventLogFileRestart eventLogAcctFileRestart eventLogFileClosed eventLogAcctFileClosed eventLogFileShutdown eventLogFileCount evLogCountChng evLogSizeChng evLogFileMsgQChng evLogSaveToChng evLogMaxEvtMemSizeChng evLogFilterLevelChng activeTimingFailed activeTimingSwitchover oscillatorActive mtaFailed mtaOperational mtaTotalFailure informReqQueueFlushed informReqQueueFull alarmInChangeOfState PadThresholdCrossing callAdmissionSuspended callAdmissionEnabled callTraceHit trunkEnabled trunkDisabled trunkInService trunkOutOfService trunkDeleted annFileNotFound annFileFound annFileInvalid annFileValid annSegLoadFailure annResUnavail annResAvailable rtpPacketLossExceeded
Using SNMP
4-55
TABLE 4 -1.

MIB Name sonusRtcpPacketLossThresholdClearedNotification sonusRtcpNoRtpOrRtcpPacketsReceivedNotification sonusRtcpNoRtpOrRtcpPacketsClearedNotification sonusNrsNifInServiceNotification sonusNrsNifOutOfServiceNotification sonusNrsNifEnabledNotification sonusNrsNifDisabledNotification sonusNrsNifDeletedNotification sonusNrsNifHighWatermarkNotification sonusNrsNifLowWatermarkNotification sonusNrsNifBwHighDeviationNotification sonusNrsNifBwLowDeviationNotification sonusNrsLinkDownNotification sonusNrsLinkUpNotification sonusNrsNifCreatedNotification sonusAtmExtVclInServiceNotification sonusAtmExtVclOutOfServiceNotification sonusAtmExtVclEnabledNotification sonusAtmExtVclDisabledNotification sonusAtmExtVclDeletedNotification sonusAtmExtVclHighWatermarkNotification sonusAtmExtVclLowWatermarkNotification sonusAtmExtVclBwHighDeviationNotification sonusAtmExtVclBwLowDeviationNotification sonusDsx1AdminChangeNotification sonusDsx1OutOfServiceNotification sonusDsx1ThresholdCrossingNotification sonusDsx1LineStatusChangeNotification sonusDsx3AdminChangeNotification sonusDsx3OutOfServiceNotification sonusDsx3ThresholdCrossingNotification sonusDsx3LineStatusChangeNotification sonusSonetPortAdminStatusNotification sonusSonetPortOperStatusNotification sonusSonetLineAlarmNotification sonusSonetLineThresholdCrossNotification sonusSonetPathAdminStatusNotification sonusSonetPathOperStatusNotification sonusSonetPathAlarmNotification sonusSonetPathThresholdCrossNotification sonusSonetPortOutOfServiceNotification
Trap Name rtpPacketLossCleared noRtpOrRtcpPackets noRtpOrRtcpCleared nifInService nifOutOfService nifEnabled nifDisabled nifDeleted nifHighWatermark nifLowWatermark nifBwHighDeviation nifBwLowDeviation linkFailed linkConnected nifCreated atmExtVclInService atmExtVclOutOfService atmExtVclEnabled atmExtVclDisabled atmExtVclDeleted atmExtVclHighWatermark atmExtVclLowWatermark atmExtVclHighDeviation atmExtVclLowDeviation ds1AdminChange ds1OutOfService ds1ThresholdCrossing ds1LineStatusChange ds3AdminChange ds3OutOfService ds3ThresholdCrossing ds3LineStatusChange sonetPortAdminStatus sonetPortOperStatus sonetLineAlarm sonetLineThreshCross sonetPathAdminStatus sonetPathOperStatus sonetPathAlarm sonetPathThreshCross sonetPortOutOfService
4-56
Using SNMP
TABLE 4 -1.

MIB Name sonusSonetPathOutOfServiceNotification sonusNtpServerInServiceNotification sonusNtpServerOutOfServiceNotification sonusNtpUpNotification sonusNtpDownNotification sonusSs7NodeConnectionEstablishedNotification sonusSs7NodeConnectionFailedNotification sonusSs7NodeConnectionStateChangeNotification sonusSs7NodeMtpStateChangeNotification sonusCallAccountingInServiceNotification sonusCallAccountingOutOfServiceNotification sonusSscsInServiceNotification sonusSscsOutOfServiceNotification sonusSscsSwitchoverNotification sonusSscsRouteFailureNotification sonusSscsTransErrorNotification sonusSscsRejectIndNotification sonusRedundGroupSwitchOverNotification sonusRedundGroupNoRedundancyNotification sonusRedundGroupFullRedundancyNotification sonusRedundGroupProtectedClientRestored sonusRedundGroupMnsActiveNotification sonusSoftwareUpgradeInitiatedNotification sonusSoftwareUpgradeTerminatedNotification sonusSoftwareUpgradeSucceededNotification sonusMgcpSessionConnectNotification sonusMgcpSessionDisconnectNotification sonusMgcpCallAgntConnectNotification sonusMgcpCallAgntDisconnectNotification sonusIuaAsDownNotification sonusIuaAsInactiveNotification sonusIuaAsActiveNotification sonusIuaAsPendingNotification sonusIuaAspDownNotification sonusIuaAspUpNotification sonusIsupSvcGrpInServiceNotification sonusIsupSvcGrpOutOfServiceNotification sonusIsupCircuitBlockedNotification sonusIsupCircuitUnblockedNotification sonusIsupCircuitResetNotification sonusIsupContinuityRecheckFailureNotification
Trap Name sonetPathOutOfService ntpServerInService ntpServerOutOfService ntpUp ntpDown ss7NodeConnected ss7NodeFailed ss7NodeStateChanged ss7NodeMtpState accountingInService accountingOutOfService softswitchInService softswitchOutOfService softswitchSwitchover softswitchRouteFailure softswitchTransError softswitchRejectInd redundGrpSwitchOver redundGrpNoRedund redundGrpFullRedund redundGrpProtectSlotOk redundGrpMnsActive swUpgradeInitiated swUpgradeTerminated swUpgradeSucceeded mgcpSessionConnect mgcpSessionDisconnect mgcpCallAgntConnect mgcpCallAgntDisconnect iuaAsDown iuaAsInactive iuaAsActive iuaAsPending iuaAspDown iuaAspUp IsupSrvcInService IsupSrvcOutOfService IsupCircuitBlocked IsupCircuitUnblocked IsupCircuitReset IsupContRecheckFailure
Using SNMP
4-57
TABLE 4 -1.

MIB Name sonusIsupCicRegistrationFailedNotification sonusIsupHopCounterExhaustedNotification sonusIsupRelWithExchangeRoutingErrorNotification sonusIsupCqmTimeoutNotification sonusIsupCvtTimeoutNotification sonusIsupFarendCircuitStateMismatchedNotification sonusIsupCircuitTimerExpired sonusGwCallSigChanOpenNotification sonusGwCallSigChanCloseNotification sonusGwSigChanOpenNotification sonusGwSigChanCloseNotification sonusIsdnSvcGrpInServiceNotification sonusIsdnSvcGrpOutOfServiceNotification sonusIsdnBChannelInServiceNotification sonusIsdnBChannelOutOfServiceNotification sonusIsdnPrimaryDChannelInServiceNotification sonusIsdnPrimaryDChannelOutOfServiceNotification sonusIsdnBackupDChannelInServiceNotification sonusIsdnBackupDChannelOutOfServiceNotification sonusCasSvcGrpInServiceNotification sonusCasSvcGrpOutOfServiceNotification sonusCasChannelInServiceNotification sonusCasChannelOutOfServiceNotification sonusSipCallSigPortOpenNotification sonusSipCallSigPortCloseNotification
Trap Name IsupCicRegFailure IsupHopCounterExhausted IsupExchangeRouteError IsupCqmTimeout IsupCvtTimeout IsupFEStateMismatched IsupCircuitTimerExpired CallSigChanOpen CallSigChanClose GwSigChanOpen GwSigChanClose IsdnSvcGrpInService IsdnSvcGrpOutOfService IsdnBChanInService IsdnBChanOutOfService IsdnPriDChanInSvc IsdnPriDChanOutOfSvc IsdnBacDChanInSvc IsdnBacDChanOutOfSvc CasSrvcInService CasSrvcOutOfService CasChanInService CasChanOutOfService SipCallSigPortOpen SipCallSigPortClose
TABLE 4 -2.
Sonus SoftSwitch (PSX6000) MIB Names
MIB Name sonusSoftSwitchUpNotification sonusSoftSwitchDownNotification sonusSoftSwitchPesUpNotification sonusSoftSwitchPesDownNotification sonusSoftSwitchPesDbOperationFailureNotification sonusSoftSwitchPesRegisterNotification sonusSoftSwitchPesUnregisterNotification sonusSoftSwitchPesLnpServiceUpNotification sonusSoftSwitchPesLnpServiceDownNotification sonusSoftSwitchPesTollFreeServiceUpNotification sonusSoftSwitchPesTollFreeServiceDownNotification
4-58
Using SNMP
TABLE 4 -2.
Sonus SoftSwitch (PSX6000) MIB Names
MIB Name sonusSoftSwitchPesPgkServiceUpNotification sonusSoftSwitchPesPgkServiceDownNotification sonusSoftSwitchPesPgkInterfaceUpNotification sonusSoftSwitchPesPgkInterfaceDownNotification sonusSoftSwitchPesPgkChangeoverNotification sonusSoftSwitchPesH323AccountingNotification sonusSoftSwitchPesH323AccountingShutdownNotification sonusSoftSwitchPgkUpNotification sonusSoftSwitchPgkDownNotification sonusSoftSwitchPgkPesServiceUpNotification sonusSoftSwitchPgkPesServiceDownNotification sonusSoftSwitchPgkPesInterfaceUpNotification sonusSoftSwitchPgkPesInterfaceDownNotification sonusSoftSwitchPgkPesChangeoverNotification sonusSoftSwitchPesScpaInterfaceUpNotification sonusSoftSwitchPesScpaInterfaceDownNotification
TABLE 4 -3.
Sonus Insight MIB Names
MIB Name sonusEmsRisingEventNotification sonusEmsFallingEventNotification sonusEmsNodeUnreachableNotification sonusEmsNodeReachableNotification sonusEmsNodeRestartedNotification sonusEmsNodeCfgFailNotification sonusEmsNodeCfgDoneNotification sonusEmsFmSequenceGapNotification sonusSgxAgtEvtEventNotification
Loading MIBs into a Network Management System

The GSX9000 release MIBs will are in two directories:
.../MIB/SMIv1 - SNMPv1 MIBs .../MIB/SMIv2 - SNMPv2 MIBs
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. The order that you load the Sonus MIBs into a Network Management system is very important. You must:
Using SNMP
4-59
1.
Unload obsolete MIBs.
File Name rfc1406.mib rfc1407.mib if.mib sonusRedund.mib sonusPscs.mib
MIB Name DS1-MIB DS3-MIB IF-MIB SONUS-RTM-SERVICES-MIB SONUS-SOFTSWITCH-CLIENT-SERVICES-MIB
2.
Load order dependant standard MIBs, replacing any existing versions.
File Name rfc1902.mib rfc1903.mib rfc1904.mib rfc1907.mib IANAifType.mib rfc1573.mib rfc2011.mib rfc2320.mib rfc2493.mib rfc2495.mib rfc2496.mib rfc2514.mib rfc2515.mib rfc2558.mib
MIB Name SNMPv2-SMI SNMPv2-TC SNMPv2-CONF SNMPv2-MIB IANAifType-MIB IF-MIB IP-MIB IPOA-MIB PerfHist-TC-MIB DS1-MIB DS3-MIB ATM-TC-MIB ATM-MIB SONET-MIB
Note
The RFC2514 MIB (ATM-MIB) that is shipped with the GSX9000 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.
3.
Load order dependant Sonus MIBs, replacing any existing versions.
4-60
Using SNMP
File Name sonus.mib sonusTc.mib sonusCommon.mib sonusNrs.mib sonusAps.mib sonusAtmExt.mib sonusSonet.mib
MIB Name SONUS-SMI SONUS-TC SONUS-COMMON-MIB SONUS-IP-INTERFACE-MIB SONUS-SONET-APS-MIB SONUS-ATM-EXTENSIONS-MIB SONUS-SONET-MIB
4.
Load order independant Sonus MIBs, replacing any existing versions.
File Name sonusAm.mib sonusArm.mib sonusCam.mib sonusCassg.mib sonusDirServ.mib sonusDrm.mib sonusDs1.mib sonusDs3.mib sonusEventLog.mib sonusGw.mib sonusH323.mib sonusMgcp.mib sonusIsdnsg.mib sonusIsupsg.mib sonusMgsg.mib sonusNode.mib sonusNrm.mib sonusNrsAddr.mib sonusNrsForward.mib sonusNrsProt.mib sonusNtp.mib sonusPerformanceStats.mib sonusRedundancy.mib sonusRtcp.mib sonusSip.mib sonusSoftwareUpgrade.mib sonusSs7Fe.mib sonusSscs.mib
MIB Name SONUS-ALARM-CONTACT-MIB SONUS-ANNOUNCEMENT-RESOURCES-MIB SONUS-ACCOUNTING-SERVICES-MIB SONUS-CAS-MIB SONUS-DIRECTORY-SERVICES-MIB SONUS-DSP-RESOURCES-MIB SONUS-DS1-MIB SONUS-DS3-MIB SONUS-EVENT-LOG-MIB SONUS-GATEWAY-SIGNALLING-MIB SONUS-H323-SIGNALLING-MIB SONUS-MGCP-SERVICES-MIB SONUS-ISDN-SERVICE-GROUP-MIB SONUS-ISUP-SERVICE-GROUP-MIB SONUS-MEDIA-GATEWAY-SERVICE-GROUP-MIB SONUS-NODE-MIB SONUS-NODE-RESOURCES-MIB SONUS-IP-ADDRESS-MIB SONUS-IP-FORWARDING-MIB SONUS-IP-PROTOCOL-MIB SONUS-NTP-SERVICES-MIB SONUS-PERFORMANCE-STATISTICS-MIB SONUS-REDUNDANCY-SERVICES-MIB SONUS-RTCP-MIB SONUS-SIP-SIGNALLING-MIB SONUS-SOFTWARE-UPGRADE-SERVICES-MIB SONUS-SS7-SERVICES-MIB SONUS-SOFTSWITCH-CLIENT-SERVICES-MIB
Using SNMP
4-61
File Name sonusSt.mib sonusTccs.mib sonusTrm.mib sonusXrm.mib

5.
MIB Name SONUS-SYSTEM-TIMING-MIB SONUS-TCAP-CLIENT-SERVICES-MIB SONUS-TRUNK-GROUP-RESOURCES-MIB SONUS-TRANSPORT-RESOURCES-MIB
Load order dependant Sonus SoftSwitch (PSX6000) MIBs, replacing any existing versions. If the GSX9000 MIBs were just loaded, load only the last four PSX6000 MIBs below (beginning with sonusSsTc.mib).
File Name rfc1902.mib rfc1903.mib rfc1904.mib sonus.mib sonusTc.mib sonusCommon.mib sonusSsTc.mib sonusSs.mib sonusSsPes.mib sonusSsPgk.mib
MIB Name SNMPv2-SMI SNMPv2-TC SNMPv2-CONF SONUS-SMI SONUS-TC SONUS-COMMON-MIB SONUS-SOFTSWITCH-TC SONUS-SOFTSWITCH-MIB SONUS-SOFTSWITCH-POLICY-EXECUTIONSERVER-MIB SONUS-SOFTSWITCH-PROXY-GATEKEEPER-MIB
6.
Load Sonus SGX2000 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).
File Name sonusASFEvents.mib
MIB Name sonusSgxAgtEvtEventNotification
Note
Refer to your Network Management System documentation for the specific instructions for loading all of the above MIBs. Managing your GSX9000 through SNMP is a subject that is beyond the scope of this guide.
4-62
Verifying ISUP Circuits

You may verify one or more ISUP circuits between the near and far-ends through the CLI. Sonus provides facilities to:
Check ISUP Circuit Conformance (to Bellcore GR-905-CORE) Initiate a manual continuity check procedure between the GSX and the far-end switch
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 an accounting of the ISUP circuit, configuration (CVT) and status (CQM) at the far-end. 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. You initiate a Circuit Validation Test on a ISUP circuit through the SHOW ISUP CIRCUIT SERVICE ... FAREND ADMIN command. 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: 1999/10/29 21:01:10 Zone: GMTMINUS05-EASTERN-US Trunk Group Point Code CIC: 10000 Trunk Number : Control : NOCICS Validation Test: SUCCESSFUL Group Carrier : DIGITAL : PERCALL OfficeA : OfficeZ : Location: : tgPSTN3 : 3-3-3 GMT
ISUP Service : ss72 ----------------------------------------------------------------
Alarm Carrier: SOFTWARE Continuity
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. Trunk Number, OfficeA, OfficeZ, and Location are optional parameters that have not been set at the farend. The following example shows another successful CVT response, this time with most optional parameters present:
Node: tpubs Date: 1999/10/29 21:01:10 Zone: GMTMINUS05-EASTERN-US Trunk Group : tgPSTN3 GMT
4-63
ISUP Service : ss71 Point Code : 11-20-20 ---------------------------------------------------------------CIC: 1000 Trunk Number : 1234 Validation Test: SUCCESSFUL Control : NOCICS Group Carrier : DIGITAL Alarm Carrier: SOFTWARE Continuity : PERCALL OfficeA :BOST-MA-11-ABC OfficeZ :ITHA-NY-PH-101 Location:
The next example indicates an unsuccessful CVT:

Node: tpubs Date: 1999/10/29 21:01:10 Zone: GMTMINUS05-EASTERN-US Trunk Group Point Code : tgPSTN4 : 11-20-20 GMT
ISUP Service : ss71 ---------------------------------------------------------------CIC: 1250 Trunk Number : Validation Test: FAILURE Control : NOCICS Group Carrier : UNKNOWN Alarm Carrier: UNKNOWN Continuity : UNKNOWN OfficeA : OfficeZ : Location:WTFD-MA-AC-121
You initiate a Circuit Query Message (CQM) through the SHOW ISUP CIRCUIT SERVICE ..FAREND STATUS command. A successful response to this command will cause the circuit status at both the near and far-end to be displayed. 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
Trunk Group : tgPSTN4 ISUP Service : ss72 Point Code : 11-3-3 ======== FAR END ======== CIC Status ----- ------------------------2000 IDLE
Service Mode : INSERVICE Service Status : AVAILABLE ================== NEAR END =============== Circuit Maint Maint HW HW Status Mode Local Remote Local Remote ---------- -------- ----- ------ ----- ---IDLE UNBLOCK UNBLK UNBLK UNBLK UNBLK
The displayed result indicates the CQM was successful and that the circuit is available (unblocked) at both ends. 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
Trunk Group : tgPSTN4 ISUP Service : ss72 Service Mode : INSERVICE Point Code : 11-3-3 Service Status : AVAILABLE --------------------------------------------------------------------------Circuit Maint Maint HW HW Man CIC Port Ch Status Mode Local Remot Local Remot Cot ----- ------------------------ -- -------- ------- ----- ----- ----- ----- 2000 T1-1-12-1 1 IDLE UNBLOCK UNBLK UNBLK UNBLK UNBLK N/A
Notice that this result agrees with the CQM initiated result, as expected.
4-64
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.
Manual Continuity Check (COT)

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-315 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
To abort this COT while it is in progress, enter the command:

CONFIG ISUP CIRCUIT SERVICE ss72 CIC 6000 MODE reset
To examine the result of a COT, enter the command:

SHOW ISUP CIRCUIT SERVICE ss72 CIC 6000 STATUS
The display returned by the GSX software, such as,

Node: TPUBS Date: 2000/11/08 22:30:02 Zone: GMTMINUS05-EASTERN-US Trunk Group Point Code : tg1 Service Mode : INSERVICE : 1-1-1 Circuit CIC 6000 Port T1-1-3-1-1 Ch Status 1 IDLE Mode COT Service Status : AVAILABLE Maint Maint HW HW Man GMT
ISUP Service : ss72
-----------------------------------------------------------------Local Remot Local Remot Cot UNBLK UNBLK TRN-U UNBLK PASS
----- ------------------------------------------------------------
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). The table below lists the meanings of all values that may be displayed in Man Cot.
Man Cot Value
Indication The continuity check procedure has never been tried on this circuit. The continuity check procedure is pending. The circuit is in remote maintenance block, remote hardware block, local hardware block, trunk group out of service, port out of service, service group out of service, or server module out of service. When the circuit becomes local maintenance blocked only, the procedure will start automatically and take one of the values below.
N/A PEND
4-65
Man Cot Value
Indication The continuity check procedure is in progress. This status typically advances to PASS or FAIL. If the circuit is placed under additional block for the PEND reasons listed above, its status may return to PEND. The continuity check procedure has failed. This status remains until another check procedure is initiated and accepted. The continuity check procedure has succeeded. This status remains until another check procedure is initiated and accepted. The continuity check procedure was terminated by the user command shown above while it was in PEND status, before a PASS or FAIL status could be attained. This status remains until another check procedure is initiated and accepted. The continuity check procedure did not receive a Loop Back Acknowledgement message from the far-end switch. This may be a signaling problem rather than a circuit problem if, for example, the far-end of the circuit is under checking. This status remains until another check procedure is initiated and accepted.
PROG
FAIL PASS ABORT
LPA_F
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:
a check-loop if the circuit is 4-wire a transponder if the circuit is 2-wire
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. Figure 4-15, Successful COT Sequence illustrates these signaling message exchanges.
4-66
TIME
GSX/SGX
CCR Loop back tone on the circuit Send check tone on the circuit COT (successful, optional) REL RLC
LPA
Far-end Switch
Tccr
T24
FIGURE 4-15
Successful COT Sequence
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:
1. 2. 3.
continuity is detected, Man Cot = PASS the user specified TIMEOUT expires, Man Cot = FAIL the user terminates the procedure with the RESET command, Man Cot = ABORT
Figure 4-16, Failure COT Sequence illustrates these signaling message exchanges 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 farend 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.
Announcements
4-67
TIME Tone not detected Tone not detected
GSX/SGX
CCR
LPA
Send check tone on the circuit
COT failure CCR (sent only once)
LPA
Far-end Switch
Send check tone
T26 Tccr T24
Subsequent Retry
FIGURE 4-16
Failure COT Sequence
Announcements
You may direct the GSX to play announcements on PSTN circuits. The initiation of an announcement sequence is controlled by either the PSX6000 Sonus SoftSwitch or a third party MGCP soft switch. The soft switch selects an announcement file residing in the GSX9000 system tree. This tree is illustrated in Figure 4-17, GSX System Tree. 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 soft switch is described in detail. See the PSX6000 Sonus SoftSwitch Operations Guide for detail on playing announcements under the control of the PSX6000.
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.
Creating Announcement 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 4-17,
4-68
Announcements
GSX System Tree. The files in preload are read by the GSX when it is booted and then cached locally on each CNS module. The files in ondemand are not read until a request to play a particular announcement is received from the soft switch. At the time of this request the file is retrieved and cached locally on the CNS module that will play it. Each file is named: sXXXXX.wav 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. Under MGCP soft switch control, this ID is specified in a RequestNotify (RQNT) command. Under Sonus SoftSwitch control, this ID is specified in the Service Information Building Block (see Playing Announcements under Sonus SoftSwitch Control on page 473). The CNS module caches up to 34 minutes of announcements. Therefore, the total time for the .wav files (1 or more) stored in the CNS module cache may not exceed 34 minutes (2048 seconds). Sonus Networks recommends a .wav file size of 5 minutes. Then, if each.wav file size is 5 minutes, the CNS module will be able to cache up to 6 announcements. The .wav file data format requirements are:
Format: Number Of Channels: Samples Per Second: Average Bytes Per Second: Block Align: Bits Per Sample:
MuLaw 1 (Mono) 8000 8000 1 (1 byte per sample) 8
Validating Announcement Files

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 GSX9000 System Tree (see Figure 4-17). You may thereafter invoke it to determine whether or not a file will play properly on the GSX9000. 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: Announcement File Status: 32 VALID
An example of a verbose file validation is:

Announcements
4-69
> verifyAnnFile s32.wav -v Segment ID: Wav File Statistics Format Tag: Number of Channels: Samples per Second: Average Bytes per Second: Block Align: Length in Bytes: Announcement File Status: 0x0007 (MuLaw) 1 8000 8000 1 4000 VALID 32
An example of a verbose file rejection is:

> verifyAnnFile s49.wav -v Segment ID: 49 ERROR: verifyAnnFile, wav format: Not MuLaw Wav File Statistics Format Tag: Number of Channels: Samples per Second: Average Bytes per Second: Block Align: Length in Bytes: Announcement File Status: 0x0001 (PCM) 1 8000 8000 1 3970 INVALID
4-70
export/SonusNFS
mount-point
/<BASEDIR>
boot path
FIGURE 4-17
/evlog
/announcements
/<SOFTWPTH>
/<----->
/<----->
GSX System Tree
software release directory
/<NODEID>
*.wav *.wav core.*
/preload /ondemand /coredump /cli
/param
*.prm *.bck
/images
mns10.bin cns10.bin pns10.bin cns30.bin . .
/DBG /SYS
*.TRC *.ACT
/TRC
/ACT
/sys
/scripts /logs
*.tcl commands.def showscreens.sda sysinit.tcl sessinit.tcl alarmUtils.tcl . . sysinit.tcl.out sysinit.tcl.out.last
Announcements
*.DBG
*.SYS
Announcements
4-71
Sample Announcement Files Provided

Sonus provides several prerecorded announcement files that you can use to verify that the system is playing announcements properly. These files are named s201.wav, s202.wav, s203.wav, and s204.wav. These announcements are provided on the GSX software CD.
Conversational TCAP Announcements

A series of infodigit and related announcements may be requested of the Sonus SoftSwitch by the SS7 Service Control Point (SCP). This overall capability is known as Conversational TCAP. To accomodate this facility, the files listed in the table below are provided on the GSX software CD and dedicated to infodigit announcements. These filenames and the corresponding announcement IDs used in GSX scripts are reserved for Conversational TCAP in your GSX system tree. 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, and so on. Each announcement file itself may be overwritten with the equivalent message and voice that you prefer.
Reserved Infodigit Announcement Files

Filename s10000.wav s10001.wav s10002.wav s10003.wav s10004.wav s10005.wav s10006.wav s10007.wav s10008.wav s10009.wav Audio Message 0 1 2 3 4 5 6 7 8 9
Additionally the files s900.wav through s999.wav, and the corresponding announcements IDs are reserved for announcement messages on behalf of this facility. The files listed in the table below are those that are populated on the GSX software CD provided with this release. Additional files in this block will be populated as necessary to support PSX applications in the future.
4-72
Announcements
Reserved Announcement Message Files

Filename s900.wav s901.wav s902.wav s903.wav s904.wav s905.wav s906.wav Audio Message Enter your PIN number Enter your authorization code You have entered an invalid PIN Authorization code validation failed Authorization code digit collection failure This call is terminated PIN digit collection failure
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 GSX9000 checks the preload and ondemand directories for deletions and modifications every 60 seconds. When the GSX9000 detects that an announcement file has been removed, the GSX9000 flushes the announcement from all CNS modules which have the announcement loaded. If a CNS 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 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 GSX9000 will not recognize the change. If this happens, then use the UNIX touch command to change the new file's last modification time.
Exceeding Announcement Memory

Once a CNS module's announcement memory is full, a new announcement will force the least recently used segment(s) to be flushed from CNS 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
MGCP Continuity Tests
4-73
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.
Playing Announcements under Sonus SoftSwitch Control

In a Sonus SoftSwitch controlled environment, the announcement is part of one of the services that is configured on the PSX6000 Sonus SoftSwitch. 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 Sonus SoftSwitch by the GSX9000, this script is part of the policy response returned by the PSX6000, for execution on the GSX9000. Announcement caching, updating, and memory flushing are handled as discussed above. For details on configuring PSX6000 services to include announcements, see the PSX6000 Sonus SoftSwitch Operations Guide.

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. In order to perform continuity tests, you must:
1. 2. 3. 4. 5. 6. 7.
Create a new Circuit Service Profile (dual tone), or use the default profile (single tone) Configure the CONTINUITYTEST TYPE parameter appropriately (dual tone) Enable the profile for dual tone (the default profile is enabled by the GSX software) Configure the media gateway circuits to use the new or default profile Enable the media gateway circuits Connect the media gateway circuits to be tested appropriately Issue the necessary commands to each circuit to initiate the continuity tests
The steps that are necessary to generate a dual tone continuity test are elaborated in the following example. A new Circuit Service Profile, dualtone, is created by the command:
CREATE CIRCUIT SERVICE PROFILE dualtone
The new profile is configured with a CONTINUITYTEST TYPE of remote4wire, a timeout of 2 seconds, a minimum detect of 45 milliseconds, and a minimum release of 25 milliseconds by the command:
4-74
CONFIGURE CIRCUIT
SERVICE PROFILE dualtone ..
CONTINUITYTEST TYPE remote4wire TIMEOUT 2 MIN DETECT 45 MIN RELEASE 25
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. This profile is activated by the command:
CONFIG CIRCUIT SERVICE PROFILE dualtone STATE enabled
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
To activate these circuits:

CONFIGURE MEDIA GATEWAY CIRCUIT PORT T1-1-3-1 .. CHANNEL 1-24 STATE enabled CONFIGURE MEDIA GATEWAY CIRCUIT PORT T1-1-3-2 .. CHANNEL 1-24 STATE enabled
Assuming that a connection between the T1s that correspond to T1-1-3-1 and T11-3-2 is in place, the soft switch 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 soft switch 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.
ISDN Call Support Through the Sonus SoftSwitch
4-75

PRI ISDN connections between the GSX and an ISDN switch are supported through a Sonus SoftSwitch, as depicted in Figure 4-18, ISDN PRI Connection to the GSX, and discussed in Adding an ISDN PRI. 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.
Adding an ISDN PRI
10/100M Ethernet Sonus SoftSwitch
GSX9000
ISDN Switch
B-channels
D-channel
PRI (T1)
CNA10 PNA10
MNA10
IP
100M Ethernet
FIGURE 4-18
ISDN PRI Connection to the GSX
Each ISDN 23B+D PRI occupies a T1 span on a CNA30/CNA10. 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. To configure your GSX for this environment, you must know:
1. 2. 3.
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
4-76
4. 5. 6.
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 a configuration sequence in which:

1. 2. 3. 4. 5. 6. 7. 8. 9. 10.
the ISDN service isdnserv1 is created the trunk group tg1 is bound to isdnserv1 Interface 0 is created and associated with the ISDN service isdnserv1 the T1 span T1-1-3-1 is assigned to the ISDN service isdnserv1 the ISDN service isdnserv1 is declared to behave as the user switch side Interface 0 is declared to include the primary D-channel for the ISDN service isdnserv1 the ISDN service isdnserv1 is declared to behave as if residing on a dms250 switch the ISDN service isdnserv1 is enabled Interface 0 is enabled the PRI line B-channels are all enabled and put into service
Default values are installed for all parameters that are not explicitly set below:
#1 CREATE ISDN SERVICE isdnserv1 #2 CONFIGURE ISDN SERVICE isdnserv1 TRUNK GROUP tg1 #3 CREATE ISDN INTERFACE SERVICE isdnserv1 INTERFACE 0 #4 CONFIGURE ISDN INTERFACE SERVICE isdnserv1 .. INTERFACE 0 PORT T1-1-3-1 #5 CONFIGURE ISDN SERVICE isdnserv1 SWITCHSIDE user #6 CONFIGURE ISDN SERVICE isdnserv1 .. PRIMARY DCHANNEL INTERFACE 0 #7 CONFIGURE ISDN SERVICE isdnserv1 SWITCHTYPE dms250 #8 CONFIGURE ISDN SERVICE isdnserv1 STATE enabled #9 CONFIGURE ISDN SERVICE isdnserv1 INTERFACE 0 .. STATE enabled #10 CONFIGURE ISDN BCHANNEL SERVICE isdnserv1 .. INTERFACE 0 BCHANNEL 1-23 STATE enabled CONFIGURE ISDN BCHANNEL SERVICE isdnserv1 ..
4-77
INTERFACE 0 BCHANNEL 1-23 MODE inservice
The D-channel is unconditionally assigned to channel 24 and activated when the administrative state of Interface 0 is enabled (step #9). The configuration of the ISDN service isdnserv1 may be displayed with the command:
Node: TPUBS Date: 2000/02/07 22:12:08 Zone: GMTMINUS05-EASTERN-US ---------------------------------------------------Trunk Group : tg1 ISDN Service: isdnserv1 Default Directory Number Calling Party Number Provision Calling Party Number Discard Calling Party Number Delivery Calling Party Subaddress Transfer Calling Party Subaddress Delivery B-channel Availability Signaling Service Profile: Hunt Algorithm : LOWLOW Cost Tracing : 50 : NONE Primary: 0 Primary: 24 Primary: INSERVICE Backup: 1 Backup: 24 Backup: UNEQUIPPED State: ENABLED : : NECESSARY : NO : YES : YES : YES : YES Switch Side Switch Type Switch Profile : USER : DMS250 : Mode: INSERVICE GMT
----------------------------------------------------
The status of the ISDN service isdnserv1 may be displayed with the command:
Node: TPUBS Date: 2000/02/07 22:27:55 Zone: GMTMINUS05-EASTERN-US ---------------------------------------------------Trunk Group : outpri ISDN Service: isdnserv1 Bchannels Configured: 23 Active Calls Call Attempts Call Completions Primary Dchannel InPkts: 22078 InByts: 145691 OutPkts: 22088 OutByts: 212261 Mode: INSERVICE Mode: INSERVICE Status: AVAILABLE Available: 23 Egress: 0 Egress: 1902 Egress: 1889 Backup Dchannel InPkts: 0 InByts: 0 OutPkts: 0 OutByts: 0 GMT
Ingress: 0 Ingress: 0 Ingress: 0
Mode: INSERVICE Status:INSERVICE Mode:UNEQUIPPED Status:UNEQUIPPED
----------------------------------------------------
4-78
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 Zone: GMTMINUS05-EASTERN-US Trunk Group ISDN Service Interface --------0 : tg1 : isdnserv1 Port ---------------T1-1-3-1 State ----------ENABLED GMT
----------------------------------------------------------------
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 Zone: GMTMINUS05-EASTERN-US Trunk Group ISDN Service Interface --------0 : tg1 : isdnserv1 Port ---------------T1-1-3-1 State ----------ENABLED Mode ---ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED ENABLED INSERVICE INSERVICE INSERVICE INSERVICE INSERVICE INSERVICE INSERVICE INSERVICE INSERVICE INSERVICE INSERVICE INSERVICE INSERVICE INSERVICE INSERVICE INSERVICE INSERVICE INSERVICE INSERVICE INSERVICE GMT
----------------------------------------------------------------
---------------------------------------------------------------Channel CircuitProfile Direction State ------- -------------- --------- ----1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 DEFAULT DEFAULT DEFAULT DEFAULT DEFAULT DEFAULT DEFAULT DEFAULT DEFAULT DEFAULT DEFAULT DEFAULT DEFAULT DEFAULT DEFAULT DEFAULT DEFAULT DEFAULT DEFAULT DEFAULT TWOWAY TWOWAY TWOWAY TWOWAY TWOWAY TWOWAY TWOWAY TWOWAY TWOWAY TWOWAY TWOWAY TWOWAY TWOWAY TWOWAY TWOWAY TWOWAY TWOWAY TWOWAY TWOWAY TWOWAY
4-79
21 22 23
DEFAULT DEFAULT DEFAULT
TWOWAY TWOWAY TWOWAY
ENABLED ENABLED ENABLED
INSERVICE INSERVICE INSERVICE
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 Zone: GMTMINUS05-EASTERN-US Trunk Group ISDN Service Interface --------0 Channel ------1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 : tg1 : isdnserv1 Port ---------------T1-1-3-1 Usage Local Admn ----- ---------IDLE IDLE IDLE IDLE IDLE IDLE IDLE IDLE IDLE IDLE IDLE IDLE IDLE IDLE IDLE IDLE IDLE IDLE IDLE IDLE IDLE IDLE IDLE IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS Local Hdwr ---------IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS State ----------ENABLED Remote -----IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS GMT
----------------------------------------------------------------
----------------------------------------------------------------
Note
The Remote B-channel status is as polled from the ISDN switch.
Adding an ISDN NFAS Group

An NFAS group may consist of up to 12 or 20 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 20 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 necesVersion 4.01, Document Version 2 GSX9000 Open Services Switch Operations Guide
4-80
sary 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-20. These T1 spans need not be connected to the same CNS server module as the PRI(s), as discussed subsequently in this section.
GSX9000
ISDN Switch PRI (T1) PRI (T1) (T1)
CNA10 PNA10 MNA10
IP
100M Ethernet
FIGURE 4-19
ISDN NFAS Group
Figure 4-19, ISDN NFAS Group depicts an NFAS group, 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. 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
4-81
% 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
Notice that by default:
Interface 0 is assigned to the primary D-channel Interface 1 is assigned to the backup D-channel the primary D-channel is put into service the isdnserv1 service group is configured as a network-side switch
Figure 4-20, ISDN NFAS Group with Primary/Backup D-channels depicts an NFAS group with 4 interfaces that uses Interface 0 as the primary D-channel and Interface 1 as the backup D-channel.
4-82
10/100M Ethernet
Sonus SoftSwitch PRI (T1) GSX9000 PRI (T1) B-channels B-channels (T1) (T1)
CNA10 PNA10 MNA10
ISDN Switch
IP
100M Ethernet
FIGURE 4-20
ISDN NFAS Group with Primary/Backup D-channels
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 4-21, ISDN NFAS Group across CNS/CNA Modules.
4-83
GSX9000
ISDN Switch PRI (T1) PRI (T1) (T1)
CNA10 CNA10 PNA10 MNA10
IP
100M Ethernet
FIGURE 4-21
ISDN NFAS Group across CNS/CNA Modules
Adding a Euro-ISDN PRI

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 4-75, describes procedures and considerations for adding a Euro-ISDN PRI by replaying the referenced procedure and examining the steps that differ in the EuroISDN procedure. The PRI ISDN connection depicted in Figure 4-18, ISDN PRI Connection to the GSX, illustrates the Euro-ISDN connection except that E1 spans make up the PRI instead of T1 spans. Hence the PRI (T1) depicted in Figure 4-18 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. The following Euro-ISDN example is modeled after the example in Adding an ISDN PRI. This example illustrates a configuration sequence in which:
1. 2. 3. 4.
the ISDN service isdneserv1 is created the trunk group tg1 is bound to isdneserv1 Interface 0 is created and associated with the ISDN service isdneserv1 the E1 span E1-1-3-1 is assigned to the ISDN service isdneserv1
4-84
5. 6. 7. 8. 9. 10.
the ISDN service isdneserv1 is declared to behave as the user switch side Interface 0 is declared to include the primary D-channel for the ISDN service isdneserv1 the ISDN service isdneserv1 is declared to behave as if residing on a euroIsdn switch the ISDN service isdneserv1 is enabled Interface 0 is enabled the PRI line B-channel bank of channels 1-15 are enabled and put into service, followed by the PRI line B-channel bank of channels 17-31
Default values are installed for all parameters that are not explicitly set below:
#1 CREATE ISDN SERVICE isdneserv1 #2 CONFIGURE ISDN SERVICE isdneserv1 TRUNK GROUP tg1 #3 CREATE ISDN INTERFACE SERVICE isdneserv1 INTERFACE 0 #4 CONFIGURE ISDN INTERFACE SERVICE isdneserv1 .. INTERFACE 0 PORT E1-1-3-1 #5 CONFIGURE ISDN SERVICE isdneserv1 SWITCHSIDE user #6 CONFIGURE ISDN SERVICE isdneserv1 .. PRIMARY DCHANNEL INTERFACE 0 #7 CONFIGURE ISDN SERVICE isdneserv1 SWITCHTYPE euroIsdn #8 CONFIGURE ISDN SERVICE isdneserv1 STATE enabled #9 CONFIGURE ISDN SERVICE isdneserv1 INTERFACE 0 .. STATE enabled #10 CONFIGURE ISDN BCHANNEL SERVICE isdneserv1 .. INTERFACE 0 BCHANNEL 1-15 STATE enabled CONFIGURE ISDN BCHANNEL SERVICE isdneserv1 .. INTERFACE 0 BCHANNEL 17-31 STATE enabled CONFIGURE ISDN BCHANNEL SERVICE isdneserv1 .. INTERFACE 0 BCHANNEL 1-15 MODE inservice CONFIGURE ISDN BCHANNEL SERVICE isdneserv1 .. INTERFACE 0 BCHANNEL 17-31 MODE inservice
The D-channel is unconditionally assigned to channel 16 and activated when the administrative state of Interface 0 is enabled (step #9). The configuration of the ISDN service isdneserv1 may be displayed with the command:
Japan Call Support
4-85
% SHOW ISDN SERVICE isdneserv1 ADMIN

Node: TPUBS Date: 2000/02/07 22:12:08 Zone: GMTMINUS05-EASTERN-US ---------------------------------------------------Trunk Group : tg1 ISDN Service: isdneserv1 Default Directory Number Calling Party Number Provision Calling Party Number Discard Calling Party Number Delivery Calling Party Subaddress Transfer Calling Party Subaddress Delivery B-channel Availability Signaling Service Profile: Hunt Algorithm : LOWLOW Cost Tracing : 50 : NONE Primary: 0 Primary: 16 Primary: INSERVICE Backup: 1 Backup: 16 Backup: UNEQUIPPED State: ENABLED : : NECESSARY : NO : YES : YES : YES : NO Switch Side Switch Type Switch Profile : USER : euroIsdn : Mode: INSERVICE GMT
----------------------------------------------------
Note
B channel availability signaling is not supported by the Euro-ISDN switch.
Japan Call Support

Sonus provides support for Japans ISDN Primary Rate Interface (PRI) variant INS1500. The Sonus implementation conforms to NTT Technical Reference Interface for INS NET Service:
The 2nd Volume (Layer 1 and 2 Specifications) 4th Edition The 3rd Volume (Layer 3 circuit-switching) The 5th Edition
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-323 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:
NTT-Q761 Functions of the ISDN User Part, Signalling System No. 7 NTT-Q762 General Function of Messages and Signals NTT-Q763 Formats and Codes NTT-Q764 ISDN User Part message and code
See ISUP Service Group on page 3-265 for additional configuration information.
4-86
Japan Call Support
PRI-PBX Functionality (w/Japan INS-1500 ISDN)

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:

Note
Calling line identification presentation (CLIP) including forced CLIP Calling line identification restriction (CLIR) Sub-address (SUB) User-to-user signaling (UUS)
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. 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.
Note
Internet Offload Support (w/Japan INS-1500 ISDN)

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.
Address Complete Message (ACM) Answer Message (ANM) Charge Message (CHG) Call Progress Message (CPG) Initial Address Message (IAM) Release Message (REL) Resume Message (RES) Release Complete Message (RLC) Suspend Message (SUS)
CAS Services
4-87
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.
CAS Services
Sonus Networks recommends configuration of the CAS objects in the order discussed in CAS Service Group on page 3-443. 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.
4-88
CAS Services
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. This egress SSP controls the propagation of call progress tones to the incoming caller. One of two methods may be used:
1. 2.
cut-through the call and allow the caller to hear the tones from the far end generate and provide the tones from the GSX
The scenarios below provide additional detail.
CAS Ingress to CAS Egress

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.
Non-CAS Ingress to CAS Egress

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.
CAS Ingress to Non-CAS Egress

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-
Two Stage Calls
4-89
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.
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-484 and Announcements on page 4-67). However, control over these services is provided by the Sonus SoftSwitch rather than GSX configuration commands.
Initiation of a Two Stage Call

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 PSX6000 Sonus SoftSwitch Operations 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 4-22, Two Stage Call Processing SIBBs. This flowchart depicts a simplified set processing points for a two stage call.
4-90
Two Stage Calls
Begin the Script
Play Announcement
Collect Digits
Trigger Request
Compare Two Parameters
PIN_VALID
Place an Outgoing Call
PIN_INVALID
End the Script
FIGURE 4-22
Two Stage Call Processing SIBBs
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 SoftSwitch (to authenticate the digit string that was collected), and compare two variables to choose a subsequent pro-
Two Stage Calls
4-91
cessing 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:
1. 2.
The initial inbound call (possibly placed to an 800 number). The final outbound call to the destination party, beginning with the PIN_VALID branch.
The first call is also referred to as a terminated call. The second is a stage 2 tandem call.
GSX Processing of a Two Stage Call

An exchange of information occurs between the GSX and the PSX as the two stage call processing script is processed by the GSX. The table below summarizes the GSX actions that take place as each SIBB is processed:
GSX Two Stage Call Processing

SIBB Play Announcement GSX Actions This SIBB directs the playing of an announcement, using the previously discussed facility, see Playing Announcements under Sonus SoftSwitch Control on page 4-73. This SIBB uses the facilities discussed in Tone Processing on page 3-484. The directive and all parameters are controlled by the call processing script. Exception actions, such as inter-digit timeout are also specified in the script. (This SIBB may be used more than once in a practical scenario, once to collect the authorization code, and once to collect the called party number.) This special SIBB returns processing control to the PSX. In this case, the collected digits may be authenticated. Routing may be performed on the called number. A pair of variables are passed to the GSX. The GSX performs a comparison operation such as equal, not equal, greater than, or others, and branches accordingly. In this example, these branches depend on whether the authentication was valid or invalid. Following a success indication from the PSX, this SIBB results in the routing of an outgoing call,
Collect Digits
Trigger Request
Compare Two Parameters
Place an Outgoing Call
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 5-4. Call statistics such as call counts will be generated for each call separately. Refer to the PSX6000 Sonus SoftSwitch Operations Guide for a comprehensive summary of enhanced services that may be deployed through call processing scripts.
4-92
GSX Call Rerouting Policy

Rerouting (or Crankback) of unsuccessful network call attempts are performed when the Release/Disconnect from Egress Signaling contains the following reason codes: Call Termination Reason Codes ID DEFINITION
(Added Explanation)
Q.931 Standard (0-127)

2 3 NO ROUTE TO SPECIFIED NETWORK NO ROUTE TO DESTINATION (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.) 34 NO CIRCUIT AVAILABLE (The GSX may release a call with this cause value if: The GSX attempts to reroute the call, but is out of routes. 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.) 42 SWITCHINGEQUIP CONGESTION (The GSX may release a call with this cause value if: The GSX attempts to reroute the call, but is out of routes. A GSX software programming error occurred.) 44 REQUESTED CIRCUIT NOT AVAILABLE
Sonus Extension (above 127)

130 INSUFFICIENT DESTINATION RESOURCES [This Sonus code is mapped to Q.931 ID 31] (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.) 135 COLLISION REATTEMPT EXHAUSTED (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-IPPSTN calls, the call is reattempted using the next route in the list.) GSX9000 Open Services Switch Operations Guide Version 4.01, Document Version 2
4-93
Call Termination Reason Codes

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.) 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.)
Rerouting is performed for all the above codes (except 135) for all possible PSTNPSTN scenarios. Rerouting is performed in the originating GSX for all calls that use Gateway-to-Gateway Signaling, since thats where the original routing was performed. Rerouting is performed for all SIP and H.323 calls whenever the Egress Signaling Entity releases the call with one of the above reason codes. Rerouting is not performed for any MGCP calls.
4-94
SIP DTMF Detection/Insertion Handling

PSTN
SIP Application Server
IP
PSTN Phone
SIP Signaling Channel
GSX
IP Media Stream
Media Server/ IAD/SIP Phone
SIP Call Signaling Packets without DTMF INFO messages SIP Call Signaling Packets with DTMF INFO messages G.711 G.711 / RFC2833 G.72X G.72X / RFC2833
G.711 / RFC2833 (with Digits Removed)
G.72X / RFC2833 (with Digits Removed)
FIGURE 4-23
SIP IP Pipes
Figure 4-23 depicts the IP pipes used by the SIP software in the GSX9000:
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 4-23. 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 one of four possible algorithms for delivery via the IP Media Stream:
1. 2. 3. 4.
G.711 G.711 with Silence Suppression G.729A G.729A+B
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. These two algorithms are hereafter combined as G.711. G.729A and G.729A+B audio encoding reduce the IP bandwidth that is needed to maintain a call, relative to the PSTN bandwidth required.
4-95
For this reason, these two audio encoding techniques are combined, using the term audio compression. DTMF tones (digits) may be present in any call. Three methods of DTMF digit delivery are available for SIP calls:
1. 2. 3.
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 encoding algorithms. Method 1, above, results in no manipulation of RTP packets and relys 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. This scheme relys 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 the SIP MS/IAD/phone. The legend in Figure 4-23 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. 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 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.729 represents a G.729a or G.729A+B audio packet stream that contains compressed DTMF information that is encoded in the IP Media Stream along with all other (compressed) audio data. G.729/RFC2833 represents a G.729 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.729/RFC2833 (with Digits Removed) represents a G.729 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. 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.
4-96
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.
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 Packet Service Profile. This parameter may take one of three values:
never - DTMF tones are present in the audio stream only, regardless of the PREFERRED ENCODING setting. useIfCompressedAudio - DTMF tones are explicitly exchanged if PREFERRED ENCODING is g729a or g729ab, but not if PREFERRED ENCODING is g711 or g711ss. always - DTMF tones are explicitly designated, using one of the IP pipes, under all circumstances.
Once they are directed to be explicitly exchanged, DTMF tones may be delivered in band or out of band.
In Band DTMF
In band DTMF is achieved by delivering DTMF digits in the IP Media Stream. When PREFERRED ENCODING is g711 or g711ss, this is the default, exclusive means of delivery, using RFC2833. RTP is the standard packet protocol on the IP Media Stream. The RFC2833 mechanism defines RTP packet payload types to designate the unique DTMF digits. When PREFERRED ENCODING is g729a or g729ab, you may, but need not, direct DTMF digit delivery through the same RFC2833 mechanism. In band DTMF Relay is specified by the DTMF RELAY OUT OF BAND parameter in the Packet Service Profile. When this parameter takes the default value of disabled, (and DTMF RELAY is not never), in band DTMF tone delivery, using RFC2833, is directed. 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.
4-97
Out of Band DTMF

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 directed by the DTMF RELAY OUT OF BAND parameter in the Packet Service Profile. When you set this parameter to the value enabled, (and DTMF RELAY is not never), you direct DTMF digit delivery on the SIP Signaling Channel.
Remove Digits
DTMF Relay may be further qualified by the DTMF RELAY REMOVE DIGITS parameter in the Packet Service Profile. This parameter is meaningful only when DTMF RELAY is not never. When you direct DTMF digits to be explicitly inserted for a call, via DTMF RELAY, this 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 is supporting the SIP call. These resources are only available on the GSX server modules:
SPS30 - Signal Processing Server CNS25 - 12 Span E1 Circuit Network Server
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 probabilites of successfully excuting 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 SPS30 and CNS25 server modules present in your GSX.
G.711 without DTMF RELAY Scenario

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 423. Call flows from IP to PSTN, which require the use of the default Packet Service Profile, are described.
4-98
PSTN
IP
PSTN Phone
GSX
IP Media Stream
SIP Call Signaling Packets without DTMF INFO messages SIP Call Signaling Packets with DTMF INFO messages G.711 G.711 / RFC2833 G.72X G.72X / RFC2833 G.72X / RFC2833 (with Digits Removed)
G.711 / RFC2833 (with Digits Removed)
FIGURE 4-24
G.711 without DTMF RELAY
Figure 4-24 illustrates the IP streams for SIP calls when PREFERRED ENCODING is g711 or g711ss and DTMF RELAY is never. 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 SPS30 or CNS25 resources are necessary to support this scenario. The default Packet Service Profile shown below provides this SIP IP environment.
SHOW PACKET SERVICE PROFILE default ADMIN
Packet Service Profile default Configuration Index: Admin. State: Preferred Audio Encoding: Preferred Encoding Packet Size (ms): Default Encoding Packet Size (ms): Default Audio: Silence Factor: Fax Relay: DTMF Relay: DTMF Relay Out Of Band: DTMF Relay Remove Digits: Voice Initial Playout Buffer Delay (ms): Failure Fallback Handling: 1 ENABLED G711 10 10 ENABLED 0 NEVER NEVER DISABLED DISABLED 10 CONTINUE
4-99
Type Of Service (TOS) Setting: Data Parameters: RTP Payload Type: Initial Playout Buffer Delay (ms): Silence Suppression Parameters: G.711 Send SID: G.711 SID Payload Type: SID Heartbeat: RTCP Parameters: RTCP: Packet Loss Threshold: Packet Loss Action: Peer Absence Action:
0x00
56 50
ENABLED 19 ENABLED DISABLED 0 NONE NONE
G.711 with DTMF RELAY
PSTN
IP
PSTN Phone
GSX
IP Media Stream
SIP Call Signaling Packets without DTMF INFO m essages SIP Call Signaling Packets with DTMF INFO m essages G.711 G.711 / RFC2833 G.72X G.72X / RFC2833
G.711 / RFC2833 (with Digits Rem oved)
G.72X / RFC2833 (with Digits Rem oved)
FIGURE 4-25
G.711 with DTMF RELAY
Figure 4-25 illustrates the IP streams for SIP calls when PREFERRED ENCODING is g711 or g711ss and DTMF RELAY is always. This establishes in band DTMF Relay using the RFC2833 mechanism. (Under G.711, DTMF Relay is performed only in band, using the RFC2833 mechanism; out of band DTMF Relay is not defined.) Thus, although the SIP Signaling channel is active, it does not carry DTMF tones. At least one SPS30 or CNS25 server module must be present in the GSX to provide processing resources for DTMF Relay, even under G.11 encoding. The default Packet Service Profile shown below provides this SIP IP environment.
4-100
Node: TPUBS
Date: 2001/07/02 17:00:28 Zone: GMTMINUS05-EASTERN-US
GMT
Packet Service Profile default Configuration Index: Admin. State: Preferred Audio Encoding: Preferred Encoding Packet Size (ms): Default Encoding Packet Size (ms): Default Audio: Silence Factor: Fax Relay: DTMF Relay: DTMF Relay Out Of Band: DTMF Relay Remove Digits: Voice Initial Playout Buffer Delay (ms): Failure Fallback Handling: Type Of Service (TOS) Setting: Data Parameters: RTP Payload Type: Initial Playout Buffer Delay (ms): Silence Suppression Parameters: G.711 Send SID: G.711 SID Payload Type: SID Heartbeat: RTCP Parameters: RTCP: Packet Loss Threshold: Packet Loss Action: Peer Absence Action: DISABLED 0 NONE NONE ENABLED 19 ENABLED 56 50 1 ENABLED G711 10 10 ENABLED 0 NEVER ALWAYS DISABLED DISABLED 10 CONTINUE 0x00
4-101
G.711 with DTMF Relay, with Digits Removed
PSTN
IP
PSTN Phone
GSX
IP Media Stream
FIGURE 4-26
G.711with DTMF RELAY with DIGITS REMOVED
Figure 4-26 illustrates the IP streams for SIP calls when PREFERRED ENCODING is g711 or g711ss, DTMF RELAY is always, and DTMF RELAY REMOVE DIGITS is enabled. This establishes in band DTMF Relay using the RFC2833 mechanism. (Under G.711, DTMF Relay is performed only in band, using the RFC2833 mechanism; out of band DTMF Relay is not defined.) 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 SPS30 or CNS25 server module must be present in the GSX to provide processing resources for DTMF Relay, even under G.11 encoding. The default Packet Service Profile shown below provides this SIP IP environment.
Node: TPUBS Date: 2001/07/02 17:00:28 Zone: GMTMINUS05-EASTERN-US Packet Service Profile default Configuration Index: Admin. State: Preferred Audio Encoding: Preferred Encoding Packet Size (ms): Default Encoding Packet Size (ms): Default Audio: Silence Factor: Fax Relay: DTMF Relay: 1 ENABLED G711 10 10 ENABLED 0 NEVER ALWAYS GMT
4-102
DTMF Relay Out Of Band: DTMF Relay Remove Digits: Voice Initial Playout Buffer Delay (ms): Failure Fallback Handling: Type Of Service (TOS) Setting: Data Parameters: RTP Payload Type: Initial Playout Buffer Delay (ms): Silence Suppression Parameters: G.711 Send SID: G.711 SID Payload Type: SID Heartbeat: RTCP Parameters: RTCP: Packet Loss Threshold: Packet Loss Action: Peer Absence Action:
DISABLED ENABLED 10 CONTINUE 0x00 56 50 ENABLED 19 ENABLED
DISABLED 0 NONE NONE
G.729A with DTMF Relay, Out of Band
PSTN
IP
PSTN Phone
GSX
IP Media Stream
FIGURE 4-27
G.729A with DTMF RELAY, Out of Band
Figure 4-27 illustrates the IP streams for SIP calls when PREFERRED ENCODING is g729a or g729ab, DTMF RELAY is useIfCompressedAudio, DTMF RELAY OUT OF BAND is enabled, and DTMF RELAY REMOVE DIGITS is disabled. 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.
4-103
At least one SPS30 or CNS25 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.
Node: TPUBS Date: 2001/07/02 17:00:28 Zone: GMTMINUS05-EASTERN-US Packet Service Profile default Configuration Index: Admin. State: Preferred Audio Encoding: Preferred Encoding Packet Size (ms): Default Encoding Packet Size (ms): Default Audio: Silence Factor: Fax Relay: DTMF Relay: DTMF Relay Out Of Band: DTMF Relay Remove Digits: Voice Initial Playout Buffer Delay (ms): Failure Fallback Handling: Type Of Service (TOS) Setting: Data Parameters: RTP Payload Type: Initial Playout Buffer Delay (ms): Silence Suppression Parameters: G.711 Send SID: G.711 SID Payload Type: SID Heartbeat: RTCP Parameters: RTCP: Packet Loss Threshold: Packet Loss Action: Peer Absence Action: DISABLED 0 NONE NONE ENABLED 19 ENABLED 56 50 1 ENABLED G729A 10 10 ENABLED 0 NEVER USEIFCOMPRESSEDAUDIO ENABLED DISABLED 10 CONTINUE 0x00 GMT
G.729A with DTMF Relay, Out of Band, with Digits
4-104
Removed
PSTN
IP
PSTN Phone
GSX
IP Media Stream
FIGURE 4-28
G.729A with DTMF RELAY, Out of Band, with DIGITS REMOVED
Figure 4-27 illustrates the IP streams for SIP calls when PREFERRED ENCODING is g729a or g729ab, DTMF RELAY is useIfCompressedAudio, DTMF RELAY OUT OF BAND is enabled, and DTMF RELAY 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. In this case, the DTMF audio is removed from the packets in the IP Media Stream. At least one SPS30 or CNS25 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.
Node: TPUBS Date: 2001/07/02 17:00:28 Zone: GMTMINUS05-EASTERN-US Packet Service Profile default Configuration Index: Admin. State: Preferred Audio Encoding: Preferred Encoding Packet Size (ms): Default Encoding Packet Size (ms): Default Audio: Silence Factor: Fax Relay: DTMF Relay: DTMF Relay Out Of Band: 1 ENABLED G729A 10 10 ENABLED 0 NEVER USEIFCOMPRESSEDAUDIO ENABLED GMT
4-105
DTMF Relay Remove Digits: Voice Initial Playout Buffer Delay (ms): Failure Fallback Handling: Type Of Service (TOS) Setting: Data Parameters: RTP Payload Type: Initial Playout Buffer Delay (ms): Silence Suppression Parameters: G.711 Send SID: G.711 SID Payload Type: SID Heartbeat: RTCP Parameters: RTCP: Packet Loss Threshold: Packet Loss Action: Peer Absence Action:
DISABLED 10 CONTINUE 0x00
56 50
ENABLED 19 ENABLED DISABLED 0 NONE NONE
4-106
5-1
CHAPTER 5
Call Accounting
The Call Accounting Manager (CAM) running on every GSX9000 shelf logs ASCII system accounting data to the event log 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 4-35 for a discussion of non-accounting event logging.
Accounting Files
The accounting files are saved in the <BASEDIR>/evlog/<NODEID>/ACT subdirectory of the GSX system tree on the NFS server (see Figure 4-17 on page 4-70).
File Name
Each accounting file name is constructed as follows:
SXXXXXX.ACT
Where,
S is the shelf number (hex) XXXXXX is a 6 digit sequence number (hex) that increments by one every time a new file is created (as discussed below in Sequence Number in File Name) ACT is the file name extension for accounting event log files
Thus a file named 100003A.ACT designates an accounting file for shelf 1, sequence number 58.
File Size
The size of each accounting file is established by the FILESIZE parameter of the acct Event Log object (see Event Log on page 3-53). By default this size is 32768K bytes. Each accounting record is queued in MNS1x 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 acct object (by default this parameter is 10)
5-2
Accounting Files
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.
Number of Coexisting Files

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 60 seconds 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!
Sequence Number in File Name

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. To guarantee that this naming strategy is not violated, do not alter or remove the NEXTACTn file. The examples below illustrate the CAM strategies for creating, naming, and maintaining the accounting log files.
Warning
Accounting Files
5-3
NUMFILES value 512
# of .ACT files in /ACT 32
content of NEXTACT1 000121
CAM Action to create a new file
create 1000121.ACT write 000122 into NEXTACT1 send 50% full event to Event Notification Manager create 1000317.ACT write 000318 into NEXTACT1 create 1000001.ACT create NEXTACT1 and write 000002 into it create 1FFFFFF.ACT write 000001 into NEXTACT1 send full event to Event Notification Manager
512
255
000317
512
0 or more (see note)
non-existent
512
32
FFFFFF
512
512
0004AE
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).
File Header
Every event log file, including accounting logs, begins with a file header. This 128 character string is terminated by a carriage return. The layout of this string is shown below:
Event Log File Header

Field Offset 0 20 28 30 Field Length 20 8 2 2 Field Content ASCII OEM string, blank padded, (for example Sonus Networks, Inc. Reserved File Version. This value is 13 for GSX Software Release 4.01. (Accounting log files only.) Hex offset to the Event Log Type, or the number of bytes from the beginning of the record to the beginning of the Event Log Type field Reserved
32
18
5-4
Accounting Records
Event Log File Header

Field Offset 50 54 96 99 115 127 Field Length 4 42 3 16 12 1 Field Content Hex offset to start of data Reserved Event Log Type (same as file extension) File creation time Reserved Header terminator (carriage return)
Accounting Records
The CAM generates one of six types of accounting records corresponding to specific events in the life of a call:
REBOOT - Generated when the shelf reboots. SWITCHOVER - Generated when the shelf switches over from the active MNS to the standby MNS. This record is effectively a REBOOT record, and hereafter all REBOOT explanation pertains as well to SWITCHOVER. START - Generated when a call is successfully completed, that is, a connect is received and the call is cut-through. STOP - Generated when a call that was successfully completed is terminated. ATTEMPT - Generated on termination of a call that was not completed.

Note
In an ATTEMPT record, the validity of the fields depends on the stage of call establishment in which the call was disconnected. Information that is not available or applicable will not be present (the field will be empty).
INTERMEDIATE - Generated at periodic intervals while the call is established.
Each of the Accounting Records have multiple fields which are saved in a commadelimited 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 GSX9000 node is configured. Billing application programs can use this field in conjunction with the timestamps in GMT to convert those timestamps into local time.
Accounting Records Summary
5-5

Table 5 -1 below, describes each field in the Reboot, Start, Stop, Attempt, and Intermediate records by location within the record, field length, and field type.
TABLE 5 -1.

Max Length Type
Field Name
R E B O O T
S T A R T
S T O P
A T T E M P T
I N T E R M
Record Number REBOOT Field on page 5-12 START Field on page 5-12 STOP Field on page 5-12 ATTEMPT Field on page 512 INTERMEDIATE Field on page 5-12 Gateway Name Field on page 5-12 Accounting ID Field on page 5-12 Start Time in System Ticks Field on page 5-13 Node Time Zone Field on page 5-13 Start Date Field on page 5-14 Start Time Field on page 514 Time Elapsed from Receipt of Setup Message to Policy Server/Sonus SoftSwitch Response Field on page 5-14 Time Elapsed from Receipt of Setup Message to Receipt of Alerting/ProcProg Field on page 5-14 Time Elapsed from Receipt of Setup Message to Service Established on page 5-15 Intermediate Date Field on page 5-15 Intermediate Time Field on page 5-15 10 5 4 7 12 27 64 bit 10 23 10 10 10 Characters Characters Characters Characters Characters Characters Hexadecimal Decimal Characters
mm/dd/yyyy
1 1 1 1 1 2 3 2 3 4 4 5 6 5 6 7 8 2 3 4 5 6 7 8 2 3 4 5 6 7 8 2 3 4 5 6 7 8
hh:mm:ss.d Decimal
10
Decimal
10
Decimal
10
10
10 10
mm/dd/yyyy
10 11
hh:mm:ss.s
5-6
TABLE 5 -1.

Max Length Type
Field Name
R E B O O T
S T A R T
S T O P
A T T E M P T
I N T E R M
Record Number Disconnect Date Field on page 5-15 Disconnect Time Field on page 5-15 Time Elapsed from Receipt of Disconnect to Completion of Call Field on page 5-15 Call Service Duration Field on page 5-15 Call Disconnect Reason Field on page 5-16 Service Delivered Field on page 5-25 Call Direction Field on page 5-25 Service Provider Field on page 5-25 Transit Network Selection Code Field on page 5-26 Calling Number Field on page 5-26 Called Number Field on page 5-26 Extra Called Address Digits Field on page 5-26 Number of Called Num Translations Done by This Node Field on page 5-26 Called Number Before Translation #1 Field on page 5-27 Translation Type 1 Field on page 5-27 Called Number Before Translation #2 Field on page 5-28 Translation Type 2 Field on page 5-28 Billing Number Field on page 5-28 Route Label Field on page 528 10 10 10
mm/dd/yyyy
11 12 13
105 10 11
hh:mm:ss.s Decimal
10 3 22 12 23 4 30 30 30 1
Decimal Decimal Characters Characters Characters Characters Characters Characters Characters Decimal 11 12 13 14 15 16 17 18
14 15 16 17 18 19 20 21 22 23 12 13 14 15 16 17 18 19 20
12
13 14 15 16 17 18 19 20
30 1 30 1 30 23
Characters Decimal Characters Decimal Characters Characters
19 20 21 22 23 24
24 25 26 27 28 29
21 22 23 24 25 26
21 22 23 24 25 26
5-7
TABLE 5 -1.

Max Length Type
Field Name
R E B O O T
S T A R T
S T O P
A T T E M P T
I N T E R M
Record Number Route Attempt Number Field on page 5-29 Route Selected Field on page 5-29 Local Gateway Signaling IP Address Field on page 5-29 Remote Gateway Signaling IP Address Field on page 5-29 Ingress PSTN Trunk Name Field on page 5-29 Ingress PSTN Circuit End Point Field on page 5-29 Ingress IP Circuit End Point Field on page 5-29 Egress PSTN Circuit End Point Field on page 5-29 Egress IP Circuit End Point Field on page 5-30 Number of Audio Bytes Sent Field on page 5-30 Number of Audio Packets Sent Field on page 5-30 Number of Audio Bytes Received Field on page 5-30 Number of Audio Packets Received Field on page 5-30 Originating Line Information (OLIP) Field on page 5-30 Jurisdiction Information Parameter Field on page 5-31 Carrier Code Field on page 5-31 Call Group ID Field on page 5-32 Script Log Data Field on page 5-32 Time Elapsed from Receipt of Setup Message to Receipt of Exit Message Field on page 532 1 51 15 15 23 39 37 39 37 9 9 9 9 3 15 4 32 bit 96 10 Decimal Characters Dotted Decimal Dotted Decimal Characters Characters Characters Characters Characters Decimal Decimal Decimal Decimal Decimal Characters Characters Hexidecimal Characters Decimal 38 34 35 36 37 25 26 27 28 29 30 31 32 33 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 36 37 38 39 40 41 95 54 55 36 37 27 28 29 30 31 32 33 34 35 27 28 29 30 31 32 33 34 35
5-8
TABLE 5 -1.

Max Length Type
Field Name
R E B O O T
S T A R T
S T O P
A T T E M P T
I N T E R M
Record Number Time Elapsed from Receipt of Setup Message to Generation of Exit Message Field on page 5-32 Calling Party Nature of Address Field on page 5-32 Called Party Nature of Address Field on page 5-32 Protocol Variant Specific Data #1 Field on page 5-33 Ingress Signaling Type Field on page 5-33 Egress Signaling Type Field on page 5-33 Ingress Far End Switch Type Field on page 5-33 Egress Far End Switch Type Field on page 5-33 Carrier Code of the Carrier That Owns the Far End of the Ingress Trunk Group Field on page 5-33 Carrier Code of the Carrier That Owns the Far End of the Egress Trunk Group Field on page 5-34 Calling Party Category Field on page 5-35 Dialed Number Field on page 5-37 Carrier Selection Information Field on page 5-37 Called Number Numbering Plan Field on page 5-37 Generic Address Parameter Field on page 5-38 Disconnect Initiator Field on page 5-38 Number of Packets Recorded as Lost Field on page 5-39 10 Decimal 39 49 42 96
3 3 376 2 2 1 1 4
Decimal Decimal Characters Decimal Decimal Decimal Decimal Characters
40 41 42 43 44 45 46 47
50 51 52 53 54 55 56 57
43 44 45 46 47 48 49 50
56 57 38 39 40 41 42 43
Characters
48
58
51
44
8 bits 30 1 1 30 1 10
Hexadecimal Characters Decimal Decimal Characters Decimal Decimal
49 50 51 52 53
59 60 61 62 63 64 65
52 53 54 55 56 57
45 46 47 48 49
5-9
TABLE 5 -1.

Max Length Type
Field Name
R E B O O T
S T A R T
S T O P
A T T E M P T
I N T E R M
Record Number Interarrival Packet Jitter Field on page 5-39 Last Measurement for Latency Field on page 5-39 Egress Trunk Group Name Field on page 5-39 Protocol Variant Specific Data #2 Field on page 5-39 Incoming Calling Number Field on page 5-39 Intermediate Record Reason Field on page 5-39 AMA Call Type Field on page 5-40 Message Billing Index (MBI) Field on page 5-40 Originating LATA Field on page 5-40 Route Index Used Field on page 5-40 Calling Party Number Presentation Restriction Field on page 5-40 Incoming ISUP Charge Number Field on page 5-40 Incoming ISUP Charge Number NOA Field on page 5-41 Dialed Number NOA Field on page 5-41 Ingress Codec Type Field on page 5-41 Egress Codec Type Field on page 5-41 RTP Packetization Time Field on page 5-41 GSX Call ID Field on page 5-41 Terminated with Script Field on page 5-41 5 5 23 376 30 1 3 3 3 2 1 Decimal Decimal Characters Characters Characters Decimal Characters Characters Characters Decimal Decimal 57 58 59 60 61 71 72 73 74 75 61 62 63 64 65 61 54 55 56 66 67 68 69 70 58 59 60 50 51 52 53 58 59 60
30 3 3 5 5 3 32 bit 1
Characters Decimal Decimal String String Decimal Hexadecimal Boolean
62 63 64
76 77 78 79 80 81
66 67 68 69 70 71 72 73
62 63 64
65
82
65
5-10
TABLE 5 -1.

Max Length Type
Field Name
R E B O O T
S T A R T
S T O P
A T T E M P T
I N T E R M
Record Number Originator Echo Cancellation Field on page 5-42 Terminator Echo Cancellation Field on page 5-42 Charge Flag Field on page 542 AMA Service Logic Identification Field on page 5-42 AMA BAF Module Field on page 5-43 AMA Set Hex AB Indication Field on page 5-47 Service Feature ID Field on page 5-48 FE Parameter Field on page 5-50 Satellite Indicator Field on page 5-52 PSX Billing Information Field on page 5-53 Originating TDM Trunk Group Type Field on page 562 Terminating TDM Trunk Group Type Field on page 563 Ingress Trunk Member Number Field on page 5-63 Egress Trunk Group ID Field on page 5-63 Egress Switch ID Field on page 5-63 Active Call Ingress Local ATM Address Field on page 5-63 Active Call Ingress Remote ATM Address Field on page 5-64 Active Call Egress Local ATM Address Field on page 5-64 1 1 1 9 256 1 3 22 1 256 1 Decimal Decimal Decimal Characters Characters Boolean Characters Hexadecimal Decimal Hexadecimal Decimal 66 67 68 69 70 71 72 73 74 83 84 85 86 87 88 89 90 91 92 93 74 75 76 77 78 79 80 81 82 83 84 66 67 68 69 70 71 72 73 74
Decimal
75
94
85
75
5 5 5 0
Decimal Decimal Decimal Reserved
76 77 78 79
95 96 97 98
86 87 88 89
76 77 78 79
Reserved
80
99
90
80
Reserved
81
100
91
81
5-11
TABLE 5 -1.

Max Length Type
Field Name
R E B O O T
S T A R T
S T O P
A T T E M P T
I N T E R M
Record Number Active Call Egress Remote ATM Address Field on page 5-64 Policy Response Call Type Field on page 5-64 Outgoing Route Identification Field on page 5-65 Outgoing Message Identification Field on page 5-65 Incoming Route Identification Field on page 5-66 Calling Name Field on page 5-66 Calling Name Type Field on page 5-67 Incoming Calling Party Numbering Plan on page 5-67 Outgoing Calling Party Numbering Plan on page 5-68 Calling Party Business Group ID on page 5-68 Called Party Business Group ID on page 5-69 Calling Party Public Presence Directory Number on page 569 Elapsed Time from Receipt of Setup Message to Last Call Routing Attempt on page 5-69 Billing Number NOA on page 5-69 Incoming Calling Number NOA on page 5-70 Egress Trunk Member Number on page 5-70 Selected Route Type on page 5-70 0 Reserved 82 101 92 82
2 5 1 5 24 1 2 2 10 10 30
Decimal Decimal Decimal Decimal Characters Decimal Decimal Decimal Decimal Decimal Characters
83 84 85 86 87 88 89 90 91 92 93
102 103 104 105 106 107 108 109 110 111 112
93 94 95 96 97 98 99 100 101 102 103
83 84 85 86 87 88 89 90 91 92 93
Decimal
94
113
104
94
1 1 5 1
Decimal Decimal Decimal Decimal
95 96 97 98
114 115 116 117
106 107 108 109
97 98 99 100
5-12
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 5-5 to view the chronological arrangement of the fields of any one of these record types.
REBOOT Field
The 6 character string REBOOT, or the 10 character string SWITCHOVER.
START Field
The 5 character string START.
STOP Field
The 4 character string STOP.
ATTEMPT Field
The 7 character string ATTEMPT.
INTERMEDIATE Field
The 12 character string INTERMEDIATE.
Gateway Name Field

Gateway Name (up to 27 characters). If parameter loading is turned on (see Non-Volatile Storage (NVS) Parameters on page 3-34), 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-15), then this value will be None in the REBOOT and SWITCHOVER records.
Accounting ID Field
Accounting ID (64 bits in HEX format). 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 5-1, Accounting ID.
5-13
Shelf Number (16 bits)
Boot Count (16 bits)
Call ID (32 bits)
FIGURE 5-1
Accounting ID
Note
The Boot Count is incremented every time the shelf reboots or an MNS 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 Field

Start time in system ticks - the timestamp of when Setup Request was received (Decimal number 0 - 4,294,967,295).
Node Time Zone Field

Node Time Zone (up to 23 characters). This field must be occupied by one of the following strings:
"GMT-12:00-Eniuetok" "GMT-11:00-Midway Island" "GMT-10:00-Hawaii" "GMT-09:00-Alaska" "GMT-08:00-Alaska-DST" "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(Cana" Note: trailing "da)" is truncated by the GSX "GMT-03:00-Atlantic-DST" "GMT-04:00-Caracas"
Note: DST stands for Daylight Savings Time
5-14
"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" "GMT+09:30-Adelaide" "GMT+10:00-Guam" "GMT+11:00-Magadan" "GMT+12:00-Fiji" "Time Zone Not Set"
Start Date Field

Start Date (mm/dd/yyyy) - GMT datestamp when Setup Request was received. In the BOOT record, this is the date that the GSX was last booted.
Start Time Field

Start Time (hh:mm:ss.d) (d=deci-seconds) - GMT timestamp when Setup Request was received, for example 12:20:38.6. In the BOOT record, this is the time that the GSX was last booted.
Time Elapsed from Receipt of Setup Message to Policy Server/Sonus SoftSwitch Response Field
Time Elapsed from Receipt of Setup Message to Policy Server/Sonus SoftSwitch Response in 10 millisecond Ticks (Decimal number 0 - 4,294,967,295).
Time Elapsed from Receipt of Setup Message to Receipt

5-15
of Alerting/ProcProg Field
Time Elapsed from Receipt of Setup Message to Receipt of Alerting/Proc/Prog in 10 millisecond Ticks (Decimal number 0 - 4,294,967,295).
Time Elapsed from Receipt of Setup Message to Service Established

Time Elapsed from Receipt of Setup Message to Service Est (Receipt of Answer and Completion of Cut-through) in 10 millisecond Ticks (Decimal number 0 4,294,967,295).
Intermediate Date Field

Intermediate Date (mm/dd/yyyy) - GMT datestamp when Intermediate Accounting Timer expired., for example 02/06/1999.
Intermediate Time Field

Intermediate Time (hh:mm:ss.d) (d=deci-seconds) - GMT timestamp when Intermediate Accounting Timer expired, for example 12:20:38.6.
Disconnect Date Field

Disconnect Date (mm/dd/yyyy) - GMT datestamp when Disconnect Request was received.
Disconnect Time Field

Disconnect Time (hh:mm:ss.d) (d=deci-seconds) - GMT timestamp when Disconnect Request was received.
Time Elapsed from Receipt of Disconnect to Completion of Call Field

Time Elapsed from Disconnect receipt to Call Termination completion in 10 millisecond ticks (Decimal number 0 - 4,294,967,295).
Call Service Duration Field

Call Service Duration in 10 millisecond ticks (Decimal number 0 - 4,294,967,295).
5-16
Call Disconnect Reason Field

UNALLOCATED NUMBER Call1 Disconnect Reason (0 - 255). (Because the GSX never generates this internally, this code originates at a switch The Call Termination Reason Codes shown below are taken from the Q.931 Standard that is downstream from this GSX.) for all codes less than 128. 2 equal to NO ROUTE SPECIFIED NETWORK Codes or greaterTO 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 3 NO ROUTE TO DESTINATION appropriate Q.931 Standard code. The Sonus Reason Codes will appear in the system codes 138 and 139 are mapped this ID] These codes could expand event logs to [Sonus give specific information about the to call failure. in the future. (The GSX may release a call with this cause value if:
Note
CAS SSP configuration CAS SignalSeq on page 3-457 and The PSX(see loses connectivity to the Oracle DB server andfollowhence is unable to ing) allows the administrator to specify the disconnect reason codes to be perform routing.) used when errors are encountered during CAS call establishment. ThereSEND SPECIAL INFOcould TONE fore,4any of the error codes below 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 then that value is mapped to one of the 7 Mapped To cause values listed in 6 5 -2, CHANNEL UNACCEPTABLE Table 5 -3, Mapping by Cause Code Class. In all cases, the Mapped To value is deter7 mined by the CALL Class AWARDED 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).
TABLE 5 -2.
No routes are configured on the PSX for this destination.
MISDIALED TRUNK PREFIX
Call Termination Reason Codes DEFINITION

(Added Explanation)
ID
Q.931 Standard (0-127)

0 INVALID DISCONNECT REASON
5-17
UNALLOCATED NUMBER (Because the GSX never generates this internally, this code originates at a switch that is downstream from this GSX.)
2 3
NO ROUTE TO SPECIFIED NETWORK NO ROUTE TO DESTINATION [Sonus codes 138 and 139 are mapped to this ID] (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 5 6 7
SEND SPECIAL INFO TONE MISDIALED TRUNK PREFIX CHANNEL UNACCEPTABLE CALL AWARDED
5-18
TABLE 5 -2.

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.)
26
27 28
DESTINATION OUT OF ORDER 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 30
FACILITY REJECTED 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.)
34
NO CIRCUIT AVAILABLE [Sonus codes 128, 140, and 142 are mapped to this ID] (The GSX may release a call with this cause value if: The GSX attempts to reroute the call, but is out of routes. A GSX software programming error occurred.)
5-19
TABLE 5 -2.

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.)
38
39 40 41
PERM FM CONNECTION OOS PERM FM CONNECTION OPERATIONAL TEMPORARY FAILURE [Sonus codes 131, 132, and 136 are mapped to this ID] (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 Switchover, MNS 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 doesnt 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 (The GSX may release a call with this cause value if a GSX software programming error occurred. The GSX may propagate this code, if it receives it from the network.)
43
ACCESS INFORMATION DISCARDED (The GSX may release a call with this cause value if this code is returned before an ANM/CONNECT message.)
5-20
TABLE 5 -2.

REQUESTED CIRCUIT NOT AVAILABLE ANSI PREEMPTION PRECEDENCE CALL BLOCKED RESOURCE UNAVAILABLE UNSPECIFIED [ISUP codes 39, 40, and 45 are mapped to this ID]
44 45 46 47
49 50 51 53 54 55
QUALITY OF SERVICE UNAVAILABLE REQUESTED FACILITY NOT SUBSCRIBED CALL TYPE INCOMPATIBLE WITH SEREVICE OUTGOING CALL BARRED CUG CALL BLOCKED GROUP RESTRICTIONS 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 58 62 63
BEARER CAPABILITY NOT AUTHORIZED BEARER CAPABILITY PRESENTLY NOT AVAILABLE INCONSISTENT OUTGOING SUBSCRIBER CLASS SERVICE OR OPTION NOT AVAILABLE UNSPECIFIED [Sonus code 137 is mapped to this ID] [ISUP codes 49, 51, and 54 are mapped to this ID]
65 66 69 70 79
BEARER CAPABILITY NOT IMPLEMENTED CHANNEL TYPE NOT IMPLEMENTED REQUESTED FACILITY NOT IMPLEMENTED ONLY RESTRICTED DIGITAL INFO BEARER CAPABILITY AVAILABLE SERVICE OR OPTION NOT IMPLEMENTED UNSPECIFIED [ISUP code 66 is mapped to this ID]
81 82 83 84 85 86 87
INVALID CALL REFERENCE CHANNEL DOES NOT EXIST SUSPENDED CALL NO IDENTITY CALL IDENTITY IN USE NO CALL SUSPENDED CALL IDENTITY CLEARED 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
5-21
TABLE 5 -2.

NON-EXISTENT CUG INVALID NETWORK SELECTION INVALID MESSAGE UNSPECIFIED [ISUP codes 81, 82, 83, 84, 85, and 86 are mapped to this ID]
90 91 95
96 97 98
MANDATORY INFORMATION ELEMENT MISSING MESSAGE TYPE NON-EXISTENT OR NOT IMPLEMENTED 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 100 101 102
IE NOT IMPLEMENTED INVALID INFORMATION ELEMENT CONTENT MSG NOT COMPATIBLE WITH STATE 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 110 111
PARAMETER NOT IMPLEMENTED UNRECOGNIZED PARAMETER PROTOCOL ERROR UNSPECIFIED [ISUP codes 96, 98, 100, and 101 are 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)
5-22
TABLE 5 -2.

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 switchover, CNS switchover, etc. The GSX memory resources are exhausted.)
128
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 31] (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 31] (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-IPPSTN calls, the call is reattempted using the next route in the list.)
5-23
TABLE 5 -2.

CONTINUITY 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 continuity tests on the selected egress circuits fail. After one reattempt, the call is released with this code.)
136
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.)
5-24
TABLE 5 -2.

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.)
143
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.)
TABLE 5 -3.
Mapping by Cause Code Class

Mapped to Cause Code 31 31
Class of Mapped From Cause Code 000 Normal 001 Normal
Definition of Mapped to Cause Code NORMAL_UNSPECIFIED NORMAL_UNSPECIFIED
5-25
TABLE 5 -3.
Mapping by Cause Code Class

Mapped to Cause Code 47 63 79 95 111 127
Class of Mapped From Cause Code 010 Resource Unavailable 011 Service or Option not Available 100 Service or Option Not Implemented 101 Invalid Message 110 Protocol Error 111 Interworking
Definition of Mapped to Cause Code RESOURCE_UNAVAILABLE_UNSP ECIFIED SERVICE_OR_OPTION_NOT_AVAIL ABLE_UNSPECIFIED SERVICE_OR_OPTION_NOT_IMPLE MENTED_UNSPECIFIED INVALID_MESSAGE_UNSPECIFIED PROTOCOL_ERROR_UNSPECIFIED INTERWORKING_UNSPECIFIED
Service Delivered Field

Service Delivered - VoIP/Circuit Switched Voice (up to 22 characters). For PSTN-toPSTN 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.
Call Direction Field

Call Direction - PSTN-TO-IP/PSTN-TO-PSTN/IP-TO-PSTN/PSTN-TO-TERM/IPTO-TERM/TERM-TO-PSTN/TERM-TO-IP (up to 12 characters). The first stage of a two stage call is either PSTN-TO-TERM or IP-TO-TERM (not yet supported). The second stage of a two stage call is either TERM-TO-PSTN or TERMTO-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".
Service Provider Field

Service Provider (up to 23 characters). This field is populated with the route partition ID that the PSX used for routing the call.
5-26
Transit Network Selection Code Field

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 Field

Calling Number (up to 31 characters). 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 Field

Called Number (up to 31 characters). 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 Field

Extra Called Address Digits (string up to 31 characters, 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 GSX9000 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 GSX9000 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: Called Number = 978-321 Extra Called Address Digits = 1234
Number of Called Num Translations Done by This Node Field

Number of Called Num Translations on this node (Decimal number 0 - 2). The fields,
Number of Called Num Translations Done by This Node Called Number Before Translation #1 Translation Type 1 Called Number Before Translation #2
5-27
Translation Type 2
carry information about TollFree/LNP translation that was performed by the PSX. For example the called number received by the GSX9000 in the incoming IAM is 1800-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: Called Number = 781-123-1000 Number of Called Num Translations Done by This Node = 1 Called Number Before Translation #1 = 617-123-1234 Translation Type 1 = 1 Called Number Before Translation #2 Empty Translation Type 2 - 0 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 performed by the PSX, see Dialed Number Field on page 5-37.
Called Number Before Translation #1 Field

Called Number before translation #1 (up to 31 characters). This field carries information about TollFree/LNP translation that was performed by the PSX. This field will be empty (), if the following conditions are true:
The dialed number is to a ported NPA/NXX. The number has not been ported.
ACCOUNTING POPULATE NON-PORTED LNP NUMBERS is false
The Translation Type 1 field is 1 (CPC_ADDR_TRANS_LNP). See Translation Type 1 Field on page 5-27.
Translation Type 1 Field

Translation Type 1. 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)
5-28
3 - CPC_ADDR_TRANS_PRIVATE
Called Number Before Translation #2 Field

Called Number before translation #2 (up to 31 characters). This field carries information about TollFree/LNP translation that was performed by the PSX. This field will be empty (), if the following conditions are true:
The dialed number is to a ported NPA/NXX. The number has not been ported.
ACCOUNTING POPULATE NON-PORTED LNP NUMBERS is false
The Translation Type 2 field is 1 (CPC_ADDR_TRANS_LNP). See Translation Type 2 Field on page 5-28.
Translation Type 2 Field

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
Billing Number Field

This field is a string of up to 30 characters. The record is populated using the following precedence:
1. 2. 3.
If SCP returns a billing number, it takes precedence over the others. If billing number is present in the incoming signaling message, then it is used. If there is no billing number returned by SCP or in the incoming signaling message, then the billing number configured against the ingress trunk on the PSX is used.
See the relevant table in Nature of Address Enumeration Values on page 5-72.
Route Label Field

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:
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.
5-29
Route Attempt Number Field

Route Attempt Number (Decimal number 1 - 10).
Route Selected Field

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.
Local Gateway Signaling IP Address Field

Local Gateway Signaling IP Address (Applicable only for VoIP Calls) - IP address in dotted decimal format, for example 128.1.22.233 (up to 15 characters).
Remote Gateway Signaling IP Address Field

Remote Gateway Signaling IP Address (Applicable only for VoIP Calls) - IP address in dotted decimal format, for example 128.1.22.233 (up to 15 characters).
Ingress PSTN Trunk Name Field

Ingress PSTN Trunk Name (Applicable only for PSTN-IP and PSTN-PSTN Calls) (up to 23 characters).
Ingress PSTN Circuit End Point Field

Ingress PSTN Circuit End Point - Shelf (1-6):Slot (1-16):Port (1-28):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).
Ingress IP Circuit End Point Field

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 Field

Egress PSTN Circuit End Point - Shelf (1-6):Slot (1-16):Port (1-28):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).
5-30
Egress IP Circuit End Point Field

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)).
Number of Audio Bytes Sent Field

Number of Audio Bytes Sent (decimal representation of a 64 bit number, that is 1 1.844674407*1019).
Number of Audio Packets Sent Field

Number of Audio Packets Sent (decimal representation of a 64 bit number, that is 1 1.844674407*1019).
Number of Audio Bytes Received Field

Number of Audio Bytes Received (decimal representation of a 64 bit number, that is 1 1.844674407*1019).
Number of Audio Packets Received Field

Number of Audio Packets Received (decimal representation of a 64 bit number, that is 1 - 1.844674407*1019).
Originating Line Information (OLIP) Field

Originating Line Information (OLIP), also known as info digits. A decimal value. The values in Table 5 -4 (below) match ANSI T1.113 (ANSI ISUP).
TABLE 5 -4.
OLIP Parameters
Value 0 1 2 6 7 8 10 20 23
Names OLI_POTS OLI_ONI OLI_ANI_FAILURE OLI_HOTEL OLI_SPECIAL_OPERATOR OLI_RSTRCTD OLI_TEST1 OLI_AIOD OLI_IDENTIFIED
5-31
TABLE 5 -4.
OLIP Parameters
Value 24
Names OLI_TOLLFREE (Non Payphone 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_PAYPHONE_TOLLFREE (Payphone 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 OLI_INMATE OLI_TELCO_OPERATOR OLI_OUTWATS OLI_TRS OLI_CELLULAR_TYPE1 OLI_CELLULAR_TYPE2 OLI_CELLULAR_ROAMING OLI_PRIVATE_PAYSTATION OLI_RSTRCTD_COINLESS OLI_PRIVATE_VIRTUAL_NW OLI_PINK_PUBLIC_PHONE (Japan only) OLI_PINK_OTHER_PHONE (Japan only) Reserved
25
27 29 34 52 60 61 62 63 70 78 93 94 95 96255
Jurisdiction Information Parameter Field

Jurisdiction Information Parameter (JIP). In Local Number Portability (LNP) applications, provides the Local Routing Number (LRN) assigned to the originating number, which is then used for determining proper billing for the call. (String up to 15 characters).
Carrier Code Field

Carrier Code (up to 4 characters, for example 0288). This is the carrier identification code 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 would be empty.
5-32
Call Group ID Field

Call Group ID. (32 bit HEX format, for example, 8 digits). This is an internal identifier used by the GSX9000 to identify all calls that are associated with the same two-stage call group. For example, a two-stage script gets executed, the GSX9000 answers the first stage call, and then the user makes multiple second stage calls. Then accounting records for the first stage call and all subsequent second stage calls would share the same call group ID.
Script Log Data Field

Script Log Data (A string which contains data logged by a Sonus CPL script which was executed for the call). Multiple variables may be logged within this field, with each variable data separated by a 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 subfields 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.
Time Elapsed from Receipt of Setup Message to Receipt of Exit Message Field
Time Elapsed from Receipt of Setup Message to Receipt of Exit Message (EXM) in 10 ms Ticks (Decimal number 0 - 4,294,967,295).
Time Elapsed from Receipt of Setup Message to Generation of Exit Message Field
Time Elapsed from Receipt of Setup Message to Generation of Exit Message (EXM) in 10 ms Ticks (Decimal number 0 - 4,294,967,295).
Calling Party Nature of Address Field

Calling Party Nature of Address. Decimal Value. See the relevant table in Nature of Address Enumeration Values on page 5-72.
Called Party Nature of Address Field

Called Party Nature of Address. Decimal Value.
5-33
See the relevant table in Nature of Address Enumeration Values on page 5-72.
Protocol Variant Specific Data #1 Field

Protocol Variant Specific Data #1. String with delimiters . See Japan ISUP Variant Sub-field Descriptions on page 5-74, SIP Variant Sub-field Descriptions on page 5-77, H.323 Signaling Sub-field Descriptions on page 5-77, GSX Gateway to Gateway Signaling Sub-field Descriptions on page 5-78 and BTIUP Variant Sub-field Descriptions on page 5-78 for these specific variants. Note For calls that require two protocol specific fields to be populated, such as Japanese ISUP and SIP, one variant is placed in the Protocol Variant Specific Data#1 field and the other in the Protocol Variant Specific Data#2 field. The specific variant is always identified in the first sub-field of that field.
Ingress Signaling Type Field

Ingress Signaling Type. Decimal Value. See Signaling Type Enumeration Values on page 5-81.
Egress Signaling Type Field

Egress Signaling Type. Decimal Value. See Signaling Type Enumeration Values on page 5-81.
Ingress Far End Switch Type Field

Ingress Far End Switch Type. Decimal Value. See Far End Switch Type Enumeration Values on page 5-81.
Egress Far End Switch Type Field

Egress Far End Switch Type. Decimal Value. See Far End Switch Type Enumeration Values on page 5-81.
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 four characters such as 0288.
5-34
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 four characters such as 0288. Figure 5-2, Trunk Ownership Fields in START/STOP Records illustrates a typical PSTN-to-PSTN network in which the local GSX is writing accounting records to its NFS 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. Note This depiction applies to all PSTN-to-PSTN networks except Japan.
Carrier that owns this trunk:at this end : START RECORD - Field 47 STOP RECORD - Field 57 ATTEMPT RECORD - Field 50 INTERMEDIATE RECORD - 43
Carrier that owns this trunk at this end: : START RECORD - Field 48 STOP RECORD - Field 58 ATTEMPT RECORD - Field 51 INTERMEDIATE RECORD - Field 44
End Office PSTN Switch
Local GSX (writing CDRs) Local GSX (writing CDRs)
IP Cloud
Far End GSX
End Office PSTN Switch
Egress Trunk Ingress Trunk
FIGURE 5-2
Trunk Ownership Fields in START/STOP Records
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 4 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. 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 5-2, Trunk Ownership Fields in START/STOP Records for more explanation about this Carrier Code. 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.
2.
3.
In all cases, a string of 4 characters such as 0288, is placed in this record.
5-35
Calling Party Category Field

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. Valid hex values are shown in Table 5 -5 (below).
TABLE 5 -5.
Calling Party Category Enumeration Values

0x00 0x01 0x02 0x03 0x04 0x05 0x06 0x07 0x08 0x09
CPC_CALLING_PARTY_CATEGORY_UNKNOWN CPC_CALLING_PARTY_CATEGORY_FRENCH_LANG_OPERATOR CPC_CALLING_PARTY_CATEGORY_ENGLISH_LANG_OPERATOR CPC_CALLING_PARTY_CATEGORY_GERMAN_LANG_OPERATOR CPC_CALLING_PARTY_CATEGORY_RUSSIAN_LANG_OPERATOR CPC_CALLING_PARTY_CATEGORY_SPANISH_LANG_OPERATOR CPC_CALLING_PARTY_CATEGORY_OPERATOR_AVAILABLE1 CPC_CALLING_PARTY_CATEGORY_OPERATOR_AVAILABLE2 CPC_CALLING_PARTY_CATEGORY_OPERATOR_AVAILABLE3 CPC_CALLING_PARTY_CATEGORY_NATIONAL_NETWORK_OPERATOR_S ERVICE
(Italy)
CPC_CALLING_PARTY_CATEGORY_ORD_SUBSCRIBER CPC_CALLING_PARTY_CATEGORY_SUBSCRIBER_WITH_PRIORITY CPC_CALLING_PARTY_CATEGORY_DATA_CALL_VOICE_BAND_DATA CPC_CALLING_PARTY_CATEGORY_TEST_CALL CPC_CALLING_PARTY_CATEGORY_SPARE CPC_CALLING_PARTY_CATEGORY_PAY_PHONE CPC_CALLING_PARTY_CATEGORY_CCITT_SPARE1 CPC_CALLING_PARTY_CATEGORY_INTERCEPT _OPERATOR
0x0a 0x0b 0x0c 0x0d 0x0e 0x0f 0x10 0x11 0x12 0x13 0x14 0x15 0x16
(Singapore)
CPC_CALLING_PARTY_CATEGORY_PRIVATE_METERING
(Singapore)
CPC_CALLING_PARTY_CATEGORY_PBX
(Singapore)
CPC_CALLING_PARTY_CATEGORY_PBX_WITH_PRIORITY
(Singapore)
CPC_CALLING_PARTY_CATEGORY_CITY_WIDE_CENTREX_SUB
(Singapore)
CPC_CALLING_PARTY_CATEGORY_BASIC_BUSINESS_GROUP_SUB
(Singapore)
5-36
TABLE 5 -5.

0x17 0x18 0x19 0x1a 0x1b 0x1c 0x1d 0x1e 0x1f 0x20 0x21 0x22 0x23 0x24 0x25 0x26 0x27 0x28 0x29 0x2a 0x2b 0x2c 0x2d 0x2e 0x2f 0x30 0x31 0x32 0x33 0x34
CPC_CALLING_PARTY_CATEGORY_PABX_WITH_PRIVATE_METERING
(Singapore)
CPC_CALLING_PARTY_CATEGORY_HOTEL_SUBSCRIBER
(Singapore)
CPC_CALLING_PARTY_CATEGORY_HOTEL_SUB_WITH_PRI_METERING
(Singapore)
CPC_CALLING_PARTY_CATEGORY_DENMARKIC_249
(Denmark)
CPC_CALLING_PARTY_CATEGORY_DENMARKIC_254
(Denmark)
CPC_CALLING_PARTY_CATEGORY_IUP_ORD_SUB_RESIDENTIAL CPC_CALLING_PARTY_CATEGORY_IUP_ORD_SUB_BUSINESS CPC_CALLING_PARTY_CATEGORY_IUP_ADMIN_DIV_ORD CPC_CALLING_PARTY_CATEGORY_IUP_ADMIN_DIV_PAYPHONE CPC_CALLING_PARTY_CATEGORY_IUP_ISDN_RESIDENTIAL CPC_CALLING_PARTY_CATEGORY_IUP_ISDN_BUSINESS CPC_CALLING_PARTY_CATEGORY_IUP_PAYPHONE_PUBLIC CPC_CALLING_PARTY_CATEGORY_IUP_PAYPHONE_RENT_RESIDENTIAL CPC_CALLING_PARTY_CATEGORY_IUP_PAYPHONE_RENT_BUSINESS CPC_CALLING_PARTY_CATEGORY_IUP_SERVICE_LINE CPC_CALLING_PARTY_CATEGORY_IUP_CENTREX CPC_CALLING_PARTY_CATEGORY_IUP_OSS_OPERATOR CPC_CALLING_PARTY_CATEGORY_IUP_AMC_OP_NND_IND CPC_CALLING_PARTY_CATEGORY_IUP_AMC_OP_NND CPC_CALLING_PARTY_CATEGORY_IUP_DPNSS CPC_CALLING_PARTY_CATEGORY_IUP_RSVD_ITU_LANG1 CPC_CALLING_PARTY_CATEGORY_IUP_RSVD_ITU_LANG2 CPC_CALLING_PARTY_CATEGORY_IUP_RSVD_ITU_LANG3 CPC_CALLING_PARTY_CATEGORY_SPECIAL_LINE_2 CPC_CALLING_PARTY_CATEGORY_SLOW_ORDINARY CPC_CALLING_PARTY_CATEGORY_TELETASA CPC_CALLING_PARTY_CATEGORY_MOBILE CPC_CALLING_PARTY_CATEGORY_VIRTUAL_PRIVATE_NETWORK CPC_CALLING_PARTY_CATEGORY_SPECIAL_LINE_1 CPC_CALLING_PARTY_CATEGORY_NATIONAL_OP_INT_CAP
5-37
TABLE 5 -5.

0x35 0xdf 0xe0 0xe1 0xe2 0xe3 0xef 0xf0 0xfe
CPC_CALLING_PARTY_CATEGORY_IMMEDIATE_CHG_RATE_SERV CPC_CALLING_PARTY_CATEGORY_CCITT_SPARE2 CPC_CALLING_PARTY_CATEGORY_EMERG_SERV_CALL_IN_PROG CPC_CALLING_PARTY_CATEGORY_HIGH_PRIORITY_CALL_INDICATION CPC_CALLING_PARTY_CATEGORY_NSEP_CALL CPC_CALLING_PARTY_CATEGORY_ANSI_SPARE1 CPC_CALLING_PARTY_CATEGORY_ANSI_SPARE2 CPC_CALLING_PARTY_CATEGORY_NETWORK_SPECIFIC1 CPC_CALLING_PARTY_CATEGORY_NETWORK_SPECIFIC2
Dialed Number Field

Dialed Number (up to 31 characters). The actual dialed number received by the GSX9000 before any digit manipulation was performed by the PSX. These are the called number digits received by the GSX9000 from the ingress signaling group, before any digit manipulation, address translations, etc., by the PSX.
Carrier Selection Information Field

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 provides this field, it is left empty. Valid decimal values are shown in Table 5 -6 (below).
TABLE 5 -6.
Carrier Selection Information Enumeration Values

1 2 3 4 5
CPC_OP_CARRIER_SELECTION_NO_INDICATION CPC_OP_CARRIER_SELECTION_PRESUB_NOT_INPUT CPC_OP_CARRIER_SELECTION_PRESUB_INPUT CPC_OP_CARRIER_SELECTION_PRESUB_NO_INDICATION CPC_OP_CARRIER_SELECTION_NOT_PRESUB_INPUT
Called Number Numbering Plan Field

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
5-38
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 5 -7 below. 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.
TABLE 5 -7.
Address Numbering Plan Enumeration Values

0 1 2 3 4 5 6 7 10 14 15
CPC_ADDR_NUMBERING_PLAN_INVALID CPC_ADDR_NUMBERING_PLAN_ISDN CPC_ADDR_NUMBERING_PLAN_DATA CPC_ADDR_NUMBERING_PLAN_TELEX CPC_ADDR_NUMBERING_PLAN_PRIVATE Reserved for Sonus Use Reserved for Sonus Use Reserved for Sonus Use ISUP NPI 2 ISUP NPI 6 ISUP NPI 7
Generic Address Parameter Field

Generic Address Parameter (up to 31 characters) The original called number if LNP was performed by a switch preceding the GSX9000. 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 GSX9000. 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).
Disconnect Initiator Field

Disconnect Initiator (0-Internal 1-Calling Party, 2-Called Party). This indicates whether call release was initiated by the calling party (by the ingress signaling group), or the called party (by the egress signaling group), or was released internally by the call control entity in the GSX9000 (due to some error in the processing of the call).
5-39
Number of Packets Recorded as Lost Field

Number of packets recorded as lost packet. A decimal representation of a 32 bit number. (Applicable to RTCP statistics for VoIP calls only.)
Interarrival Packet Jitter Field

Maximum interarrival Packet Jitter time (in milliseconds). A decimal representation of a 16 bit number, hence must be in the range 0-65535. (Applicable to RTCP statistics for VoIP calls only.)
Last Measurement for Latency Field

The last measurement for latency (in milliseconds). 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 Trunk Group Name Field

Egress Trunk Group Name. Applicable only for IP-PSTN and PSTN-PSTN calls. (String up to 23 characters.)
Protocol Variant Specific Data #2 Field

Protocol Variant Specific Data #2. String with delimiters . See Japan ISUP Variant Sub-field Descriptions on page 5-74, SIP Variant Sub-field Descriptions on page 5-77, H.323 Signaling Sub-field Descriptions on page 5-77, GSX Gateway to Gateway Signaling Sub-field Descriptions on page 5-78 and BTIUP Variant Sub-field Descriptions on page 5-78 for these specific variants.
Incoming Calling Number Field

Incoming Calling Number. This field represents the calling number presented to the GSX prior to any digit manipulation or translation by the PSX. It is the Calling Number in the Incoming Signaling Message (IAM/SETUP etc.) to the GSX translation. (String up to 31 characters.)
Intermediate Record Reason Field

Intermediate Record Reason. The reason the Intermediate Record was generated:
0 - (PERIODIC) The intermediate accounting interval expired for this call, a normal event. 1 - (MTP_PAUSE_EVENT) An SS7 Server link failure occurred. 2 - (SS7_CONNECTION_FAILURE) The connection to the SGX was lost.
5-40
3 - (MALICIOUS CALL TRACE) A Malicious Call Trace was initiated (BT-IUP only).
AMA Call Type Field

Automatic Message Accounting (AMA) Call Type. (Also known as the AMA Call Code.) This field, provided by the Sonus PSX, determines how the call will be billed, such as Flat Rate, Local Measured, EAS, etc. If AMA Call Type is not available, this field will be empty (). (Three digit decimal number in the range 000-999, with leading zeroes always present.)
Message Billing Index (MBI) Field

Message Billing Indicator (MBI). This field is provided by the Sonus PSX. If MBI is not available, this field will be empty (). (Three digit decimal number in the range 000-999, with leading zeroes always present.)
Originating LATA Field

Originating Local Access and Transport Area (LATA). This field, provided by the Sonus PSX in the Policy Response, represents the originating LATA. (Three character string.)
Route Index Used Field

Route Index Used. This field signifies which route in the route table was used. This index can be combined with the Routing Label (see Route Label Field on page 5-28) to determine the chosen route. (Decimal number in the range 1-10.)
Calling Party Number Presentation Restriction Field

Calling Party Presentation Restriction. This field indicates the Presentation Restriction as follows:
0 - INVALID 1 - ALLOWED 2 - RESTRICTED 3 - NUMBER_UNAVAILABLE 4 - SPARE
(Decimal number in the range 0-4.)
Incoming ISUP Charge Number Field

Incoming ISUP Charge Number. This field is extracted from the ISDN User Part (ISUP) Initial Address Message (IAM) received on an SS7 trunk. If the number is not available this field will be empty (). (String up to 30 characters.)
5-41
Incoming ISUP Charge Number NOA Field

Incoming ISUP Charge Number Nature of Address (NOA). (Decimal number in the range 0-255.) See Nature of Address Enumeration Values on page 5-72.
Dialed Number NOA Field

Dialed Number Nature of Address (NOA). (Decimal number in the range 0-255.) See Nature of Address Enumeration Values on page 5-72.
Ingress Codec Type Field

Ingress Codec Type. (Five character string.) See Codec Type Descriptions on page 5-81.
Egress Codec Type Field

Egress Codec Type. (Five character string.) See Codec Type Descriptions on page 5-81.
RTP Packetization Time Field

RTP Packetization Time. (Decimal value indicating the duration of RTP packets in milliseconds.) If the call is PSTN to PSTN, this field will be empty ().
GSX Call ID Field

GSX Call ID. This field, assigned by the GSX, uniquely identifies a call within a single GSX and hence is equivalent to the GSXs internally assigned Global Call ID (GCID). This value is unique for this call within a GSX, but will vary from GSX to GSX. Use the Gateway to Gateway Handle to uniquely identify a call across multiple GSXs. (32 bit hexadecimal value, prefixed by 0x, such as 0x89ABCDEF.)
Terminated with Script Field

Terminated With Script. Indicates whether a script was executed before the call was terminated as follows:
0 - the call was terminated without executing a script. 1 - the PSX returned a script which was executed by the GSX before terminating the call; the call was not routed.
(Decimal number in the range 0-1.)
5-42
Originator Echo Cancellation Field

Original Echo Cancellation. This field indicates whether or not the GSX performed echo cancellation on the ingress leg of this call as follows:
0 - GSX did not perform echo cancellation on ingress leg of call 1 - GSX performed echo cancellation on ingress leg of call
This applies only to PSTN to IP and PSTN to PSTN calls. If the call is IP to PSTN, this field will be empty ().
Terminator Echo Cancellation Field

Terminator Echo Cancellation. This field indicates whether or not the GSX performed echo cancellation on the egress leg of this call as follows:
0 - GSX did not perform echo cancellation on egress leg of call 1 - GSX performed echo cancellation on egress leg of call
This applies only to IP to PSTN and PSTN to PSTN calls. If the call is PSTN to IP, this field will be empty ().
Charge Flag Field

The Charge Indicator values provisioned on the PSX. These apply to the Ingress Trunk Group. These values are shown in Table 5 -8 below.
TABLE 5 -8.
Charge Flag Enumeration Values

0 1 2 3 4
NONE NO CHARGE CHARGE SPARE NO INDICATION
AMA Service Logic Identification Field

AMA Service Logic Identification (AMAslpID). This field is used in an Advanced Intelligent Network (AIN) environment to record the identification of the service logic in the Service Control Point (SCP) that was used. (Fixed nine digit decimal number, with any leading zeroes present.) Table 5 -9 (below) describes the AMAslpID values. The PSX provides this data in Binary Coded Decimal (BCD) format, and the GSX software converts these strings to the fixed 9 character fields described below. If the BCD string contains more than 9 digits, the converted string is truncated. The terminating sign nibble in the BCD string (typically 0xC) is not present in the AMAslpID field. If this data is unavailable, this field will be empty (). See GR-1100-CORE, Section 2 for more detail about this native data.
5-43
TABLE 5 -9.
AMAslpID Values
Local Exchange Carrier (LEC)-assignable Advanced Intelligent Network (AIN) default routing invoked Toll-free service : Carrier Identification Code (CIC) not equal to 0110 Toll-free service: CIC equal to 0110 Switch generated AMAslipID: Default AIN Structure (220) with Resource Timing (Module 290) Service Control Point (SCP) Default Service Logic value for Toll-Free Unknown
000000000 - 899999999 900000000 900000141 900000142 90000050 900000866 999999999
AMA BAF Module Field

The Billing Automatic Message Accounting Format (AMA BAF) Module. This Module is used to record a variety of billing information. The first three characters represent the Module Code Identification that, in turn, specifies how to interpret the remaining characters. See Table 5 -10, BAF Module Number/Module Name for these codes. The remaining characters are defined in Section 1.4, Data Fields of the Telcordia Technologies Generic Requirements (GR-1100-CORE) Issue 4. Refer to that document for all definitions. A string of 4-256 hexadecimal characters. If the BAF Module is unavailable, this field is empty (). Table 5 -10 below lists each valid BAF Module Number/Module Name as published in Telcordia Technologies Generic Requirements (GR-1100-CORE) Issue 4. The Telcordia document, rather than the table below, defines the valid BAF Modules.
TABLE 5 -10.
BAF Module Number/Module Name
Module Code 000
Module Name Final Module
019 020 021 022 023 024 025 026
Originating Billing/Services Information Carrier Access - Terminating Carrier Access - Originating Long Duration Connection Wide Area Telecommunications Service (WATS) Public Switched Digital Service (PSDS) Circuit Release Module Private Virtual Network (PVN )Module
5-44
TABLE 5 -10.
Module Code
Module Name
027 028 029 030 039 040 043 044 047 049 050 051 052 053 054 055 056 057 058 059 060 062 063 067 068 070 071 072 073 074 075 076 079 082
083
Business Customer ID Module Additional Digits Dialed Module Alternate Billing Number Module Translation Settable Service Logic Identification Module Digits Module Multi-Level Precedence and Preemption (NDGR) Interexchange Carrier Code (Vendor Specific) Network Facility Access Information Module Calling Name/Number Delivery Module Person Handling Module Call Completion Service Module Alternate Billing Module IC/INC Call Delivery Module IC/INC Information Module Listing Service Module Busy Line Verification (BLV) Service Module General Assistance Service Module Credit Recording Service Module Exchange Access Service Processing Time Module Charge Module Notify/Operator Assist Calling Card w/DDD (Vendor Specific) Intercept Module Automated Position (Vendor Specific) Called Directory Number (DN) Descriptor Integrated Services Digital Network (ISDN) Core Module Integrated Services Digital Network (ISDN) Core Module (Abbreviated) Daily Aggregate Service Event Module Terminating User Service Module Basic Business Group (BBG) Module Electronic Key Telephone Service (EKTS) Capabilities Module Call Pickup Module Early Cut-Through Module Common Channel Signaling (CCS) Aggregate Usage Module
Common Channel Signaling (CCS) Detailed Usage Module
084 085 086
Address Module Type of Aggregate Counts Module Network User Identification Service Module
5-45
TABLE 5 -10.
Module Code
Module Name
087 088 089 090 091 092 099 101 102 103 104 105 106 107 108 109 112 113 114 119 122 123 124 125 128 139 141 142
143
Directory Number Descriptor Overflow Counts Operator Recall (Vendor Specific) Resource Usage Module Frame Relay Count Module Basic Busintess Group (BBG-)I Calling Name/Number Delivery Daily Aggregate of ISDN Selective Call Rejection by Calling DN Digits Dialed Module Authorization Code Module Account Code/Customer Dialed Account Recording (CDAR) Module Trunk Identification Module Message Detail Recording (MDR) Facility/Trunk Identification Module Business Features Module Operator Services System (OSS) Signaling System 7 (SS7) (Vendor Specific) Screening List Daily Continuation Incoming MVS Connection with Default Charging and Default Dial-in Parameters Incoming MVS Connection with Default Charging and Per-Connection Dial-in Parameters Reservation Information Interconnection Information Country Direct Service (Vendor Specific) Record Matching Information (Vendor Specific) Release to Pivot (RTP) Redirect Interconnection Timing Module Asynchronous Transfer Mode (ATM) End System Addresses (AESA) Rate Period Cell Counts (Vendor Specific) One ATM Traffic Parameter (NDGR) Two ATM Traffic Parameters (NDGR)
ATM Address Format
144 145 146 147 148 150 151
ATM Rate Period Cell Counts Carrier Identifier Internetwork ATM Switched Services (Vendor Specific) Three ATM Traffic Parameters Connection Type and Identification (Vendor Specific) E.164 Call Completion Service Module
5-46
TABLE 5 -10.
Module Code
Module Name
156 158 160 161 162 164 178 179 180 181 182 183 184 185 186 187 195 196 197 198 201 202 203 204 205 207 210 219 227 229
230
E.164 Busy Line Verification Service Module E.164 Credit Recording Service Module Call Redirection or Call Deflection Indication Module Release To Pivot (RTP) Basic Services Module Release To Pivot (RTP) Alternate Billing Services Module E.164/X.121 Number Module Integrated Services Digital Network (ISDN) Access Service Module Integrated Customer Advanced Networking (ICAN) Number/ Name Delivery Integrated Services Digital Network (ISDN) Channel Identifier Module Incoming Trunk Identification Module Common Channel Signaling (CCS) Parameter Aggregate Usage Module Common Channel Signaling (CCS) Parameter Detailed Usage Module Service Node ID (Vendor Specific) Service ID (Vendor Specific) Service Node Formatted - Small (Vendor Specific) Service Node Formatted - Large (Vendor Specific) Flexible Length Module - Repetitive Fields (NDGR) Flexible Length Module - Encapsulated Modules (NDGR) Flexible Length Module - Flexible Length Field (NDGR) Flex Module (NDGR) Advanced Intelligent Network (AIN) Service Control Point (SCP) Network Services Aggregate Module Advanced Intelligent Network (AIN) Service Control Point (SCP) Aggregate Module Service Provider Identifier Indicator Module Billing Attributes (Vendor Specific) Line Number Module (2) Originating Line Number Screening (OLNS) Information Module (Vendor Specific) Additional Originating Billing/Services Information Business Customer ID Module (2) Alternate Billing Number Module (2)
Translation-Settable Module (2)
239 240 241 242
Service Logic Identification Module (2) Digits Module (2) Alternate (ALT) Timing Call Setup Timing
5-47
TABLE 5 -10.
Module Code
Module Name
243 270 290 300 301 302 305 306 307 320 321 338 344 400 498 499 501 505 506 507 611 612 613 616 617 621 718 719
720
Generic Timing Indicator Module (Vendor Specific) Message/Outcall Attributes Module Resource Timing Module Customer Account Services Module (Vendor Specific) Subaccount Billing Module (Vendor Specific) Operator - ID Module (Vendor Specific) Account/Authorization Code (Vendor Specific) Originating Line Information Parameter (OLIP) (Vendor Specific) Line Number Module Improved Third Number Acceptance (ITNA) (Vendor Specific) Listing Services Call Completion (Vendor Specific) Service Provider Information Module Code Division Multiple Access (CDMA) Circuit Mode Data (Vendor Specific) Advanced Intelligent Network (AIN) Trigger Identification Module Additional LIDB Aggregate Service Count Module LIDB Aggregate Service Count Module LIDB Query Aggregate Response Module Selective Call Management Basic Business Group - Calling Identity Information Redirecting Information Identification Generic Module: One Digits String Format Generic Module: Two Digits String Format Generic Module: Three Digits String Format 5 Digit Information Module (Vendor Specific) Generic Module with Elapsed Time Digit (Information) Flexible Module (Vendor Specific) LNP Location Module Local Number Portability Core Module
Local Number Portability (LNP) Module (NDGR)
AMA Set Hex AB Indication Field

AMA Set Hex AB Indicator:
1 - AMA BAF Module contains a known or suspected error. 0 - AMA BAF Module contains no known errors. - (empty) AMA BAF Module is not present.
5-48
Service Feature ID Field

Service Feature ID. This field is a BAF parameter that indicates a customers originating or terminating line characteristics. This ID, if available, is provided as a fixed 3 digit decimal number. If no data is available, this field is left empty (). The Service Feature ID is a BAF parameter that indicates a customers originating or terminating line characteristics. This indication may be used by an accounting application to assess applicable tariffs to determine the price for services rendered. The PSX provides this data as a three ASCII character string of decimal digits. The GSX passes this data to the accounting record unchanged. The terminating sign nibble (typically hexadecimal C) is not propagated to the accounting record. The table below lists every valid Service Feature ID.
Service Feature Codes

Value 000 001 002 003 004 005 006 008 009 010 011 012 014 015 016 017 018 019 020 021 022 023 025 026 027 031 Description None of the following values apply Local Exchange Carrier (LEC)-owned standard interface public line Hotel/motel, no tax PICTUREPHONE (3 ESS) (Vendor Specific) Postpay coin (Vendor Specific) Chargeable quotation Centrex attendant Inward Wide Area Telecommunications Service (INWATS) Common Channel Interoffice Signaling (CCIS) INWATS Intrastate (Vendor Specific) Three-Way Calling Hotel/motel with tax Call Forwarding Call Forwarding Busy Line or Call Forwarding Dont Answer Public Switched Digital Service with Toll-Free Service Private Switching Digital Capability (PSDC) Call Forwarding (Term.leg) (Vendor Specific) Remote Call Forwarding Usage-Sensitive Three-Way Calling Message Detailed Recording/Revenue Accounting Office (RAO) (Message Detail Recording [MDR] via RAO) (Vendor Specific) Voice Storage System (VSS) AC Call Switched and Billed (Vendor Specific) VSS AC Call Billed, Not Switched (Vendor Specific) VSS AC Call Switched Not Billed (Vendor Specific) Cellular Mobile Carrier - Type-2A Feature Verification (Vendor Specific) Private Virtual Network - Remote access indicator Advanced Intelligent Network (AIN) - Default Wakeup Call Activation
5-49

Value 048 049 050 055 056 057 058 059 060 061 083 084 089 154 202 203 204 301 400 401 402 406 407 420 423 424 427 429 430 431 432 434 440 441 442 443 444 445 446 447 Description Audible Voice Identity Delivery Usage-Sensitive Call Forwarding Usage Sensitive Call Waiting (Vendor Specific) Call Forwarding - Immediate + Busy/Dont Answer/No Page Response (Vendor Specific) Call Waiting (Vendor Specific) Private Facility Pooling (PFP) (Vendor Specific) Direct Distance Dialing (DDD) Centrex Data Facility Pooling (Vendor Specific) City Wide Centrex (CWC) (Vendor Specific) Mobile (Vendor Specific) Marine (Vendor Specific) Call Delivery to Call Waiting (Vendor Specific) Direct International Originating Call (Vendor Specific) Feature Activation/Deactivation via CN (Vendor Specific) Last Call Return + 3 Way Calling LEC-owned alternate interface public line Independent Payphone Provider (IPP)-owned standard interface public line IPP-owned alternate interface public line Last Call Return (Vendor Specific) Plain Old Telephone Service (POTS) Multi-party Line (more than 2) Automatic Number Identification (ANI) Failure Station Level Rating Restricted line - smart payphone or hotel/hospital Automatic Identified Outward Dialing (AIOD) Coin or Non-Coin - on calls using database access 800 Service Call "Dumb" payphone Prison/Inmate payphone Intercept (empty) Intercept (trouble) Intercept (regular) Telco Operator Handled Call Unrestricted Use - locally determined by carrier Unrestricted Use - locally determined by carrier Unrestricted Use - locally determined by carrier Unrestricted Use - locally determined by carrier Unrestricted Use - locally determined by carrier Unrestricted Use - locally determined by carrier Unrestricted Use - locally determined by carrier Unrestricted Use - locally determined by carrier
5-50

Value 448 449 452 460 Description Unrestricted Use - locally determined by carrier Unrestricted Use - locally determined by carrier Outward Wide Area telecommunications Service (OUTWATS) Telecommunications Relay Service (TRS) - ANI II digit pair 60 (indicates that the associated call is a TRS call delivered to a transport carrier from a TRS Provider and that the call originated from an unrestricted e) Cellular/Wireless Personal Cellular Service (PCS) (Type 1) Cellular/Wireless PCS (Type 2) Cellular/Wireless PCS (Roaming) TRS - ANI II digit pair 66 indicates that the associated call is a TRS call delivered to a transport carrier from a TRS Provider, and that the call originates from a hotel/motel. TRS - ANI II digit pair 67 indicates that the associated call is a TRS call delivered to a transport carrier from a TRS Provider and that the call originated from a restricted line. "Smart" payphone Access for private virtual network types of service: the ANI code "93" indicates, to the IC, that the originating call is a private virtual network type of service call. Directory Assistance (DA) Call Completion Other (Vendor Specific) DA Call Completion Prepay Coin (Vendor Specific) DA Call Completion Hotel/Motel without Tax (Vendor Specific) DA Call Completion Postpay Coin (Vendor Specific) DA Call Completion Chargeable Quotation (Vendor Specific) DA Call Completion Hotel/Motel with Tax (Vendor Specific) Intercept Other (Vendor Specific) LEC-assignable DA Other (Vendor Specific) DA Prepay Coin (Vendor Specific) DA Hotel/Motel without Tax (Vendor Specific) DA Postpay Coin (Vendor Specific) DA Hotel/Motel with Tax (Vendor Specific)
461 462 463 466
467
470 493 700 701 702 704 705 711 800 800-999 900 901 902 904 911
FE Parameter Field
FE Parameter. This is an optional parameter in backwards call control messages (ACM, CPG, ANM, and Gateway-to-Gateway signaling). If the egress GSX is the terminating switch, then the GSX will generate this parameter. Otherwise, the downstream legacy switch generates this parameter and the GSX logs and forwards it to the accounting record. If the FE Parameter is not present, this field will be left empty (). This record is generated in one of two formats:
Short Form, using 16 hexadecimal characters to represent 8 bytes of binary data. Long Form, using 20 hexadecimal characters to represent 10 bytes of binary data.
5-51
The Parameter Length field of the record designates whether the record is the Short Form or the Long Form. Each of these forms is depicted below: / FE Parameter Format (Short Form)
Bits --> Byte 1 Byte 2 Byte 3 Byte 4 Byte 5 Byte 6 Spare (always 0) Completion Code Spare (always 0000) 8 7 6 5 4 3 2 1 Parameter Code (always 0xFE) Parameter Length (always 0x06) Answer Type Final Trunk Group ID (Most Significant Bits) Final Switch ID Final Trunk Group ID (Least Significant Bits)
Byte 7 Byte 8
Final Trunk Member(Least Significant Bits) Final Trunk Member (Most Significant Bits)
FE Parameter Format (Long Form)

Bits --> Byte 1 Byte 2 Byte 3 Byte 4 Byte 5 Byte 6 Spare (always 0) Completion Code Spare (always 0000) 8 7 6 5 4 3 2 1 Parameter Code (always 0xFE) Parameter Length (always 0x08) Answer Type Final Trunk Group ID (Most Significant Bits) Spare (always 0000000) Final Trunk Group ID (Least Significant Bits)
Byte 7 Byte 8 Byte 9 Byte 10
Final Trunk Member(Least Significant Bits) Final Trunk Member (Most Significant Bits) Final Switch ID (Least Significant Bits) Spare (always 000000) Final Switch ID (Most Significant Bits)
The Answer Type and Completion Code (manner by which the call was terminated) are 4 bit values as depicted in the table below:
Answer Type & Completion Code Values

Value 0000 0001 0010 Answer Type Nil Value (Caller abandon during origination) Software Answer, no voice detected Software Answer, voice detected Completion Code Normal Completed Call Treated Call Abandoned Call
5-52
Answer Type & Completion Code Values

Value 0011 0100 0101 0110 0111 Answer Type Software Answer, audio ringback detected Hardware Answer Software Answer, silence detected Software Answer, persistent ringing Audio Tone Detector (ATD) hardware error or forced disconnect and continuous tone at remote switch Software Answer, busy tone detected Software Answer, reorder tone detected IMT software answer IMT hardware answer Early Billing Active with no Answer Early Billing Active with Answer Not Used Not Used Completion Code Abnormal Call Signaling System Error Forced Disconnect Invoked (brought down via manual intervention) Offnet Route Advance Invoked Test Call
1000 1001 1010 1011 1100 1101 1110 1111
Reserved TCAP SCP Response Time Out Not Used Not Used Abnormal Release Call Completed Answer Not Used Class of Service Screening Failure
Example
The FE Parameter record below: 0xFE0812BC0A006745DF03 is generated by the following FE Parameter subfield values: Format = Long Form Completion Code = Treated Call (1) Answer Type = Software Answer, voice detected (2) Final Trunk Group ID = 0xABC Final Switch ID = 0x3DF Final Trunk Member = 0x4567
Satellite Indicator Field

Satellite Indicator (SAT):
1 - A satellite trunk was used. 0 - No satellite trunk was used, or a non-ISUP signaling variant such as ISDN or CAS was used.
This value is extracted from the Forward Call Indicator.
5-53
PSX Billing Information Field
Header Portion
Common Portion
128 bytes
Route Specific Tag Portion
Route Specific Data Portion
FIGURE 5-3
PSX Billing Info Parameter
5-54
Figure 5-3, PSX Billing Info Parameter, above, displays a high level view of the PSX Billing Information field within an accounting record. This field contains billing data that is generated by the PSX. The data is encoded in bytes, which are represented as hexadecimal characters (00 to FF). This variable length field may contain up to 128 bytes of binary data, which would be represented by 256 hexadecimal characters. Every subfield in the PSX Billing Info field is provisioned on the PSX and is placed into the GSX accounting record as a result of that provisioning. Therefore the exact nature of this field depends on PSX provisioning. The example representations at the end of this section must be viewed with that in mind. These results reflect particular PSX provisioning of the PSX Billing Info entity. You should not expect similar results in your records unless you provision each PSX Billing Info subfield accordingly. The PSX Billing Info field is divided into four portions:
1. 2. 3. 4.
Header Common Route Specific Tag Route Specific Data
Each portion is a series of one or more subfields. The Billing File Info Header contains a unique 16 bit value. The Common and Route Specific Tag portions are comprised of subfields that consist of a unique Tag, a Tag Data Length Indicator, and Data for that Tag (or value). In any of these subfields, the one byte Tag Data Length Indicator could be zero, resulting in a zero length value. The Route Specific Data portion is comprised of subfields of Tag Data Length Indicator and Data for that Tag (or value), for each Tag, for each route. In this portion, the Tags themselves were defined in the Route Specific Tag portion and hence are not present in the subfields. This subfield detail is depicted below:
Billing File Header Portion

Byte 1 Byte 2 Billing Info Variant
Common Portion - Subfield 1

Byte 1 Byte 2 Tag Byte 3 Length Byte 4 Tag Data ..... Byte n
Common Portion - Subfield 2

. .
5-55
Common Portion - Subfield n

Route Specific Tag Portion

Route Specific Data Portion - Route 1

Byte 1 Length 1 Byte 2 Data 1 Byte 3 Byte 4 ..... Byte n

. .

Byte 1 Length n Byte 2 Data n Byte 3 Byte 4 ..... Byte n


. .

5-56
. .
Route Specific Data Portion - Route n


. .

Billing Info Variant

This field contains a two byte Billing Information Variant. This subfield is provisioned on the PSX. This field is always occupied by four hexadecimal characters representing two bytes of binary data. A user provisioned Billing Information Variant of 0000 is depicted below: Billing Info Variant
Byte 1 00 Byte 2 00
Tag, Length, and Tag Data

Table 5 -11 lists the Tags, Tag Data lengths, and Tag Data descriptions that apply to the Billing Information Variants. In this table, the Max Length is the value provisioned in the PSX Billing Info entity. The Max Length value is always less than or equal to the Max Length Limit value, which is hard coded into the entity. As mentioned previously, every Tag/Length/Value subfield as well as every Route Specific Length/Value must be provisioned in the Billing Info entity on the PSX in order to be present in any accounting record. Furthermore, the Billing Info Profile ID that is provisioned on the PSX must be associated with the (ingress) trunk group entity, also on the PSX. See the PSX Policy Server Provisioning Guide, and the PSX Policy Server PSX GUI Reference for these procedures.
5-57
TABLE 5 -11.
Tags for Billing Information Variant 0001

Common or Route Specific Common Max. Length (Bytes) 1 Max. Length Limit (Bytes) 1
Tag (Hex) 0001
Name Carrier ID Origin
Data Type Hex
Description ENUM in range 0x00-0xFF 01 - Received CIC within the CIP 02 - Default CIC from the ingress trunk group 03 - CIC received from the SCP 04 - Received CIC within the TNS 05 - 1010 CIC received within the Called Party Number 06 - 950 Access 07 - 900 NXX translated to Carrier
0002
SCP PIN Digits
Common
BCD
As provisioned 1 As provisioned As provisioned As provisioned 1 As provisioned As provisioned
Each byte stores 2 digits where the LSB/MSB placement is consistent with the GSX binary format. Last value returned from SCP (0x00-0xFF) Each byte stores 2 digits where the LSB/MSB placement is consistent with the GSX binary format. Each byte stores 2 digits where the LSB/MSB placement is consistent with the GSX binary format. Each byte stores 2 digits where the LSB/MSB placement is consistent with the GSX binary format. Stores 2 nibbles Last value returned from SCP (0x00000000-0xFFFFFFFF) Country code associated with the calling party (typically 3 digits). Each byte stores 2 digits. Populated from the ingress signal if available, otherwise from the ingress trunk group provisioned on the PSX. Country code associated with the called party (typically 3 digits). Each byte stores 2 digits. Populated from the ingress signal if available, otherwise from the ingress trunk group provisioned on the PSX, assuming the call is a national call.
0003 0004
SCP Treatment Index Ingress Trunk Group Number Ingress Switch ID SCP Returned Supplementary Digits SCP Call Information SCP Bill Information Calling Country Code
Common Common
Hex Integer
1 4
0005
Common
Integer
0006
Common
BCD
0007 0008 0009
Common Common Common
Hex Integer BCD
1 4 2
000A
Called Country Code
Common
BCD
As provisioned
5-58
TABLE 5 -11.

Common or Route Specific Common Max. Length (Bytes) As provisioned Max. Length Limit (Bytes) 8
Tag (Hex) 000B
Name Calling Location Routing Number (LRN)
Data Type BCD
Description Location Routing Number of the calling party. Each byte stores 2 digits. If a number is ported to a GSX, then the new GSX will have the LRN associated with it. If the calling number is ported in, then the first LRN associated with the GSX is present in this field.
000C
Normalized Called Number
Common
BCD
As provisioned
The PSX will normalize the called number if required. (This is typically a 10 digit number in North America). Each byte stores 2 digits. This value uniquely identifies the subscriber.
000D
Normalized Calling Number
Common
BCD
As provisioned
The PSX will normalize the calling number if required. (This is typically a 10 digit number in North America). Each byte stores 2 digits. This value uniquely identifies the subscriber.
000E
SCP Dip Indicator
Common
Binary
If the PSX did an SCP query, this fact is indicated in this field. A bit is allocated for each TDP request message that is supported as of PSX Release 4.01. When the PSX sends the SCP query, the corresponding bit is set in this field as follows: Bit 7 - unused Bit 6 - unused Bit 5 - unused Bit 4 - unused Bit 3 - CNAM Bit 2 - Information Collected Bit 1 - Information Analyzed Bit 0 - TR-533
5-59
TABLE 5 -11.

Common or Route Specific Common Max. Length (Bytes) 1 Max. Length Limit (Bytes) 1
Tag (Hex) 000F
Name Ported Type M bit Indicator
Data Type Integer
Description The M bit in the ISUP IAM message, ForwardCallIndicator parameter, indicates whether the LNP query was performed for the ported number. The valid values returned in this one byte integer are: 0 - M bit was not set. 1 - A previous switch performed the LNP query to the SCP. 2 - The PSX performed the LNP query to the SCP.
0010
Scratch Pad
Common
ASCII
As provisioned As provisioned As provisioned
16
Populated with the contents of the corresponding field of the PSX Billing Info entity. Populated with the contents of the number returned by the SCP in response to the translation request. Location Routing Number of the called party. Each byte stores 2 digits. If a number is ported to a GSX, then the new GSX will have the LRN associated with it. If the calling number is ported in to a GSX using an LNP query, the PSX determines the LRN of this number and routes the call to the new GSX. The LRN associated with this new GSX is present in this field. Populated from the ingress signal if available. If not, if the PSX did an LNP query to the SCP and the response had LRN, then this (LRN) is the value that is present.
0013
SCP Translated Number Called LRN
Common
BCD
03E9
Common
BCD
0FA0
Meta Tag
Route Specific
Integer
As provisioned
As provisioned
Contains one or more of the route specific tags listed below.
5-60
TABLE 5 -11.

Common or Route Specific Route Specific Max. Length (Bytes) 1 Max. Length Limit (Bytes) 1
Tag (Hex) 0FA1
Name Egress Trunk Group Charge Indicator
Data Type Integer
Description The charging information for the egress trunk group: 0 - No charge indication present for the egress trunk group. 1 - Dont charge for the egress trunk group. 2 - Charge for the egress trunk group.
0FA2
Egress Trunk Group Number
Route Specific
Hex
The egress trunk group number provisioned in the trunk group profile entity on the PSX. This number is typically used in signaling to indicate the trunk group selected for the call. Using the maximum length of 4 bytes, this value can range from 0x00 to 0xFFFFFFFF.
When the length of the data that contains integer or hex digits is an odd number, the most significant byte will have a leading 0. When the length of the data that contains BCD digits is an odd number, the most significant byte will have a leading F. The SCP may return certain values more than once. If this is the case, then the corresponding subfield will be populated in the PSX Billing Info field once per SCP reply. Data from each reply is appended to the end of the Common Portion field, so the first occurrence of a subfield corresponds with the first SCP reply, the next occurrence with the second reply, and so on. The following SCP subfields may be populated more than once in the PSX Billing Info field:
0002 SCP Pin Digits 0006 SCP returned Supp Dig 0007 SCP Call Info 0008 SCP Bill
Example 1
The following PSX Billing Info field: 00000005000001010603E903F60389000901F1000B03F978580004 022345000A01F1000D03F97869000E0100000F010000100A4D696C6 96E6473204269000C03F60346001304F46089800FA0040FA10FA201 00010F01000109010001090100010901000109 Should be interpreted as:
5-61
Tag 0000
Length
Value
Description Variant
HEADER PORTION COMMON PORTION 0005 0001 00 01 06
Ingress Switch ID (no value provisioned) Carrier ID Origin (6=950 Access) Called LRN (60389) Calling Country Code (1) Calling LRN (97858) Ingress TG Number (2345) Called Country Code (1) Normalized Calling Number (97869) SCP Dip Indicator (0=No Dip) Ported M bit Indicator (0=No M bit set) Scratch Pad Normalized Called Number (60346) The seven digit Translated Number returned by the SCP (4608980) Meta Tag (Eg Charge Ind, Eg TG Number) Route 1 Egress Charge Indicator (0) Route 1 Egress Trunk Group Number (15) Route 2 Egress Charge Indicator (0) Route 2 Egress Trunk Group Number (9) Route 3 Egress Charge Indicator (0) Route 3 Egress Trunk Group Number (9) Route 4 Egress Charge Indicator (0)
03E9 0009 000B 0004 000A 000D 000E 000F

0010
03 01 03 02 01 03 01 01
0A
F60389 F1 F97858 2345 F1 F97869 00 00 4D696C696E6473204269 F60346

F4608980
000C 0013
03 04
ROUTE SPECIFIC TAG PORTION 0FA0 04 0FA1 0FA2
ROUTE SPECIFIC DATA PORTION

01 01 01 01 01 01 01 00 0F 00 09 00 09 00
5-62
Tag
Length 09 00 09
Value 09 00 09
Description
Route 4 Egress Trunk Group Number (9) Route 5 Egress Charge Indicator (0) Route 5 Egress Trunk Group Number (9)
Example 2
The PSX Billing Information record below: 000100010101000203F12345000301200004030223450005019900060298760007010 00008045678EF9A03E905978555121200070122 Should be interpreted as:
Tag 0001
Length
Value
Description Variant
HEADER PORTION COMMON PORTION 0001 0002 0003 01 03 01 01 F12345 20
Carrier ID Origin (01)

SCP PIN Digits (12345) SCP Treatment Index (20)
0004
0005 0006 0007 0008
03
01 02 01 04
022345
99 9876 00 5678EF9A
Ingress TG Number (22345) Ingress Switch ID (99)

SCP Returned Supplementary Digits (9876) SCP Call Information (First SCP Reply - 00) SCP Billing Information (5678EF9A)
03E9
0007
05
01
9785551212
22
Called LRN (9785551212)

SCP Call Information (Second SCP Reply - 22)
Originating TDM Trunk Group Type Field

Originating TDM Trunk Group Type. The customer specific defined trunk group types are listed in TDM Trunk Group Type Enumeration Values on page 5-83. This field is supplied by the PSX, after customer specific provisioning. If this field is not provisioned on the PSX, it will be left empty ().
5-63
Terminating TDM Trunk Group Type Field

Terminating TDM Trunk Group Type. The customer specific defined trunk group types are listed in TDM Trunk Group Type Enumeration Values on page 5-83. This field is supplied by the PSX, after customer specific provisioning. If this field is not provisioned on the PSX, it will be left empty ().
Ingress Trunk Member Number Field

Ingress Trunk Member Number. The ingress trunk member number that was provisioned on the GSX circuit endpoint. This field takes the decimal values 0-65534. If this field was not provisioned, or was subsequently UNSET for this circuit, it will be left empty ().
Egress Trunk Group ID Field

Egress Trunk Group ID. The egress trunk group ID on the egress GSX. The content of this field will differ from the corresponding field in the FE Parameter record whenever the final switch is not the same as the egress GSX. This field is supplied by the PSX, taking the decimal values 0 - 4095. If this field is not provisioned on the PSX, it will be left empty (). This field is supplied to the GSX by the PSX as a 13 character string terminated by a NULL character (). Therefore, future PSX releases may supply Trunk Group IDs outside the above specified range.
Egress Switch ID Field

Egress Switch ID. The egress switch ID on the egress GSX. The content of this field will differ from the corresponding field in the FE Parameter record whenever the final switch is not the same as the egress GSX. This field is supplied by the PSX, taking the decimal values 0 - 1023. If this field is not provisioned on the PSX, it will be left empty (). This field is supplied to the GSX by the PSX as a 9 character string terminated by a NULL character (). Therefore, future PSX releases may supply Trunk Group IDs outside the above specified range.
Active Call Ingress Local ATM Address Field

ATM address of the local physical port attached to the ATM network on the ingress leg of the call. Because this field is not currently supported, it will always be empty ().
5-64
Active Call Ingress Remote ATM Address Field

ATM address of the remote physical port attached to the ATM network on the ingress leg of the call. Because this field is not currently supported, it will always be empty ().
Active Call Egress Local ATM Address Field

ATM address of the local physical port attached to the ATM network on the egress leg of the call. Because this field is not currently supported, it will always be empty ().
Active Call Egress Remote ATM Address Field

ATM address of the remote physical port attached to the ATM network on the egress leg of the call. Because this field is not currently supported, it will always be empty ().
Policy Response Call Type Field

The PSX call type, based on the results of the digit analyses performed by the PSX, which is then used as part of the route selection process. The call type enumeration permits 31 predefined (Sonus) values [0-30] and 31 user defined values [1001-1031] as shown in Table 5 -12below:
TABLE 5 -12.
Policy Response Call Type Enumeration Values 0

1 2 3 4 5 6 7 8 9 10 11 12 13
Unknown No Digits Lec Operator Subscriber Operator National Operator Subscriber National Vertical Service Code Emergency Directory Assistance Ein Free Premium Ixc Operator
5-65
TABLE 5 -12.
Policy Response Call Type Enumeration Values

14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29-30 31 10011031
International International Operator Service Access Code Carrier Code Carrier Code 2 Private Premium Internet Offload Standard Internet Offload Economy Internet Offload Anonymous IP VPN Test Internet Reception Service Transit Other Carrier Chosen Reserved for Sonus Reserved Reserved for Users
Outgoing Route Identification Field

The outgoing trunk group number for calls that overflow from one gateway to another via a Singapore Inter-Gateway Circuit (IGC) trunk. The GSX extracts this value from the optional Outgoing Route Identification (ORI) parameter in the ISUP Address Complete Message (ACM). This is a decimal value in the range 0-65535. If the GSX is not deployed in a Singapore network, this field will be left empty ().
Outgoing Message Identification Field

The type of route that was selected from a GSX deployed in a Singapore network. The GSX will extract this value from the optional Outgoing Route Identification (ORI) parameter in the ISUP Address Complete Message (ACM) . These route types are shown in Table 5 -13 below.
5-66
TABLE 5 -13.
Outgoing Message Identification Enumeration Values 0

1 2 3
National Route Transit Route Terminating Route Spare
If the ORI is not present, the GSX will generate and populate the Outgoing Message Identification according to the Network Indicator as follows:
If the Network Indicator is set to 2 (National 1), then the Outgoing Message Identification is set to 0 (National Route). If the Network Indicator is set to 0 (International) and the GSX is a transit exchange, then the Outgoing Message Identification is set to 1 (Transit Route). If the Network Indicator is set to 0 (International) and the GSX is not a transit exchange, then the Outgoing Message Identification is set to 2 (Terminating Route).
If the GSX is not deployed in a Singapore network, this field will be left empty ().
Incoming Route Identification Field

The incoming trunk group number on a GSX deployed in a Singapore network. The GSX will extract this value from the optional Incoming Route Identification (IRI) parameter in the ISUP Initial Address Message (IAM) . If the IRI is not present or if the GSX is not deployed in a Singapore network, this field will be left empty ().
Calling Name Field

The calling partys name in text. The ANSI SS7 specification defines this field as up to 15 characters of name information coded in IA5 format. The GSX passes this 15 character string to the PSX in the Policy Request message. The PSX returns a Calling Name in the Policy Response that is either the same or a new Calling Name. New Calling Names provided by the PSX may be up to 24 characters. Hence the maximum length of this string is 26 characters (24 character string plus the delimiting double quotes ). The following transformations may be applied to this string:
Non-printable IA5 characters (1..31 and 127) are displayed as white space (blanks). Commas are displayed as is (because the delimiters are the double quotes). Double quotes are displayed as single quotes.
Examples of these transformations are shown in the table below:
5-67
Calling Name in Policy Response Doe, John<NULL> Jake the snake<NULL> Smith<CR>Mary<CR><NULL> <NULL>
Calling Name in CDR
,Doe, John,
,Jake the snake, ,Smith Mary , ,,
If the Calling Name is unknown, or not provided, then the field is left blank without displaying the double quotes, as depicted in the last example above.
Calling Name Type Field

The Calling Name Type delivered in the PSX Policy Response. These Calling Name Types are shown in Table 5 -14 below.
TABLE 5 -14.
Calling Name Type Enumeration Values 0

1 2 3 4 5
Invalid Spare Calling Name Original Calling Name Redirect Name Connected Name
If Calling Name data is not available, this field will be left empty ().
Incoming Calling Party Numbering Plan

This field represents the Calling Party Numbering Plan received in the incoming setup message. For ISUP calls this value is contained in the optional Calling Party Number parameter in the Initial Address Message (IAM). For SIP calls, this value is contained in the FROM, TO, REQUEST URI, CONTACT and DIVERSION headers. The value logged to the CDR does not comply to the standard ISUP enumeration. This decimal value in the range 0-15 must be interpreted according to Table 5 -15, below.
5-68
TABLE 5 -15.
Numbering Plan Enumerations

ISUP Value (binary) N/A
CPC/CDR Value (decimal)
Numbering Plan Indicates that this data is: unavailable unknown an invalid numbering plan (the received ISUP value was greater than 7).
1 2 3 4 8 10 14 15
001 011 100 101 000 010 110 111
ISDN numbering plan (Rec. E.164, E.163) Reserved ITU-TS Data Numbering Plan Reserved ITU-TS Telex Numbering Plan Private numbering plan Unknown numbering plan Spare 2 Spare 6 Spare 7
Outgoing Calling Party Numbering Plan

The GSX sends the Incoming Calling Party Numbering Plan to the PSX in the Policy Request message. As part of the routing process the PSX may manipulate the Calling Party Numbering Plan. This possibly modified value is then sent back to the GSX where it is used in outgoing signaling messages. This value is logged as the Outgoing Calling Party Numbering Plan. The value logged to the CDR does not comply to the standard ISUP enumeration. This decimal value in the range 0-15 must be interpreted according to Table 5 -15, above. Note If the PSX does not manipulate this field, then the Incoming and Outgoing Calling Party Numbering Plans will be the same.
Calling Party Business Group ID

START-91, STOP-110, ATTEMPT-101, INTERMEDIATE-91 This value represents the Business Group ID of the calling party. The GSX receives this value in the SIP INCOMING INVITE message. This decimal value is in the range 0 to 4294967295. If this data is not present or unknown, then a one 1 (Public Business Group) will be logged. In release 4.1, SIP is the only protocol which supports Business Group IDs. For all other protocols (ISUP, H323, etc.) this field will be logged as 1.
5-69
Called Party Business Group ID

This value represents the Business Group ID of the called party. The GSX receives this value in the SIP INCOMING INVITE message. This value is then sent to the PSX in the Policy Request message. As part of the routing process the PSX may modify this value and return it in the Policy Response. The GSX logs the value supplied by the PSX, not the value received in the SIP INCOMING INVITE message. This decimal value is in the range 0 to 4294967295. If this data is not present or unknown, then a one 1 (Public Business Group) will be logged. In release 4.1, SIP is the only protocol which supports Business Group IDs. For all other protocols (ISUP, H323, etc.) this field will be logged as 1.
Calling Party Public Presence Directory Number

The Calling Party Public Presence Directory Number (PPDN) is an optional SIP parameter which is propagated as the calling number when a call goes into the Public PSTN. If the SIP INCOMING INVITE messages Remote Party ID header contains id-context=ppdn, then the Remote Party ID will be interpreted and logged as the Calling PPDN. This string is up to 30 characters. If the id-context is not PPDN or if the ingress protocol is not SIP, then this field will be empty ().
Elapsed Time from Receipt of Setup Message to Last Call Routing Attempt
Carriers bill each other based on Carrier Elapsed Time (as opposed to Customer Elapsed Time). Carrier Elapsed time is defined as the Carrier Connect Time to call disconnect time. Telcordia GR-508-CORE defines Carrier Connect Time as: The time when first wink is received from a carrier for Feature Group D (FGD) calls. For Feature Group B (FGB) calls, carrier connect time is the time when carrier off-hook is detected. The closest the GSX can get to recording the actual carrier connect time is to capture when the IAM for the selected route was sent. The selected route is always the final route attempted. The GSX will capture and log the Time Elapsed from Receipt of Setup Message to Last Call Routing Attempt. This field contains that elapsed time in 10 millisecond ticks. If no routing attempts were made, then this field will be left empty ().
Billing Number NOA

The incoming ISUP IAM message may contain an optional Charge Number parameter. This parameter contains a nature of address (NOA) indicator for the charge number. The GSX logs this value. See Incoming ISUP Charge Number NOA Field on page 5-41. The GSX also sends this incoming value to the PSX in the Policy Request message. As part of the routing process the PSX may override this value with the Billing Number NOA provisioned for the ingress trunk group. The PSX returns this possibly modified
5-70
NOA to the GSX in the Policy Response message. See Table 5 -20, Nature of Address Parameter Values for Billing and Charge Numbers. The GSX uses this returned value in outgoing signaling messages and logs it to this field, the Billing Number NOA. This field takes a decimal value in the range 1 to 255. If Billing Number NOA is unknown, then this field will be left empty ().
Incoming Calling Number NOA

START-96 STOP-115 ATTEMPT-107 INTERMEDIATE-98 The incoming ISUP IAM message may contain an optional Calling Number parameter. This parameter contains a nature of address (NOA) indicator for the calling number. See Table 5 -18, Nature of Address Parameter Values for Calling Number. The GSX will log this NOA in this field. Note The outgoing calling number NOA is determined by the PSX and is logged in the Calling Party Nature of Address field. See Calling Party Nature of Address Field on page 5-32. This field takes a decimal value in the range 1 to 255. If an Incoming Calling Number NOA is not received, then this field will be left empty ().
Egress Trunk Member Number

The trunk member used by the egress trunk group for this call. This number uniquely identifies the channel used for this call. The Trunk Member object can only be configured for ISDN (see ISDN B-channel on page 3-351), ISUP (see ISUP Circuit on page 3-315), and CAS (see CAS Channel on page 3-467) service groups. This field takes a decimal value in the range 0 to 65535. If the Trunk Member for the egress trunk group is not configured, then this field will be left empty ().
Selected Route Type

This field identifies the destination gateways type, such as GSX Gateway, SIP Proxy Server, ASX Gateway, etc. See Table 5 -16, below, for a the definition of each valid type. See Route Selected Field on page 5-29 for additional destination gateway information that is logged. This field takes a decimal value in the range 0-6. For terminating records, this field will be left empty ().
TABLE 5 -16.
Selected Route Types

Route Type (Not Applicable - a terminating record) CPC_ROUTE_TYPE_UNKNOWN CPC_ROUTE_TYPE_GATEWAY CPC_ROUTE_TYPE_GATEWAY_LOCAL CPC_ROUTE_TYPE_SIPPROXY
CDR Value NULL 0 1 2 3
Second Stage Accounting Records
5-71
TABLE 5 -16.
Selected Route Types

Route Type CPC_ROUTE_TYPE_H323GATEKEEPER CPC_ROUTE_TYPE_H323GATEWAY CPC_ROUTE_TYPE_ASXGATEWAY
CDR Value 4 5 6
Second Stage Accounting Records

Calls that require an authorization code to be entered by the user result in two stage calls. For two stage calls, separate accounting records are generated for each stage of the call. Each call in the two stage call has a START + STOP accounting record pair. The Call Direction field defines which stage of the call is represented in the current record. The Call Group Identifier field identifies calls that are part of the same two stage call group. The GSX software will allow multiple second stage calls to be made. One example of this feature is a Calling Card application, where the calling party is allowed to make a call to a new called number after finishing the call to the first called number. Second stage accounting records of a 2-stage call are identified by the Call Direction Field. If the value of this field is TERM-TO-PSTN or TERM-TO-IP, then the underlying accounting record reflects the second stage of the call. The content of other specific fields of the record is influenced by the SECOND STAGE INHERIT FIRST parameter. This parameter qualifies the ACCOUNTING object. When the value of this parameter is true, the respective fields of the respective records shown below are unconditionally inherited from the corresponding fields of the first stage call records.
TABLE 5 -17.
Inherited Fields in Second Stage Accounting Records

I N T E R M E D I A T E 4 6 7 31 32 39 41
Field Name Start Time in System Ticks Start Date Start Time Ingress PSTN Trunk Name Ingress PSTN Circuit End Point Ingress Signaling Type Ingress Far End Switch Type
S T A R T 4 6 7 29 30 43 45
S T O P 4 6 7 34 35 53 55
A T T E M P T 4 6 7 31 32 46 48
5-72
Accounting Record Field Codes
TABLE 5 -17.
Inherited Fields in Second Stage Accounting Records

I N T E R M E D I A T E 43 N/A N/A 74 76 8
Field Name Carrier Code of the Carrier who Owns the Far End of the Ingress Trunk Group Ingress Codec Type Originator Echo Cancellation Originating Trunk Group Type Ingress Trunk Member Number Time Elapsed From Receipt of setup to Policy Server/Sonus SoftSwitch Response
S T A R T 47 N/A N/A 74 76 8
S T O P 57 79 83 93 95 8
A T T E M P T 50 69 74 84 86 8
Note
The Time Elapsed From Receipt of Setup to Policy Server/Sonus SoftSwitch Response field is the time elapsed from the receipt of setup to the initiation of the second stage call, in second stage call accounting records configured to INHERIT FIRST. Otherwise stated, this is the time spent prompting and collecting digits before initiating the second stage call.

The tables below describe important codes that occur in certain sub-fields of the accounting records.
Nature of Address Enumeration Values

The decimal value of the field is an enumeration of CPC_ADDR_NATURE_OF_ADDR_ENUM defined in cpcPub.h.
TABLE 5 -18.
Nature of Address Parameter Values for Calling Number

Value 0 1 2 3
Parameter Names
CPC_ADDR_NATURE_INVALID CPC_ADDR_NATURE_UNIQUE_SUBSCRIBER_NUMBER CPC_ADDR_NATURE_UNIQUE_NATIONAL_NUMBER CPC_ADDR_NATURE_UNIQUE_INTERNATIONAL_NUMBER
5-73
TABLE 5 -18.
Nature of Address Parameter Values for Calling Number

Value 4 5 6 7 8-20 21
Parameter Names
CPC_ADDR_NATURE_NON_UNIQUE_SUBSCRIBER_NUMBER CPC_ADDR_NATURE_NON_UNIQUE_NATIONAL_NUMBER CPC_ADDR_NATURE_NON_UNIQUE_INTERNATIONAL_NUMBER CPC_ADDR_NATURE_TEST_LINE_CODE Reserved CPC_ADDR_NATURE_HK_NATL_UNKNOWN

(Hong Kong National Unknown)
TABLE 5 -19.
Nature of Address Parameter Values for Called Number

Value 0 1 2 3 4 5 6 7 8 9 10 17 18 19 20
Parameter Names
CPC_ADDR_NATURE_INVALID CPC_ADDR_NATURE_UNIQUE_SUBSCRIBER_NUMBER CPC_ADDR_NATURE_UNIQUE_NATIONAL_NUMBER CPC_ADDR_NATURE_UNIQUE_INTERNATIONAL_NUMBER CPC_ADDR_NATURE_NON_UNIQUE_SUBSCRIBER_NUMBER (0+) CPC_ADDR_NATURE_NON_UNIQUE_NATIONAL_NUMBER (0+) CPC_ADDR_NATURE_NON_UNIQUE_INTERNATIONAL_NUMBER (01+) CPC_ADDR_NATURE_TEST_LINE_CODE CPC_ADDR_NATURE_NO_NUMBER_PRESENT_OPERATOR_REQUE STED (0-) CPC_ADDR_NATURE_NO_NUMBER_PRESENT_CUTTHROUGH_CAL L_TO_CARRIER CPC_ADDR_NATURE_950 CPC_ADDR_NATURE_UNKNOWN CPC_ADDR_NATURE_NO_CHANGE (Japan only) CPC_ADDR_NATURE_NETWORK_SPECIFIC (Japan only) CPC_ADDR_NATURE_SS7_RESERVED (Japan only)
5-74
TABLE 5 -20.
Nature of Address Parameter Values for Billing and Charge

Value 11 12 13 14 15 16
Numbers
Parameter Names
CPC_ADDR_NATURE_ANI_OF_CALLING_PARTY_SUBSCRIBER_ NUMBER CPC_ADDR_NATURE_ANI_NOT_AVAILABLE_OR_NOT_PROVIDE D CPC_ADDR_NATURE_ANI_OF_CALLING_PARTY_NATIONAL_NU MBER CPC_ADDR_NATURE_ANI_OF_CALLED_PARTY_SUBSCRIBER_N UMBER CPC_ADDR_NATURE_ANI_OF_CALLED_PARTY_NO_NUMBER_PR ESENT CPC_ADDR_NATURE_ANI_OF_CALLED_PARTY_NATIONAL_NUM BER
The Nature of Address range includes the ISUP Reserve/Spare values. The block of ISUP NOA enumerations (0 to 127) is appended to the existing Sonus enumerations, beginning at 128. This arrangement is depicted below
Nature of Address Value Ranges

Sonus Defined Values (0-21) Sonus Reserved Values (22-127) ISUP Reserve/Spares (128-255)
Therefore NOA values in the record which are less than 22 should be interpreted as Sonus NOAs. Values greater than 127 are ISUP (Spare/Reserve) NOAs, to be derived by subtracting 128 from the record value. For example, a record value of 254 is an ISUP 126 NOA (254-128). ISUP NOAs which map to a Sonus NOA are generated without any offset.
Japan ISUP Variant Sub-field Descriptions

Table 5 -21 lists all the sub-fields in the Japan ISUP specific data field. This protocol specific field is a string delimited by the string delimiter . The multiple sub-fields identify the protocol type and all information specific to the protocol. The sub-fields are separated by a comma (,). An empty field is represented by either two consecutive commas (,,) or by comma-space-comma (, ,). For example: JAPAN,0,0, ,,,,...,0x04
5-75
Note
The Calling Party Category and Dialed Number fields are not present in these sub-fields. The are included as regular fields in the underlying Start, Stop, Attempt, or Intermediate Record.
TABLE 5 -21.
Sub-fields in Japan ISUP Specific Data Field

Protocol Variant (String up to 16 characters, e.g. JAPAN) UUI Sending Count (1 decimal character, 0-9) UUI Receiving Count (1 decimal character, 0-9) PSTN additional Calling partys category 1 (4 hex characters, 0x00-0xFF) Mobil additional Calling partys category 1 (4 hex characters, 0x00-0xFF) Mobil additional Calling partys category 2 (4 hex characters, 0x00-0xFF) Mobil additional Calling partys category 3 (4 hex characters, 0x00-0xFF) PSTN additional Called partys category 1 (4 hex characters, 0x00-0xFF) Mobil additional Called partys category 1 (4 hex characters, 0x00-0xFF) Mobil additional Called partys category 2 (4 hex characters, 0x00-0xFF) Mobil additional Called partys category 3 (4 hex characters, 0x00-0xFF) Called CA (5 decimal characters, 0000099999) Calling CA (5 decimal characters, 0000099999) Called IN Number (String up to 26 decimal characters) Called Terminal Type (1 binary character, 0-1) Calling Terminal Type (1 binary character, 0-1) Unit rate indicator (4 hex characters, 0x00-0xFF) Initial lump-call rate (Max 2 decimal characters, 0-15) First charging period (Max 3 decimal digits, 0-999) Second charging period (Max 3 decimal digits, 0-999) Third charging period (Max 3 decimal digits, 0-999) Fourth charging period (Max 3 decimal digits, 0-999) Contractor Number (String up to 26 decimal characters) National/international call (1 binary character, 0-1) Original Called IN Number (Max 26 digits decimal) Redirecting Number (Max 26 digits decimal) Carrier Flag 1 (4 hex characters, 0x00-0xFF) Carrier Code 1 (4 decimal characters, 0000-9999) POI-CA Code 1 (5 decimal characters, 00000-99999) POI Level 1 (4 hex characters, 0x00-0xFF)
Sub-field 1: Sub-field 2: Sub-Field 3: Sub-Field 4: Sub-Field 5: Sub-Field 6: Sub-Field 7: Sub-Field 8: Sub-Field 9: Sub-Field 10: Sub-Field 11: Sub-Field 12: Sub-Field 13: Sub-Field 14: Sub-Field 15: Sub-Field 16: Sub-Field 17: Sub-Field 18: Sub-Field 19: Sub-Field 20: Sub-Field 21: Sub-Field 22: Sub-Field 23: Sub-Field 24: Sub-Field 25: Sub-Field 26: Sub-Field 27: Sub-Field 28: Sub-Field 29: Sub-Field 30:
5-76
TABLE 5 -21.

Carrier Flag 2 (4 hex characters, 0x00-0xFF) Carrier Code 2 (4 decimal characters, 0000-9999) POI-CA Code 2 (5 decimal characters, 00000-99999) POI Level 2 (4 hex characters, 0x00-0xFF) Carrier Flag 3 (4 hex characters, 0x00-0xFF) Carrier Code 3 (4 decimal characters, 0000-9999) POI-CA Code 3 (5 decimal characters, 00000-99999) POI Level 3 (4 hex characters, 0x00-0xFF) Carrier Flag 4 (4 hex characters, 0x00-0xFF) Carrier Code 4 (4 decimal characters, 0000-9999) POI-CA Code 4 (5 decimal characters, 00000-99999) POI Level 4 (4 hex characters, 0x00-0xFF) Carrier Flag 5 (4 hex characters, 0x00-0xFF) Carrier Code 5 (4 decimal characters, 0000-9999) POI-CA Code 5 (5 decimal characters, 00000-99999) POI Level 5 (4 hex characters, 0x00-0xFF) Carrier Flag 6 (4 hex characters, 0x00-0xFF) Carrier Code 6 (4 decimal characters, 0000-9999) POI-CA Code 6 (5 decimal characters, 00000-99999) POI Level 6 (4 hex characters, 0x00-0xFF) Carrier Flag 7 (4 hex characters, 0x00-0xFF) Carrier Code 7 (4 decimal characters, 0000-9999) POI-CA Code 7 (5 decimal characters, 00000-99999) POI Level 7 (4 hex characters, 0x00-0xFF) SCP Carrier Code (4 decimal characters, 0000-9999) Additional POI-CA Code (5 decimal characters, 00000-99999) Transmission Medium Requirement (4 hex characters, 0x00-0xFF) Calling Party Subadress (String up to 12 ASCII characters) This field identifies a subaddress associated with the origin of a call. It is obtained from the Calling Party Subaddress Information Element (IE) in the SETUP or the Access Transport (AT) field in the ISUP IAM message. See the ISDN specification Q.931, Section 4.5.11 for more information.
Sub-Field 31: Sub-Field 32: Sub-Field 33: Sub-Field 34: Sub-Field 35: Sub-Field 36: Sub-Field 37: Sub-Field 38: Sub-Field 39: Sub-Field 40: Sub-Field 41: Sub-Field 42: Sub-Field 43: Sub-Field 44: Sub-Field 45: Sub-Field 46: Sub-Field 47: Sub-Field 48: Sub-Field 49: Sub-Field 50: Sub-Field 51: Sub-Field 52: Sub-Field 53: Sub-Field 54: Sub-Field 55: Sub-Field 56: Sub-Field 57: Sub-Field 58:
5-77
TABLE 5 -21.

Called Party Subadress (String up to 12 ASCII characters) This field identifies a subaddress associated with the called party of a call. It is obtained from the Called Party Subaddress Information Element (IE) in the SETUP or the Access Transport (AT) field in the ISUP IAM message. See the ISDN specification Q.931, Section 4.5.9 for more information.
Sub-Field 59:
SIP Variant Sub-field Descriptions

Table 5 -22 lists all the sub-fields in the SIP specific data field.
TABLE 5 -22.
Sub-fields in SIP Specific Data Fields

Protocol Variant (String up to 16 characters, for example: SIP) Call ID (variable length string , for example: 44-871244022@sylcs.sonusnet.com). From Field (variable length string, for example: 3211941116@10.99.55.6) To Field (variable length string, for example: 2971612002@10.20.9.73)
Sub-Field 1: Sub-Field 2: Sub-Field 3: Sub-Field 4:
This SIP variant is delimited by the delimiter . The sub-fields are separated by a comma (,). An empty field is represented by either two consecutive commas (,,) or by comma-space-comma (, ,). For example:
SIP,44-871244022@sycls.sonusnet.com,3211941116@10.99.55.6,2971612002@10.20.9.73
If a double quote () occurs within a sub-field, then the escape sequence %22 will replace the double quote. For example, the SIP Protocol Variant: "SIP,f26b0300-464a4c40-7704286-322e3031@10.20.9.68,6976921234 <sip:6976921234@10.99.55.6>;tag=, <sip:3216921115@10.99.55.6>;tag=34" will be rendered as: "SIP,f26b0300-464a4c40-7704286-322e3031@10.20.9.68,%226976921234%22 <sip:6976921234@10.99.55.6>;tag=, <sip:3216921115@10.99.55.6>;tag=34"
H.323 Signaling Sub-field Descriptions

Table 5 -23 lists all the sub-fields in the H.323 Signaling specific data field.
TABLE 5 -23.
Sub-fields in H.323 Signaling Specific Data Fields

Protocol Variant (always H323) H.323 Call Identifier. A 16 byte hexadecimal number that identifies the H.323 call globally and uniquely. H.323 Conference Identifier. A 16 byte hexadecimal number that is used to associate H.323 calls in the same conference.
Sub-Field 1: Sub-Field 2: Sub-Field 3:
The H.323 Protocol string is always 72 characters, including both double quotes. For example, when the H.323 Call Identifier is,
5-78
0x000102030405060708090A0B0C0D0E0F
and the H.323 Conference Identifier is,

0x00112233445566778899AABBCCDDEEFF
the Protocol string is:

H323,000102030405060708090A0B0C0D0E0F,0011223344556677 8899AABBCCDDEEFF
GSX Gateway to Gateway Signaling Sub-field Descriptions

Table 5 -24 lists all the sub-fields in the GSX Gateway to GSX Gateway Signaling specific data field.
TABLE 5 -24.
Sub-fields in GSX Gateway to GSX GatewaySignaling Specific

Protocol Variant (always GSX2GSX) The GSX Gateway to GSX Gateway Handle. A 32 bit hexadecimal number used to uniquely identify a single call across multiple GSXs. The GSX Call ID (see GSX Call ID Field on page 5-41) cannot be used for this purpose because it may vary from GSX to GSX.
Data Fields
Sub-Field 1: Sub-Field 2:
The GSX Gateway to GSX Gateway Protocol string is always 20 characters, including both double quotes. For example:
GSX2GSX,0x12345678
BT-IUP Variant Sub-field Descriptions

Table 5 -25 lists all the sub-fields in the British Telecom Interconnect User Part (BTIUP) protocol variant specific data fields.
5-79
TABLE 5 -25.
Sub-fields in BT-IUP Specific Data Fields

Protocol Variant (always BT-IUP). The Presentation Number Nature of Address (3 decimal characters). The Presentation Number is the number displayed on a Called persons phone, when the actual Calling Line Identification may be misleading or confusing to the user, or the calling person may wish the call returned to a different number. Valid Nature of Address values are: 0-2 - Reserved 3 - National (Significant) Number 4 - International Number 5-127 - Reserved
Sub-Field 3:
The Presentation Number Address Restriction Indicator (1 decimal character). Indicates if the Presentation Number can be shown to the end user. Valid values are: 0 - Presentation Allowed 1 - Presentation Restricted 2-3 - Reserved
Sub-Field 4:
The Presentation Number Screening Indicator (1 decimal character). Indicates the screening performed on the Presentation Number. Valid values are: 0 - User Provided not Verified 1 - User Provided Verified and Passed 2 - Reserved 3 - Network Provided
5-80
TABLE 5 -25.
Sub-fields in BT-IUP Specific Data Fields

The Presentation Number Digits (variable length string of up to 18 characters). This is a globally unique identifier used within the U.K. network. The Partial Calling Line Identification Digits (variable length string of up to 18 characters). The Partial Calling Line Identification is generated when the actual Calling Line Identification is not available or can not be obtained. Each switch within the Network is assigned a unique Partial Calling Line Identification, which is obtained from the Official Telecommunication body (OFTEL). For example, a Partial Calling Line Identification of 12345678904545 is interpreted as follows: 12 - Type of Switch 345 - PNO Identify 678 - Switch Number Remaining Digits - Bilaterally Agreed Digits
Sub-Field 7:
The Release Reason (3 decimal characters, 0-255). The IUP specific Release Reason used to terminate the Call. The value is encoded per the PNO 6 specification, Section 2.4.24, Release Reason.
Sub-Field 8:
Malicious Call Trace (variable length string of up to 3 characters). Valid values are: - No trace on this call. MCT - A Malicious Call Trace (MCT) is being performed on this call. This will help tracing the call through the network.
This BT-IUP variant is delimited by the delimiter . The sub-fields are separated by a comma (,). An empty field is represented by either two consecutive commas (,,) or by comma-space-comma (, ,). For example:
BT-IUP,3,0,1,01793602000,01254267323,47,MCT
The maximum total field length of the BT-IUP variant is 62 characters, as analyzed below:
2 - Leading and Trailing Double Quotes 53 - Total of the 8 data sub-fields (6 + 3 + 1 + 1 + 18 + 18 + 3 + 3) 7 - Commas between sub-fields
5-81
Signaling Type Enumeration Values

TABLE 5 -26.
Signaling Type Enumeration Values

0 1 2 3 4 5 6 7 8 9 10 11 12
FIRST_SG_TYPE SG_TYPE_SS7 SG_TYPE_CAS SG_TYPE_ISDN SG_TYPE_H323 SG_TYPE_GW SG_TYPE_DEDICATED SG_TYPE_RAS SG_TYPE_MGSG SG_TYPE_ASG SG_TYPE_STATIC_PST N SG_TYPE_STATIC_IP SG_TYPE_SIP
Far End Switch Type Enumeration Values

TABLE 5 -27.
Far End Switch Type Enumeration Values

0 1 2 3 4 5
CPC_PSTN_TG_FAREND_SWITCH_TYPE_UNKNOWN CPC_PSTN_TG_FAREND_SWITCH_TYPE_ACCESS CPC_PSTN_TG_FAREND_SWITCH_TYPE_TANDEM CPC_PSTN_TG_FAREND_SWITCH_TYPE_EAEO CPC_PSTN_TG_FAREND_SWITCH_TYPE_NONEAEO CPC_PSTN_TG_FAREND_SWITCH_TYPE_IXC
Codec Type Descriptions

Table 5 -28 lists all the sub-fields in the Ingress and Egress Codec Type fields. A colon character (:) separates sub-field 1 from sub-field 2 and sub-field 2 from sub-field 3.
5-82
TABLE 5 -28.
Sub-fields in Codec Type Fields

Network Type (one character): C - Circuit Network P - Packet Network
Sub-Field 1:
Sub-Field 2:
Codec Type (one numeric digit): 0 - PKT_ENCODING_NULL 1 - PKT_ENCODING_G711 2 - PKT_ENCODING_G711_SILENCE_SUPPRESS 3 - PKT_ENCODING_G723 4 - PKT_ENCODING_G729A 5 - PKT_ENCODING_G729AB 6 - PKT_ENCODING_FAX_RELAY 7 - PKT_ENCODING_G723A 8 - PKT_ENCODING_FAX_G726
Sub-Field 3:
G711 Audio Encoding Types (these one digit values apply only when the Codec Type is G711 or G711_SILENCE_SUPPRESS ): 0 - CKT_ENCODING_NULL 1 - CKT_ENCODING_G711_ULAW 2 - CKT_ENCODING_G711_ALAW G723 Audio Encoding Type (these one digit values apply only when the Codec Type is G723 or G723A): 0 - G723_CODING_RATE_5P3_KBPS (5.3K bits per second) 1 - G723_CODING_RATE_6P3_KBPS (6.3K bits per second) G726 Audio Encoding Type (this one digit value applies only when the Codec Type is G726): 2 - G726_CODING_RATE_32KBPS Sub-Field 3 is not applicable (treated as dont care) for Code Types NULL, G729A, G729AB, and FAX_RELAY)
The Codec Type string is always 5 characters, including both colons. For example,
P:4:1
indicates that the ingress or egress leg is from a packet network with G729A encoding. The Audio Encoding Type of 1 is meaningless or dont care for G729A packet encoding. The string,
C:1:2
indicates that the ingress or egress leg is from a circuit network with G711 encoding and aLaw audio encoding. The string,
P:1:2
indicates a G711 packet call with aLaw encoding. The string,

C:3:1
indicate a G723 circuit call a 6300 bits per second.
5-83
Note
Circuit calls will alway be of codec type G711.
TDM Trunk Group Type Enumeration Values

TABLE 5 -29.
TDM Trunk Group Type Enumeration Values

1 2 3 4 5 6 7
Unknown or Other IMT (Inter-Machine Trunk) FGD (Feature Group D) DAL (Direct Access Line) FGB (Feature Group B) CNAT (Connecting Network Access Trunking) CAMA (Centralized Automatic Message Accounting) TYPE 2A (Mobil Switching Center to Access Tandem)
5-84
6-1
CHAPTER 6
Troubleshooting
This chapter answers some frequently asked questions about the GSX9000 and presents some solutions to common problems that Sonus personnel have encountered. The chapter organization is:
Frequently Asked Questions on page 6-1 Solutions to Frequently Encountered Problems on page 6-2 Replacing Modules on page 6-7 Reporting Problems on page 6-7
Frequently Asked Questions

This section answers some frequently asked questions about the GSX9000.
Is the SS7 Gateway Interacting Properly with the GSX?

This question is answered via a series of further questions.
Can you successfully ping the SS7 Gateway?

If yes, proceed to the next question. If no, reset and restart the SS7 Gateway as necessary. See the SGX2000 SS7 Signaling Gateway Installation and Operations Guide for details.
Is the Policy Server Interacting Properly with the GSX?

This question is answered via a series of further questions.
Can you successfully ping the Policy Server?

If yes, proceed to the next question. If no, reset and restart the Policy Server as necessary. See the PSX6000 Policy Server Installation and Operations Guide for details.
6-2
Solutions to Frequently Encountered Problems

This section provides solutions to problems that have been encountered by Sonus personnel. Each case is headed by a problem statement. The text that follows expands the statement, if necessary, and adds typical symptoms. Each subheading presents a possible solution, as detailed further in the text that follows it.
Unable to Log on to the MNS Firmware from Craft Port

Youre unable to reach the NVS Parameters Main Menu after booting the GSX. If you dont even see the Password prompts on your local terminal, the latter solutions are more likely.
Use the Correct Passwords

When the GSX is shipped, the default Access Password and the default Secure Password is gsx9000. This value is case sensitive. If you have changed this value, you must enter the current password. See Cant Remember Admin Password.
Set Matching Baud Rates

When the GSX is shipped, the default MNS1x firmware baud rate is 9600. Your local ASCII terminal must use the same 9600 rate. If you change the MNS1x rate, you must change the rate at your terminal to match it.
Make Sure Youre Using the Right Cable

The GSX is shipped with a craft port serial straight through cable, 9 pin to 9 pin. A 9 pin to 25 pin adapter is also shipped. See the craft port pin out table in Chapter 5 of the GSX9000 Installation Guide to confirm that your local ASCII terminal is properly connected to the craft port.
Unable to Connect Successfully to a Router

IP exchanges between the GSX and the IP router are unsuccessful. Often these problems are resolved through specific configuration of the router rather than the GSX9000.
Configure 3Com Routers Properly

When connecting directly to a 3Com CBX500 router, the Ethernet frame type for the GSX must be Ethernet 2, not SNAP. The link speed for this connection must be 100 Mb half-duplex.
6-3
Configure Cisco Routers Properly

When connecting directly to a Cisco 4000 switch, spanning tree must be disabled. For improved performance with Cisco routers, proxy_arp should remain disabled at all times on the router.
Manually Configure MNA10 Link Parameters

By default when first connected to a router, the GSX auto-negotiates the Ethernet link parameters (speed, duplex) on all MNA10 Ethernet ports. This practice is recommended by Sonus. If a particular router does not support auto-negotiation or fails to properly synchronize while using it, you may manually configure the link parameters. You must invoke the NVS Configuration Menus as discussed in the GSX9000 Open Services Switch Installation Guide, Chapter 8, Booting. You may set the GSX link parameters to 100BaseTX full duplex, 100BaseTX half duplex, 10BaseT full duplex, 10BaseT half duplex, and auto-negotiate. The menu sequence below demonstrates the manipulations that you would perform to view the current status of the Ethernet ports on the MNA10. Your input data is shown in bold font.
NVS Parameters Main Menu 1 - NVS Parameter Display 2 - IP Parameter Display 3 - MFG Parameter Display 4 - NVS Parameter Modification 5 - NFS Parameter Display 6 - Ethernet Port Status Display f - Field Service Access r - restore default NVS Parameters x - exit, save changes q - quit, do not save changes Choice: 6
6-4
Ethernet Port Status Display Ethernet Port 1 Configured Speed: Auto Negotiate Link Status: Up Negotiated Speed: 100BaseTX Full Peer Advertisement: Ack 100BaseTX_FD 100BaseTX 10BaseT_FD 10BaseT Ethernet Port 2 Configured Speed: Auto Negotiate Link Status: Down Press any key to continue...
MNS10 Server Module: Server Name: Firmware Version: Ethernet Port 1: Ethernet Port 2: Field Service Port:
Slot 2 MRG_2 V01.00.04 R000 00-10-6B-00-00-BC 00-10-6B-00-00-BD 00-10-6B-00-00-BB
10.6.1.49 10.6.1.50 10.5.1.61
255.255.0.0 255.255.0.0 255.255.0.0
0.0.0.0 0.0.0.0 10.5.7.9
The menu sequence below changes the Ethernet link parameters on MNA10 port 2 from auto-negotiate to 10BaseT full duplex.
NVS Parameters Main Menu 1 - NVS Parameter Display 2 - IP Parameter Display 3 - MFG Parameter Display 4 - NVS Parameter Modification 5 - NFS Parameter Display 6 - Ethernet Port Status Display f - Field Service Access r - restore default NVS Parameters x - exit, save changes q - quit, do not save changes Choice: 4
6-5
NVS Parameter Modification 1 - Server Module 2 - Master State 3 - Parameter Loading Mode 4 - CLI Startup Script File 5 - NVS Menu Parameters 6 - NFS Parameters 7 - Load File Parameters 8 - Core Dump State 9 - Core Dump Level a - Ethernet Port 1 IP Parameters b - Ethernet Port 2 IP Parameters c - Field Service Port IP Parameters d - Ethernet Port 1 Speed e - Ethernet Port 2 Speed x - Return Choice: e
Ethernet Port 2 Speed 1 - Auto Negotiate 2 - 100BaseTX Full 3 - 100BaseTX Half 4 - 10BaseT Full 5 - 10BaseT Half x - Return Current: Auto Negotiate Choice: 4
Unable to Telnet to the GSX

You dont get a log on prompt when you telnet to the GSX that youve just booted.
6-6
Specify the Correct Management Ethernet Port

When you configured the NVS parameters, you specified the Ethernet Port 1 IP Address and the Ethernet Port 1 IP Subnet mask. Your subnet mask must properly describe the network and host numbers in your IP address. You must telnet to the IP address for Ethernet Port 1, not Ethernet Port 2.
Make sure the CLI is Loaded and Initialized

When you booted the GSX you downloaded and initialized program image files from the system tree. If any of these files failed to properly download or initialize, they retry indefinitely. Thus at the time that you try to log on, the GSX will be attempting to complete the boot and will not respond to your input. A successful boot is indicated by:
completion messages from your CLI Startup Script File being present in the GSX system tree in /cli/logs Status LEDs on each initialized module should flash once per second
If these indications are not present, correct your CLI Startup Script File and reboot.
Cant Remember Admin Password

This problem is self-explanatory but most problematic as you can see from the latter solutions.
Change the Password through Another User

If you can log on to the GSX through another user account that has admin privileges, you can assign a new password to user admin, and thereafter log on using that password.
Remove All Saved Configurations and Reboot

Backup and then delete all .prm and .bck parameter files from the /param directory of the GSX System Tree. Power-cycle the GSX. This will cause the GSX to boot with default parameters. If you restore these parameters, you will also restore the troublesome password.
Return the MNS Module to the Factory

If you have no other user accounts except admin, and you are unable or unwilling to remove your current configuration, then you will need to return your MNS1x module(s) to Sonus to get the default admin password, gsx9000 reinstalled.
Replacing Modules
6-7
Replacing Modules
If a PNS10, CNS10, or CNS30 module fails or has hardware related problems, you must replace the module by following the procedure below.
To Replace a Module
1.
Use the appropriate CONFIGURE command(s) to change the modules operational state to outofservice. If there are active calls on the module, and you want to let them complete before replacing the module, use dryup as the teardownmode or action. dryup keeps any new calls from using the module specified, and waits for active calls to complete, or releases them after a specified timeout period. If you want to force all calls to be released immediately, use force as the teardownmode or action.. force forces all calls to be immediately released. For a PNS10 module, refer to PNS10 Network Interface (Ethernet NIF) on page 3-69 for the command syntax and definitions. See also FRU document 55000022. For a CNS10 module, refer to T1 on page 3-186 for the command syntax and definitions. See also FRU document 550-00018. For a CNS20 module, refer to E1 on page 3-205 for the command syntax and definitions. See also FRU document 550-00059. For a CNS30 module, refer to T3 on page 3-218 for the command syntax and definitions. See also FRU document 550-00020.
2.
When the modules state has changed to outofservice, remove the module and replace it with a new one. As soon as the module is replaced, the new module will load and go to an inservice state.
Reporting Problems
If you need to report a serious problem to Sonus, you may be asked to provide a core dump. Core dumps help Sonus to debug problems if a software error occurs on a board in the GSX9000. By default, core dumping is enabled for all modules in the system. For information on setting the core dump state and sensitivity, refer to Non-Volatile Storage (NVS) Parameters on page 3-34. Core dump files are maintained in the coredump subdirectory of the GSX system tree on the NFS server. This tree is shown in Figure 7-3 of the GSX9000 Open Services Switch Installation Guide. Using the Figure 7-3 tree as an example, the coredump subdirectory would be /export/SonusNFS/BOOT/coredump. All core dumps are written to files in this subdirectory that are named as follows:
core.aaaaa.bb.cc.<uniqueID>
where,
aaaaa is the least significant 5 digits of the module's serial number, bb is the shelf index,
6-8
Reporting Problems
cc is the card's slot number in the chassis (an "xx" represents an MNS) uniqueID is a unique time stamp representing the time of day of the crash.
For example, the core dump filename core.00056.00.12.221417 means a server card with the last five serial number digits are 00056 on shelf 0 slot 12 dumped at 22:14:17 UTC. To disable dumping on an MNS, you must disable the NVS parameter "Core Dump State". You may accomplish this by either:
Modifying the parameter appropriately when you boot the GSX (see GSX9000 Installation Guide, Chapter 8). After booting successfully, modifying the parameter through the CLI command:
CONFIG NODE NVS SHELF 1 SLOT 1 CORE DUMP STATE disabled
(The SLOT parameter is 1 or 2, depending which slot you use for your MNS/MNA modules.) This parameter setting is retained when you reboot your system.
A-1
APPENDIX A
CLI Facilities
The CLI provides a means of configuring your GSX node. The command syntax, parameter descriptions, and management considerations have been presented. This section lists many important features that will assist your use of the CLI application.
Command Line Interface Inline Editing

The CLI provides inline editing capabilities using EMACS and vi. EMACS is the default editing mode. To display the current editing mode, enter the TCL command:
puts $EDITOR
To change editing mode to vi, enter the TCL command:

set EDITOR vi
EMACS Edit Mode

Table A -1, EMACS Edit Mode Commandslists available editing commands. Descriptions include command names, an n if the command can be prefixed with a count, and keys to which the command is bound by default (written in caret notation, e.g., ASCII ESC character is written as ^[). A command count prefix is shown with the sequence ^[n, where n is a sequence of digits. If a count is omitted, it defaults to 1 unless otherwise specified. Note that edit command names are used only with the bind command, and that many editing commands are useful only on terminals with visible cursors. Default bindings were chosen to resemble EMACS key bindings. The users tty characters (e.g., ERASE) are bound to substitutes and override the default bindings.
TABLE A -1.
EMACS Edit Mode Commands

Key Sequence ^G n n ^B Description Useful as a response to a request for a search-history pattern in order to abort the search. Causes the character to appear as literal input. Most ordinary characters are bound to this. Moves the cursor back n characters.
Command abort auto-insert backward-char
A-2
TABLE A -1.

Key Sequence n ^[B Description Moves the cursor back to the beginning of a word; words consist of alphanumerics, underscore (_) and dollar ($). Moves to the beginning of the history. Moves the cursor to the beginning of the edited input line. Uppercase the first character in the next n words, leaving the cursor at the end of the last word. If this line does not begin with a comment character, add one at the beginning of the line and enter the line (as if return was pressed), or remove existing comment characters and move the cursor to the beginning of the line. Deletes n characters before the cursor. Deletes n characters after the cursor. Deletes n words before the cursor. Deletes characters after the cursor to the end of n words. Scrolls history buffer forward n lines. Initially, each line starts after the last history buffer entry, so down-history is useful only after performing search-history or up-history. Lowercases the next n words. Moves to the end of the history. Moves the cursor to the end of the input line. Acts as an end-of-file; this is useful because edit mode input disables normal terminal input canonicalization. Acts as eot if alone on a line; otherwise acts as delete-char-forward. Error (ring the bell). ^X^X n ^F n ^[f n ^[g KILL ^W n ^K Places the cursor where the mark is, and sets the mark to where the cursor was. Moves the cursor forward n characters. Moves the cursor forward to the end of the nth word. Goes to history number n. Deletes the entire input line. Deletes the input between the cursor and the mark. Deletes from the cursor to the end of the line if no n is specified, otherwise deletes characters from the cursor to column n. Causes the current input line to be processed by the shell. The current cursor position may be anywhere on the line. Version 4.01, Document Version 2
Command backward-word
beginning-of-history beginning-of-line capitalize-word
^[< Â n ^[c, ^[C
delete-char-backward delete-char-forward delete-word-backward delete-word-forward down-history
n ERASE, ^?, ^H n n ^[ERASE, ^[^?, ^[^H, ^[h n ^[d n ^N
downcase-word end-of-history end-of-line eot
n ^[L, ^[l ^[> Ê ^_
eot-or-delete error exchange-point-a nd-mark forward-char forward-word goto-history kill-line kill-region kill-to-eol
n ^D
newline
^J, ^M
A-3
TABLE A -1.

Key Sequence Ô Description Causes the current input line to be processed by the shell, and the next line from history becomes the current line. This is only useful after an up-history or search-history. This does nothing. Introduces a 2-character command sequence. Introduces a 2-character command sequence. Introduces a 2-character command sequence. The last (nth) word of the previous command is inserted at the cursor. The following character is taken literally rather than as an editing command. Reprints the prompt string and the current input line. Search backward in the current line for the nth occurrence of the next character typed. Search forward in the current line for the nth occurrence of the next character typed. Enter incremental search mode. The internal history list is searched backwards for commands matching the input. An initial ^ in the search string anchors the search. The abort key exits search mode. Other commands are executed after leaving search mode. Successive search-history commands continue searching backward to the previous occurrence of the pattern. The history buffer retains a finite number of lines; the oldest are discarded as necessary. Set the mark at the cursor position. If at the end of line, or if the gmacs (currently unsupported) option is set, this exchanges the two previous characters; otherwise, it exchanges the previous and current characters and moves the cursor one character to the right. Scrolls the history buffer backward n lines (earlier). Uppercases the next n words. Inserts the most recently killed text string at the cursor. Immediately after yank, replaces the inserted text string with the next previous killed text string.
Command newline-and-next
no-op prefix-1 prefix-2 prefix-2 prev-hist-word quote redraw search-character-backward search-character-forward search-history
QUIT ^[ ^X ^[[ n ^[., ^[_ ^^ ^L n ^[^] n ^] ^R
set-mark-command transpose-chars
^[<space> ^T
up-history upcase-word yank yank-pop
n ^P n ^[U, ^[u ^Y ^[y
VI Edit Mode
The vi command line editor has basically the same commands as the vi editor, with the following exceptions:
You start out in insert mode The _ command is different (it is the last argument command, in vi it goes to the start of the current line)
A-4
The / and G commands move in the opposite direction as the j command Commands which don't make sense in a single line editor are not available (e.g., screen movement commands, ex : commands, etc.).
Note that the ^X stands for control-X; also <esc>, <space> and <tab> are used for escape, space and tab, respectively. Like vi, there are two modes: insert mode and command mode. In insert mode, most characters are simply put in the buffer at the current cursor position as they are typed, however some characters are treated specially. In particular, the following characters are taken from current tty settings and have their usual meaning (normal values are in parentheses): kill (Û), erase (^?), werase (^W), eof (^D), intr (^C) and quit (^\). In addition to the above, the following characters are also treated specially in insert mode:
TABLE A -2.
VI Edit Mode Keys

Description Erases previous character Literal next: the next character typed is not treated specially (can be used to insert characters being described here) End of line: the current line is read, parsed, and executed by the shell Places the editor in command mode (see below)
Key ^H ^V ^J, ^M <esc>
If a line is longer than the screen width, a >, + or < character is displayed in the last column indicating that there are more characters after, before and after, or before the current position, respectively. The line is scrolled horizontally as necessary. In command mode, each character is interpreted as a command. Characters that don't correspond to commands are illegal combinations of commands or are commands that can't be carried out all cause beeps. In the following command descriptions, a n indicates the command may be prefixed by a number (e.g., 10l moves right 10 characters); if no number prefix is used, n is assumed to be 1 unless otherwise specified. The term current position refers to the position between the cursor and the character preceding the cursor. A word is a sequence of letters, digits and underscore characters or a sequence of non-letter, non-digit, non-underscore, non-white-space characters (e.g., ab2*&^ contains two words) and a `big-word' is a sequence of non-white-space characters.
Special Commands
The following commands are not in, or are different from, the normal vi file editor:
TABLE A -3.
VI Mode Special Commands

Description Insert a space followed by the nth big-word from the last command in the history at the current position and enter insert mode; if n is not specified, the last word is inserted. Insert the comment character (#) at the start of the current line and return the line to the shell (equivalent to I#^J). Like G, except if n is not specified, it goes to the most recent remembered line.
Key n_
# ng
A-5
Intra-line Movement Commands

TABLE A -4.
VI Mode Intra-line Movement Commands

Description Move left n characters. Move right n characters. Move to column 0. Move to the first non white-space character. Move to column n. Move to the last character. Move back n words. Move back n big-words. Move forward to the end the word, n times. Move forward to the end the big-word, n times. Move forward n words. Move forward n big-words. Find match: the editor looks forward for the nearest parenthesis, bracket or brace and then moves to the matching parenthesis, bracket or brace. Move forward to the nth occurrence of the character c. Move backward to the nth occurrence of the character c. Move forward to just before the nth occurrence of the character c. Move backward to just before the nth occurrence of the character c. Repeats the last f, F, t or T command. Repeats the last f, F, t or T command, moving in the opposite direction.
Key nh and n^H nl and n<space> 0 ^ n| $ nb nB ne nE nw nW %
nfc nFc ntc nTc n; n,
Inter-line Movement Commands

TABLE A -5.
VI Mode Inter-line Movement Commands

Description Move to the nth next line in the history. Move to the nth previous line in the history. Move to line n in the history; if n is not specified, the first remembered line is used. Like G, except if n is not specified, it goes to the last remembered line. Search backward through the history for the nth line containing string; if string starts with ^, the remainder of the string must appear at the start of the history line for it to match. Same as /, except it searches forward through the history. Search for the nth occurrence of the last search string; the direction of the search is the same as the last search. Search for the nth occurrence of the last search string; the direction of the search is the opposite of the last search.
Key nj and n+ and n^N nk and n- and n^P nG ng n/<string>
n?<string> nn nN
A-6
Edit Commands
TABLE A -6.
VI Mode Edit Commands

Description Append text n times: goes into insert mode just after the current position. The append is only replicated if command mode is re-entered (i.e., <esc> is used). Same as a, except it appends at the end of the line. Insert text n times: goes into insert mode at the current position. The insertion is only replicated if command mode is re-entered (i.e., <esc> is used). Same as i, except the insertion is done just before the first non-blank character. Substitute the next n characters (i.e., delete the characters and go into insert mode). Substitute whole line: all characters from the first non-blank character to the end of line are deleted and insert mode is entered. Change from the current position to the position resulting from n move-cmds (i.e., delete the indicated region and go into insert mode); if move-cmd is c, the line starting from the first non-blank character is changed. Change from the current position to the end of the line (i.e., deletes to the end of the line and go into insert mode). Delete the next n characters. Delete the previous n characters. Delete to the end of the line. Same as a, except it appends at the end of the line. Delete from the current position to the position resulting from n move-cmds; move-cmd is a movement command (see above) or d, in which case the current line is deleted. Replace the next n characters with the character c. Replace: enter insert mode but overwrite existing characters instead of inserting before existing characters. The replacement is repeated n times. Change the case of the next n characters. Yank from the current position to the position resulting from n move-cmds into the yank buffer; if move-cmd is y, the whole line is yanked. Yank from the current position to the end of the line. Paste the contents of the yank buffer just after the current position, n times. Same as p, except the buffer is pasted at the current position.
Key na
nA ni
nI ns S ncmove-cmd
C nx nX D nA ndmove-cmd
nrc nR
n~ nymove-cmd
Y np nP
Command Syntax Assistance
A-7
Miscellaneous Commands
TABLE A -7.
VI Mode Miscellaneous Commands

Description The current line is read, parsed and executed by the shell. Redraw the current line. Redo the last edit command n times. Undo the last edit command. Undo all changes that have been made to the current line. The interrupt and quit terminal characters cause the current line to be deleted and a new prompt to be printed.
Key ^J and ^M ^L and ^R n. u U intr and quit
Command Syntax Assistance

The <enter> and <tab> keys may be used to gather hints about command syntax when you are interacting with the CLI.
<enter> Key
This key terminates a command and submits it for processing. When the command is rejected because it is incomplete, the rejection message displays the set of keywords that will increase (and possibly satisfy) command completeness. For example:
% SHOW USER INCOMPLETE COMMAND. EXPECTED ONE OF: <TEXT> PROFILE SUMMARY.
<tab> Key
This key displays the set of keywords that will increase (and possibly satisfy) command completeness, and then restores the command to the point at which you requested this information. The command is not terminated (and possibly rejected), but continued in the presence of additional, helpful information. For example:
% SHOW USER <TEXT> PROFILE SUMMARY % SHOW USER
This key is recommended over <enter> when you are seeking online command syntax assistance.
Administrator Command Extensions

CLI users with ACCESS type admin may make use of the extended TCL commands shown in Table A -8, User TCL Command Extensions.
A-8
Shell Variables
TABLE A -8.
User TCL Command Extensions

Description Loads the command database located in the GSX System Tree at cli/sys/commands.def. Loads the screen definition archive file located in the GSX System Tree at
Command
admin load commands
admin load sdafile
cli/sys/showscreens.sda
This loads all memory resident screens and clears the showcache of all screens.
admin show sessions admin show showcache
Lists all current CLI sessions. Displays the showcache and the resident screens. The showcache is the last n screen definitions loaded from disk. This cache is first checked before loading a screen from disk. Resident screens are screen definitions loaded from disk during the boot process (or by admin load sdafile) that reside permanently in memory.
admin reset showcache source [-f] <file>
Resets the showcache to zero. Evaluates the content of the specified file. The -f option (force) prevents a script from aborting if an error occurs while evaluating a command.
admin break <task id>
Sends an interrupt to a CLI session task. This is useful when it is necessary to stop a script that is running in another session.
Shell Variables
Various aspects of the TCL environment can be inspected and/or controlled by special built-in shell variables.
CLI Prompt
You may wish to display the name of the GSX as the CLI prompt. To do so, set the shell variable PROMPT, using the CLI variable $HOST:
set PROMPT $HOST>
The CLI variable $HOST contains the nodename configured by the CLI command:
CONFIGURE NODE NAME nodename
The $HOST variable is not updated until you next log on. The set PROMPT .. command above may be conveniently placed in the cli/sys/sessinit.tcl file.
Shell Variables
A-9
To illustrate this feature, enter the CLI commands:

CONFIGURE NODE NAME flintstone set PROMPT $HOST> log out
The following is displayed when you log on to this GSX:

telnet 10.1.3.10 Trying 10.1.3.10... Connected to 10.1.3.10. Escape character is '^]'. Sonus Networks, Inc. GSX9000 (10.1.3.10) V02.01.00 R001 Login: admin Password: ******* System Time: Sat Jan 22, 2000 01:31
Welcome to the GSX 9000 flintstone> flintstone> lo Connection closed by foreign host.
The table below summarizes the shell variables that are accessible to CLI users.
TABLE A -9.
Shell Variables
Access read/write Description Describes which editor is used for command line editing. Two editors are supported: vi and emacs. emacs is the default editor. Determines how errors from Sonus configuration commands are handled. If set to one (1) commands that fail are ignored (e.g. processing of a script will continue). Zero (0) is the default and commands that fail will abort a script. Product name (for example GSX9000) Sets the interactive prompt (default %) Sets the continuation prompt. This prompt is used to indicate that input is required to complete a TCL command. (default >) The task id of the shell. User name of the person logged in.
Variable EDITOR
IGNORE_ERRORS
read/write
PRODUCT PROMPT PROMPT1
read/only read/write read/write
TID USER
read/only read/only
A-10
Shell Variables
TABLE A -9.
Shell Variables
Access read/only read/only Description Product software version (e.g. "V01.00.00 A009 Build 0743) The GSX node name as assigned by the CONFIGURE NODE NAME .. command.
Variable VERSION HOST
INDEX
C
Commands
text convention for 2
T
Text conventions 2 Topology
management network 4 network components 3
Conventions
text formats 2
Cross-reference format 2
G
GSX9000
description of 5 infrastructure 4 management network 4 network topology 3
I
Installation sequence 6 Intended audience 2
M
Management network 4
N
Network components 3
P
PSX6000
description of 5
R
Related documents 9
S
SGX2000
description of 5
Sonus Networks, Inc.

address 1
Sonus SoftSwitch
description of 5
SS7 signaling gateway 5
Index-1
Index-2

550-00224 GSX 4.1 Operations Guide 2

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

550-00224 GSX 4.1 Operations Guide 2

Uploaded by

Copyright:

Available Formats

SONUS TECHNICAL PUBLISHING

Sonus Part Number: Document Version: Software Version:

Disclaimer and Restrictions

Chapter 2 Using the CLI to Configure Objects

Chapter 3 CLI Reference

Chapter 4 Managing the GSX

GSX9000 Open Services Switch Operations Guide - 550-00224 - 2

Chapter 5 Call Accounting

GSX9000 Open Services Switch Operations Guide - 550-00224 - 2

GSX9000 Open Services Switch Operations Guide - 550-00224 - 2

GSX9000 Open Services Switch Operations Guide - 550-00224 - 2

Version 4.01, Document Version 2

GSX9000 Open Services Switch Operations Guide

About This Manual

About This Manual

GSX9000 Open Services Switch Operations Guide

Version 4.01, Document Version 2

Network Components and Topology

Network Components and Topology

Overall Network Topology

Overall GSX9000 Open Services Switch Network Topology

Version 4.01, Document Version 2

Network Components and Topology

GSX9000 Open Services Switch Management Network Topology

10/100M Ethernet Insignus Softswitch PSX Policy Server (H.323 GK)

BITS or SETS Timing Source SONET/ Ethernet

GSX9000 Open Services Switch Management Network Topology

GSX9000 Open Services Switch Operations Guide

Version 4.01, Document Version 2

Network Components and Topology

GSX9000 Open Services Switch

Insignus Softswitch PSX Policy Server

Insignus Softswitch SGX SS7 Gateway

MGCP Soft Switch

Version 4.01, Document Version 2

GSX9000 Open Services Switch Operations Guide

NFS and NTP Servers

GSX9000 Open Services Switch Operations Guide

Version 4.01, Document Version 2

Using Insignus Softswitch Control Elements

Perform Perform Site Site Survey Survey

Read and understand the Requirements 1

Collect all required Information

Build out infrastructure as necessary 3

Install Install Hardware Hardware

Install SGX SS7 Gateway 4

Install PSX Policy Server 5

Install NFS server (if necessary) 7

Install Insight server (if necessary) 8

Install Install Software Software

Install/ Configure Sonus Insight 9

Install/ Configure PSX Policy Server 10

Install/ Configure SGX SS7 Gateway (if necessary) 11

Install NFS server 12

Install NTP server (if necessary) 13

Load software into GSX System Tree 14

Configure NVS Parameters 15

Configure Configure GSX GSX

Logon to GSX and access the CLI 17

Configure GSX Management Objects 18

The information in this manual pertains to boxes 17-20 in this process.

Version 4.01, Document Version 2

GSX9000 Open Services Switch Operations Guide